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
151 Show all of the threads associated with each process.
153 Repeat the information header as often as necessary to guarantee one
154 header per page of information.
156 Print information associated with the following keywords:
157 .Cm user , pid , ppid , pgid , sid , jobc , state , tt , time ,
161 Display information about processes which match the specified jail IDs.
162 This may be either the
170 to display only host processes.
175 List the set of keywords available for the
181 Display information associated with the following keywords:
182 .Cm uid , pid , ppid , cpu , pri , nice , vsz , rss , mwchan , state ,
187 Extract values associated with the name list from the specified core
188 instead of the currently running system.
190 Sort by memory usage, instead of the combination of controlling
191 terminal and process ID.
193 Extract the name list from the specified system instead of the default,
194 which is the kernel image the system has booted from.
196 Add the information associated with the space or comma separated list
197 of keywords specified, after the process ID,
198 in the default information
200 Keywords may be appended with an equals
203 This causes the printed header to use the specified string instead of
206 Display information associated with the space or comma separated
207 list of keywords specified.
208 The last keyword in the list may be appended with an equals
210 sign and a string that spans the rest of the argument, and can contain
211 space and comma characters.
212 This causes the printed header to use the specified string instead of
214 Multiple keywords may also be given in the form of more than one
217 So the header texts for multiple keywords can be changed.
218 If all keywords have empty header texts, no header line is written.
220 Display information about processes which match the specified process IDs.
222 Sort by current CPU usage, instead of the combination of controlling
223 terminal and process ID.
225 Change the way the process times, namely cputime, systime, and usertime,
226 are calculated by summing all exited children to their parent process.
228 Display information about processes attached to the device associated
229 with the standard input.
231 Display information about processes attached to the specified terminal
233 Full pathnames, as well as abbreviations (see explanation of the
235 keyword) can be specified.
237 Display the processes belonging to the specified usernames.
239 Display information associated with the following keywords:
240 .Cm user , pid , %cpu , %mem , vsz , rss , tt , state , start , time ,
249 Display information associated with the following keywords:
250 .Cm pid , state , time , sl , re , pagein , vsz , rss , lim , tsiz ,
260 Use 132 columns to display information, instead of the default which
264 option is specified more than once,
266 will use as many columns as necessary without regard for your window size.
267 Note that this option has no effect if the
269 column is not the last column displayed.
271 When displaying processes matched by other options, skip any processes
272 which do not have a controlling terminal.
273 This is the default behaviour.
275 When displaying processes matched by other options, include processes
276 which do not have a controlling terminal.
277 This is the opposite of the
284 are specified in the same command, then
286 will use the one which was specified last.
290 label to the list of keywords for which
292 will display information.
295 A complete list of the available keywords are listed below.
296 Some of these keywords are further specified as follows:
297 .Bl -tag -width lockname
299 The CPU utilization of the process; this is a decaying average over up to
300 a minute of previous (real) time.
301 Since the time base over which this is computed varies (since processes may
302 be very young) it is possible for the sum of all
304 fields to exceed 100%.
306 The percentage of real memory used by this process.
308 Login class associated with the process.
310 The flags associated with the process as in
313 .Bl -column P_SINGLE_BOUNDARY 0x40000000
314 .It Dv "P_ADVLOCK" Ta No "0x00001" Ta "Process may hold a POSIX advisory lock"
315 .It Dv "P_CONTROLT" Ta No "0x00002" Ta "Has a controlling terminal"
316 .It Dv "P_KPROC" Ta No "0x00004" Ta "Kernel process"
317 .It Dv "P_PPWAIT" Ta No "0x00010" Ta "Parent is waiting for child to exec/exit"
318 .It Dv "P_PROFIL" Ta No "0x00020" Ta "Has started profiling"
319 .It Dv "P_STOPPROF" Ta No "0x00040" Ta "Has thread in requesting to stop prof"
320 .It Dv "P_HADTHREADS" Ta No "0x00080" Ta "Has had threads (no cleanup shortcuts)"
321 .It Dv "P_SUGID" Ta No "0x00100" Ta "Had set id privileges since last exec"
322 .It Dv "P_SYSTEM" Ta No "0x00200" Ta "System proc: no sigs, stats or swapping"
323 .It Dv "P_SINGLE_EXIT" Ta No "0x00400" Ta "Threads suspending should exit, not wait"
324 .It Dv "P_TRACED" Ta No "0x00800" Ta "Debugged process being traced"
325 .It Dv "P_WAITED" Ta No "0x01000" Ta "Someone is waiting for us"
326 .It Dv "P_WEXIT" Ta No "0x02000" Ta "Working on exiting"
327 .It Dv "P_EXEC" Ta No "0x04000" Ta "Process called exec"
328 .It Dv "P_WKILLED" Ta No "0x08000" Ta "Killed, shall go to kernel/user boundary ASAP"
329 .It Dv "P_CONTINUED" Ta No "0x10000" Ta "Proc has continued from a stopped state"
330 .It Dv "P_STOPPED_SIG" Ta No "0x20000" Ta "Stopped due to SIGSTOP/SIGTSTP"
331 .It Dv "P_STOPPED_TRACE" Ta No "0x40000" Ta "Stopped because of tracing"
332 .It Dv "P_STOPPED_SINGLE" Ta No "0x80000" Ta "Only one thread can continue"
333 .It Dv "P_PROTECTED" Ta No "0x100000" Ta "Do not kill on memory overcommit"
334 .It Dv "P_SIGEVENT" Ta No "0x200000" Ta "Process pending signals changed"
335 .It Dv "P_SINGLE_BOUNDARY" Ta No "0x400000" Ta "Threads should suspend at user boundary"
336 .It Dv "P_HWPMC" Ta No "0x800000" Ta "Process is using HWPMCs"
337 .It Dv "P_JAILED" Ta No "0x1000000" Ta "Process is in jail"
338 .It Dv "P_TOTAL_STOP" Ta No "0x2000000" Ta "Stopped for system suspend"
339 .It Dv "P_INEXEC" Ta No "0x4000000" Ta "Process is in execve()"
340 .It Dv "P_STATCHILD" Ta No "0x8000000" Ta "Child process stopped or exited"
341 .It Dv "P_INMEM" Ta No "0x10000000" Ta "Loaded into memory"
342 .It Dv "P_SWAPPINGOUT" Ta No "0x20000000" Ta "Process is being swapped out"
343 .It Dv "P_SWAPPINGIN" Ta No "0x40000000" Ta "Process is being swapped in"
344 .It Dv "P_PPTRACE" Ta No "0x80000000" Ta "Vforked child issued ptrace(PT_TRACEME)"
349 associated with the process as in
352 .Bl -column P2_INHERIT_PROTECTED 0x00000001
353 .It Dv "P2_INHERIT_PROTECTED" Ta No "0x00000001" Ta "New children get P_PROTECTED"
354 .It Dv "P2_NOTRACE" Ta No "0x00000002" Ta "No ptrace(2) attach or coredumps"
355 .It Dv "P2_NOTRACE_EXEC" Ta No "0x00000004" Ta "Keep P2_NOPTRACE on exec(2)"
356 .It Dv "P2_AST_SU" Ta No "0x00000008" Ta "Handles SU ast for kthreads"
357 .It Dv "P2_PTRACE_FSTP" Ta No "0x00000010" Ta "SIGSTOP from PT_ATTACH not yet handled"
360 The MAC label of the process.
362 The soft limit on memory used, specified via a call to
365 The exact time the command started, using the
370 The name of the lock that the process is currently blocked on.
371 If the name is invalid or unknown, then
375 The login name associated with the session the process is in (see
378 The event name if the process is blocked normally, or the lock name if
379 the process is blocked on a lock.
380 See the wchan and lockname keywords
383 The process scheduling increment (see
384 .Xr setpriority 2 ) .
386 the real memory (resident set) size of the process (in 1024 byte units).
388 The time the command started.
389 If the command started less than 24 hours ago, the start time is
394 If the command started less than 7 days ago, the start time is
398 Otherwise, the start time is displayed using the
402 The state is given by a sequence of characters, for example,
404 The first character indicates the run state of the process:
406 .Bl -tag -width indent -compact
408 Marks a process in disk (or other short term, uninterruptible) wait.
410 Marks a process that is idle (sleeping for longer than about 20 seconds).
412 Marks a process that is waiting to acquire a lock.
414 Marks a runnable process.
416 Marks a process that is sleeping for less than about 20 seconds.
418 Marks a stopped process.
420 Marks an idle interrupt thread.
422 Marks a dead process (a
426 Additional characters after these, if any, indicate additional state
429 .Bl -tag -width indent -compact
431 The process is in the foreground process group of its control terminal.
433 The process has raised CPU scheduling priority.
439 The process is trying to exit.
441 Marks a process which is in
443 The hostname of the prison can be found in
444 .Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
446 The process has pages locked in core (for example, for raw
449 The process has reduced CPU scheduling priority (see
450 .Xr setpriority 2 ) .
452 The process is a session leader.
454 The process' parent is suspended during a
456 waiting for the process to exec or exit.
458 The process is swapped out.
460 The process is being traced or debugged.
463 An abbreviation for the pathname of the controlling terminal, if any.
464 The abbreviation consists of the three letters following
466 or, for pseudo-terminals, the corresponding entry in
468 This is followed by a
470 if the process can no longer reach that
471 controlling terminal (i.e., it has been revoked).
474 without a preceding two letter abbreviation or pseudo-terminal device number
475 indicates a process which never had a controlling terminal.
476 The full pathname of the controlling terminal is available via the
480 The event (an address in the system) on which a process waits.
481 When printed numerically, the initial part of the address is
482 trimmed off and the result is printed in hex, for example, 0x80324000 prints
486 When printing using the command keyword, a process that has exited and
487 has a parent that has not yet waited for the process (in other words, a zombie)
490 and a process which is blocked while trying
493 If the arguments cannot be located (usually because it has not been set, as is
494 the case of system processes and/or kernel threads) the command name is printed
495 within square brackets.
498 utility first tries to obtain the arguments cached by the kernel (if they were
499 shorter than the value of the
500 .Va kern.ps_arg_cache_limit
502 The process can change the arguments shown with
506 makes an educated guess as to the file name and arguments given when the
507 process was created by examining memory or the swap area.
508 The method is inherently somewhat unreliable and in any event a process
509 is entitled to destroy this information.
510 The ucomm (accounting) keyword can, however, be depended on.
511 If the arguments are unavailable or do not agree with the ucomm keyword,
512 the value for the ucomm keyword is appended to the arguments in parentheses.
514 The following is a complete list of the available keywords and their
516 Several of them have aliases (keywords which are synonyms).
518 .Bl -tag -width ".Cm sigignore" -compact
520 percentage CPU usage (alias
523 percentage memory usage (alias
526 accounting flag (alias
529 command and arguments
535 command and arguments
537 number of copy-on-write faults
539 short-term CPU usage factor (for scheduling)
541 data size (in Kbytes)
543 system-call emulation environment (ABI)
545 elapsed running time, format
550 elapsed running time, in decimal integer seconds
552 default FIB number, see
555 the process flags, in hexadecimal (alias
558 the additional set of process flags, in hexadecimal (alias
561 effective group ID (alias
564 group name (from egid) (alias
567 total blocks read (alias
580 lock currently blocked on (as a symbolic name)
582 login name of user who started the session
586 thread (light-weight process) ID (alias
593 total messages received (reads from pipes/sockets)
595 total messages sent (writes on pipes/sockets)
597 wait channel or lock currently blocked on
602 total involuntary context switches
604 number of threads (light-weight processes) tied to a process
606 total signals taken (alias
611 total voluntary context switches
613 wait channel (as an address)
615 total blocks written (alias
620 pageins (same as majflt)
630 core residency time (in seconds; 127 = infinity)
634 group name (from rgid)
638 realtime priority (101 = not a realtime process)
642 user name (from ruid)
646 pending signals (alias
649 caught signals (alias
652 ignored signals (alias
655 blocked signals (alias
658 sleep time (in seconds; 127 = infinity)
660 stack size (in Kbytes)
664 symbolic process state (alias
667 saved gid from a setgid executable
669 saved UID from a setuid executable
671 accumulated system CPU time
677 control terminal device number
679 accumulated CPU time, user + system (alias
682 control terminal process group ID
686 .\"text resident set size (in Kbytes)
688 control terminal session ID
690 text size (in Kbytes)
692 control terminal name (two letter abbreviation)
694 full name of control terminal
696 name to be used for accounting
698 effective user ID (alias
701 scheduling priority on return from system call (alias
708 accumulated user CPU time
712 virtual size in Kbytes (alias
715 wait channel (as a symbolic name)
717 exit or stop status (valid only for stopped or zombie process)
722 column displays bitmask of signals pending in the process queue when
724 option is not specified, otherwise the per-thread queue of pending signals
727 The following environment variables affect the execution of
729 .Bl -tag -width ".Ev COLUMNS"
731 If set, specifies the user's preferred output width in column positions.
734 attempts to automatically determine the terminal width.
737 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
738 .It Pa /boot/kernel/kernel
739 default system namelist
742 Display information on all system processes:
754 .Xr xo_parse_args 3 ,
761 For historical reasons, the
765 supports a different set of options from what is described by
767 and what is supported on
775 in section 8 of the manual.
779 cannot run faster than the system and is run as any other scheduled
780 process, the information it displays can never be exact.
784 utility does not correctly display argument lists containing multibyte