use .opt macro all over

This commit is contained in:
albert 2004-12-02 17:53:33 +00:00
parent f2dab95a92
commit dfd72b363c

259
ps/ps.1
View File

@ -7,8 +7,8 @@
.TH PS 1 "July 28, 2004" "Linux" "Linux User's Manual"
.\"
.\" To render this page:
.\" groff -t -b -man -X -P-resolution -P100 -Tps nicolas-ps.1 &
.\" groff -t -b -man -X -TX100 nicolas-ps.1 &
.\" groff -t -b -man -X -P-resolution -P100 -Tps ps.1 &
.\" groff -t -b -man -X -TX100 ps.1 &
.\" tbl ps.1 | troff -Ww -man -z
.\" groff -t -man -Tps ps.1 | ps2pdf - - > ps.pdf
.\"
@ -160,12 +160,10 @@ Print only the name of PID 42:
.PP
.\" """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH "SIMPLE PROCESS SELECTION"
.TP \n[OptSize]
.B \-A
.opt \-A
Select all processes. Identical to \fB\-e\fR.
.TP
.B \-N
.opt \-N
Select all processes except those that fulfill the specified conditions.
(negates the selection) Identical to \fB\-\-deselect\fR.
@ -173,13 +171,11 @@ Select all processes except those that fulfill the specified conditions.
Select all processes associated with this terminal. Identical to the
\fBt\fR option without any argument.
.TP
.B \-a
.opt \-a
Select all processes except session leaders (see \fIgetsid\fR(2)) and
processes not associated with a terminal.
.TP
.B a
.opt a
Lift the BSD\-style "only yourself" restriction, which is imposed upon
the set of all processes when some BSD\-style (without\ "\-") options
are used or when the \fBps\fR personality setting is BSD\-like.
@ -189,12 +185,10 @@ An alternate description is that this option causes \fBps\fR to
list all processes with a terminal (tty),
or to list all processes when used together with the \fBx\fR option.
.TP
.B \-d
.opt \-d
Select all processes except session leaders.
.TP
.B \-e
.opt \-e
Select all processes. Identical to \fB\-A\fR.
.\" Current "g" behavior: add in the session leaders, which would
@ -202,18 +196,15 @@ Select all processes. Identical to \fB\-A\fR.
.\" add in the group leaders -- at least according to the SunOS 4
.\" man page on the FreeBSD site. Uh oh. I think I had tested SunOS
.\" though, so maybe the code is correct.
.TP
.B g
.opt g
Really all, even session leaders. This flag is obsolete and may be
discontinued in a future release. It is normally implied by the \fBa\fR flag,
and is only useful when operating in the sunos4 personality.
.TP
.B r
.opt r
Restrict the selection to only running processes.
.TP
.B x
.opt x
Lift the BSD\-style "must have a tty" restriction, which is imposed upon
the set of all processes when some BSD\-style (without\ "\-") options
are used or when the \fBps\fR personality setting is BSD\-like.
@ -223,8 +214,7 @@ An alternate description is that this option causes \fBps\fR to
list all processes owned by you (same EUID as \fBps\fR),
or to list all processes when used together with the \fBa\fR option.
.TP
.B \-\-deselect
.opt \-\-deselect
Select all processes except those that fulfill the specified conditions.
(negates the selection) Identical to \fB\-N\fR.
@ -236,23 +226,20 @@ These options accept a single argument in the form of a blank\-separated
or comma\-separated list. They can be used multiple times.
For\ example:\ \fBps\ \-p\ "1\ 2"\ \-p\ 3,4\fR
.P
.TP \n[OptSize]
.BI \-C \ cmdlist
.opt \-C \ cmdlist
Select by command name.
.br
This selects the processes whose executable name is given in
\fIcmdlist\fR.
.TP
.BI \-G \ grplist
.opt \-G \ grplist
Select by real group ID (RGID) or name.
.br
This selects the processes whose real group name or ID is in the
\fIgrplist\fR list. The real group ID identifies the group of the user
who created the process, see \fIgetgid\fR(2).
.TP
.BI U \ userlist
.opt U \ userlist
Select by effective user ID (EUID) or name.
.br
This selects the processes whose effective user name
@ -262,8 +249,7 @@ access permissions are used by the process
(see\ \fIgeteuid\fR(2)).
Identical to \fB\-u\fR and\ \fB\-\-user\fR.
.TP
.BI \-U \ userlist
.opt \-U \ userlist
select by real user ID (RUID) or name.
.br
It selects the processes whose real user name or ID is in the
@ -271,8 +257,7 @@ It selects the processes whose real user name or ID is in the
The real user ID identifies the user who created the process,
see\ \fIgetuid\fR(2).
.TP
.BI \-g \ grplist
.opt \-g \ grplist
Select by session OR by effective group name.
.br
Selection by session is specified by many standards,
@ -283,34 +268,29 @@ is completely numeric (as\ sessions\ are).
Group ID numbers will work only when some group names are also specified.
See the \fB\-s\fR and \fB\-\-group\fR options.
.TP
.BI p \ pidlist
.opt p \ pidlist
Select by process ID. Identical to \fB\-p\fR and\ \fB\-\-pid\fR.
.TP
.BI \-p \ pidlist
.opt \-p \ pidlist
Select by PID.
.br
This selects the processes whose process ID numbers appear in
\fIpidlist\fR. Identical to \fBp\fR and\ \fB\-\-pid\fR.
.TP
.BI \-s \ sesslist
.opt \-s \ sesslist
Select by session ID.
.br
This selects the processes
with a session ID specified in\ \fIsesslist\fR.
.TP
.BI t \ ttylist
.opt t \ ttylist
Select by tty. Nearly identical to \fB\-t\fR and \fB\-\-tty\fR,
but can also be used with an empty \fIttylist\fR to indicate
the terminal associated with \fBps\fR.
Using the \fBT\fR option is considered cleaner than using \fBT\fR with
an\ empty\ \fIttylist\fR.
.TP
.BI \-t \ ttylist
.opt \-t \ ttylist
Select by tty.
.br
This selects the processes associated with the terminals
@ -319,8 +299,7 @@ Terminals (ttys, or screens for text output) can be specified in several
forms: /dev/ttyS1, ttyS1, S1.
A\ plain "\-" may be used to select processes not attached to any terminal.
.TP
.BI \-u \ userlist
.opt \-u \ userlist
Select by effective user ID (EUID) or name.
.br
This selects the processes whose effective user name or ID is in
@ -328,16 +307,13 @@ This selects the processes whose effective user name or ID is in
access permissions are used by the process (see\ \fIgeteuid\fR(2)).
Identical to \fBU\fR and \fB\-\-user\fR.
.TP
.BI \-\-Group \ grplist
.opt \-\-Group \ grplist
Select by real group ID (RGID) or name. Identical to \fB\-G\fR.
.TP
.BI \-\-User \ userlist
.opt \-\-User \ userlist
Select by real user ID (RUID) or name. Identical to \fB\-U\fR.
.TP
.BI \-\-group \ grplist
.opt \-\-group \ grplist
Select by effective group ID (EGID) or name.
.br
This selects the processes whose effective group name or ID is in
@ -345,37 +321,30 @@ This selects the processes whose effective group name or ID is in
access permissions are used by the process (see\ \fIgeteuid\fR(2)).
The \fB\-g\fR option is often an alternative to\ \fB\-\-group\fR.
.TP
.BI \-\-pid \ pidlist
.opt \-\-pid \ pidlist
Select by process\ ID. Identical to \fB\-p\fR\ and\ \fBp\fR.
.TP
.BI \-\-ppid \ pidlist
.opt \-\-ppid \ pidlist
Select by parent process\ ID.
This selects the processes
with a parent\ process\ ID in \fRpidlist\fR.
That\ is, it selects processes that are children
of those listed in \fRpidlist\fR.
.TP
.BI \-\-sid \ sesslist
.opt \-\-sid \ sesslist
Select by session\ ID. Identical to\ \fB\-s\fR.
.TP
.BI \-\-tty \ ttylist
.opt \-\-tty \ ttylist
Select by terminal. Identical to \fB\-t\fR and\ \fBt\fR.
.TP
.BI \-\-user \ userlist
.opt \-\-user \ userlist
Select by effective user ID (EUID) or name.
Identical to \fB\-u\fR and\ \fBU\fR.
.TP
\fB\-\fI123\fR
.opt \-\fI123\fR
Identical to \fB\-\-sid\ \fI123\fR.
.TP
.B \fI123\fR
.opt \fI123\fR
Identical to \fB\-\-pid\ \fI123\fR.
.\" """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
@ -386,18 +355,15 @@ These options are used to choose the information displayed by \fBps\fR.
The output may differ by personality.
.PP
.TP \n[OptSize]
.B \-F
.opt \-F
extra full format. See the \fB\-f\fR option, which \fB\-F\fR implies.
.TP
.BI \-O \ format
.opt \-O \ format
is like \fB\-o\fR, but preloaded with some default columns.
Identical to \fB\-o\ pid,\fIformat\fB,state,tname,time,command\fR
or \fB\-o\ pid,\fIformat\fB,tname,time,cmd\fR, see\ \fB\-o\fR\ below.
.TP
.BI O \ format
.opt O \ format
is preloaded \fBo\fR (overloaded).
.br
The BSD \fBO\fR option can act like \fB\-O\fR (user\-defined output
@ -409,24 +375,19 @@ formatting), specify the option in some other way
When used as a formatting option, it is identical to \fB\-O\fR, with the
BSD\ personality.
.TP
.B \-M
.opt \-M
Add a column of security data. Identical to \fBZ\fR. (for\ SE\ Linux)
.TP
.B X
.opt X
Register format.
.TP
.B Z
.opt Z
Add a column of security data. Identical to \fB\-M\fR. (for\ SE\ Linux)
.TP
.B \-c
.opt \-c
Show different scheduler information for the \fB\-l\fR option.
.TP
.B \-f
.opt \-f
does full\-format listing. This option can be combined with many
other UNIX\-style options to add additional columns. It also causes
the command arguments to be printed. When used with \fB\-L\fR, the
@ -434,29 +395,23 @@ NLWP (number of threads) and LWP (thread ID) columns will be added.
See the \fBc\fR option, the format keyword \fBargs\fR, and the
format keyword \fBcomm\fR.
.TP
.B j
.opt j
BSD job control format.
.TP
.B \-j
.opt \-j
jobs format
.TP
.B l
.opt l
display BSD long format.
.TP
.B \-l
.opt \-l
long format. The \fB\-y\fR option is often useful with this.
.TP
.BI o \ format
.opt o \ format
specify user\-defined format. Identical to \fB\-o\fR and
\fB\-\-format\fR.
.TP
.BI \-o \ format
.opt \-o \ format
user\-defined format.
.br
\fIformat\fR is a single argument in the form of a
@ -478,29 +433,23 @@ Use the \fBPS_FORMAT\fR environment variable to specify a default
as desired; DefSysV and DefBSD are macros that may be used to
choose the default UNIX or BSD columns.
.TP
.B s
.opt s
display signal format
.TP
.B u
.opt u
display user\-oriented format
.TP
.B v
.opt v
display virtual memory format
.TP
.B \-y
.opt \-y
Do not show flags; show rss in place of addr.
This option can only be used with \fB\-l\fR.
.TP
.BI \-\-format \ format
.opt \-\-format \ format
user\-defined format. Identical to \fB\-o\fR and \fBo\fR.
.TP
.B \-\-context
.opt \-\-context
Display security context format. (for\ SE\ Linux)
.\" """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
@ -512,16 +461,13 @@ Display security context format. (for\ SE\ Linux)
.\" .B C
.\" use raw CPU time for %CPU instead of decaying average
.TP \n[OptSize]
.B \-H
.opt \-H
show process hierarchy (forest)
.TP
.BI N \ namelist
.opt N \ namelist
Specify namelist file. Identical to \fB\-n\fR, see \fB\-n\fR above.
.TP
.BI O \ order
.opt O \ order
Sorting order. (overloaded)
.br
The BSD \fBO\fR option can act like \fB\-O\fR (user\-defined output
@ -541,14 +487,12 @@ merely re\-iterating the default direction on a key,
but may help to distinguish an \fBO\fR sort from an \fBO\fR format.
The\ "\-" reverses direction only on the key it precedes.
.TP
.B S
.opt S
Sum up some information, such as CPU usage, from dead child processes
into their parent. This is useful for examining a system where a
parent process repeatedly forks off short\-lived children to do work.
.TP
.B c
.opt c
Show the true command name. This is derived from the name of the
executable file, rather than from the argv value. Command arguments
and any modifications to them (see\ \fIsetproctitle\fR(3)) are
@ -560,16 +504,13 @@ display the command arguments.
See the \fB\-f\fR option, the format keyword \fBargs\fR, and the
format keyword \fBcomm\fR.
.TP
.B e
.opt e
Show the environment after the command.
.TP
.B f
.opt f
ASCII\-art process hierarchy (forest)
.TP
.B h
.opt h
No header. (or, one header per screen in the BSD personality)
.br
The \fBh\fR option is problematic. Standard BSD \fBps\fR uses
@ -582,8 +523,7 @@ current personality, you can use the long options \fB\-\-headers\fR
and \fB\-\-no\-headers\fR to enable printing headers each page or
disable headers entirely, respectively.
.TP
.BI k \ spec
.opt k \ spec
specify sorting order. Sorting syntax is
[\fB+\fR|\fB\-\fR]\fIkey\fR[,[\fB+\fR|\fB\-\fR]\fIkey\fR[,...]]
Choose a multi\-letter key from the \fBSTANDARD FORMAT SPECIFIERS\fR section.
@ -596,8 +536,7 @@ lexicographic order. Identical to \fB\-\-sort\fR. Examples:
.br
\fBps\ kstart_time\ \-ef\fR
.TP
.BI \-n \ namelist
.opt \-n \ namelist
set namelist file. Identical to \fBN\fR.
.br
The namelist file is needed for a proper WCHAN display, and must match
@ -620,52 +559,40 @@ Without this option, the default search path for the namelist is:
.br
/System.map
.TP
.B n
.opt n
Numeric output for WCHAN and USER. (including all types of UID and GID)
.TP
.B \-w
.opt \-w
Wide output. Use this option twice for unlimited width.
.TP
.B w
.opt w
Wide output. Use this option twice for unlimited width.
.TP
.BI \-\-cols \ n
.opt \-\-cols \ n
set screen width
.TP
.BI \-\-columns \ n
.opt \-\-columns \ n
set screen width
.TP
.B \-\-cumulative
.opt \-\-cumulative
include some dead child process data (as a sum with the parent)
.TP
.B \-\-forest
.opt \-\-forest
ASCII art process tree
.TP
.B \-\-headers
.opt \-\-headers
repeat header lines, one per page of output
.TP
.B \-\-no\-headers
.opt \-\-no\-headers
print no header line at all
.TP
.BI \-\-lines \ n
.opt \-\-lines \ n
set screen height
.TP
.BI \-\-rows \ n
.opt \-\-rows \ n
set screen height
.TP
.BI \-\-sort \ spec
.opt \-\-sort \ spec
specify sorting order. Sorting syntax is
[\fB+\fR|\fB\-\fR]\fIkey\fR[,[\fB+\fR|\fB\-\fR]\fIkey\fR[,...]]
Choose a multi\-letter key from the \fBSTANDARD FORMAT SPECIFIERS\fR section.
@ -673,8 +600,7 @@ The\ "+" is optional since default direction is increasing numerical or
lexicographic order. Identical to\ \fBk\fR.
For example: \fBps\ jax\ \-\-sort=uid,\-ppid,+pid\fR
.TP
.BI \-\-width \ n
.opt \-\-width \ n
set screen width
.\" """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
@ -683,24 +609,19 @@ set screen width
.SH "THREAD DISPLAY"
.PD 0
.TP \n[OptSize]
.B H
.opt H
Show threads as if they were processes
.TP
.B \-L
.opt \-L
Show threads, possibly with LWP and NLWP columns
.TP
.B \-T
.opt \-T
Show threads, possibly with SPID column
.TP
.B m
.opt m
Show threads after processes
.TP
.B \-m
.opt \-m
Show threads after processes
.\" """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
@ -709,28 +630,22 @@ Show threads after processes
.SH "OTHER INFORMATION"
.PD 0
.TP \n[OptSize]
.B L
.opt L
List all format specifiers.
.TP
.B \-V
.opt \-V
Print the procps version.
.TP
.B V
.opt V
Print the procps version.
.TP
.B \-\-help
.opt \-\-help
Print a help message.
.TP
.B \-\-info
.opt \-\-info
Print debugging info.
.TP
.B \-\-version
.opt \-\-version
Print the procps version.
.\" """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""