Checking commit emails.
[dragonfly.git] / bin / ps / ps.1
1 .\" Copyright (c) 1980, 1990, 1991, 1993, 1994
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)ps.1        8.3 (Berkeley) 4/18/94
33 .\" $FreeBSD: src/bin/ps/ps.1,v 1.24.2.7 2002/06/20 22:43:33 charnier Exp $
34 .\" $DragonFly: src/bin/ps/ps.1,v 1.12 2006/05/28 23:12:09 dillon Exp $
35 .\"
36 .Dd April 6, 2006
37 .Dt PS 1
38 .Os
39 .Sh NAME
40 .Nm ps
41 .Nd process status
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl aCcefhjlmrSTuvwx
45 .Op Fl M Ar core
46 .Op Fl N Ar system
47 .Op Fl O Ar fmt
48 .Op Fl o Ar fmt
49 .Op Fl p Ar pid
50 .Op Fl t Ar tty
51 .Op Fl U Ar username
52 .Nm
53 .Op Fl L
54 .Sh DESCRIPTION
55 The
56 .Nm
57 utility
58 displays a header line followed by lines containing information about your
59 processes that have controlling terminals.
60 This information is sorted by controlling terminal, then by process ID.
61 .Pp
62 The information displayed is selected based on a set of keywords (see the
63 .Fl L
64 .Fl O
65 and
66 .Fl o
67 options).
68 The default output format includes, for each process, the process' ID,
69 controlling terminal, CPU time (including both user and system time),
70 state, and associated command.
71 .Pp
72 The process file system (see
73 .Xr procfs 5 )
74 should be mounted when
75 .Nm
76 is executed, otherwise not all information will be available.
77 .Pp
78 The options are as follows:
79 .Bl -tag -width indent
80 .It Fl a
81 Display information about other users' processes as well as your own.
82 This can be disabled by setting the
83 .Va kern.ps_showallprocs
84 sysctl to zero.
85 .It Fl c
86 Change the ``command'' column output to just contain the executable name,
87 rather than the full command line.
88 .It Fl C
89 Change the way the CPU percentage is calculated by using a ``raw''
90 CPU calculation that ignores ``resident'' time (this normally has
91 no effect).
92 .It Fl e
93 Display the environment as well.
94 .It Fl f
95 Show commandline and environment information about swapped out processes.
96 This option is honored only if the uid of the user is 0.
97 .It Fl h
98 Repeat the information header as often as necessary to guarantee one
99 header per page of information.
100 .It Fl j
101 Print information associated with the following keywords:
102 .Cm user , pid , ppid , pgid , sess , jobc , state , tt , time ,
103 and
104 .Cm command .
105 .It Fl L
106 List the set of available keywords.
107 .It Fl l
108 Display information associated with the following keywords:
109 .Cm uid , pid , ppid , cpu , pri , nice , vsz , rss , wchan , state ,
110 .Cm tt , time ,
111 and
112 .Cm command .
113 .It Fl M
114 Extract values associated with the name list from the specified core
115 instead of the default
116 .Pa /dev/kmem .
117 .It Fl m
118 Sort by memory usage, instead of by process ID.
119 .It Fl N
120 Extract the name list from the specified system instead of the default
121 .Pa /kernel .
122 .It Fl O
123 Add the information associated with the space or comma separated list
124 of keywords specified, after the process ID,
125 in the default information
126 display.
127 Keywords may be appended with an equals (``='') sign and a string.
128 This causes the printed header to use the specified string instead of
129 the standard header.
130 .It Fl o
131 Display information associated with the space or comma separated list
132 of keywords specified.
133 Keywords may be appended with an equals (``='') sign and a string.
134 This causes the printed header to use the specified string instead of
135 the standard header.
136 .It Fl p
137 Display information associated with the specified process ID.
138 .It Fl r
139 Sort by current CPU usage, instead of by process ID.
140 .It Fl S
141 Change the way the process time is calculated by summing all exited
142 children to their parent process.
143 .It Fl T
144 Display information about processes attached to the device associated
145 with the standard input.
146 .It Fl t
147 Display information about processes attached to the specified terminal
148 device.
149 .It Fl U
150 Display the processes belonging to the specified
151 .Ar username .
152 .It Fl u
153 Display information associated with the following keywords:
154 .Cm user , pid, %cpu , %mem , vsz , rss , tt , state , start , time ,
155 and
156 .Cm command .
157 The
158 .Fl u
159 option implies the
160 .Fl r
161 option.
162 .It Fl v
163 Display information associated with the following keywords:
164 .Cm pid , state , time , sl , re , pagein , vsz , rss , lim , tsiz ,
165 .Cm %cpu , %mem
166 and
167 .Cm command .
168 The
169 .Fl v
170 option implies the
171 .Fl m
172 option.
173 .It Fl w
174 Use 132 columns to display information, instead of the default which
175 is your window size.
176 If the
177 .Fl w
178 option is specified more than once,
179 .Nm
180 will use as many columns as necessary without regard for your window size.
181 .It Fl x
182 Display information about processes without controlling terminals.
183 .El
184 .Pp
185 A complete list of the available keywords are listed below.
186 Some of these keywords are further specified as follows:
187 .Bl -tag -width ".Cm lstart"
188 .It Cm %cpu
189 The CPU utilization of the process; this is a decaying average over up to
190 a minute of previous (real) time.
191 Since the time base over which this is computed varies (since processes may
192 be very young) it is possible for the sum of all
193 .Cm %cpu
194 fields to exceed 100%.
195 .It Cm %mem
196 The percentage of real memory used by this process.
197 .It Cm flags
198 The flags associated with the process as in
199 the include file
200 .In sys/proc.h :
201 .Bl -column P_BREAKTSLEEP 0x10000000
202 .It Dv "P_ADVLOCK" Ta No "0x00001       Process may hold a POSIX advisory lock"
203 .It Dv "P_CONTROLT" Ta No "0x00002      Has a controlling terminal"
204 .It Dv "P_SWAPPEDOUT" Ta No "0x00004    Swapped out of memory"
205 .It Dv "P_BREAKTSLEEP" Ta No "0x00008   Event pending, break tsleep on sigcont"
206 .It Dv "P_PPWAIT" Ta No "0x00010        Parent is waiting for child to exec/exit"
207 .It Dv "P_PROFIL" Ta No "0x00020        Has started profiling"
208 .It Dv "P_SELECT" Ta No "0x00040        Selecting; wakeup/waiting danger"
209 .It Dv "P_SINTR" Ta No "0x00080         Sleep is interruptible"
210 .It Dv "P_SUGID" Ta No "0x00100         Had set id privileges since last exec"
211 .It Dv "P_SYSTEM" Ta No "0x00200        System proc: no sigs, stats or swapping"
212 .It Dv "P_STOPPED" Ta No "0x00400       SIGSTOP status"
213 .It Dv "P_TRACED" Ta No "0x00800        Debugged process being traced"
214 .It Dv "P_WAITED" Ta No "0x01000        SIGSTOP status was returned by wait3/4"
215 .It Dv "P_WEXIT" Ta No "0x02000         Working on exiting"
216 .It Dv "P_EXEC" Ta No "0x04000          Process called exec"
217 .It Dv "P_UPCALLPEND" Ta No "0x20000    An upcall is pending"
218 .It Dv "P_SWAPWAIT" Ta No "0x40000      Waiting for a swapin"
219 .It Dv "P_ZOMBIE" Ta No "0x80000        Now in a zombied state"
220 .It Dv "P_ONRUNQ" Ta No "0x100000       On a user scheduling run queue"
221 .It Dv "P_KTHREADP" Ta No "0x200000     Process is really a kernel thread"
222 .It Dv "P_IDLESWAP" Ta No "0x400000     Swapout was due to idleswap, not load"
223 .It Dv "P_DEADLKTREAT" Ta No "0x800000  Lock aquisition - deadlock treatment"
224 .It Dv "P_JAILED" Ta No "0x1000000      Process is in jail"
225 .It Dv "P_OLDMASK" Ta No "0x2000000     Need to restore mask before pause"
226 .It Dv "P_ALTSTACK" Ta No "0x4000000    have alternate signal stack"
227 .It Dv "P_INEXEC" Ta No "0x8000000      Process is in execve()"
228 .It Dv "P_PASSIVE_ACQ" Ta No "0x10000000        Passive acquire cpu (see kern_switch)"
229 .It Dv "P_UPCALLWAIT" Ta No "0x20000000 Wait for upcall or signal"
230 .El
231 .It Cm lim
232 The soft limit on memory used, specified via a call to
233 .Xr setrlimit 2 .
234 .It Cm lstart
235 The exact time the command started, using the ``%c'' format described in
236 .Xr strftime 3 .
237 .It Cm nice
238 The process scheduling increment (see
239 .Xr setpriority 2 ) .
240 .It Cm rss
241 the real memory (resident set) size of the process (in 1024 byte units).
242 .It Cm start
243 The time the command started.
244 If the command started less than 24 hours ago, the start time is
245 displayed using the ``%l:ps.1p'' format described in
246 .Xr strftime 3 .
247 If the command started less than 7 days ago, the start time is
248 displayed using the ``%a6.15p'' format.
249 Otherwise, the start time is displayed using the ``%e%b%y'' format.
250 .It Cm state
251 The state is given by a sequence of letters, for example,
252 .Dq Li RWNA .
253 The first letter indicates the run state of the process:
254 .Pp
255 .Bl -tag -width indent -compact
256 .It Li D
257 Marks a process in disk (or other short term, uninterruptible) wait.
258 .It Li I
259 Marks a process that is idle (sleeping for longer than about 20 seconds).
260 .It Li J
261 Marks a process which is in
262 .Xr jail 2 .
263 The hostname of the prison can be found in
264 .Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
265 .It Li R
266 Marks a runnable process.
267 .It Li S
268 Marks a process that is sleeping for less than about 20 seconds.
269 .It Li T
270 Marks a stopped process.
271 .It Li Z
272 Marks a dead process (a
273 .Dq zombie ) .
274 .El
275 .Pp
276 Additional characters after these, if any, indicate additional state
277 information:
278 .Pp
279 .Bl -tag -width indent -compact
280 .It Li +
281 The process is in the foreground process group of its control terminal.
282 .It Li <
283 The process has raised CPU scheduling priority.
284 .It Li >
285 The process has specified a soft limit on memory requirements and is
286 currently exceeding that limit; such a process is (necessarily) not
287 swapped.
288 .It Li A
289 the process has asked for random page replacement
290 .Pf ( Dv MADV_RANDOM ,
291 from
292 .Xr madvise 2 ,
293 for example,
294 .Xr lisp 1
295 in a garbage collect).
296 .It Li E
297 The process is trying to exit.
298 .It Li L
299 The process has pages locked in core (for example, for raw
300 .Tn I/O ) .
301 .It Li M
302 On SMP systems indicates a process or thread which is
303 .Em not
304 holding the MP lock (the Big Giant Lock).
305 .It Li N
306 The process has reduced CPU scheduling priority (see
307 .Xr setpriority 2 ) .
308 .It Li S
309 The process has asked for FIFO page replacement
310 .Pf ( Dv MADV_SEQUENTIAL ,
311 from
312 .Xr madvise 2 ,
313 for example, a large image processing program using virtual memory to
314 sequentially address voluminous data).
315 .It Li s
316 The process is a session leader.
317 .It Li V
318 The process is suspended during a
319 .Xr vfork 2 .
320 .It Li W
321 The process is swapped out.
322 .It Li X
323 The process is being traced or debugged.
324 .El
325 .It Cm tt
326 An abbreviation for the pathname of the controlling terminal, if any.
327 The abbreviation consists of the three letters following
328 .Pa /dev/tty ,
329 or, for the console, ``con''.
330 This is followed by a ``-'' if the process can no longer reach that
331 controlling terminal (i.e., it has been revoked).
332 .It Cm wchan
333 The event (an address in the system) on which a process waits.
334 When printed numerically, the initial part of the address is
335 trimmed off and the result is printed in hex, for example, 0x80324000 prints
336 as 324000.
337 .El
338 .Pp
339 When printing using the
340 .Cm command
341 keyword, a process that has exited and
342 has a parent that has not yet waited for the process (in other words, a zombie)
343 is listed as ``<defunct>'', and a process which is blocked while trying
344 to exit is listed as ``<exiting>''.
345 The
346 .Nm
347 utility
348 makes an educated guess as to the file name and arguments given when the
349 process was created by examining memory or the swap area.
350 The method is inherently somewhat unreliable and in any event a process
351 is entitled to destroy this information, so the names cannot be depended
352 on too much.
353 The
354 .Cm ucomm
355 (accounting) keyword can, however, be depended on.
356 .Sh KEYWORDS
357 The following is a complete list of the available keywords and their
358 meanings.
359 Several of them have aliases (keywords which are synonyms).
360 .Pp
361 .Bl -tag -width ".Cm sigignore" -compact
362 .It Cm %cpu
363 percentage CPU usage (alias
364 .Cm pcpu )
365 .It Cm %mem
366 percentage memory usage (alias
367 .Cm pmem )
368 .It Cm acflag
369 accounting flag (alias
370 .Cm acflg )
371 .It Cm batch
372 batchness of the process (higher numbers mean less interactivity)
373 .It Cm command
374 command and arguments
375 .It Cm cpu
376 short-term CPU usage factor (for scheduling)
377 .It Cm f
378 the process flags, in hexadecimal (alias
379 .Cm flags )
380 .It Cm inblk
381 total blocks read (alias
382 .Cm inblock )
383 .It Cm jail
384 jail ID
385 .It Cm jobc
386 job control count
387 .It Cm ktrace
388 tracing flags
389 .It Cm ktracep
390 tracing vnode
391 .It Cm lastcpu
392 CPU ID the process was last scheduled on
393 .It Cm lim
394 memoryuse limit
395 .It Cm login
396 login name of user who started the process (alias
397 .Cm logname )
398 .It Cm lstart
399 time started
400 .It Cm majflt
401 total page faults
402 .It Cm minflt
403 total page reclaims
404 .It Cm msgrcv
405 total messages received (reads from pipes/sockets)
406 .It Cm msgsnd
407 total messages sent (writes on pipes/sockets)
408 .It Cm nice
409 nice value (alias
410 .Cm ni )
411 .It Cm nivcsw
412 total involuntary context switches
413 .It Cm nsigs
414 total signals taken (alias
415 .Cm nsignals )
416 .It Cm nswap
417 total swaps in/out
418 .It Cm nvcsw
419 total voluntary context switches
420 .It Cm nwchan
421 wait channel (as an address)
422 .It Cm oublk
423 total blocks written (alias
424 .Cm oublock )
425 .It Cm p_ru
426 resource usage (valid only for zombie)
427 .It Cm paddr
428 swap address
429 .It Cm pagein
430 pageins (same as
431 .Cm majflt )
432 .It Cm pgid
433 process group number
434 .It Cm pid
435 process ID
436 .It Cm ppid
437 parent process ID
438 .It Cm pri
439 scheduling priority (lower == better)
440 .It Cm re
441 core residency time (in seconds; 127 = infinity)
442 .It Cm rgid
443 real group ID
444 .It Cm rlink
445 reverse link on run queue, or 0
446 .It Cm rss
447 resident set size
448 .It Cm rsz
449 resident set size + (text size / text use count) (alias
450 .Cm rssize )
451 .It Cm rtprio
452 realtime priority (101 = not a realtime process)
453 .It Cm ruid
454 real user ID
455 .It Cm ruser
456 user name (from ruid)
457 .It Cm sess
458 session pointer
459 .It Cm sig
460 pending signals (alias
461 .Cm pending )
462 .It Cm sigcatch
463 caught signals (alias
464 .Cm caught )
465 .It Cm sigignore
466 ignored signals (alias
467 .Cm ignored )
468 .It Cm sigmask
469 blocked signals (alias
470 .Cm blocked )
471 .It Cm sl
472 sleep time (in seconds; 127 = infinity)
473 .It Cm start
474 time started
475 .It Cm state
476 symbolic process state (alias
477 .Cm stat )
478 .It Cm svgid
479 saved gid from a setgid executable
480 .It Cm svuid
481 saved uid from a setuid executable
482 .It Cm tdev
483 control terminal device number
484 .It Cm tdpri
485 LWKT thread priority (0-31, 31 highest), and critical section count
486 .It Cm time
487 accumulated CPU time, user + system (alias
488 .Cm cputime )
489 .It Cm tpgid
490 control terminal process group ID
491 .\".It Cm trss
492 .\"text resident set size (in Kbytes)
493 .It Cm tsess
494 control terminal session pointer
495 .It Cm tsiz
496 text size (in Kbytes)
497 .It Cm tt
498 control terminal name (two letter abbreviation)
499 .It Cm tty
500 full name of control terminal
501 .It Cm ucomm
502 name to be used for accounting
503 .It Cm uid
504 effective user ID
505 .It Cm user
506 user name (from uid)
507 .It Cm vsz
508 virtual size in Kbytes (alias
509 .Cm vsize )
510 .It Cm wchan
511 wait channel (as a symbolic name)
512 .It Cm xstat
513 exit or stop status (valid only for stopped or zombie process)
514 .El
515 .Sh FILES
516 .Bl -tag -width /var/db/kvm_kernel.db -compact
517 .It Pa /dev/kmem
518 default kernel memory
519 .It Pa /var/run/dev.db
520 /dev name database
521 .It Pa /var/db/kvm_kernel.db
522 system namelist database
523 .It Pa /kernel
524 default system namelist
525 .It Pa /proc
526 the mount point of
527 .Xr procfs 5
528 .El
529 .Sh SEE ALSO
530 .Xr kill 1 ,
531 .Xr w 1 ,
532 .Xr kvm 3 ,
533 .Xr strftime 3 ,
534 .Xr procfs 5 ,
535 .Xr pstat 8 ,
536 .Xr sysctl 8
537 .Sh HISTORY
538 The
539 .Nm
540 command appeared in
541 .At v4 .
542 .Sh BUGS
543 Since
544 .Nm
545 cannot run faster than the system and is run as any other scheduled
546 process, the information it displays can never be exact.