emo/procps
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity

docs: some manpage fixes

Browse Source 
Some editorial changes so the man pages follow the standards.

References:
 procps#173
This commit is contained in:
Craig Small 2020-06-04 22:25:26 +10:00
parent f0fb35b645
commit cc032cbd99
12 changed files with 88 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
pgrep.1
View File

@ -1,13 +1,13 @@
.\"
.\" Copyright 2000 Kjetil Torgrim Homme
.\" 2017 Craig Small
.\" 2017-2020 Craig Small
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.TH PGREP "1" "2020-04-24" "procps-ng" "User Commands"
.TH PGREP "1" "2020-06-04" "procps-ng" "User Commands"
.SH NAME
pgrep, pkill \- look up or signal processes based on name and other attributes
.SH SYNOPSIS
@ -141,29 +141,27 @@ context. In
context this option is disabled.
.TP
\fB\-x\fR, \fB\-\-exact\fR\fR
Only match processes whose names (or command line if \-f is specified)
Only match processes whose names (or command lines if \fB\-f\fR is specified)
.B exactly
match the
.IR pattern .
.TP
\fB\-F\fR, \fB\-\-pidfile\fR \fIfile\fR
Read
.IR PID 's
from file. This option is perhaps more useful for
Read \fIPID\fRs from \fIfile\fR. This option is perhaps more useful for
.B pkill
than
.BR pgrep .
.TP
\fB\-L\fR, \fB\-\-logpidfile\fR
Fail if pidfile (see -F) not locked.
Fail if pidfile (see \fB\-F\fR) not locked.
.TP
\fB\-r\fR, \fB\-\-runstates\fR \fID,R,S,Z,\fP...
Match only processes which match the process state.
.TP
\fB\-\-ns \fIpid\fP
Match processes that belong to the same namespaces. Required to run as
root to match processes from other users. See \-\-nslist for how to limit
which namespaces to match.
root to match processes from other users. See \fB\-\-nslist\fR for how to
limit which namespaces to match.
.TP
\fB\-\-nslist \fIname\fP,...
Match only the provided namespaces. Available namespaces:
@ -234,7 +232,7 @@ Fatal error: out of memory etc.
.PD
.SH NOTES
The process name used for matching is limited to the 15 characters present in
the output of /proc/\fIpid\fP/stat. Use the \-f option to match against the
the output of /proc/\fIpid\fP/stat. Use the \fB\-f\fR option to match against the
complete command line, /proc/\fIpid\fP/cmdline.
.PP
The running

13
pidof.1
View File

@ -15,22 +15,22 @@
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
.\"
.TH PIDOF 1 "2019-09-21" "" "User Commands"
.TH PIDOF 1 "2020-06-04" "" "User Commands"
.SH NAME
pidof -- find the process ID of a running program.
pidof -- find the process ID of a running program
.SH SYNOPSIS
.B pidof
.RB [ \-s ]
.RB [ \-c ]
.RB [ \-x ]
.RB [ \-o
.IR omitpid[,omitpid..] ]
.IR omitpid[,omitpid...] ]
.RB [ \-o
.IR omitpid[,omitpid..].. ]
.IR omitpid[,omitpid...]... ]
.RB [ \-S
.IR separator ]
.B program
.RB [ program.. ]
.RB [ program... ]
.SH DESCRIPTION
.B Pidof
finds the process id's (pids) of the named programs. It prints those
@ -52,7 +52,8 @@ program, in other words the calling shell or shell script.
.IP "-S \fIseparator\fP"
Use \fIseparator\fP as a separator put between pids. Used only when
more than one pids are printed for the program.
The \fI\-d\fR option is an alias for this option for sysvinit pidof
The \fB\-d\fR option is an alias for this option for sysvinit
.B pidof
compatibility.
.SH "EXIT STATUS"
.TP

10
pmap.1
View File

