]> CyberLeo.Net >> Repos - FreeBSD/releng/8.2.git/blob - bin/ps/ps.1
Copy stable/8 to releng/8.2 in preparation for FreeBSD-8.2 release.
[FreeBSD/releng/8.2.git] / bin / ps / ps.1
1 .\"-
2 .\" Copyright (c) 1980, 1990, 1991, 1993, 1994
3 .\"     The Regents of the University of California.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 4. Neither the name of the University nor the names of its contributors
14 .\"    may be used to endorse or promote products derived from this software
15 .\"    without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" SUCH DAMAGE.
28 .\"
29 .\"     @(#)ps.1        8.3 (Berkeley) 4/18/94
30 .\" $FreeBSD$
31 .\"
32 .Dd July 24, 2010
33 .Dt PS 1
34 .Os
35 .Sh NAME
36 .Nm ps
37 .Nd process status
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl aCcdefHhjlmrSTuvwXxZ
41 .Op Fl O Ar fmt | Fl o Ar fmt
42 .Op Fl G Ar gid Ns Op , Ns Ar gid Ns Ar ...
43 .Op Fl M Ar core
44 .Op Fl N Ar system
45 .Op Fl p Ar pid Ns Op , Ns Ar pid Ns Ar ...
46 .Op Fl t Ar tty Ns Op , Ns Ar tty Ns Ar ...
47 .Op Fl U Ar user Ns Op , Ns Ar user Ns Ar ...
48 .Nm
49 .Op Fl L
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility
54 displays a header line, followed by lines containing information about
55 all of your
56 processes that have controlling terminals.
57 .Pp
58 A different set of processes can be selected for display by using any
59 combination of the
60 .Fl a , G , p , T , t ,
61 and
62 .Fl U
63 options.
64 If more than one of these options are given, then
65 .Nm
66 will select all processes which are matched by at least one of the
67 given options.
68 .Pp
69 For the processes which have been selected for display,
70 .Nm
71 will usually display one line per process.
72 The
73 .Fl H
74 option may result in multiple output lines (one line per thread) for
75 some processes.
76 By default all of these output lines are sorted first by controlling
77 terminal, then by process ID.
78 The
79 .Fl m , r , u ,
80 and
81 .Fl v
82 options will change the sort order.
83 If more than one sorting option was given, then the selected processes
84 will be sorted by the last sorting option which was specified.
85 .Pp
86 For the processes which have been selected for display, the information
87 to display is selected based on a set of keywords (see the
88 .Fl L , O ,
89 and
90 .Fl o
91 options).
92 The default output format includes, for each process, the process' ID,
93 controlling terminal, CPU time (including both user and system time),
94 state, and associated command.
95 .Pp
96 The process file system (see
97 .Xr procfs 5 )
98 should be mounted when
99 .Nm
100 is executed, otherwise not all information will be available.
101 .Pp
102 The options are as follows:
103 .Bl -tag -width indent
104 .It Fl a
105 Display information about other users' processes as well as your own.
106 This will skip any processes which do not have a controlling terminal,
107 unless the
108 .Fl x
109 option is also specified.
110 This can be disabled by setting the
111 .Va security.bsd.see_other_uids
112 sysctl to zero.
113 .It Fl c
114 Change the
115 .Dq command
116 column output to just contain the executable name,
117 rather than the full command line.
118 .It Fl C
119 Change the way the CPU percentage is calculated by using a
120 .Dq raw
121 CPU calculation that ignores
122 .Dq resident
123 time (this normally has
124 no effect).
125 .It Fl d
126 Arrange processes into descendancy order and prefix each command with
127 indentation text showing sibling and parent/child relationships.
128 If either of the
129 .Fl m
130 and
131 .Fl r
132 options are also used, they control how sibling processes are sorted
133 relative to eachother.
134 .It Fl e
135 Display the environment as well.
136 .It Fl f
137 Show commandline and environment information about swapped out processes.
138 This option is honored only if the UID of the user is 0.
139 .It Fl G
140 Display information about processes which are running with the specified
141 real group IDs.
142 .It Fl H
143 Show all of the
144 .Em kernel visible
145 threads associated with each process.
146 Depending on the threading package that
147 is in use, this may show only the process, only the kernel scheduled entities,
148 or all of the process threads.
149 .It Fl h
150 Repeat the information header as often as necessary to guarantee one
151 header per page of information.
152 .It Fl j
153 Print information associated with the following keywords:
154 .Cm user , pid , ppid , pgid , sid , jobc , state , tt , time ,
155 and
156 .Cm command .
157 .It Fl L
158 List the set of keywords available for the
159 .Fl O
160 and
161 .Fl o
162 options.
163 .It Fl l
164 Display information associated with the following keywords:
165 .Cm uid , pid , ppid , cpu , pri , nice , vsz , rss , mwchan , state ,
166 .Cm tt , time ,
167 and
168 .Cm command .
169 .It Fl M
170 Extract values associated with the name list from the specified core
171 instead of the currently running system.
172 .It Fl m
173 Sort by memory usage, instead of the combination of controlling
174 terminal and process ID.
175 .It Fl N
176 Extract the name list from the specified system instead of the default,
177 which is the kernel image the system has booted from.
178 .It Fl O
179 Add the information associated with the space or comma separated list
180 of keywords specified, after the process ID,
181 in the default information
182 display.
183 Keywords may be appended with an equals
184 .Pq Ql =
185 sign and a string.
186 This causes the printed header to use the specified string instead of
187 the standard header.
188 .It Fl o
189 Display information associated with the space or comma separated
190 list of keywords specified.
191 The last keyword in the list may be appended with an equals
192 .Pq Ql =
193 sign and a string that spans the rest of the argument, and can contain
194 space and comma characters.
195 This causes the printed header to use the specified string instead of
196 the standard header.
197 Multiple keywords may also be given in the form of more than one
198 .Fl o
199 option.
200 So the header texts for multiple keywords can be changed.
201 If all keywords have empty header texts, no header line is written.
202 .It Fl p
203 Display information about processes which match the specified process IDs.
204 .It Fl r
205 Sort by current CPU usage, instead of the combination of controlling
206 terminal and process ID.
207 .It Fl S
208 Change the way the process time is calculated by summing all exited
209 children to their parent process.
210 .It Fl T
211 Display information about processes attached to the device associated
212 with the standard input.
213 .It Fl t
214 Display information about processes attached to the specified terminal
215 devices.
216 .It Fl U
217 Display the processes belonging to the specified usernames.
218 .It Fl u
219 Display information associated with the following keywords:
220 .Cm user , pid , %cpu , %mem , vsz , rss , tt , state , start , time ,
221 and
222 .Cm command .
223 The
224 .Fl u
225 option implies the
226 .Fl r
227 option.
228 .It Fl v
229 Display information associated with the following keywords:
230 .Cm pid , state , time , sl , re , pagein , vsz , rss , lim , tsiz ,
231 .Cm %cpu , %mem ,
232 and
233 .Cm command .
234 The
235 .Fl v
236 option implies the
237 .Fl m
238 option.
239 .It Fl w
240 Use 132 columns to display information, instead of the default which
241 is your window size.
242 If the
243 .Fl w
244 option is specified more than once,
245 .Nm
246 will use as many columns as necessary without regard for your window size.
247 .It Fl X
248 When displaying processes matched by other options, skip any processes
249 which do not have a controlling terminal.
250 .It Fl x
251 When displaying processes matched by other options, include processes
252 which do not have a controlling terminal.
253 This is the opposite of the
254 .Fl X
255 option.
256 If both
257 .Fl X
258 and
259 .Fl x
260 are specified in the same command, then
261 .Nm
262 will use the one which was specified last.
263 .It Fl Z
264 Add
265 .Xr mac 4
266 label to the list of keywords for which
267 .Nm
268 will display information.
269 .El
270 .Pp
271 A complete list of the available keywords are listed below.
272 Some of these keywords are further specified as follows:
273 .Bl -tag -width lockname
274 .It Cm %cpu
275 The CPU utilization of the process; this is a decaying average over up to
276 a minute of previous (real) time.
277 Since the time base over which this is computed varies (since processes may
278 be very young) it is possible for the sum of all
279 .Cm %cpu
280 fields to exceed 100%.
281 .It Cm %mem
282 The percentage of real memory used by this process.
283 .It Cm flags
284 The flags associated with the process as in
285 the include file
286 .In sys/proc.h :
287 .Bl -column P_SINGLE_BOUNDARY 0x40000000
288 .It Dv "P_ADVLOCK" Ta No "0x00001       Process may hold a POSIX advisory lock"
289 .It Dv "P_CONTROLT" Ta No "0x00002      Has a controlling terminal"
290 .It Dv "P_KTHREAD" Ta No "0x00004       Kernel thread"
291 .It Dv "P_PPWAIT" Ta No "0x00010        Parent is waiting for child to exec/exit"
292 .It Dv "P_PROFIL" Ta No "0x00020        Has started profiling"
293 .It Dv "P_STOPPROF" Ta No "0x00040      Has thread in requesting to stop prof"
294 .It Dv "P_HASTHREADS" Ta No "0x00080    Has had threads (no cleanup shortcuts)"
295 .It Dv "P_SUGID" Ta No "0x00100         Had set id privileges since last exec"
296 .It Dv "P_SYSTEM" Ta No "0x00200        System proc: no sigs, stats or swapping"
297 .It Dv "P_SINGLE_EXIT" Ta No "0x00400   Threads suspending should exit, not wait"
298 .It Dv "P_TRACED" Ta No "0x00800        Debugged process being traced"
299 .It Dv "P_WAITED" Ta No "0x01000        Someone is waiting for us"
300 .It Dv "P_WEXIT" Ta No "0x02000         Working on exiting"
301 .It Dv "P_EXEC" Ta No "0x04000          Process called exec"
302 .It Dv "P_WKILLED" Ta No "0x08000       Killed, shall go to kernel/user boundary ASAP"
303 .It Dv "P_CONTINUED" Ta No "0x10000     Proc has continued from a stopped state"
304 .It Dv "P_STOPPED_SIG" Ta No "0x20000   Stopped due to SIGSTOP/SIGTSTP"
305 .It Dv "P_STOPPED_TRACE" Ta No "0x40000 Stopped because of tracing"
306 .It Dv "P_STOPPED_SINGLE" Ta No "0x80000        Only one thread can continue"
307 .It Dv "P_PROTECTED" Ta No "0x100000    Do not kill on memory overcommit"
308 .It Dv "P_SIGEVENT" Ta No "0x200000     Process pending signals changed"
309 .It Dv "P_SINGLE_BOUNDARY" Ta No "0x400000      Threads should suspend at user boundary"
310 .It Dv "P_HWPMC" Ta No "0x800000        Process is using HWPMCs"
311 .It Dv "P_JAILED" Ta No "0x1000000      Process is in jail"
312 .It Dv "P_INEXEC" Ta No "0x4000000      Process is in execve()"
313 .It Dv "P_STATCHILD" Ta No "0x8000000   Child process stopped or exited"
314 .It Dv "P_INMEM" Ta No "0x10000000      Loaded into memory"
315 .It Dv "P_SWAPPINGOUT" Ta No "0x20000000        Process is being swapped out"
316 .It Dv "P_SWAPPINGIN" Ta No "0x40000000 Process is being swapped in"
317 .El
318 .It Cm label
319 The MAC label of the process.
320 .It Cm lim
321 The soft limit on memory used, specified via a call to
322 .Xr setrlimit 2 .
323 .It Cm lstart
324 The exact time the command started, using the
325 .Ql %c
326 format described in
327 .Xr strftime 3 .
328 .It Cm lockname
329 The name of the lock that the process is currently blocked on.
330 If the name is invalid or unknown, then
331 .Dq ???\&
332 is displayed.
333 .It Cm logname
334 The login name associated with the session the process is in (see
335 .Xr getlogin 2 ) .
336 .It Cm mwchan
337 The event name if the process is blocked normally, or the lock name if
338 the process is blocked on a lock.
339 See the wchan and lockname keywords
340 for details.
341 .It Cm nice
342 The process scheduling increment (see
343 .Xr setpriority 2 ) .
344 .It Cm rss
345 the real memory (resident set) size of the process (in 1024 byte units).
346 .It Cm start
347 The time the command started.
348 If the command started less than 24 hours ago, the start time is
349 displayed using the
350 .Dq Li %l:ps.1p
351 format described in
352 .Xr strftime 3 .
353 If the command started less than 7 days ago, the start time is
354 displayed using the
355 .Dq Li %a6.15p
356 format.
357 Otherwise, the start time is displayed using the
358 .Dq Li %e%b%y
359 format.
360 .It Cm state
361 The state is given by a sequence of characters, for example,
362 .Dq Li RWNA .
363 The first character indicates the run state of the process:
364 .Pp
365 .Bl -tag -width indent -compact
366 .It Li D
367 Marks a process in disk (or other short term, uninterruptible) wait.
368 .It Li I
369 Marks a process that is idle (sleeping for longer than about 20 seconds).
370 .It Li L
371 Marks a process that is waiting to acquire a lock.
372 .It Li R
373 Marks a runnable process.
374 .It Li S
375 Marks a process that is sleeping for less than about 20 seconds.
376 .It Li T
377 Marks a stopped process.
378 .It Li W
379 Marks an idle interrupt thread.
380 .It Li Z
381 Marks a dead process (a
382 .Dq zombie ) .
383 .El
384 .Pp
385 Additional characters after these, if any, indicate additional state
386 information:
387 .Pp
388 .Bl -tag -width indent -compact
389 .It Li +
390 The process is in the foreground process group of its control terminal.
391 .It Li <
392 The process has raised CPU scheduling priority.
393 .It Li E
394 The process is trying to exit.
395 .It Li J
396 Marks a process which is in
397 .Xr jail 2 .
398 The hostname of the prison can be found in
399 .Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
400 .It Li L
401 The process has pages locked in core (for example, for raw
402 .Tn I/O ) .
403 .It Li N
404 The process has reduced CPU scheduling priority (see
405 .Xr setpriority 2 ) .
406 .It Li s
407 The process is a session leader.
408 .It Li V
409 The process is suspended during a
410 .Xr vfork 2 .
411 .It Li W
412 The process is swapped out.
413 .It Li X
414 The process is being traced or debugged.
415 .El
416 .It Cm tt
417 An abbreviation for the pathname of the controlling terminal, if any.
418 The abbreviation consists of the three letters following
419 .Pa /dev/tty ,
420 or, for the console,
421 .Dq Li con .
422 This is followed by a
423 .Ql -
424 if the process can no longer reach that
425 controlling terminal (i.e., it has been revoked).
426 .It Cm wchan
427 The event (an address in the system) on which a process waits.
428 When printed numerically, the initial part of the address is
429 trimmed off and the result is printed in hex, for example, 0x80324000 prints
430 as 324000.
431 .El
432 .Pp
433 When printing using the command keyword, a process that has exited and
434 has a parent that has not yet waited for the process (in other words, a zombie)
435 is listed as
436 .Dq Li <defunct> ,
437 and a process which is blocked while trying
438 to exit is listed as
439 .Dq Li <exiting> .
440 If the arguments cannot be located (usually because it has not been set, as is
441 the case of system processes and/or kernel threads) the command name is printed
442 within square brackets.
443 The
444 .Nm
445 utility first tries to obtain the arguments cached by the kernel (if they were
446 shorter than the value of the
447 .Va kern.ps_arg_cache_limit
448 sysctl).
449 The process can change the arguments shown with
450 .Xr setproctitle 3 .
451 Otherwise,
452 .Nm
453 makes an educated guess as to the file name and arguments given when the
454 process was created by examining memory or the swap area.
455 The method is inherently somewhat unreliable and in any event a process
456 is entitled to destroy this information.
457 The ucomm (accounting) keyword can, however, be depended on.
458 If the arguments are unavailable or do not agree with the ucomm keyword,
459 the value for the ucomm keyword is appended to the arguments in parentheses.
460 .Sh KEYWORDS
461 The following is a complete list of the available keywords and their
462 meanings.
463 Several of them have aliases (keywords which are synonyms).
464 .Pp
465 .Bl -tag -width ".Cm sigignore" -compact
466 .It Cm %cpu
467 percentage CPU usage (alias
468 .Cm pcpu )
469 .It Cm %mem
470 percentage memory usage (alias
471 .Cm pmem )
472 .It Cm acflag
473 accounting flag (alias
474 .Cm acflg )
475 .It Cm args
476 command and arguments
477 .It Cm comm
478 command
479 .It Cm command
480 command and arguments
481 .It Cm cpu
482 short-term CPU usage factor (for scheduling)
483 .It Cm etime
484 elapsed running time
485 .It Cm flags
486 the process flags, in hexadecimal (alias
487 .Cm f )
488 .It Cm inblk
489 total blocks read (alias
490 .Cm inblock )
491 .It Cm jid
492 jail ID
493 .It Cm jobc
494 job control count
495 .It Cm ktrace
496 tracing flags
497 .It Cm label
498 MAC label
499 .It Cm lim
500 memoryuse limit
501 .It Cm lockname
502 lock currently blocked on (as a symbolic name)
503 .It Cm logname
504 login name of user who started the session
505 .It Cm lstart
506 time started
507 .It Cm majflt
508 total page faults
509 .It Cm minflt
510 total page reclaims
511 .It Cm msgrcv
512 total messages received (reads from pipes/sockets)
513 .It Cm msgsnd
514 total messages sent (writes on pipes/sockets)
515 .It Cm mwchan
516 wait channel or lock currently blocked on
517 .It Cm nice
518 nice value (alias
519 .Cm ni )
520 .It Cm nivcsw
521 total involuntary context switches
522 .It Cm nsigs
523 total signals taken (alias
524 .Cm nsignals )
525 .It Cm nswap
526 total swaps in/out
527 .It Cm nvcsw
528 total voluntary context switches
529 .It Cm nwchan
530 wait channel (as an address)
531 .It Cm oublk
532 total blocks written (alias
533 .Cm oublock )
534 .It Cm paddr
535 swap address
536 .It Cm pagein
537 pageins (same as majflt)
538 .It Cm pgid
539 process group number
540 .It Cm pid
541 process ID
542 .It Cm poip
543 pageouts in progress
544 .It Cm ppid
545 parent process ID
546 .It Cm pri
547 scheduling priority
548 .It Cm re
549 core residency time (in seconds; 127 = infinity)
550 .It Cm rgid
551 real group ID
552 .It Cm rgroup
553 group name (from rgid)
554 .It Cm rlink
555 reverse link on run queue, or 0
556 .It Cm rss
557 resident set size
558 .It Cm rtprio
559 realtime priority (101 = not a realtime process)
560 .It Cm ruid
561 real user ID
562 .It Cm ruser
563 user name (from ruid)
564 .It Cm sid
565 session ID
566 .It Cm sig
567 pending signals (alias
568 .Cm pending )
569 .It Cm sigcatch
570 caught signals (alias
571 .Cm caught )
572 .It Cm sigignore
573 ignored signals (alias
574 .Cm ignored )
575 .It Cm sigmask
576 blocked signals (alias
577 .Cm blocked )
578 .It Cm sl
579 sleep time (in seconds; 127 = infinity)
580 .It Cm start
581 time started
582 .It Cm state
583 symbolic process state (alias
584 .Cm stat )
585 .It Cm svgid
586 saved gid from a setgid executable
587 .It Cm svuid
588 saved UID from a setuid executable
589 .It Cm tdaddr
590 thread address
591 .It Cm tdev
592 control terminal device number
593 .It Cm time
594 accumulated CPU time, user + system (alias
595 .Cm cputime )
596 .It Cm tpgid
597 control terminal process group ID
598 .\".It Cm trss
599 .\"text resident set size (in Kbytes)
600 .It Cm tsid
601 control terminal session ID
602 .It Cm tsiz
603 text size (in Kbytes)
604 .It Cm tt
605 control terminal name (two letter abbreviation)
606 .It Cm tty
607 full name of control terminal
608 .It Cm uprocp
609 process pointer
610 .It Cm ucomm
611 name to be used for accounting
612 .It Cm uid
613 effective user ID
614 .It Cm upr
615 scheduling priority on return from system call (alias
616 .Cm usrpri )
617 .It Cm user
618 user name (from UID)
619 .It Cm vsz
620 virtual size in Kbytes (alias
621 .Cm vsize )
622 .It Cm wchan
623 wait channel (as a symbolic name)
624 .It Cm xstat
625 exit or stop status (valid only for stopped or zombie process)
626 .El
627 .Pp
628 Note that the
629 .Cm pending
630 column displays bitmask of signals pending in the process queue when
631 .Fl H
632 option is not specified, otherwise the per-thread queue of pending signals
633 is shown.
634 .Sh ENVIRONMENT
635 The following environment variables affect the execution of
636 .Nm :
637 .Bl -tag -width ".Ev COLUMNS"
638 .It Ev COLUMNS
639 If set, specifies the user's preferred output width in column positions.
640 By default,
641 .Nm
642 attempts to automatically determine the terminal width.
643 .El
644 .Sh FILES
645 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
646 .It Pa /boot/kernel/kernel
647 default system namelist
648 .It Pa /proc
649 the mount point of
650 .Xr procfs 5
651 .El
652 .Sh SEE ALSO
653 .Xr kill 1 ,
654 .Xr pgrep 1 ,
655 .Xr pkill 1 ,
656 .Xr procstat 1 ,
657 .Xr w 1 ,
658 .Xr kvm 3 ,
659 .Xr strftime 3 ,
660 .Xr mac 4 ,
661 .Xr procfs 5 ,
662 .Xr pstat 8 ,
663 .Xr sysctl 8 ,
664 .Xr mutex 9
665 .Sh STANDARDS
666 For historical reasons, the
667 .Nm
668 utility under
669 .Fx
670 supports a different set of options from what is described by
671 .St -p1003.2 ,
672 and what is supported on
673 .No non- Ns Bx
674 operating systems.
675 .Sh HISTORY
676 The
677 .Nm
678 command appeared in
679 .At v4 .
680 .Sh BUGS
681 Since
682 .Nm
683 cannot run faster than the system and is run as any other scheduled
684 process, the information it displays can never be exact.
685 .Pp
686 The
687 .Nm
688 utility does not correctly display argument lists containing multibyte
689 characters.