]> CyberLeo.Net >> Repos - FreeBSD/releng/8.1.git/blob - bin/ps/ps.1
Copy stable/8 to releng/8.1 in preparation for 8.1-RC1.
[FreeBSD/releng/8.1.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 April 13, 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_SUGID" Ta No "0x00100         Had set id privileges since last exec"
295 .It Dv "P_SYSTEM" Ta No "0x00200        System proc: no sigs, stats or swapping"
296 .It Dv "P_SINGLE_EXIT" Ta No "0x00400   Threads suspending should exit, not wait"
297 .It Dv "P_TRACED" Ta No "0x00800        Debugged process being traced"
298 .It Dv "P_WAITED" Ta No "0x01000        Someone is waiting for us"
299 .It Dv "P_WEXIT" Ta No "0x02000         Working on exiting"
300 .It Dv "P_EXEC" Ta No "0x04000          Process called exec"
301 .It Dv "P_WKILLED" Ta No "0x08000       Killed, shall go to kernel/user boundary ASAP"
302 .It Dv "P_CONTINUED" Ta No "0x10000     Proc has continued from a stopped state"
303 .It Dv "P_STOPPED_SIG" Ta No "0x20000   Stopped due to SIGSTOP/SIGTSTP"
304 .It Dv "P_STOPPED_TRACE" Ta No "0x40000 Stopped because of tracing"
305 .It Dv "P_STOPPED_SINGLE" Ta No "0x80000        Only one thread can continue"
306 .It Dv "P_PROTECTED" Ta No "0x100000    Do not kill on memory overcommit"
307 .It Dv "P_SIGEVENT" Ta No "0x200000     Process pending signals changed"
308 .It Dv "P_SINGLE_BOUNDARY" Ta No "0x400000      Threads should suspend at user boundary"
309 .It Dv "P_HWPMC" Ta No "0x800000        Process is using HWPMCs"
310 .It Dv "P_JAILED" Ta No "0x1000000      Process is in jail"
311 .It Dv "P_INEXEC" Ta No "0x4000000      Process is in execve()"
312 .It Dv "P_STATCHILD" Ta No "0x8000000   Child process stopped or exited"
313 .It Dv "P_INMEM" Ta No "0x10000000      Loaded into memory"
314 .It Dv "P_SWAPPINGOUT" Ta No "0x20000000        Process is being swapped out"
315 .It Dv "P_SWAPPINGIN" Ta No "0x40000000 Process is being swapped in"
316 .El
317 .It Cm label
318 The MAC label of the process.
319 .It Cm lim
320 The soft limit on memory used, specified via a call to
321 .Xr setrlimit 2 .
322 .It Cm lstart
323 The exact time the command started, using the
324 .Ql %c
325 format described in
326 .Xr strftime 3 .
327 .It Cm lockname
328 The name of the lock that the process is currently blocked on.
329 If the name is invalid or unknown, then
330 .Dq ???\&
331 is displayed.
332 .It Cm logname
333 The login name associated with the session the process is in (see
334 .Xr getlogin 2 ) .
335 .It Cm mwchan
336 The event name if the process is blocked normally, or the lock name if
337 the process is blocked on a lock.
338 See the wchan and lockname keywords
339 for details.
340 .It Cm nice
341 The process scheduling increment (see
342 .Xr setpriority 2 ) .
343 .It Cm rss
344 the real memory (resident set) size of the process (in 1024 byte units).
345 .It Cm start
346 The time the command started.
347 If the command started less than 24 hours ago, the start time is
348 displayed using the
349 .Dq Li %l:ps.1p
350 format described in
351 .Xr strftime 3 .
352 If the command started less than 7 days ago, the start time is
353 displayed using the
354 .Dq Li %a6.15p
355 format.
356 Otherwise, the start time is displayed using the
357 .Dq Li %e%b%y
358 format.
359 .It Cm state
360 The state is given by a sequence of characters, for example,
361 .Dq Li RWNA .
362 The first character indicates the run state of the process:
363 .Pp
364 .Bl -tag -width indent -compact
365 .It Li D
366 Marks a process in disk (or other short term, uninterruptible) wait.
367 .It Li I
368 Marks a process that is idle (sleeping for longer than about 20 seconds).
369 .It Li L
370 Marks a process that is waiting to acquire a lock.
371 .It Li R
372 Marks a runnable process.
373 .It Li S
374 Marks a process that is sleeping for less than about 20 seconds.
375 .It Li T
376 Marks a stopped process.
377 .It Li W
378 Marks an idle interrupt thread.
379 .It Li Z
380 Marks a dead process (a
381 .Dq zombie ) .
382 .El
383 .Pp
384 Additional characters after these, if any, indicate additional state
385 information:
386 .Pp
387 .Bl -tag -width indent -compact
388 .It Li +
389 The process is in the foreground process group of its control terminal.
390 .It Li <
391 The process has raised CPU scheduling priority.
392 .It Li E
393 The process is trying to exit.
394 .It Li J
395 Marks a process which is in
396 .Xr jail 2 .
397 The hostname of the prison can be found in
398 .Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
399 .It Li L
400 The process has pages locked in core (for example, for raw
401 .Tn I/O ) .
402 .It Li N
403 The process has reduced CPU scheduling priority (see
404 .Xr setpriority 2 ) .
405 .It Li s
406 The process is a session leader.
407 .It Li V
408 The process is suspended during a
409 .Xr vfork 2 .
410 .It Li W
411 The process is swapped out.
412 .It Li X
413 The process is being traced or debugged.
414 .El
415 .It Cm tt
416 An abbreviation for the pathname of the controlling terminal, if any.
417 The abbreviation consists of the three letters following
418 .Pa /dev/tty ,
419 or, for the console,
420 .Dq Li con .
421 This is followed by a
422 .Ql -
423 if the process can no longer reach that
424 controlling terminal (i.e., it has been revoked).
425 .It Cm wchan
426 The event (an address in the system) on which a process waits.
427 When printed numerically, the initial part of the address is
428 trimmed off and the result is printed in hex, for example, 0x80324000 prints
429 as 324000.
430 .El
431 .Pp
432 When printing using the command keyword, a process that has exited and
433 has a parent that has not yet waited for the process (in other words, a zombie)
434 is listed as
435 .Dq Li <defunct> ,
436 and a process which is blocked while trying
437 to exit is listed as
438 .Dq Li <exiting> .
439 If the arguments cannot be located (usually because it has not been set, as is
440 the case of system processes and/or kernel threads) the command name is printed
441 within square brackets.
442 The
443 .Nm
444 utility first tries to obtain the arguments cached by the kernel (if they were
445 shorter than the value of the
446 .Va kern.ps_arg_cache_limit
447 sysctl).
448 The process can change the arguments shown with
449 .Xr setproctitle 3 .
450 Otherwise,
451 .Nm
452 makes an educated guess as to the file name and arguments given when the
453 process was created by examining memory or the swap area.
454 The method is inherently somewhat unreliable and in any event a process
455 is entitled to destroy this information.
456 The ucomm (accounting) keyword can, however, be depended on.
457 If the arguments are unavailable or do not agree with the ucomm keyword,
458 the value for the ucomm keyword is appended to the arguments in parentheses.
459 .Sh KEYWORDS
460 The following is a complete list of the available keywords and their
461 meanings.
462 Several of them have aliases (keywords which are synonyms).
463 .Pp
464 .Bl -tag -width ".Cm sigignore" -compact
465 .It Cm %cpu
466 percentage CPU usage (alias
467 .Cm pcpu )
468 .It Cm %mem
469 percentage memory usage (alias
470 .Cm pmem )
471 .It Cm acflag
472 accounting flag (alias
473 .Cm acflg )
474 .It Cm args
475 command and arguments
476 .It Cm comm
477 command
478 .It Cm command
479 command and arguments
480 .It Cm cpu
481 short-term CPU usage factor (for scheduling)
482 .It Cm etime
483 elapsed running time
484 .It Cm flags
485 the process flags, in hexadecimal (alias
486 .Cm f )
487 .It Cm inblk
488 total blocks read (alias
489 .Cm inblock )
490 .It Cm jid
491 jail ID
492 .It Cm jobc
493 job control count
494 .It Cm ktrace
495 tracing flags
496 .It Cm label
497 MAC label
498 .It Cm lim
499 memoryuse limit
500 .It Cm lockname
501 lock currently blocked on (as a symbolic name)
502 .It Cm logname
503 login name of user who started the session
504 .It Cm lstart
505 time started
506 .It Cm majflt
507 total page faults
508 .It Cm minflt
509 total page reclaims
510 .It Cm msgrcv
511 total messages received (reads from pipes/sockets)
512 .It Cm msgsnd
513 total messages sent (writes on pipes/sockets)
514 .It Cm mwchan
515 wait channel or lock currently blocked on
516 .It Cm nice
517 nice value (alias
518 .Cm ni )
519 .It Cm nivcsw
520 total involuntary context switches
521 .It Cm nsigs
522 total signals taken (alias
523 .Cm nsignals )
524 .It Cm nswap
525 total swaps in/out
526 .It Cm nvcsw
527 total voluntary context switches
528 .It Cm nwchan
529 wait channel (as an address)
530 .It Cm oublk
531 total blocks written (alias
532 .Cm oublock )
533 .It Cm paddr
534 swap address
535 .It Cm pagein
536 pageins (same as majflt)
537 .It Cm pgid
538 process group number
539 .It Cm pid
540 process ID
541 .It Cm poip
542 pageouts in progress
543 .It Cm ppid
544 parent process ID
545 .It Cm pri
546 scheduling priority
547 .It Cm re
548 core residency time (in seconds; 127 = infinity)
549 .It Cm rgid
550 real group ID
551 .It Cm rgroup
552 group name (from rgid)
553 .It Cm rlink
554 reverse link on run queue, or 0
555 .It Cm rss
556 resident set size
557 .It Cm rtprio
558 realtime priority (101 = not a realtime process)
559 .It Cm ruid
560 real user ID
561 .It Cm ruser
562 user name (from ruid)
563 .It Cm sid
564 session ID
565 .It Cm sig
566 pending signals (alias
567 .Cm pending )
568 .It Cm sigcatch
569 caught signals (alias
570 .Cm caught )
571 .It Cm sigignore
572 ignored signals (alias
573 .Cm ignored )
574 .It Cm sigmask
575 blocked signals (alias
576 .Cm blocked )
577 .It Cm sl
578 sleep time (in seconds; 127 = infinity)
579 .It Cm start
580 time started
581 .It Cm state
582 symbolic process state (alias
583 .Cm stat )
584 .It Cm svgid
585 saved gid from a setgid executable
586 .It Cm svuid
587 saved UID from a setuid executable
588 .It Cm tdev
589 control terminal device number
590 .It Cm time
591 accumulated CPU time, user + system (alias
592 .Cm cputime )
593 .It Cm tpgid
594 control terminal process group ID
595 .\".It Cm trss
596 .\"text resident set size (in Kbytes)
597 .It Cm tsid
598 control terminal session ID
599 .It Cm tsiz
600 text size (in Kbytes)
601 .It Cm tt
602 control terminal name (two letter abbreviation)
603 .It Cm tty
604 full name of control terminal
605 .It Cm uprocp
606 process pointer
607 .It Cm ucomm
608 name to be used for accounting
609 .It Cm uid
610 effective user ID
611 .It Cm upr
612 scheduling priority on return from system call (alias
613 .Cm usrpri )
614 .It Cm user
615 user name (from UID)
616 .It Cm vsz
617 virtual size in Kbytes (alias
618 .Cm vsize )
619 .It Cm wchan
620 wait channel (as a symbolic name)
621 .It Cm xstat
622 exit or stop status (valid only for stopped or zombie process)
623 .El
624 .Pp
625 Note that the
626 .Cm pending
627 column displays bitmask of signals pending in the process queue when
628 .Fl H
629 option is not specified, otherwise the per-thread queue of pending signals
630 is shown.
631 .Sh ENVIRONMENT
632 The following environment variables affect the execution of
633 .Nm :
634 .Bl -tag -width ".Ev COLUMNS"
635 .It Ev COLUMNS
636 If set, specifies the user's preferred output width in column positions.
637 By default,
638 .Nm
639 attempts to automatically determine the terminal width.
640 .El
641 .Sh FILES
642 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
643 .It Pa /boot/kernel/kernel
644 default system namelist
645 .It Pa /proc
646 the mount point of
647 .Xr procfs 5
648 .El
649 .Sh SEE ALSO
650 .Xr kill 1 ,
651 .Xr pgrep 1 ,
652 .Xr pkill 1 ,
653 .Xr procstat 1 ,
654 .Xr w 1 ,
655 .Xr kvm 3 ,
656 .Xr strftime 3 ,
657 .Xr mac 4 ,
658 .Xr procfs 5 ,
659 .Xr pstat 8 ,
660 .Xr sysctl 8 ,
661 .Xr mutex 9
662 .Sh STANDARDS
663 For historical reasons, the
664 .Nm
665 utility under
666 .Fx
667 supports a different set of options from what is described by
668 .St -p1003.2 ,
669 and what is supported on
670 .No non- Ns Bx
671 operating systems.
672 .Sh HISTORY
673 The
674 .Nm
675 command appeared in
676 .At v4 .
677 .Sh BUGS
678 Since
679 .Nm
680 cannot run faster than the system and is run as any other scheduled
681 process, the information it displays can never be exact.
682 .Pp
683 The
684 .Nm
685 utility does not correctly display argument lists containing multibyte
686 characters.