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
40 .Op Fl aCcdefHhjlmrSTuvwXxZ
41 .Op Fl O Ar fmt | Fl o Ar fmt
42 .Op Fl D Ar up | down | both
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 Expand the list of selected processes based on the process tree.
153 will add the ancestor processes,
155 will add the descendant processes, and
157 will add both the ancestor and the descendant processes.
161 but works well with it.
163 Display the environment as well.
165 Show command-line and environment information about swapped out processes.
166 This option is honored only if the UID of the user is 0.
168 Display information about processes which are running with the specified
171 Show all of the threads associated with each process.
173 Repeat the information header as often as necessary to guarantee one
174 header per page of information.
176 Print information associated with the following keywords:
177 .Cm user , pid , ppid , pgid , sid , jobc , state , tt , time ,
181 Display information about processes which match the specified jail IDs.
182 This may be either the
190 to display only host processes.
195 List the set of keywords available for the
201 Display information associated with the following keywords:
202 .Cm uid , pid , ppid , cpu , pri , nice , vsz , rss , mwchan , state ,
207 Extract values associated with the name list from the specified core
208 instead of the currently running system.
210 Sort by memory usage, instead of the combination of controlling
211 terminal and process ID.
213 Extract the name list from the specified system instead of the default,
214 which is the kernel image the system has booted from.
216 Add the information associated with the space or comma separated list
217 of keywords specified, after the process ID,
218 in the default information
220 Keywords may be appended with an equals
223 This causes the printed header to use the specified string instead of
226 Display information associated with the space or comma separated
227 list of keywords specified.
228 The last keyword in the list may be appended with an equals
230 sign and a string that spans the rest of the argument, and can contain
231 space and comma characters.
232 This causes the printed header to use the specified string instead of
234 Multiple keywords may also be given in the form of more than one
237 So the header texts for multiple keywords can be changed.
238 If all keywords have empty header texts, no header line is written.
240 Display information about processes which match the specified process IDs.
241 It implies the use of
245 all descendent processes are included.
247 Sort by current CPU usage, instead of the combination of controlling
248 terminal and process ID.
250 Change the way the process times, namely cputime, systime, and usertime,
251 are calculated by summing all exited children to their parent process.
253 Display information about processes attached to the device associated
254 with the standard input.
256 Display information about processes attached to the specified terminal
258 Full pathnames, as well as abbreviations (see explanation of the
260 keyword) can be specified.
262 Display the processes belonging to the specified usernames.
264 Display information associated with the following keywords:
265 .Cm user , pid , %cpu , %mem , vsz , rss , tt , state , start , time ,
274 Display information associated with the following keywords:
275 .Cm pid , state , time , sl , re , pagein , vsz , rss , lim , tsiz ,
285 Use at least 132 columns to display information, instead of the default which
286 is the window size if
288 is associated with a terminal.
291 option is specified more than once,
293 will use as many columns as necessary without regard for the window size.
294 Note that this option has no effect if the
296 column is not the last column displayed.
298 When displaying processes matched by other options, skip any processes
299 which do not have a controlling terminal.
300 This is the default behaviour.
302 When displaying processes matched by other options, include processes
303 which do not have a controlling terminal.
304 This is the opposite of the
311 are specified in the same command, then
313 will use the one which was specified last.
317 label to the list of keywords for which
319 will display information.
322 A complete list of the available keywords are listed below.
323 Some of these keywords are further specified as follows:
324 .Bl -tag -width lockname
326 The CPU utilization of the process; this is a decaying average over up to
327 a minute of previous (real) time.
328 Since the time base over which this is computed varies (since processes may
329 be very young) it is possible for the sum of all
331 fields to exceed 100%.
333 The percentage of real memory used by this process.
335 Login class associated with the process.
337 The flags associated with the process as in
340 .Bl -column P_SINGLE_BOUNDARY 0x40000000
341 .It Dv "P_ADVLOCK" Ta No "0x00001" Ta "Process may hold a POSIX advisory lock"
342 .It Dv "P_CONTROLT" Ta No "0x00002" Ta "Has a controlling terminal"
343 .It Dv "P_KPROC" Ta No "0x00004" Ta "Kernel process"
344 .It Dv "P_PPWAIT" Ta No "0x00010" Ta "Parent is waiting for child to exec/exit"
345 .It Dv "P_PROFIL" Ta No "0x00020" Ta "Has started profiling"
346 .It Dv "P_STOPPROF" Ta No "0x00040" Ta "Has thread in requesting to stop prof"
347 .It Dv "P_HADTHREADS" Ta No "0x00080" Ta "Has had threads (no cleanup shortcuts)"
348 .It Dv "P_SUGID" Ta No "0x00100" Ta "Had set id privileges since last exec"
349 .It Dv "P_SYSTEM" Ta No "0x00200" Ta "System proc: no sigs, stats or swapping"
350 .It Dv "P_SINGLE_EXIT" Ta No "0x00400" Ta "Threads suspending should exit, not wait"
351 .It Dv "P_TRACED" Ta No "0x00800" Ta "Debugged process being traced"
352 .It Dv "P_WAITED" Ta No "0x01000" Ta "Someone is waiting for us"
353 .It Dv "P_WEXIT" Ta No "0x02000" Ta "Working on exiting"
354 .It Dv "P_EXEC" Ta No "0x04000" Ta "Process called exec"
355 .It Dv "P_WKILLED" Ta No "0x08000" Ta "Killed, shall go to kernel/user boundary ASAP"
356 .It Dv "P_CONTINUED" Ta No "0x10000" Ta "Proc has continued from a stopped state"
357 .It Dv "P_STOPPED_SIG" Ta No "0x20000" Ta "Stopped due to SIGSTOP/SIGTSTP"
358 .It Dv "P_STOPPED_TRACE" Ta No "0x40000" Ta "Stopped because of tracing"
359 .It Dv "P_STOPPED_SINGLE" Ta No "0x80000" Ta "Only one thread can continue"
360 .It Dv "P_PROTECTED" Ta No "0x100000" Ta "Do not kill on memory overcommit"
361 .It Dv "P_SIGEVENT" Ta No "0x200000" Ta "Process pending signals changed"
362 .It Dv "P_SINGLE_BOUNDARY" Ta No "0x400000" Ta "Threads should suspend at user boundary"
363 .It Dv "P_HWPMC" Ta No "0x800000" Ta "Process is using HWPMCs"
364 .It Dv "P_JAILED" Ta No "0x1000000" Ta "Process is in jail"
365 .It Dv "P_TOTAL_STOP" Ta No "0x2000000" Ta "Stopped for system suspend"
366 .It Dv "P_INEXEC" Ta No "0x4000000" Ta Process is in Xr execve 2
367 .It Dv "P_STATCHILD" Ta No "0x8000000" Ta "Child process stopped or exited"
368 .It Dv "P_INMEM" Ta No "0x10000000" Ta "Loaded into memory"
369 .It Dv "P_SWAPPINGOUT" Ta No "0x20000000" Ta "Process is being swapped out"
370 .It Dv "P_SWAPPINGIN" Ta No "0x40000000" Ta "Process is being swapped in"
371 .It Dv "P_PPTRACE" Ta No "0x80000000" Ta "Vforked child issued ptrace(PT_TRACEME)"
376 associated with the process as in
379 .Bl -column P2_INHERIT_PROTECTED 0x00000001
380 .It Dv "P2_INHERIT_PROTECTED" Ta No "0x00000001" Ta "New children get P_PROTECTED"
381 .It Dv "P2_NOTRACE" Ta No "0x00000002" Ta "No" Xr ptrace 2 attach or coredumps
382 .It Dv "P2_NOTRACE_EXEC" Ta No "0x00000004" Ta Keep P2_NOPTRACE on Xr execve 2
383 .It Dv "P2_AST_SU" Ta No "0x00000008" Ta "Handles SU ast for kthreads"
384 .It Dv "P2_PTRACE_FSTP" Ta No "0x00000010" Ta "SIGSTOP from PT_ATTACH not yet handled"
387 The MAC label of the process.
389 The soft limit on memory used, specified via a call to
392 The exact time the command started, using the
397 The name of the lock that the process is currently blocked on.
398 If the name is invalid or unknown, then
402 The login name associated with the session the process is in (see
405 The event name if the process is blocked normally, or the lock name if
406 the process is blocked on a lock.
407 See the wchan and lockname keywords
410 The process scheduling increment (see
411 .Xr setpriority 2 ) .
413 the real memory (resident set) size of the process (in 1024 byte units).
415 The time the command started.
416 If the command started less than 24 hours ago, the start time is
421 If the command started less than 7 days ago, the start time is
425 Otherwise, the start time is displayed using the
429 The state is given by a sequence of characters, for example,
431 The first character indicates the run state of the process:
433 .Bl -tag -width indent -compact
435 Marks a process in disk (or other short term, uninterruptible) wait.
437 Marks a process that is idle (sleeping for longer than about 20 seconds).
439 Marks a process that is waiting to acquire a lock.
441 Marks a runnable process.
443 Marks a process that is sleeping for less than about 20 seconds.
445 Marks a stopped process.
447 Marks an idle interrupt thread.
449 Marks a dead process (a
453 Additional characters after these, if any, indicate additional state
456 .Bl -tag -width indent -compact
458 The process is in the foreground process group of its control terminal.
460 The process has raised CPU scheduling priority.
466 The process is trying to exit.
468 Marks a process which is in
470 The hostname of the prison can be found in
471 .Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
473 The process has pages locked in core (for example, for raw I/O).
475 The process has reduced CPU scheduling priority (see
476 .Xr setpriority 2 ) .
478 The process is a session leader.
480 The process' parent is suspended during a
482 waiting for the process to exec or exit.
484 The process is swapped out.
486 The process is being traced or debugged.
489 An abbreviation for the pathname of the controlling terminal, if any.
490 The abbreviation consists of the three letters following
492 or, for pseudo-terminals, the corresponding entry in
494 This is followed by a
496 if the process can no longer reach that
497 controlling terminal (i.e., it has been revoked).
500 without a preceding two letter abbreviation or pseudo-terminal device number
501 indicates a process which never had a controlling terminal.
502 The full pathname of the controlling terminal is available via the
506 The event (an address in the system) on which a process waits.
507 When printed numerically, the initial part of the address is
508 trimmed off and the result is printed in hex, for example, 0x80324000 prints
512 When printing using the command keyword, a process that has exited and
513 has a parent that has not yet waited for the process (in other words, a zombie)
516 and a process which is blocked while trying
519 If the arguments cannot be located (usually because it has not been set, as is
520 the case of system processes and/or kernel threads) the command name is printed
521 within square brackets.
524 utility first tries to obtain the arguments cached by the kernel (if they were
525 shorter than the value of the
526 .Va kern.ps_arg_cache_limit
528 The process can change the arguments shown with
532 makes an educated guess as to the file name and arguments given when the
533 process was created by examining memory or the swap area.
534 The method is inherently somewhat unreliable and in any event a process
535 is entitled to destroy this information.
536 The ucomm (accounting) keyword can, however, be depended on.
537 If the arguments are unavailable or do not agree with the ucomm keyword,
538 the value for the ucomm keyword is appended to the arguments in parentheses.
540 The following is a complete list of the available keywords and their
542 Several of them have aliases (keywords which are synonyms).
544 .Bl -tag -width ".Cm sigignore" -compact
546 percentage CPU usage (alias
549 percentage memory usage (alias
552 accounting flag (alias
555 command and arguments
561 command and arguments
563 number of copy-on-write faults
565 The processor number on which the process is executing (visible only on SMP
568 data size (in Kbytes)
570 system-call emulation environment (ABI)
572 elapsed running time, format
579 elapsed running time, in decimal integer seconds
581 default FIB number, see
584 the process flags, in hexadecimal (alias
587 the additional set of process flags, in hexadecimal (alias
590 effective group ID (alias
593 group name (from egid) (alias
596 total blocks read (alias
611 lock currently blocked on (as a symbolic name)
613 login name of user who started the session
617 thread (light-weight process) ID (alias
624 total messages received (reads from pipes/sockets)
626 total messages sent (writes on pipes/sockets)
628 wait channel or lock currently blocked on
633 total involuntary context switches
635 number of threads (light-weight processes) tied to a process
637 total signals taken (alias
642 total voluntary context switches
644 wait channel (as an address)
646 total blocks written (alias
651 pageins (same as majflt)
661 core residency time (in seconds; 127 = infinity)
665 group name (from rgid)
669 realtime priority (see
674 user name (from ruid)
678 pending signals (alias
681 caught signals (alias
684 ignored signals (alias
687 blocked signals (alias
690 sleep time (in seconds; 127 = infinity)
692 stack size (in Kbytes)
696 symbolic process state (alias
699 saved gid from a setgid executable
701 saved UID from a setuid executable
703 accumulated system CPU time
709 control terminal device number
711 accumulated CPU time, user + system (alias
714 control terminal process group ID
718 .\"text resident set size (in Kbytes)
720 control terminal session ID
722 text size (in Kbytes)
724 control terminal name (two letter abbreviation)
726 full name of control terminal
728 name to be used for accounting
730 effective user ID (alias
733 scheduling priority on return from system call (alias
740 accumulated user CPU time
744 virtual size in Kbytes (alias
747 wait channel (as a symbolic name)
749 exit or stop status (valid only for stopped or zombie process)
754 column displays bitmask of signals pending in the process queue when
756 option is not specified, otherwise the per-thread queue of pending signals
759 The following environment variables affect the execution of
761 .Bl -tag -width ".Ev COLUMNS"
763 If set, specifies the user's preferred output width in column positions.
766 attempts to automatically determine the terminal width.
769 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
770 .It Pa /boot/kernel/kernel
771 default system namelist
776 Display information on all system processes:
788 .Xr xo_parse_args 3 ,
795 For historical reasons, the
799 supports a different set of options from what is described by
801 and what is supported on
809 in section 8 of the manual.
813 cannot run faster than the system and is run as any other scheduled
814 process, the information it displays can never be exact.
818 utility does not correctly display argument lists containing multibyte