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.
104 The options are as follows:
105 .Bl -tag -width indent
109 in a selection of different human and machine readable formats.
112 for details on command line arguments.
114 Display information about other users' processes as well as your own.
116 .Va security.bsd.see_other_uids
117 sysctl is set to zero, this option is honored only if the UID of the user is 0.
121 column output to just contain the executable name,
122 rather than the full command line.
124 Change the way the CPU percentage is calculated by using a
126 CPU calculation that ignores
128 time (this normally has
131 Arrange processes into descendancy order and prefix each command with
132 indentation text showing sibling and parent/child relationships as a tree.
137 options are also used, they control how sibling processes are sorted
138 relative to each other.
139 Note that this option has no effect if the
141 column is not the last column displayed.
143 Display the environment as well.
145 Show command-line and environment information about swapped out processes.
146 This option is honored only if the UID of the user is 0.
148 Display information about processes which are running with the specified
153 threads associated with each process.
154 Depending on the threading package that
155 is in use, this may show only the process, only the kernel scheduled entities,
156 or all of the process threads.
158 Repeat the information header as often as necessary to guarantee one
159 header per page of information.
161 Print information associated with the following keywords:
162 .Cm user , pid , ppid , pgid , sid , jobc , state , tt , time ,
166 Display information about processes which match the specified jail IDs.
167 This may be either the
175 to display only host processes.
180 List the set of keywords available for the
186 Display information associated with the following keywords:
187 .Cm uid , pid , ppid , cpu , pri , nice , vsz , rss , mwchan , state ,
192 Extract values associated with the name list from the specified core
193 instead of the currently running system.
195 Sort by memory usage, instead of the combination of controlling
196 terminal and process ID.
198 Extract the name list from the specified system instead of the default,
199 which is the kernel image the system has booted from.
201 Add the information associated with the space or comma separated list
202 of keywords specified, after the process ID,
203 in the default information
205 Keywords may be appended with an equals
208 This causes the printed header to use the specified string instead of
211 Display information associated with the space or comma separated
212 list of keywords specified.
213 The last keyword in the list may be appended with an equals
215 sign and a string that spans the rest of the argument, and can contain
216 space and comma characters.
217 This causes the printed header to use the specified string instead of
219 Multiple keywords may also be given in the form of more than one
222 So the header texts for multiple keywords can be changed.
223 If all keywords have empty header texts, no header line is written.
225 Display information about processes which match the specified process IDs.
227 Sort by current CPU usage, instead of the combination of controlling
228 terminal and process ID.
230 Change the way the process times, namely cputime, systime, and usertime,
231 are calculated by summing all exited children to their parent process.
233 Display information about processes attached to the device associated
234 with the standard input.
236 Display information about processes attached to the specified terminal
238 Full pathnames, as well as abbreviations (see explanation of the
240 keyword) can be specified.
242 Display the processes belonging to the specified usernames.
244 Display information associated with the following keywords:
245 .Cm user , pid , %cpu , %mem , vsz , rss , tt , state , start , time ,
254 Display information associated with the following keywords:
255 .Cm pid , state , time , sl , re , pagein , vsz , rss , lim , tsiz ,
265 Use 132 columns to display information, instead of the default which
269 option is specified more than once,
271 will use as many columns as necessary without regard for your window size.
272 Note that this option has no effect if the
274 column is not the last column displayed.
276 When displaying processes matched by other options, skip any processes
277 which do not have a controlling terminal.
278 This is the default behaviour.
280 When displaying processes matched by other options, include processes
281 which do not have a controlling terminal.
282 This is the opposite of the
289 are specified in the same command, then
291 will use the one which was specified last.
295 label to the list of keywords for which
297 will display information.
300 A complete list of the available keywords are listed below.
301 Some of these keywords are further specified as follows:
302 .Bl -tag -width lockname
304 The CPU utilization of the process; this is a decaying average over up to
305 a minute of previous (real) time.
306 Since the time base over which this is computed varies (since processes may
307 be very young) it is possible for the sum of all
309 fields to exceed 100%.
311 The percentage of real memory used by this process.
313 Login class associated with the process.
315 The flags associated with the process as in
318 .Bl -column P_SINGLE_BOUNDARY 0x40000000
319 .It Dv "P_ADVLOCK" Ta No "0x00001" Ta "Process may hold a POSIX advisory lock"
320 .It Dv "P_CONTROLT" Ta No "0x00002" Ta "Has a controlling terminal"
321 .It Dv "P_KPROC" Ta No "0x00004" Ta "Kernel process"
322 .It Dv "P_PPWAIT" Ta No "0x00010" Ta "Parent is waiting for child to exec/exit"
323 .It Dv "P_PROFIL" Ta No "0x00020" Ta "Has started profiling"
324 .It Dv "P_STOPPROF" Ta No "0x00040" Ta "Has thread in requesting to stop prof"
325 .It Dv "P_HADTHREADS" Ta No "0x00080" Ta "Has had threads (no cleanup shortcuts)"
326 .It Dv "P_SUGID" Ta No "0x00100" Ta "Had set id privileges since last exec"
327 .It Dv "P_SYSTEM" Ta No "0x00200" Ta "System proc: no sigs, stats or swapping"
328 .It Dv "P_SINGLE_EXIT" Ta No "0x00400" Ta "Threads suspending should exit, not wait"
329 .It Dv "P_TRACED" Ta No "0x00800" Ta "Debugged process being traced"
330 .It Dv "P_WAITED" Ta No "0x01000" Ta "Someone is waiting for us"
331 .It Dv "P_WEXIT" Ta No "0x02000" Ta "Working on exiting"
332 .It Dv "P_EXEC" Ta No "0x04000" Ta "Process called exec"
333 .It Dv "P_WKILLED" Ta No "0x08000" Ta "Killed, shall go to kernel/user boundary ASAP"
334 .It Dv "P_CONTINUED" Ta No "0x10000" Ta "Proc has continued from a stopped state"
335 .It Dv "P_STOPPED_SIG" Ta No "0x20000" Ta "Stopped due to SIGSTOP/SIGTSTP"
336 .It Dv "P_STOPPED_TRACE" Ta No "0x40000" Ta "Stopped because of tracing"
337 .It Dv "P_STOPPED_SINGLE" Ta No "0x80000" Ta "Only one thread can continue"
338 .It Dv "P_PROTECTED" Ta No "0x100000" Ta "Do not kill on memory overcommit"
339 .It Dv "P_SIGEVENT" Ta No "0x200000" Ta "Process pending signals changed"
340 .It Dv "P_SINGLE_BOUNDARY" Ta No "0x400000" Ta "Threads should suspend at user boundary"
341 .It Dv "P_HWPMC" Ta No "0x800000" Ta "Process is using HWPMCs"
342 .It Dv "P_JAILED" Ta No "0x1000000" Ta "Process is in jail"
343 .It Dv "P_TOTAL_STOP" Ta No "0x2000000" Ta "Stopped for system suspend"
344 .It Dv "P_INEXEC" Ta No "0x4000000" Ta "Process is in execve()"
345 .It Dv "P_STATCHILD" Ta No "0x8000000" Ta "Child process stopped or exited"
346 .It Dv "P_INMEM" Ta No "0x10000000" Ta "Loaded into memory"
347 .It Dv "P_SWAPPINGOUT" Ta No "0x20000000" Ta "Process is being swapped out"
348 .It Dv "P_SWAPPINGIN" Ta No "0x40000000" Ta "Process is being swapped in"
349 .It Dv "P_PPTRACE" Ta No "0x80000000" Ta "Vforked child issued ptrace(PT_TRACEME)"
354 associated with the process as in
357 .Bl -column P2_INHERIT_PROTECTED 0x00000001
358 .It Dv "P2_INHERIT_PROTECTED" Ta No "0x00000001" Ta "New children get P_PROTECTED"
359 .It Dv "P2_NOTRACE" Ta No "0x00000002" Ta "No ptrace(2) attach or coredumps"
360 .It Dv "P2_NOTRACE_EXEC" Ta No "0x00000004" Ta "Keep P2_NOPTRACE on exec(2)"
361 .It Dv "P2_AST_SU" Ta No "0x00000008" Ta "Handles SU ast for kthreads"
362 .It Dv "P2_PTRACE_FSTP" Ta No "0x00000010" Ta "SIGSTOP from PT_ATTACH not yet handled"
365 The MAC label of the process.
367 The soft limit on memory used, specified via a call to
370 The exact time the command started, using the
375 The name of the lock that the process is currently blocked on.
376 If the name is invalid or unknown, then
380 The login name associated with the session the process is in (see
383 The event name if the process is blocked normally, or the lock name if
384 the process is blocked on a lock.
385 See the wchan and lockname keywords
388 The process scheduling increment (see
389 .Xr setpriority 2 ) .
391 the real memory (resident set) size of the process (in 1024 byte units).
393 The time the command started.
394 If the command started less than 24 hours ago, the start time is
399 If the command started less than 7 days ago, the start time is
403 Otherwise, the start time is displayed using the
407 The state is given by a sequence of characters, for example,
409 The first character indicates the run state of the process:
411 .Bl -tag -width indent -compact
413 Marks a process in disk (or other short term, uninterruptible) wait.
415 Marks a process that is idle (sleeping for longer than about 20 seconds).
417 Marks a process that is waiting to acquire a lock.
419 Marks a runnable process.
421 Marks a process that is sleeping for less than about 20 seconds.
423 Marks a stopped process.
425 Marks an idle interrupt thread.
427 Marks a dead process (a
431 Additional characters after these, if any, indicate additional state
434 .Bl -tag -width indent -compact
436 The process is in the foreground process group of its control terminal.
438 The process has raised CPU scheduling priority.
444 The process is trying to exit.
446 Marks a process which is in
448 The hostname of the prison can be found in
449 .Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
451 The process has pages locked in core (for example, for raw
454 The process has reduced CPU scheduling priority (see
455 .Xr setpriority 2 ) .
457 The process is a session leader.
459 The process' parent is suspended during a
461 waiting for the process to exec or exit.
463 The process is swapped out.
465 The process is being traced or debugged.
468 An abbreviation for the pathname of the controlling terminal, if any.
469 The abbreviation consists of the three letters following
471 or, for pseudo-terminals, the corresponding entry in
473 This is followed by a
475 if the process can no longer reach that
476 controlling terminal (i.e., it has been revoked).
479 without a preceding two letter abbreviation or pseudo-terminal device number
480 indicates a process which never had a controlling terminal.
481 The full pathname of the controlling terminal is available via the
485 The event (an address in the system) on which a process waits.
486 When printed numerically, the initial part of the address is
487 trimmed off and the result is printed in hex, for example, 0x80324000 prints
491 When printing using the command keyword, a process that has exited and
492 has a parent that has not yet waited for the process (in other words, a zombie)
495 and a process which is blocked while trying
498 If the arguments cannot be located (usually because it has not been set, as is
499 the case of system processes and/or kernel threads) the command name is printed
500 within square brackets.
503 utility first tries to obtain the arguments cached by the kernel (if they were
504 shorter than the value of the
505 .Va kern.ps_arg_cache_limit
507 The process can change the arguments shown with
511 makes an educated guess as to the file name and arguments given when the
512 process was created by examining memory or the swap area.
513 The method is inherently somewhat unreliable and in any event a process
514 is entitled to destroy this information.
515 The ucomm (accounting) keyword can, however, be depended on.
516 If the arguments are unavailable or do not agree with the ucomm keyword,
517 the value for the ucomm keyword is appended to the arguments in parentheses.
519 The following is a complete list of the available keywords and their
521 Several of them have aliases (keywords which are synonyms).
523 .Bl -tag -width ".Cm sigignore" -compact
525 percentage CPU usage (alias
528 percentage memory usage (alias
531 accounting flag (alias
534 command and arguments
540 command and arguments
542 number of copy-on-write faults
544 short-term CPU usage factor (for scheduling)
546 data size (in Kbytes)
548 system-call emulation environment (ABI)
550 elapsed running time, format
555 elapsed running time, in decimal integer seconds
557 default FIB number, see
560 the process flags, in hexadecimal (alias
563 the additional set of process flags, in hexadecimal (alias
566 effective group ID (alias
569 group name (from egid) (alias
572 total blocks read (alias
585 lock currently blocked on (as a symbolic name)
587 login name of user who started the session
597 total messages received (reads from pipes/sockets)
599 total messages sent (writes on pipes/sockets)
601 wait channel or lock currently blocked on
606 total involuntary context switches
608 number of threads tied to a process
610 total signals taken (alias
615 total voluntary context switches
617 wait channel (as an address)
619 total blocks written (alias
624 pageins (same as majflt)
634 core residency time (in seconds; 127 = infinity)
638 group name (from rgid)
642 realtime priority (101 = not a realtime process)
646 user name (from ruid)
650 pending signals (alias
653 caught signals (alias
656 ignored signals (alias
659 blocked signals (alias
662 sleep time (in seconds; 127 = infinity)
664 stack size (in Kbytes)
668 symbolic process state (alias
671 saved gid from a setgid executable
673 saved UID from a setuid executable
675 accumulated system CPU time
681 control terminal device number
683 accumulated CPU time, user + system (alias
686 control terminal process group ID
690 .\"text resident set size (in Kbytes)
692 control terminal session ID
694 text size (in Kbytes)
696 control terminal name (two letter abbreviation)
698 full name of control terminal
700 name to be used for accounting
702 effective user ID (alias
705 scheduling priority on return from system call (alias
712 accumulated user CPU time
716 virtual size in Kbytes (alias
719 wait channel (as a symbolic name)
721 exit or stop status (valid only for stopped or zombie process)
726 column displays bitmask of signals pending in the process queue when
728 option is not specified, otherwise the per-thread queue of pending signals
731 The following environment variables affect the execution of
733 .Bl -tag -width ".Ev COLUMNS"
735 If set, specifies the user's preferred output width in column positions.
738 attempts to automatically determine the terminal width.
741 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
742 .It Pa /boot/kernel/kernel
743 default system namelist
746 Display information on all system processes:
758 .Xr xo_parse_args 3 ,
765 For historical reasons, the
769 supports a different set of options from what is described by
771 and what is supported on
779 in section 8 of the manual.
783 cannot run faster than the system and is run as any other scheduled
784 process, the information it displays can never be exact.
788 utility does not correctly display argument lists containing multibyte