@ -5,14 +5,16 @@
.\" Licensed under version 2 of the GNU General Public License.
.\" Written by Albert Cahalan.
.\"
.TH PMAP "1" "September 2012" "procps-ng" "User Commands"
.TH PMAP "1" "2020-06-04" "procps-ng" "User Commands"
.SH NAME
pmap \- report memory map of a process
.SH SYNOPSIS
.B pmap
[\fIoptions\fR] \fIpid\fR [...]
.SH DESCRIPTION
The pmap command reports the memory map of a process or processes.
The
.B pmap
command reports the memory map of a process or processes.
.SH OPTIONS
.TP
\fB\-x\fR, \fB\-\-extended\fR
@ -78,7 +80,9 @@ Did not find all processes asked for.
.BR ps (1),
.BR pgrep (1)
.SH STANDARDS
No standards apply, but pmap looks an awful lot like a SunOS command.
No standards apply, but
.B pmap
looks an awful lot like a SunOS command.
.SH "REPORTING BUGS"
Please send bug reports to
.UR procps@freelists.org

50
ps/ps.1
View File

@ -4,7 +4,7 @@
.\" Quick hack conversion by Albert Cahalan, 1998.
.\" Licensed under version 2 of the Gnu General Public License.
.\"
.TH PS 1 2018-08-08 "procps-ng" "User Commands"
.TH PS "1" "2020-06-04" "procps-ng" "User Commands"
.\"
.\" To render this page:
.\" groff -t -b -man -X -P-resolution -P100 -Tps ps.1 &
@ -32,7 +32,7 @@ ps \- report a snapshot of the current processes.
.B ps
displays information about a selection of the active processes. If you want
a repetitive update of the selection and the displayed information, use
.IR top (1)
.B top
instead.
.P
This version of
@ -56,14 +56,14 @@ implementations that this
.B ps
is compatible with.
.P
Note that "\fBps \-aux\fR" is distinct from "\fBps\ aux\fR". The POSIX and
UNIX standards require that "\fBps\ \-aux\fR" print all processes owned by a
user named "x", as well as printing all processes that would be selected by
Note that \fBps \-aux\fR is distinct from \fBps\ aux\fR. The POSIX and
UNIX standards require that \fBps\ \-aux\fR print all processes owned by a
user named \fIx\fR, as well as printing all processes that would be selected by
the
.B \-a
option. If the user named "x" does not exist, this
option. If the user named \fIx\fR does not exist, this
.B ps
may interpret the command as "\fBps\ aux\fR" instead and print a warning.
may interpret the command as \fBps\ aux\fR instead and print a warning.
This behavior is intended to aid in transitioning old scripts and habits. It
is fragile, subject to change, and thus should not be relied upon.
.P
@ -743,7 +743,7 @@ Show threads, possibly with SPID column.
.SH "OTHER INFORMATION"
.TP
.BI \-\-help \ section
Print a help message. The section argument can be one of
Print a help message. The \fIsection\fR argument can be one of
.IR s imple,
.IR l ist,
.IR o utput,
@ -796,20 +796,18 @@ will be destroyed by
if the parent process exits.
.PP
If the length of the username is greater than the length of the display
column, the username will be truncated. See the \-o and \-O formatting
options to customize length.
column, the username will be truncated. See the \fB\-o\fR and \fB\-O\fR
formatting options to customize length.
.PP
Commands options such as
.B ps \-aux
are not recommended as it is a confusion of two different standards.
According to the POSIX and UNIX standards, the above command asks to
display all processes with a TTY (generally the commands users are
running) plus all processes owned by a user named "x". If that user
running) plus all processes owned by a user named \fIx\fR. If that user
doesn't exist, then
.B ps
will assume you really meant
.RB """" ps
.IR aux """."
will assume you really meant \fBps aux\fR.
.SH "PROCESS FLAGS"
The sum of these values is displayed in the "F" column,
which is provided by the
@ -1163,8 +1161,8 @@ fully destroyed by its parent. The output in this column may contain spaces.
(alias
.BR ucmd ", " ucomm ).
See also the
.B args format keyword,
the
.B args
format keyword, the
.B \-f
option, and the
.B c
@ -1325,7 +1323,8 @@ T}
ipcns IPCNS T{
Unique inode number describing the namespace the process belongs to.
See namespaces(7).
See
.IR namespaces (7).
T}
label LABEL T{
@ -1377,12 +1376,14 @@ T}
mntns MNTNS T{
Unique inode number describing the namespace the process belongs to.
See namespaces(7).
See
.IR namespaces (7).
T}
netns NETNS T{
Unique inode number describing the namespace the process belongs to.
See namespaces(7).
See
.IR namespaces (7).
T}
ni NI T{
@ -1407,7 +1408,7 @@ T}
numa NUMA T{
The node assocated with the most recently used processor.
A -1 means that NUMA information is unavailable.
A \fI\-1\fR means that NUMA information is unavailable.
T}
nwchan WCHAN T{
@ -1463,7 +1464,8 @@ T}
pidns PIDNS T{
Unique inode number describing the namespace the process belongs to.
See namespaces(7).
See
.IR namespaces (7).
T}
pmem %MEM T{
@ -1826,12 +1828,14 @@ T}
userns USERNS T{
Unique inode number describing the namespace the process belongs to.
See namespaces(7).
See
.IR namespaces (7).
T}
utsns UTSNS T{
Unique inode number describing the namespace the process belongs to.
See namespaces(7).
See
.IR namespaces (7).
T}
uunit UUNIT T{

6
pwdx.1
View File

@ -3,7 +3,7 @@
.\" Copyright 2004 Nicholas Miell.
.\" Based on the pmap(1) man page by Albert Cahalan.
.\"
.TH PWDX "1" "June 2011" "procps-ng" "User Commands"
.TH PWDX "1" "2020-06-04" "procps-ng" "User Commands"
.SH NAME
pwdx \- report current working directory of a process
.SH SYNOPSIS
@ -20,7 +20,9 @@ Output help screen and exit.
.BR ps (1),
.BR pgrep (1)
.SH STANDARDS
No standards apply, but pwdx looks an awful lot like a SunOS command.
No standards apply, but
.B pwdx
looks an awful lot like a SunOS command.
.SH AUTHOR
.UR nmiell@gmail.com
Nicholas Miell

9
slabtop.1
View File

@ -43,8 +43,9 @@ The following are valid sort criteria used to sort the individual slab caches
and thereby determine what are the "top" slab caches to display. The default
sort criteria is to sort by the number of objects ("o").
.PP
The sort criteria can also be changed while slabtop is running by pressing
the associated character.
The sort criteria can also be changed while
.B slabtop
is running by pressing the associated character.
.TS
l l l.
\fBcharacter description header\fR
@ -89,7 +90,9 @@ requires a 2.4 or later kernel (specifically, a version 1.1 or later
.IR /proc/slabinfo ).
Kernel 2.2 should be supported in the future.
.PP
The slabtop statistic header is tracking how many bytes of slabs are being
The
.B slabtop
statistic header is tracking how many bytes of slabs are being
used and is not a measure of physical memory. The 'Slab' field in the
/proc/meminfo file is tracking information about used slab physical memory.
.SH AUTHORS

4
sysctl.8
View File

@ -144,7 +144,9 @@ The
.B base_reachable_time
and
.B retrans_time
are deprecated. The sysctl command does not allow changing values of these
are deprecated. The
.B sysctl
command does not allow changing values of these
parameters. Users who insist to use deprecated kernel interfaces should push values
to /proc file system by other means. For example:
.PP

4
sysctl.conf.5
View File

@ -6,7 +6,7 @@
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details."
.TH SYSCTL.CONF "5" "2020-02-27" "procps-ng" "File Formats"
.TH SYSCTL.CONF "5" "2020-06-04" "procps-ng" "File Formats"
.SH NAME
sysctl.conf \- sysctl preload/configuration file
.SH DESCRIPTION
@ -27,7 +27,7 @@ token = value
.PP
Note that blank lines are ignored, and whitespace before and after a token or
value is ignored, although a value can contain whitespace within. Lines which
begin with a # or ; are considered comments and ignored.
begin with a \fI#\fR or \fI;\fR are considered comments and ignored.
If a line begins with a single \-, any attempts to set the value that fail will be
ignored.

6
tload.1
View File

@ -1,7 +1,7 @@
.\" -*-Nroff-*-
.\" This page Copyright (C) 1993 Matt Welsh, mdw@tc.cornell.edu.
.\" Freely distributable under the terms of the GPL
.TH TLOAD "1" "June 2011" "procps-ng" "User Commands"
.TH TLOAD "1" "2020-06-04" "procps-ng" "User Commands"
.SH NAME
tload \- graphic representation of system load average
.SH SYNOPSIS
@ -11,7 +11,9 @@ tload \- graphic representation of system load average
.B tload
prints a graph of the current system load average to the specified
.I tty
(or the tty of the tload process if none is specified).
(or the tty of the
.B tload
process if none is specified).
.SH OPTIONS
.TP
\fB\-s\fR, \fB\-\-scale\fR \fInumber\fR

12
vmstat.8
View File

@ -1,6 +1,6 @@
.\" This page Copyright (C) 1994 Henry Ware <al172@yfn.ysu.edu>
.\" Distributed under the GPL, Copyleft 1994.
.TH VMSTAT 8 "September 2011" "procps-ng" "System Administration"
.TH VMSTAT 8 "2020-06-04" "procps-ng" "System Administration"
.SH NAME
vmstat \- Report virtual memory statistics
.SH SYNOPSIS
@ -98,19 +98,19 @@ b: The number of processes in uninterruptible sleep.
.PP
.SS
.B "Memory"
These are affected by the \-\-unit option.
These are affected by the \fB\-\-unit\fR option.
.nf
swpd: the amount of virtual memory used.
free: the amount of idle memory.
buff: the amount of memory used as buffers.
cache: the amount of memory used as cache.
inact: the amount of inactive memory. (\-a option)
active: the amount of active memory. (\-a option)
inact: the amount of inactive memory. (\fB\-a\fR option)
active: the amount of active memory. (\fB\-a\fR option)
.fi
.PP
.SS
.B "Swap"
These are affected by the \-\-unit option.
These are affected by the \fB\-\-unit\fR option.
.nf
si: Amount of memory swapped in from disk (/s).
so: Amount of memory swapped to disk (/s).
@ -184,7 +184,7 @@ size: Size of each object
pages: Number of pages with at least one active object
.fi
.SH NOTES
.B "vmstat "
.B vmstat
does not require special permissions.
.PP
These reports are intended to help identify system bottlenecks. Linux

10
w.1
View File

@ -1,6 +1,6 @@
.\" -*-Nroff-*-
.\"
.TH W "1" "May 2012" "procps-ng" "User Commands"
.TH W "1" "2020-06-04" "procps-ng" "User Commands"
.SH NAME
w \- Show who is logged on and what they are doing.
.SH SYNOPSIS
@ -30,8 +30,12 @@ Don't print the header.
.TP
\fB\-u\fR, \fB\-\-no\-current\fR
Ignores the username while figuring out the
current process and cpu times. To demonstrate this, do a "su" and do a "w"
and a "w \-u".
current process and cpu times. To demonstrate this, do a
.B su
and do a
.B w
and a
.BR "w \-u".
.TP
\fB\-s\fR, \fB\-\-short\fR
Use the short format. Don't print the login time, JCPU or PCPU times.

13
watch.1
View File

@ -1,4 +1,4 @@
.TH WATCH 1 "2020-05-12" "procps-ng" "User Commands"
.TH WATCH 1 "2020-06-04" "procps-ng" "User Commands"
.SH NAME
watch \- execute a program periodically, showing output fullscreen
.SH SYNOPSIS
@ -13,10 +13,11 @@ allows you to watch the program output change over time. By default,
\fIcommand\fR is run every 2 seconds and \fBwatch\fR will run until interrupted.
.SH OPTIONS
.TP
\fB\-d\fR, \fB\-\-differences\fR [\fIpermanent\fR]
Highlight the differences between successive updates. Option will read
optional argument that changes highlight to be permanent, allowing to see what
has changed at least once since first iteration.
.BR \-d ", " \-\-differences [ =permanent ]
Highlight the differences between successive updates. If the optional
\fB=permanent\fR argument is specified then
.B watch
will show all changes since the first iteration.
.TP
\fB\-n\fR, \fB\-\-interval\fR \fIseconds\fR
Specify update interval. The command will not allow quicker than 0.1 second
@ -124,7 +125,7 @@ next scheduled update. All
.B \-\-differences
highlighting is lost on that update as well.
Non-printing characters are stripped from program output. Use "cat -v" as
Non-printing characters are stripped from program output. Use \fBcat -v\fR as
part of the command pipeline if you want to see them.
Combining Characters that are supposed to display on the character at the