git: ddf144a04b53 - main - ps.1: Revamp: Explain general principles, update to match reality
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Mon, 28 Apr 2025 12:23:18 UTC
The branch main has been updated by olce:
URL: https://cgit.FreeBSD.org/src/commit/?id=ddf144a04b53d8599bdd00747e1b6d77e695c292
commit ddf144a04b53d8599bdd00747e1b6d77e695c292
Author: Olivier Certner <olce@FreeBSD.org>
AuthorDate: 2025-03-14 16:17:30 +0000
Commit: Olivier Certner <olce@FreeBSD.org>
CommitDate: 2025-04-28 11:55:01 +0000
ps.1: Revamp: Explain general principles, update to match reality
The preamble has been revamped to give a thorough overview of the
different aspects of the ps(1) command in the following separate
paragraphs:
1. What it outputs.
2. Which processes are listed.
3. Which information is displayed by process.
4. How lines are sorted.
5. Considerations about the (mostly broken) output width.
6. Backwards compatibility features.
Fix or expand the description of several options and some keywords to
match their actual behavior.
Expand the STANDARDS section, noting the options conforming to POSIX and
those that do not (but may be changed to), as well as current diverging
behaviors.
Expand the BUGS section with a thorough description of other known
problems.
While here, document the POSIX-specified '-A' option. We have been
supporting it since 2004 (commit "Support more POSIX/SUSv3 options:",
a4c8a745a85b18d7, r127499) and it has been standard for longer. It
seems now highly unlikely we will ever want to use it for any other
purpose, so just stop trying to hide it.
While here, re-order flags according to mdoc(7)'s prescription. Given
the current state, this also requires less changes than, e.g., putting
all uppercase flags first.
While here, move the detailed specifications of keywords from the
DESCRIPTION to the KEYWORDS section.
While here, fix the formatting of some references to keywords.
MFC after: 3 days
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D49605
---
bin/ps/ps.1 | 957 ++++++++++++++++++++++++++++++++++++++----------------------
1 file changed, 607 insertions(+), 350 deletions(-)
diff --git a/bin/ps/ps.1 b/bin/ps/ps.1
index 542ae71e898a..412d6a5a599b 100644
--- a/bin/ps/ps.1
+++ b/bin/ps/ps.1
@@ -1,6 +1,13 @@
.\"-
+.\" SPDX-License-Identifier: BSD-3-Clause
+.\"
.\" Copyright (c) 1980, 1990, 1991, 1993, 1994
.\" The Regents of the University of California. All rights reserved.
+.\" Copyright (c) 2025 The FreeBSD Foundation
+.\"
+.\" Portions of this documentation were written by Olivier Certner
+.\" <olce@FreeBSD.org> at Kumacom SARL under sponsorship from the FreeBSD
+ \" Foundation.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@@ -26,7 +33,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd November 11, 2023
+.Dd March 14, 2025
.Dt PS 1
.Os
.Sh NAME
@@ -35,8 +42,9 @@
.Sh SYNOPSIS
.Nm
.Op Fl -libxo
-.Op Fl aCcdefHhjlmrSTuvwXxZ
-.Op Fl O Ar fmt | Fl o Ar fmt
+.Op Fl AaCcdefHhjlmrSTuvwXxZ
+.Op Fl O Ar fmt
+.Op Fl o Ar fmt
.Op Fl D Ar up | down | both
.Op Fl G Ar gid Ns Op , Ns Ar gid Ns Ar ...
.Op Fl J Ar jid Ns Op , Ns Ar jid Ns Ar ...
@@ -51,36 +59,99 @@
.Sh DESCRIPTION
The
.Nm
-utility
-displays a header line, followed by lines containing information about
-all of your
-processes that have controlling terminals.
-If the
+utility displays information about a selection of processes.
+Its traditional text style output consists of a header line followed by one line
+of information per selected process, or possibly multiple ones if using
+.Fl H
+.Pq one per lightweight-process .
+Other output styles can be requested via
+.Fl -libxo .
+.Pp
+By default, only the processes of the calling user, determined by matching their
+effective user ID with the real user ID of the
+.Nm
+process, that have controlling terminals are shown.
+A different set of processes can be selected for display by using combinations
+of the
+.Fl A , a , D , G , J , p , T , t , U , X ,
+and
.Fl x
-options is specified,
+options.
+Except for options
+.Fl A , a , X ,
+and
+.Fl x ,
+as soon as one of them appears, it inhibits the default process selection, i.e.,
+the calling user's processes are shown only on request.
+If more than one of these
+.Pq with same exceptions
+appear,
.Nm
-will also display processes that do not have controlling terminals.
+will select processes as soon as they are matched by at least one of them
+.Pq inclusive OR .
+The
+.Fl X
+option can be independently used to further filter the listed processes to only
+those that have a controlling terminal
+.Po
+except for those selected by
+.Fl p
+.Pc .
+Its opposite,
+.Fl x ,
+forcefully removes that filter.
+If none of
+.Fl X
+and
+.Fl x
+is specified, the implied default behavior is that of
+.Fl X
+unless using another option whose description explicitly says that
+.Fl x
+is implied.
.Pp
-A different set of processes can be selected for display by using any
-combination of the
-.Fl a , D , G , J , p , T , t ,
+For each selected process, the default displayed information consists of the
+process' ID, controlling terminal, state, CPU time
+.Pq including both user and system time
+and associated command
+.Po
+see the documentation for the
+.Cm command
+keyword below
+.Pc .
+This information can be tweaked using two groups of options which can be
+combined as needed.
+First, options
+.Fl o
and
-.Fl U
+.Fl O
+add columns with data corresponding to the explicitly passed keywords and, for
+.Fl O ,
+additionally the same columns as in the default display.
+Available keywords are documented in the
+.Sx KEYWORDS
+section below.
+They can be listed using option
+.Fl L .
+Second, options
+.Fl j , l , u ,
+and
+.Fl v
+designate specific predefined groups of columns, also called canned displays.
+Appearance of any of these options inhibits the default display, replacing it
+all with the requested columns, and in the order options are passed.
+The individual columns requested via a canned display option which have the same
+keyword as that of some column added by earlier options are not added again.
+This kind of automatic removal of duplicate keywords in canned displays is
+useful for slightly tweaking these displays without having to rebuild variants
+from scratch, e.g., using
+.Fl o
options.
-If more than one of these options are given, then
-.Nm
-will select all processes which are matched by at least one of the
-given options.
.Pp
-For the processes which have been selected for display,
-.Nm
-will usually display one line per process.
-The
+Output information lines are by default sorted first by controlling terminal,
+then by process ID, and then, if
.Fl H
-option may result in multiple output lines (one line per thread) for
-some processes.
-By default all of these output lines are sorted first by controlling
-terminal, then by process ID.
+has been specified, by lightweight-process (thread) ID.
The
.Fl m , r , u ,
and
@@ -89,23 +160,29 @@ options will change the sort order.
If more than one sorting option was given, then the selected processes
will be sorted by the last sorting option which was specified.
.Pp
-For the processes which have been selected for display, the information
-to display is selected based on a set of keywords (see the
-.Fl L , O ,
-and
-.Fl o
-options).
-The default output format includes, for each process, the process' ID,
-controlling terminal, state, CPU time (including both user and system time)
-and associated command.
-.Pp
-If the
+If the traditional text output (the default) is used, the default output width is that requested by the
+.Ev COLUMNS
+environment variable if present, else the line width of the terminal associated
+to the
.Nm
-process is associated with a terminal, the default output width is that of the
-terminal; otherwise the output width is unlimited.
+process, if any.
+In all other situations, the output width is unlimited.
See also the
.Fl w
+option and the
+.Sx BUGS
+section.
+.Pp
+For backwards compatibility,
+.Nm
+attempts to interpret any positional argument as a process ID, as if specified
+by the
+.Fl p
option.
+Failure to do so will trigger an error.
+.Nm
+also accepts the old-style BSD options, whose format and effect are left
+undocumented on purpose.
.Pp
The options are as follows:
.Bl -tag -width indent
@@ -116,16 +193,33 @@ in a selection of different human and machine readable formats.
See
.Xr xo_parse_args 3
for details on command line arguments.
+The default is the traditional text style output.
+.It Fl A
+Display information about all processes in the system.
+Using this option is strictly equivalent to specifying both
+.Fl a
+and
+.Fl x .
+Please see their description for more information.
.It Fl a
-Display information about other users' processes as well as your own.
+Display information about all users' processes.
+It does not, however, list all processes
+.Po
+see
+.Fl A
+and
+.Fl x
+.Pc .
+Currently, this option has no effect if any other option selecting processes to
+display is present, except for
+.Fl X
+and
+.Fl x .
If the
.Va security.bsd.see_other_uids
-sysctl is set to zero, this option is honored only if the UID of the user is 0.
-.It Fl c
-Change the
-.Dq command
-column output to just contain the executable name,
-rather than the full command line.
+sysctl is set to zero, this option is honored only if the real user ID of the
+.Nm
+process is 0.
.It Fl C
Change the way the CPU percentage is calculated by using a
.Dq raw
@@ -133,18 +227,11 @@ CPU calculation that ignores
.Dq resident
time (this normally has
no effect).
-.It Fl d
-Arrange processes into descendancy order and prefix each command with
-indentation text showing sibling and parent/child relationships as a tree.
-If either of the
-.Fl m
-and
-.Fl r
-options are also used, they control how sibling processes are sorted
-relative to each other.
-Note that this option has no effect if the
+.It Fl c
+Change the
.Dq command
-column is not the last column displayed.
+column output to just contain the executable name,
+rather than the full command line.
.It Fl D
Expand the list of selected processes based on the process tree.
.Dq UP
@@ -157,21 +244,43 @@ will add both the ancestor and the descendant processes.
does not imply
.Fl d ,
but works well with it.
+.It Fl d
+Arrange processes into descendancy order and prefix each command with
+indentation text showing sibling and parent/child relationships as a tree.
+If either of the
+.Fl m
+and
+.Fl r
+options are also used, they control how sibling processes are sorted
+relative to each other.
+Note that this option has no effect if the last column does not have
+.Cm comm ,
+.Cm command
+or
+.Cm ucomm
+as its keyword.
.It Fl e
Display the environment as well.
+.It Fl f
+Indicates to print the full command and arguments in
+.Cm command
+columns.
+This is the default behavior on
+.Fx .
+See
+.Fl c
+to turn it off.
.It Fl G
-Display information about processes which are running with the specified
-real group IDs.
+Display information about processes whose real group ID matches the specified
+group IDs or names.
+Implies
+.Fl x
+by default.
.It Fl H
Show all of the threads associated with each process.
.It Fl h
Repeat the information header as often as necessary to guarantee one
header per page of information.
-.It Fl j
-Print information associated with the following keywords:
-.Cm user , pid , ppid , pgid , sid , jobc , state , tt , time ,
-and
-.Cm command .
.It Fl J
Display information about processes which match the specified jail IDs.
This may be either the
@@ -183,9 +292,14 @@ Use
.Fl J
.Sy 0
to display only host processes.
-This flag implies
+Implies
.Fl x
by default.
+.It Fl j
+Print information associated with the following keywords:
+.Cm user , pid , ppid , pgid , sid , jobc , state , tt , time ,
+and
+.Cm command .
.It Fl L
List the set of keywords available for the
.Fl O
@@ -208,21 +322,26 @@ terminal and process ID.
Extract the name list from the specified system instead of the default,
which is the kernel image the system has booted from.
.It Fl O
-Add the information associated with the space or comma separated list
-of keywords specified, after the process ID,
-in the default information
-display.
-Keywords may be appended with an equals
+On first occurence, add all columns of the default display
+.Po
+as if by
+.Fl o
+.Pc
+and insert just after the process ID column in that default display the columns
+associated with the passed space- or comma-separated list of keywords.
+On next occurences, just insert the keywords of the passed list, as if by
+.Fl o .
+The last keyword in the list may be appended with an equals sign
.Pq Ql =
-sign and a string.
-This causes the printed header to use the specified string instead of
-the standard header.
+as explained for option
+.Fl o
+and with the same effect.
.It Fl o
-Display information associated with the space or comma separated
-list of keywords specified.
-The last keyword in the list may be appended with an equals
+Display information associated with the space- or comma-separated list of
+keywords specified.
+The last keyword in the list may be appended with an equals sign
.Pq Ql =
-sign and a string that spans the rest of the argument, and can contain
+and a string that spans the rest of the argument, and can contain
space and comma characters.
This causes the printed header to use the specified string instead of
the standard header.
@@ -233,6 +352,8 @@ So the header texts for multiple keywords can be changed.
If all keywords have empty header texts, no header line is written.
.It Fl p
Display information about processes which match the specified process IDs.
+Processes selected by this option are not subject to being filtered by
+.Fl X .
.It Fl r
Sort by current CPU usage, instead of the combination of controlling
terminal and process ID.
@@ -248,8 +369,15 @@ devices.
Full pathnames, as well as abbreviations (see explanation of the
.Cm tt
keyword) can be specified.
+Implies
+.Fl x
+by default.
.It Fl U
-Display the processes belonging to the specified usernames.
+Display information about processes whose effective user ID matches the
+specified user IDs or names.
+Implies
+.Fl x
+by default.
.It Fl u
Display information associated with the following keywords:
.Cm user , pid , %cpu , %mem , vsz , rss , tt , state , start , time ,
@@ -272,278 +400,51 @@ option implies the
.Fl m
option.
.It Fl w
-Use at least 132 columns to display information, instead of the default which
-is the window size if
-.Nm
-is associated with a terminal.
-If the
+Use at least 131 columns to display information.
+If
.Fl w
-option is specified more than once,
+is specified more than once,
.Nm
-will use as many columns as necessary without regard for the window size.
-Note that this option has no effect if the
-.Dq command
-column is not the last column displayed.
+will use as many columns as necessary.
+Please see the preamble of this manual page for how the output width is
+initially determined.
+In particular, if the initial output width is unlimited, specifying
+.Fl w
+has no effect.
+Please also consult the
+.Sx BUGS
+section.
.It Fl X
-When displaying processes matched by other options, skip any processes
-which do not have a controlling terminal.
-This is the default behaviour.
+When displaying processes selected by other options, skip any processes which do
+not have a controlling terminal, except for those selected through
+.Fl p .
+This is the default behaviour, unless using another option whose description
+explicitly says that
+.Fl x
+is implied.
.It Fl x
-When displaying processes matched by other options, include processes
-which do not have a controlling terminal.
-This is the opposite of the
-.Fl X
-option.
+When displaying processes selected by other options, include processes which do
+not have a controlling terminal.
+This option has the opposite behavior to that of
+.Fl X .
If both
.Fl X
and
-.Fl x
-are specified in the same command, then
-.Nm
-will use the one which was specified last.
-.It Fl Z
-Add
-.Xr mac 4
-label to the list of keywords for which
-.Nm
-will display information.
-.El
-.Pp
-A complete list of the available keywords are listed below.
-Some of these keywords are further specified as follows:
-.Bl -tag -width lockname
-.It Cm %cpu
-The CPU utilization of the process; this is a decaying average over up to
-a minute of previous (real) time.
-Since the time base over which this is computed varies (since processes may
-be very young) it is possible for the sum of all
-.Cm %cpu
-fields to exceed 100%.
-.It Cm %mem
-The percentage of real memory used by this process.
-.It Cm class
-Login class associated with the process.
-.It Cm flags
-The flags associated with the process as in
-the include file
-.In sys/proc.h :
-.Bl -column P_SINGLE_BOUNDARY 0x40000000
-.It Dv "P_ADVLOCK" Ta No "0x00000001" Ta "Process may hold a POSIX advisory lock"
-.It Dv "P_CONTROLT" Ta No "0x00000002" Ta "Has a controlling terminal"
-.It Dv "P_KPROC" Ta No "0x00000004" Ta "Kernel process"
-.It Dv "P_PPWAIT" Ta No "0x00000010" Ta "Parent is waiting for child to exec/exit"
-.It Dv "P_PROFIL" Ta No "0x00000020" Ta "Has started profiling"
-.It Dv "P_STOPPROF" Ta No "0x00000040" Ta "Has thread in requesting to stop prof"
-.It Dv "P_HADTHREADS" Ta No "0x00000080" Ta "Has had threads (no cleanup shortcuts)"
-.It Dv "P_SUGID" Ta No "0x00000100" Ta "Had set id privileges since last exec"
-.It Dv "P_SYSTEM" Ta No "0x00000200" Ta "System proc: no sigs, stats or swapping"
-.It Dv "P_SINGLE_EXIT" Ta No "0x00000400" Ta "Threads suspending should exit, not wait"
-.It Dv "P_TRACED" Ta No "0x00000800" Ta "Debugged process being traced"
-.It Dv "P_WAITED" Ta No "0x00001000" Ta "Someone is waiting for us"
-.It Dv "P_WEXIT" Ta No "0x00002000" Ta "Working on exiting"
-.It Dv "P_EXEC" Ta No "0x00004000" Ta "Process called exec"
-.It Dv "P_WKILLED" Ta No "0x00008000" Ta "Killed, shall go to kernel/user boundary ASAP"
-.It Dv "P_CONTINUED" Ta No "0x00010000" Ta "Proc has continued from a stopped state"
-.It Dv "P_STOPPED_SIG" Ta No "0x00020000" Ta "Stopped due to SIGSTOP/SIGTSTP"
-.It Dv "P_STOPPED_TRACE" Ta No "0x00040000" Ta "Stopped because of tracing"
-.It Dv "P_STOPPED_SINGLE" Ta No "0x00080000" Ta "Only one thread can continue"
-.It Dv "P_PROTECTED" Ta No "0x00100000" Ta "Do not kill on memory overcommit"
-.It Dv "P_SIGEVENT" Ta No "0x00200000" Ta "Process pending signals changed"
-.It Dv "P_SINGLE_BOUNDARY" Ta No "0x00400000" Ta "Threads should suspend at user boundary"
-.It Dv "P_HWPMC" Ta No "0x00800000" Ta "Process is using HWPMCs"
-.It Dv "P_JAILED" Ta No "0x01000000" Ta "Process is in jail"
-.It Dv "P_TOTAL_STOP" Ta No "0x02000000" Ta "Stopped for system suspend"
-.It Dv "P_INEXEC" Ta No "0x04000000" Ta Process is in Xr execve 2
-.It Dv "P_STATCHILD" Ta No "0x08000000" Ta "Child process stopped or exited"
-.It Dv "P_INMEM" Ta No "0x10000000" Ta "Always set, unused"
-.It Dv "P_PPTRACE" Ta No "0x80000000" Ta "Vforked child issued ptrace(PT_TRACEME)"
-.El
-.It Cm flags2
-The flags kept in
-.Va p_flag2
-associated with the process as in
-the include file
-.In sys/proc.h :
-.Bl -column P2_INHERIT_PROTECTED 0x00000001
-.It Dv "P2_INHERIT_PROTECTED" Ta No "0x00000001" Ta "New children get P_PROTECTED"
-.It Dv "P2_NOTRACE" Ta No "0x00000002" Ta "No" Xr ptrace 2 attach or coredumps
-.It Dv "P2_NOTRACE_EXEC" Ta No "0x00000004" Ta Keep P2_NOPTRACE on Xr execve 2
-.It Dv "P2_AST_SU" Ta No "0x00000008" Ta "Handles SU ast for kthreads"
-.It Dv "P2_PTRACE_FSTP" Ta No "0x00000010" Ta "SIGSTOP from PT_ATTACH not yet handled"
-.It Dv "P2_TRAPCAP" Ta No "0x00000020" Ta "SIGTRAP on ENOTCAPABLE"
-.It Dv "P2_ASLR_ENABLE" Ta No "0x00000040" Ta "Force enable ASLR"
-.It Dv "P2_ASLR_DISABLE" Ta No "0x00000080" Ta "Force disable ASLR"
-.It Dv "P2_ASLR_IGNSTART" Ta No "0x00000100" Ta "Enable ASLR to consume sbrk area"
-.It Dv "P2_PROTMAX_ENABLE" Ta No "0x00000200" Ta "Force enable implied PROT_MAX"
-.It Dv "P2_PROTMAX_DISABLE" Ta No "0x00000400" Ta "Force disable implied PROT_MAX"
-.It Dv "P2_STKGAP_DISABLE" Ta No "0x00000800" Ta "Disable stack gap for MAP_STACK"
-.It Dv "P2_STKGAP_DISABLE_EXEC" Ta No "0x00001000" Ta "Stack gap disabled after exec"
-.It Dv "P2_ITSTOPPED" Ta No "0x00002000" Ta "itimers stopped (as part of process stop)"
-.It Dv "P2_PTRACEREQ" Ta No "0x00004000" Ta "Active ptrace req"
-.It Dv "P2_NO_NEW_PRIVS" Ta No "0x00008000" Ta "Ignore setuid on exec"
-.It Dv "P2_WXORX_DISABLE" Ta No "0x00010000" Ta "WX mappings enabled"
-.It Dv "P2_WXORX_ENABLE_EXEC" Ta No "0x00020000" Ta "WxorX enabled after exec"
-.It Dv "P2_WEXIT" Ta No "0x00040000" Ta "Internal exit early state"
-.It Dv "P2_REAPKILLED" Ta No "0x00080000" Ta "REAP_KILL pass handled the process"
-.It Dv "P2_MEMBAR_PRIVE" Ta No "0x00100000" Ta "membarrier private expedited registered"
-.It Dv "P2_MEMBAR_PRIVE_SYNCORE" Ta No "0x00200000" Ta "membarrier private expedited sync core registered"
-.It Dv "P2_MEMBAR_GLOBE" Ta No "0x00400000" Ta "membar global expedited registered"
-.El
-.It Cm label
-The MAC label of the process.
-.It Cm lim
-The soft limit on memory used, specified via a call to
-.Xr setrlimit 2 .
-.It Cm lstart
-The exact time the command started, using the
-.Ql %c
-format described in
-.Xr strftime 3 .
-.It Cm lockname
-The name of the lock that the process is currently blocked on.
-If the name is invalid or unknown, then
-.Dq ???\&
-is displayed.
-.It Cm logname
-The login name associated with the session the process is in (see
-.Xr getlogin 2 ) .
-.It Cm mwchan
-The event name if the process is blocked normally, or the lock name if
-the process is blocked on a lock.
-See the wchan and lockname keywords
-for details.
-.It Cm nice
-The process scheduling increment (see
-.Xr setpriority 2 ) .
-.It Cm rss
-the real memory (resident set) size of the process in KiB.
-.It Cm start
-The time the command started.
-If the command started less than 24 hours ago, the start time is
-displayed using the
-.Dq Li %H:%M
-format described in
-.Xr strftime 3 .
-If the command started less than 7 days ago, the start time is
-displayed using the
-.Dq Li %a%H
-format.
-Otherwise, the start time is displayed using the
-.Dq Li %e%b%y
-format.
-.It Cm state
-The state is given by a sequence of characters, for example,
-.Dq Li RWNA .
-The first character indicates the run state of the process:
-.Pp
-.Bl -tag -width indent -compact
-.It Li D
-Marks a process in disk (or other short term, uninterruptible) wait.
-.It Li I
-Marks a process that is idle (sleeping for longer than about 20 seconds).
-.It Li L
-Marks a process that is waiting to acquire a lock.
-.It Li R
-Marks a runnable process.
-.It Li S
-Marks a process that is sleeping for less than about 20 seconds.
-.It Li T
-Marks a stopped process.
-.It Li W
-Marks an idle interrupt thread.
-.It Li Z
-Marks a dead process (a
-.Dq zombie ) .
-.El
-.Pp
-Additional characters after these, if any, indicate additional state
-information:
-.Pp
-.Bl -tag -width indent -compact
-.It Li +
-The process is in the foreground process group of its control terminal.
-.It Li <
-The process has raised CPU scheduling priority.
-.It Li C
-The process is in
-.Xr capsicum 4
-capability mode.
-.It Li E
-The process is trying to exit.
-.It Li J
-Marks a process which is in
-.Xr jail 2 .
-The hostname of the prison can be found in
-.Pa /proc/ Ns Ao Ar pid Ac Ns Pa /status .
-.It Li L
-The process has pages locked in core (for example, for raw I/O).
-.It Li N
-The process has reduced CPU scheduling priority (see
-.Xr setpriority 2 ) .
-.It Li s
-The process is a session leader.
-.It Li V
-The process' parent is suspended during a
-.Xr vfork 2 ,
-waiting for the process to exec or exit.
-.It Li X
-The process is being traced or debugged.
-.El
-.It Cm tt
-An abbreviation for the pathname of the controlling terminal, if any.
-The abbreviation consists of the three letters following
-.Pa /dev/tty ,
-or, for pseudo-terminals, the corresponding entry in
-.Pa /dev/pts .
-This is followed by a
-.Ql -
-if the process can no longer reach that
-controlling terminal (i.e., it has been revoked).
-A
-.Ql -
-without a preceding two letter abbreviation or pseudo-terminal device number
-indicates a process which never had a controlling terminal.
-The full pathname of the controlling terminal is available via the
-.Cm tty
-keyword.
-.It Cm wchan
-The event (an address in the system) on which a process waits.
-When printed numerically, the initial part of the address is
-trimmed off and the result is printed in hex, for example, 0x80324000 prints
-as 324000.
-.El
-.Pp
-When printing using the command keyword, a process that has exited and
-has a parent that has not yet waited for the process (in other words, a zombie)
-is listed as
-.Dq Li <defunct> ,
-and a process which is blocked while trying
-to exit is listed as
-.Dq Li <exiting> .
-If the arguments cannot be located (usually because it has not been set, as is
-the case of system processes and/or kernel threads) the command name is printed
-within square brackets.
-The
-.Nm
-utility first tries to obtain the arguments cached by the kernel (if they were
-shorter than the value of the
-.Va kern.ps_arg_cache_limit
-sysctl).
-The process can change the arguments shown with
-.Xr setproctitle 3 .
-Otherwise,
+.Fl x
+are specified,
.Nm
-makes an educated guess as to the file name and arguments given when the
-process was created by examining memory or the swap area.
-The method is inherently somewhat unreliable and in any event a process
-is entitled to destroy this information.
-The ucomm (accounting) keyword can, however, be depended on.
-If the arguments are unavailable or do not agree with the ucomm keyword,
-the value for the ucomm keyword is appended to the arguments in parentheses.
+will obey the last occurence.
+.It Fl Z
+Add
+.Xr mac 4
+label to the list of keywords for which
+.Nm
+will display information.
+.El
.Sh KEYWORDS
-The following is a complete list of the available keywords and their
-meanings.
+The following is a complete list of the available keywords and their meanings.
Several of them have aliases (keywords which are synonyms).
+Detailed descriptions for some of them can be found after this list.
.Pp
.Bl -tag -width ".Cm sigignore" -compact
.It Cm %cpu
@@ -729,7 +630,7 @@ control terminal name (two letter abbreviation)
.It Cm tty
full name of control terminal
.It Cm ucomm
-name to be used for accounting
+process name used for accounting
.It Cm uid
effective user ID (alias
.Cm euid )
@@ -753,21 +654,258 @@ wait channel (as a symbolic name)
exit or stop status (valid only for stopped or zombie process)
.El
.Pp
-Note that the
-.Cm pending
-column displays bitmask of signals pending in the process queue when
+Some of these keywords are further specified as follows:
+.Bl -tag -width lockname
+.It Cm %cpu
+The CPU utilization of the process; this is a decaying average over up to
+a minute of previous (real) time.
+Since the time base over which this is computed varies (since processes may
+be very young) it is possible for the sum of all
+.Cm %cpu
+fields to exceed 100%.
+.It Cm %mem
+The percentage of real memory used by this process.
+.It Cm class
+Login class associated with the process.
+.It Cm command
+The printed command and arguments are determined as follows.
+A process that has exited and has a parent that has not yet waited for the
+process (in other words, a zombie) is listed as
+.Dq Li <defunct>.
+If the arguments cannot be located
+.Po
+usually because they have not been set, as is the case for system processes
+and/or kernel threads
+.Pc ,
+the command name is printed within square brackets.
+The
+.Nm
+utility first tries to obtain the arguments cached by the kernel
+.Po
+if they were shorter than the value of the
+.Va kern.ps_arg_cache_limit
+sysctl
+.Pc .
+The process can change the arguments shown with
+.Xr setproctitle 3 .
+Otherwise,
+.Nm
+makes an educated guess as to the file name and arguments given when the
+process was created by examining memory or the swap area.
+The method is inherently somewhat unreliable and in any event a process
+is entitled to destroy this information.
+The
+.Cm ucomm
+keyword
+.Pq accounting
+can, however, be depended on.
+If the arguments are unavailable or do not agree with the
+.Cm ucomm
+keyword, the value for the
+.Cm ucomm
+keyword is appended to the arguments in parentheses.
+.It Cm flags
+The flags associated with the process as in
+the include file
+.In sys/proc.h :
+.Bl -column P_SINGLE_BOUNDARY 0x40000000
+.It Dv "P_ADVLOCK" Ta No "0x00000001" Ta "Process may hold a POSIX advisory lock"
+.It Dv "P_CONTROLT" Ta No "0x00000002" Ta "Has a controlling terminal"
+.It Dv "P_KPROC" Ta No "0x00000004" Ta "Kernel process"
+.It Dv "P_PPWAIT" Ta No "0x00000010" Ta "Parent is waiting for child to exec/exit"
+.It Dv "P_PROFIL" Ta No "0x00000020" Ta "Has started profiling"
+.It Dv "P_STOPPROF" Ta No "0x00000040" Ta "Has thread in requesting to stop prof"
+.It Dv "P_HADTHREADS" Ta No "0x00000080" Ta "Has had threads (no cleanup shortcuts)"
+.It Dv "P_SUGID" Ta No "0x00000100" Ta "Had set id privileges since last exec"
+.It Dv "P_SYSTEM" Ta No "0x00000200" Ta "System proc: no sigs, stats or swapping"
+.It Dv "P_SINGLE_EXIT" Ta No "0x00000400" Ta "Threads suspending should exit, not wait"
+.It Dv "P_TRACED" Ta No "0x00000800" Ta "Debugged process being traced"
+.It Dv "P_WAITED" Ta No "0x00001000" Ta "Someone is waiting for us"
+.It Dv "P_WEXIT" Ta No "0x00002000" Ta "Working on exiting"
+.It Dv "P_EXEC" Ta No "0x00004000" Ta "Process called exec"
+.It Dv "P_WKILLED" Ta No "0x00008000" Ta "Killed, shall go to kernel/user boundary ASAP"
+.It Dv "P_CONTINUED" Ta No "0x00010000" Ta "Proc has continued from a stopped state"
+.It Dv "P_STOPPED_SIG" Ta No "0x00020000" Ta "Stopped due to SIGSTOP/SIGTSTP"
+.It Dv "P_STOPPED_TRACE" Ta No "0x00040000" Ta "Stopped because of tracing"
+.It Dv "P_STOPPED_SINGLE" Ta No "0x00080000" Ta "Only one thread can continue"
+.It Dv "P_PROTECTED" Ta No "0x00100000" Ta "Do not kill on memory overcommit"
+.It Dv "P_SIGEVENT" Ta No "0x00200000" Ta "Process pending signals changed"
+.It Dv "P_SINGLE_BOUNDARY" Ta No "0x00400000" Ta "Threads should suspend at user boundary"
+.It Dv "P_HWPMC" Ta No "0x00800000" Ta "Process is using HWPMCs"
+.It Dv "P_JAILED" Ta No "0x01000000" Ta "Process is in jail"
+.It Dv "P_TOTAL_STOP" Ta No "0x02000000" Ta "Stopped for system suspend"
+.It Dv "P_INEXEC" Ta No "0x04000000" Ta Process is in Xr execve 2
+.It Dv "P_STATCHILD" Ta No "0x08000000" Ta "Child process stopped or exited"
+.It Dv "P_INMEM" Ta No "0x10000000" Ta "Always set, unused"
+.It Dv "P_PPTRACE" Ta No "0x80000000" Ta "Vforked child issued ptrace(PT_TRACEME)"
+.El
+.It Cm flags2
+The flags kept in
+.Va p_flag2
+associated with the process as in
+the include file
+.In sys/proc.h :
+.Bl -column P2_INHERIT_PROTECTED 0x00000001
+.It Dv "P2_INHERIT_PROTECTED" Ta No "0x00000001" Ta "New children get P_PROTECTED"
+.It Dv "P2_NOTRACE" Ta No "0x00000002" Ta "No" Xr ptrace 2 attach or coredumps
+.It Dv "P2_NOTRACE_EXEC" Ta No "0x00000004" Ta Keep P2_NOPTRACE on Xr execve 2
+.It Dv "P2_AST_SU" Ta No "0x00000008" Ta "Handles SU ast for kthreads"
+.It Dv "P2_PTRACE_FSTP" Ta No "0x00000010" Ta "SIGSTOP from PT_ATTACH not yet handled"
+.It Dv "P2_TRAPCAP" Ta No "0x00000020" Ta "SIGTRAP on ENOTCAPABLE"
+.It Dv "P2_ASLR_ENABLE" Ta No "0x00000040" Ta "Force enable ASLR"
+.It Dv "P2_ASLR_DISABLE" Ta No "0x00000080" Ta "Force disable ASLR"
+.It Dv "P2_ASLR_IGNSTART" Ta No "0x00000100" Ta "Enable ASLR to consume sbrk area"
+.It Dv "P2_PROTMAX_ENABLE" Ta No "0x00000200" Ta "Force enable implied PROT_MAX"
+.It Dv "P2_PROTMAX_DISABLE" Ta No "0x00000400" Ta "Force disable implied PROT_MAX"
+.It Dv "P2_STKGAP_DISABLE" Ta No "0x00000800" Ta "Disable stack gap for MAP_STACK"
+.It Dv "P2_STKGAP_DISABLE_EXEC" Ta No "0x00001000" Ta "Stack gap disabled after exec"
+.It Dv "P2_ITSTOPPED" Ta No "0x00002000" Ta "itimers stopped (as part of process stop)"
+.It Dv "P2_PTRACEREQ" Ta No "0x00004000" Ta "Active ptrace req"
+.It Dv "P2_NO_NEW_PRIVS" Ta No "0x00008000" Ta "Ignore setuid on exec"
+.It Dv "P2_WXORX_DISABLE" Ta No "0x00010000" Ta "WX mappings enabled"
+.It Dv "P2_WXORX_ENABLE_EXEC" Ta No "0x00020000" Ta "WxorX enabled after exec"
+.It Dv "P2_WEXIT" Ta No "0x00040000" Ta "Internal exit early state"
+.It Dv "P2_REAPKILLED" Ta No "0x00080000" Ta "REAP_KILL pass handled the process"
+.It Dv "P2_MEMBAR_PRIVE" Ta No "0x00100000" Ta "membarrier private expedited registered"
+.It Dv "P2_MEMBAR_PRIVE_SYNCORE" Ta No "0x00200000" Ta "membarrier private expedited sync core registered"
+.It Dv "P2_MEMBAR_GLOBE" Ta No "0x00400000" Ta "membar global expedited registered"
+.El
+.It Cm label
+The MAC label of the process.
+.It Cm lim
+The soft limit on memory used, specified via a call to
+.Xr setrlimit 2 .
+.It Cm lstart
+The exact time the command started, using the
+.Ql %c
+format described in
+.Xr strftime 3 .
+.It Cm lockname
+The name of the lock that the process is currently blocked on.
+If the name is invalid or unknown, then
+.Dq ???\&
+is displayed.
+.It Cm logname
+The login name associated with the session the process is in (see
+.Xr getlogin 2 ) .
+.It Cm mwchan
+The event name if the process is blocked normally, or the lock name if
+the process is blocked on a lock.
+See the wchan and lockname keywords
+for details.
+.It Cm nice
+The process scheduling increment (see
+.Xr setpriority 2 ) .
+.It Cm rss
+the real memory (resident set) size of the process in KiB.
+.It Cm start
+The time the command started.
+If the command started less than 24 hours ago, the start time is
+displayed using the
+.Dq Li %H:%M
+format described in
+.Xr strftime 3 .
+If the command started less than 7 days ago, the start time is
+displayed using the
+.Dq Li %a%H
+format.
+Otherwise, the start time is displayed using the
+.Dq Li %e%b%y
+format.
+.It Cm sig
+The bitmask of signals pending in the process queue if the
.Fl H
-option is not specified, otherwise the per-thread queue of pending signals
-is shown.
+option has not been specified, else the per-thread queue of pending signals.
+.It Cm state
+The state is given by a sequence of characters, for example,
+.Dq Li RWNA .
+The first character indicates the run state of the process:
+.Pp
+.Bl -tag -width indent -compact
+.It Li D
+Marks a process in disk (or other short term, uninterruptible) wait.
+.It Li I
+Marks a process that is idle (sleeping for longer than about 20 seconds).
+.It Li L
+Marks a process that is waiting to acquire a lock.
+.It Li R
+Marks a runnable process.
+.It Li S
+Marks a process that is sleeping for less than about 20 seconds.
+.It Li T
+Marks a stopped process.
+.It Li W
+Marks an idle interrupt thread.
+.It Li Z
+Marks a dead process (a
+.Dq zombie ) .
+.El
+.Pp
+Additional characters after these, if any, indicate additional state
+information:
+.Pp
+.Bl -tag -width indent -compact
+.It Li +
+The process is in the foreground process group of its control terminal.
+.It Li <
+The process has raised CPU scheduling priority.
+.It Li C
+The process is in
+.Xr capsicum 4
+capability mode.
*** 197 LINES SKIPPED ***