2 .\" Copyright (c) 1980, 1990, 1991, 1993, 1994
3 .\" The Regents of the University of California. All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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 .\" 3. 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.
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
29 .\" @(#)ps.1 8.3 (Berkeley) 4/18/94
41 .Op Fl aCcdefHhjlmrSTuvwXxZ
42 .Op Fl O Ar fmt | Fl o Ar fmt
43 .Op Fl G Ar gid Ns Op , Ns Ar gid Ns Ar ...
44 .Op Fl J Ar jid Ns Op , Ns Ar jid Ns Ar ...
47 .Op Fl p Ar pid Ns Op , Ns Ar pid Ns Ar ...
48 .Op Fl t Ar tty Ns Op , Ns Ar tty Ns Ar ...
49 .Op Fl U Ar user Ns Op , Ns Ar user Ns Ar ...
57 displays a header line, followed by lines containing information about
59 processes that have controlling terminals.
64 will also display processes that do not have controlling terminals.
66 A different set of processes can be selected for display by using any
68 .Fl a , G , J , p , T , t ,
72 If more than one of these options are given, then
74 will select all processes which are matched by at least one of the
77 For the processes which have been selected for display,
79 will usually display one line per process.
82 option may result in multiple output lines (one line per thread) for
84 By default all of these output lines are sorted first by controlling
85 terminal, then by process ID.
90 options will change the sort order.
91 If more than one sorting option was given, then the selected processes
92 will be sorted by the last sorting option which was specified.
94 For the processes which have been selected for display, the information
95 to display is selected based on a set of keywords (see the
100 The default output format includes, for each process, the process' ID,
101 controlling terminal, state, CPU time (including both user and system time)
102 and associated command.
106 process is associated with a terminal, the default output width is that of the
107 terminal; otherwise the output width is unlimited.
112 The options are as follows:
113 .Bl -tag -width indent
117 in a selection of different human and machine readable formats.
120 for details on command line arguments.
122 Display information about other users' processes as well as your own.
124 .Va security.bsd.see_other_uids
125 sysctl is set to zero, this option is honored only if the UID of the user is 0.
129 column output to just contain the executable name,
130 rather than the full command line.
132 Change the way the CPU percentage is calculated by using a
134 CPU calculation that ignores
136 time (this normally has
139 Arrange processes into descendancy order and prefix each command with
140 indentation text showing sibling and parent/child relationships as a tree.
145 options are also used, they control how sibling processes are sorted
146 relative to each other.
147 Note that this option has no effect if the
149 column is not the last column displayed.
151 Display the environment as well.
153 Show command-line and environment information about swapped out processes.
154 This option is honored only if the UID of the user is 0.
156 Display information about processes which are running with the specified
159 Show all of the threads associated with each process.
161 Repeat the information header as often as necessary to guarantee one
162 header per page of information.
164 Print information associated with the following keywords:
165 .Cm user , pid , ppid , pgid , sid , jobc , state , tt , time ,
169 Display information about processes which match the specified jail IDs.
170 This may be either the
178 to display only host processes.
183 List the set of keywords available for the
189 Display information associated with the following keywords:
190 .Cm uid , pid , ppid , cpu , pri , nice , vsz , rss , mwchan , state ,
195 Extract values associated with the name list from the specified core
196 instead of the currently running system.
198 Sort by memory usage, instead of the combination of controlling
199 terminal and process ID.
201 Extract the name list from the specified system instead of the default,
202 which is the kernel image the system has booted from.
204 Add the information associated with the space or comma separated list
205 of keywords specified, after the process ID,
206 in the default information
208 Keywords may be appended with an equals
211 This causes the printed header to use the specified string instead of
214 Display information associated with the space or comma separated
215 list of keywords specified.
216 The last keyword in the list may be appended with an equals
218 sign and a string that spans the rest of the argument, and can contain
219 space and comma characters.
220 This causes the printed header to use the specified string instead of
222 Multiple keywords may also be given in the form of more than one
225 So the header texts for multiple keywords can be changed.
226 If all keywords have empty header texts, no header line is written.
228 Display information about processes which match the specified process IDs.
230 Sort by current CPU usage, instead of the combination of controlling
231 terminal and process ID.
233 Change the way the process times, namely cputime, systime, and usertime,
234 are calculated by summing all exited children to their parent process.
236 Display information about processes attached to the device associated
237 with the standard input.
239 Display information about processes attached to the specified terminal
241 Full pathnames, as well as abbreviations (see explanation of the
243 keyword) can be specified.
245 Display the processes belonging to the specified usernames.
247 Display information associated with the following keywords:
248 .Cm user , pid , %cpu , %mem , vsz , rss , tt , state , start , time ,
257 Display information associated with the following keywords:
258 .Cm pid , state , time , sl , re , pagein , vsz , rss , lim , tsiz ,
268 Use at least 132 columns to display information, instead of the default which
269 is the window size if
271 is associated with a terminal.
274 option is specified more than once,
276 will use as many columns as necessary without regard for the window size.
277 Note that this option has no effect if the
279 column is not the last column displayed.
281 When displaying processes matched by other options, skip any processes
282 which do not have a controlling terminal.
283 This is the default behaviour.
285 When displaying processes matched by other options, include processes
286 which do not have a controlling terminal.
287 This is the opposite of the
294 are specified in the same command, then
296 will use the one which was specified last.
300 label to the list of keywords for which
302 will display information.
305 A complete list of the available keywords are listed below.
306 Some of these keywords are further specified as follows:
307 .Bl -tag -width lockname
309 The CPU utilization of the process; this is a decaying average over up to
310 a minute of previous (real) time.
311 Since the time base over which this is computed varies (since processes may
312 be very young) it is possible for the sum of all
314 fields to exceed 100%.
316 The percentage of real memory used by this process.
318 Login class associated with the process.
320 The flags associated with the process as in
323 .Bl -column P_SINGLE_BOUNDARY 0x40000000
324 .It Dv "P_ADVLOCK" Ta No "0x00001" Ta "Process may hold a POSIX advisory lock"
325 .It Dv "P_CONTROLT" Ta No "0x00002" Ta "Has a controlling terminal"
326 .It Dv "P_KPROC" Ta No "0x00004" Ta "Kernel process"
327 .It Dv "P_PPWAIT" Ta No "0x00010" Ta "Parent is waiting for child to exec/exit"
328 .It Dv "P_PROFIL" Ta No "0x00020" Ta "Has started profiling"
329 .It Dv "P_STOPPROF" Ta No "0x00040" Ta "Has thread in requesting to stop prof"
330 .It Dv "P_HADTHREADS" Ta No "0x00080" Ta "Has had threads (no cleanup shortcuts)"
331 .It Dv "P_SUGID" Ta No "0x00100" Ta "Had set id privileges since last exec"
332 .It Dv "P_SYSTEM" Ta No "0x00200" Ta "System proc: no sigs, stats or swapping"
333 .It Dv "P_SINGLE_EXIT" Ta No "0x00400" Ta "Threads suspending should exit, not wait"
334 .It Dv "P_TRACED" Ta No "0x00800" Ta "Debugged process being traced"
335 .It Dv "P_WAITED" Ta No "0x01000" Ta "Someone is waiting for us"
336 .It Dv "P_WEXIT" Ta No "0x02000" Ta "Working on exiting"
337 .It Dv "P_EXEC" Ta No "0x04000" Ta "Process called exec"
338 .It Dv "P_WKILLED" Ta No "0x08000" Ta "Killed, shall go to kernel/user boundary ASAP"
339 .It Dv "P_CONTINUED" Ta No "0x10000" Ta "Proc has continued from a stopped state"
340 .It Dv "P_STOPPED_SIG" Ta No "0x20000" Ta "Stopped due to SIGSTOP/SIGTSTP"
341 .It Dv "P_STOPPED_TRACE" Ta No "0x40000" Ta "Stopped because of tracing"
342 .It Dv "P_STOPPED_SINGLE" Ta No "0x80000" Ta "Only one thread can continue"
343 .It Dv "P_PROTECTED" Ta No "0x100000" Ta "Do not kill on memory overcommit"
344 .It Dv "P_SIGEVENT" Ta No "0x200000" Ta "Process pending signals changed"
345 .It Dv "P_SINGLE_BOUNDARY" Ta No "0x400000" Ta "Threads should suspend at user boundary"
346 .It Dv "P_HWPMC" Ta No "0x800000" Ta "Process is using HWPMCs"
347 .It Dv "P_JAILED" Ta No "0x1000000" Ta "Process is in jail"
348 .It Dv "P_TOTAL_STOP" Ta No "0x2000000" Ta "Stopped for system suspend"
349 .It Dv "P_INEXEC" Ta No "0x4000000" Ta "Process is in execve()"
350 .It Dv "P_STATCHILD" Ta No "0x8000000" Ta "Child process stopped or exited"
351 .It Dv "P_INMEM" Ta No "0x10000000" Ta "Loaded into memory"
352 .It Dv "P_SWAPPINGOUT" Ta No "0x20000000" Ta "Process is being swapped out"
353 .It Dv "P_SWAPPINGIN" Ta No "0x40000000" Ta "Process is being swapped in"
354 .It Dv "P_PPTRACE" Ta No "0x80000000" Ta "Vforked child issued ptrace(PT_TRACEME)"
359 associated with the process as in
362 .Bl -column P2_INHERIT_PROTECTED 0x00000001
363 .It Dv "P2_INHERIT_PROTECTED" Ta No "0x00000001" Ta "New children get P_PROTECTED"
364 .It Dv "P2_NOTRACE" Ta No "0x00000002" Ta "No ptrace(2) attach or coredumps"
365 .It Dv "P2_NOTRACE_EXEC" Ta No "0x00000004" Ta "Keep P2_NOPTRACE on exec(2)"
366 .It Dv "P2_AST_SU" Ta No "0x00000008" Ta "Handles SU ast for kthreads"
367 .It Dv "P2_PTRACE_FSTP" Ta No "0x00000010" Ta "SIGSTOP from PT_ATTACH not yet handled"
370 The MAC label of the process.
372 The soft limit on memory used, specified via a call to
375 The exact time the command started, using the
380 The name of the lock that the process is currently blocked on.
381 If the name is invalid or unknown, then
385 The login name associated with the session the process is in (see
388 The event name if the process is blocked normally, or the lock name if
389 the process is blocked on a lock.
390 See the wchan and lockname keywords
393 The process scheduling increment (see
394 .Xr setpriority 2 ) .
396 the real memory (resident set) size of the process (in 1024 byte units).
398 The time the command started.
399 If the command started less than 24 hours ago, the start time is
404 If the command started less than 7 days ago, the start time is
408 Otherwise, the start time is displayed using the
412 The state is given by a sequence of characters, for example,
414 The first character indicates the run state of the process:
416 .Bl -tag -width indent -compact
418 Marks a process in disk (or other short term, uninterruptible) wait.
420 Marks a process that is idle (sleeping for longer than about 20 seconds).
422 Marks a process that is waiting to acquire a lock.
424 Marks a runnable process.
426 Marks a process that is sleeping for less than about 20 seconds.
428 Marks a stopped process.
430 Marks an idle interrupt thread.
432 Marks a dead process (a
436 Additional characters after these, if any, indicate additional state
439 .Bl -tag -width indent -compact
441 The process is in the foreground process group of its control terminal.
443 The process has raised CPU scheduling priority.
449 The process is trying to exit.
451 Marks a process which is in
453 The hostname of the prison can be found in
454 .Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
456 The process has pages locked in core (for example, for raw
459 The process has reduced CPU scheduling priority (see
460 .Xr setpriority 2 ) .
462 The process is a session leader.
464 The process' parent is suspended during a
466 waiting for the process to exec or exit.
468 The process is swapped out.
470 The process is being traced or debugged.
473 An abbreviation for the pathname of the controlling terminal, if any.
474 The abbreviation consists of the three letters following
476 or, for pseudo-terminals, the corresponding entry in
478 This is followed by a
480 if the process can no longer reach that
481 controlling terminal (i.e., it has been revoked).
484 without a preceding two letter abbreviation or pseudo-terminal device number
485 indicates a process which never had a controlling terminal.
486 The full pathname of the controlling terminal is available via the
490 The event (an address in the system) on which a process waits.
491 When printed numerically, the initial part of the address is
492 trimmed off and the result is printed in hex, for example, 0x80324000 prints
496 When printing using the command keyword, a process that has exited and
497 has a parent that has not yet waited for the process (in other words, a zombie)
500 and a process which is blocked while trying
503 If the arguments cannot be located (usually because it has not been set, as is
504 the case of system processes and/or kernel threads) the command name is printed
505 within square brackets.
508 utility first tries to obtain the arguments cached by the kernel (if they were
509 shorter than the value of the
510 .Va kern.ps_arg_cache_limit
512 The process can change the arguments shown with
516 makes an educated guess as to the file name and arguments given when the
517 process was created by examining memory or the swap area.
518 The method is inherently somewhat unreliable and in any event a process
519 is entitled to destroy this information.
520 The ucomm (accounting) keyword can, however, be depended on.
521 If the arguments are unavailable or do not agree with the ucomm keyword,
522 the value for the ucomm keyword is appended to the arguments in parentheses.
524 The following is a complete list of the available keywords and their
526 Several of them have aliases (keywords which are synonyms).
528 .Bl -tag -width ".Cm sigignore" -compact
530 percentage CPU usage (alias
533 percentage memory usage (alias
536 accounting flag (alias
539 command and arguments
545 command and arguments
547 number of copy-on-write faults
549 short-term CPU usage factor (for scheduling)
551 data size (in Kbytes)
553 system-call emulation environment (ABI)
555 elapsed running time, format
560 elapsed running time, in decimal integer seconds
562 default FIB number, see
565 the process flags, in hexadecimal (alias
568 the additional set of process flags, in hexadecimal (alias
571 effective group ID (alias
574 group name (from egid) (alias
577 total blocks read (alias
592 lock currently blocked on (as a symbolic name)
594 login name of user who started the session
598 thread (light-weight process) ID (alias
605 total messages received (reads from pipes/sockets)
607 total messages sent (writes on pipes/sockets)
609 wait channel or lock currently blocked on
614 total involuntary context switches
616 number of threads (light-weight processes) tied to a process
618 total signals taken (alias
623 total voluntary context switches
625 wait channel (as an address)
627 total blocks written (alias
632 pageins (same as majflt)
642 core residency time (in seconds; 127 = infinity)
646 group name (from rgid)
650 realtime priority (101 = not a realtime process)
654 user name (from ruid)
658 pending signals (alias
661 caught signals (alias
664 ignored signals (alias
667 blocked signals (alias
670 sleep time (in seconds; 127 = infinity)
672 stack size (in Kbytes)
676 symbolic process state (alias
679 saved gid from a setgid executable
681 saved UID from a setuid executable
683 accumulated system CPU time
689 control terminal device number
691 accumulated CPU time, user + system (alias
694 control terminal process group ID
698 .\"text resident set size (in Kbytes)
700 control terminal session ID
702 text size (in Kbytes)
704 control terminal name (two letter abbreviation)
706 full name of control terminal
708 name to be used for accounting
710 effective user ID (alias
713 scheduling priority on return from system call (alias
720 accumulated user CPU time
724 virtual size in Kbytes (alias
727 wait channel (as a symbolic name)
729 exit or stop status (valid only for stopped or zombie process)
734 column displays bitmask of signals pending in the process queue when
736 option is not specified, otherwise the per-thread queue of pending signals
739 The following environment variables affect the execution of
741 .Bl -tag -width ".Ev COLUMNS"
743 If set, specifies the user's preferred output width in column positions.
746 attempts to automatically determine the terminal width.
749 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
750 .It Pa /boot/kernel/kernel
751 default system namelist
754 Display information on all system processes:
766 .Xr xo_parse_args 3 ,
773 For historical reasons, the
777 supports a different set of options from what is described by
779 and what is supported on
787 in section 8 of the manual.
791 cannot run faster than the system and is run as any other scheduled
792 process, the information it displays can never be exact.
796 utility does not correctly display argument lists containing multibyte