summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCraig Small <csmall@dropbear.xyz>2023-01-16 18:29:50 +1100
committerCraig Small <csmall@dropbear.xyz>2023-01-16 18:29:50 +1100
commitaa461df0a7727309ef2f7ce6f0336d1ba00fe414 (patch)
tree37b42ff30a9e9d5f54da55b7cbfa1df1a0e3ed9d
parentdbde44b528ed7646249e066001a600dbe1d6a196 (diff)
downloadprocps-ng-aa461df0a7727309ef2f7ce6f0336d1ba00fe414.tar.gz
docs: Minor manpage fixes
References: procps-ng/procps#230
-rw-r--r--man/kill.18
-rw-r--r--man/pgrep.126
-rw-r--r--man/pidof.132
-rw-r--r--man/ps.14
-rw-r--r--man/skill.116
-rw-r--r--man/slabtop.12
-rw-r--r--man/sysctl.812
-rw-r--r--man/watch.116
8 files changed, 68 insertions, 48 deletions
diff --git a/man/kill.1 b/man/kill.1
index c5f4229..ca02142 100644
--- a/man/kill.1
+++ b/man/kill.1
@@ -5,7 +5,7 @@
.\" Licensed under version 2 of the GNU General Public License.
.\" Written by Albert Cahalan; converted to a man page by
.\" Michael K. Johnson
-.TH KILL 1 "2021-05-18" "procps-ng" "User Commands"
+.TH KILL 1 "2023-01-16" "procps-ng" "User Commands"
.SH NAME
kill \- send a signal to a process
.SH SYNOPSIS
@@ -46,13 +46,13 @@ manual page.
.TP
\fB\-q\fR, \fB\-\-queue \fIvalue\fP
Use
-.BR sigqueue(3)
+.BR sigqueue (3)
rather than
-.BR kill(2)
+.BR kill (2)
and the value argument is used to specify
an integer to be sent with the signal. If the receiving process has
installed a handler for this signal using the SA_SIGINFO flag to
-.BR sigaction(2) ,
+.BR sigaction (2),
then it can obtain this data via the si_value field of the
siginfo_t structure.
.TP
diff --git a/man/pgrep.1 b/man/pgrep.1
index 64e610d..fb1a2d3 100644
--- a/man/pgrep.1
+++ b/man/pgrep.1
@@ -7,7 +7,7 @@
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
-.TH PGREP "1" "2022-11-01" "procps-ng" "User Commands"
+.TH PGREP "1" "2023-01-16" "procps-ng" "User Commands"
.SH NAME
pgrep, pkill, pidwait \- look up, signal, or wait for processes based on name and other attributes
.SH SYNOPSIS
@@ -172,7 +172,9 @@ match the
.TP
\fB\-F\fR, \fB\-\-pidfile\fR \fIfile\fR
Read \fIPID\fRs from \fIfile\fR. This option is more useful for
-.BR pkill or pidwait
+.B pkill
+or
+.B pidwait
than
.BR pgrep .
.TP
@@ -207,18 +209,18 @@ limit which namespaces to match.
.TP
\fB\-\-nslist \fIname\fP,...
Match only the provided namespaces. Available namespaces:
-ipc, mnt, net, pid, user,uts.
+ipc, mnt, net, pid, user, uts.
.TP
\fB\-q\fR, \fB\-\-queue \fIvalue\fP
Use
-.BR sigqueue(3)
+.BR sigqueue (3)
rather than
-.BR kill(2)
+.BR kill (2)
and the value argument is used to specify
an integer to be sent with the signal. If the receiving process has
installed a handler for this signal using the SA_SIGINFO flag to
-.BR sigaction(2)
-, then it can obtain this data via the si_value field of the
+.BR sigaction (2),
+then it can obtain this data via the si_value field of the
siginfo_t structure.
.TP
\fB\-V\fR, \fB\-\-version\fR
@@ -260,7 +262,11 @@ $ renice +4 $(pgrep chrome)
.PD 0
.TP
0
-One or more processes matched the criteria. For pkill and pidwait, one or more
+One or more processes matched the criteria. For
+.B pkill
+and
+.BR pidwait ,
+one or more
processes must also have been successfully signalled or waited for.
.TP
1
@@ -288,7 +294,7 @@ match.
.PP
The
.B \-O \-\-older
-option will silently fail if /proc is mounted with the \fIsubset=pid\fR option.
+option will silently fail if \fI/proc\fR is mounted with the \fIsubset=pid\fR option.
.SH BUGS
The options
.B \-n
@@ -314,7 +320,7 @@ system call which first appeared in Linux 5.3.
.BR skill (1),
.BR kill (1),
.BR kill (2),
-.BR cgroups (8)
+.BR cgroups (8).
.SH AUTHOR
.UR kjetilho@ifi.uio.no
Kjetil Torgrim Homme
diff --git a/man/pidof.1 b/man/pidof.1
index 9fb4df7..14e06da 100644
--- a/man/pidof.1
+++ b/man/pidof.1
@@ -15,9 +15,9 @@
.\" 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 "2020-12-22" "" "User Commands"
+.TH PIDOF 1 "2023-01-16" "" "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 ]
@@ -29,32 +29,32 @@ pidof -- find the process ID of a running program
.IR omitpid[,omitpid...]... ]
.RB [ \-S
.IR separator ]
-.B program
-.RB [ program... ]
+.I program
+.IB [ program... ]
.SH DESCRIPTION
.B Pidof
finds the process id's (pids) of the named programs. It prints those
id's on the standard output.
.SH OPTIONS
-.IP \-s
+.IP \fB\-s\fP
Single shot - this instructs the program to only return one \fIpid\fP.
-.IP \-c
+.IP \fB\-c\fP
Only return process ids that are running with the same root directory.
This option is ignored for non-root users, as they will be unable to check
the current root directory of processes they do not own.
-.IP \-q
+.IP \fB\-q\fP
Quiet mode, suppress any output and only sets the exit status accordingly.
-.IP \-w
+.IP \fB\-w\fP
Show also processes that do not have visible command line (e.g. kernel
worker threads).
-.IP \-x
+.IP \fB\-x\fP
Scripts too - this causes the program to also return process id's of
shells running the named scripts.
-.IP "-o \fIomitpid\fP"
-Tells \fIpidof\fP to omit processes with that process id. The special
-pid \fB%PPID\fP can be used to name the parent process of the \fIpidof\fP
+.IP "\fB-o\fP \fIomitpid\fP"
+Tells \fBpidof\fP to omit processes with that process id. The special
+pid \fB%PPID\fP can be used to name the parent process of the \fBpidof\fP
program, in other words the calling shell or shell script.
-.IP "-S \fIseparator\fP"
+.IP "\fB-S\fP \fIseparator\fP"
Use \fIseparator\fP as a separator put between pids. Used only when
more than one pids are printed for the program.
The \fB\-d\fR option is an alias for this option for sysvinit
@@ -69,7 +69,7 @@ At least one program was found with the requested name.
No program was found with the requested name.
.SH BUGS
-When using the \fI\-x\fP option,
+When using the \fB\-x\fP option,
.B pidof
only has a simple method for detecting scripts and will miss scripts that,
for example, use env. This limitation is due to how the scripts look in
@@ -79,4 +79,6 @@ the proc filesystem.
.BR pgrep (1),
.BR pkill (1)
.SH AUTHOR
-Jaromir Capik <jcapik@redhat.com>
+.UR jcapik@redhat.com
+Jaromir Capik
+.UE
diff --git a/man/ps.1 b/man/ps.1
index 545f49b..7f933fc 100644
--- a/man/ps.1
+++ b/man/ps.1
@@ -4,7 +4,7 @@
.\" Quick hack conversion by Albert Cahalan, 1998.
.\" Licensed under version 2 of the Gnu General Public License.
.\"
-.TH PS "1" "2023-01-15" "procps-ng" "User Commands"
+.TH PS "1" "2023-01-16" "procps-ng" "User Commands"
.\"
.\" To render this page:
.\" groff -t -b -man -X -P-resolution -P100 -Tps ps.1 &
@@ -798,7 +798,7 @@ will be destroyed by
.IR init (8)
if the parent process exits.
.PP
-If the length of the username is greater than the length of the display
+If the length of the username is greater than the width of the display
column, the username will be truncated. See the \fB\-o\fR and \fB\-O\fR
formatting options to customize length.
.PP
diff --git a/man/skill.1 b/man/skill.1
index 8ef7683..05d1c7c 100644
--- a/man/skill.1
+++ b/man/skill.1
@@ -21,15 +21,19 @@ skill, snice \- send a signal or report process status
.I expression
.SH DESCRIPTION
These tools are obsolete and unportable. The command syntax is
-poorly defined. Consider using the killall, pkill, and pgrep
+poorly defined. Consider using the
+.BR killall ,
+.BR pkill ,
+and
+.B pgrep
commands instead.
.PP
-The default signal for skill is TERM. Use \-l or \-L to list
+The default signal for \fBskill\fP is TERM. Use \fB\-l\fP or \fB\-L\fP to list
available signals. Particularly useful signals include HUP, INT,
KILL, STOP, CONT, and 0. Alternate signals may be specified in three
-ways: \-9 \-SIGKILL \-KILL.
+ways: \fB\-9\fP \fB\-SIGKILL\fP \fB\-KILL\fP.
.PP
-The default priority for snice is +4. Priority numbers range from
+The default priority for \fBsnice\fP is +4. Priority numbers range from
+20 (slowest) to \-20 (fastest). Negative priority numbers are
restricted to administrative users.
.SH OPTIONS
@@ -82,7 +86,7 @@ The next expression is a command name.
Match the processes that belong to the same namespace as pid.
.TP
\fB\-\-nslist \fIns,...\fR
-list which namespaces will be considered for the --ns option.
+list which namespaces will be considered for the \fB\-\-ns\fP option.
Available namespaces: ipc, mnt, net, pid, user, uts.
.PD
.SH SIGNALS
@@ -92,7 +96,7 @@ manual page.
.SH EXAMPLES
.TP
.B snice -c seti -c crack +7
-Slow down seti and crack commands.
++Slow down \fBseti\fP and \fBcrack\fP commands.
.TP
.B skill \-KILL \-t /dev/pts/*
Kill users on PTY devices.
diff --git a/man/slabtop.1 b/man/slabtop.1
index af45032..042dee1 100644
--- a/man/slabtop.1
+++ b/man/slabtop.1
@@ -95,7 +95,7 @@ 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.
+\fI/proc/meminfo\fR file is tracking information about used slab physical
.SH AUTHORS
Written by Chris Rivera and Robert Love.
.PP
diff --git a/man/sysctl.8 b/man/sysctl.8
index 6c5bd3c..bcf06e4 100644
--- a/man/sysctl.8
+++ b/man/sysctl.8
@@ -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 "8" "2021-03-29" "procps-ng" "System Administration"
+.TH SYSCTL "8" "2023-01-16" "procps-ng" "System Administration"
.SH NAME
sysctl \- configure kernel parameters at runtime
.SH SYNOPSIS
@@ -18,7 +18,7 @@ sysctl \- configure kernel parameters at runtime
.SH DESCRIPTION
.B sysctl
is used to modify kernel parameters at runtime. The parameters available
-are those listed under /proc/sys/. Procfs is required for
+are those listed under \fI/proc/sys/\fR. Procfs is required for
.B sysctl
support in Linux. You can use
.B sysctl
@@ -57,9 +57,9 @@ Use this option to not display the values set to stdout.
Use this option when all arguments prescribe a key to be set.
.TP
\fB\-p\fR[\fIFILE\fR], \fB\-\-load\fR[=\fIFILE\fR]
-Load in sysctl settings from the file specified or /etc/sysctl.conf if none
-given. Specifying \- as filename means reading data from standard input.
-Using this option will mean arguments to
+Load in \fBsysctl\fR settings from the file specified or \fI/etc/sysctl.conf\fR
+if none given. Specifying \- as filename means reading data from standard
+input. Using this option will mean arguments to
.B sysctl
are files, which are read in the order they are specified.
The file argument may be specified as regular expression.
@@ -159,7 +159,7 @@ 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:
+to \fB/proc\fR file system by other means. For example:
.PP
echo 256 > /proc/sys/net/ipv6/neigh/eth0/base_reachable_time
.SH FILES
diff --git a/man/watch.1 b/man/watch.1
index cef2cab..d130ef7 100644
--- a/man/watch.1
+++ b/man/watch.1
@@ -1,4 +1,4 @@
-.TH WATCH 1 "2021-04-24" "procps-ng" "User Commands"
+.TH WATCH 1 "2023-01-16" "procps-ng" "User Commands"
.SH NAME
watch \- execute a program periodically, showing output fullscreen
.SH SYNOPSIS
@@ -22,7 +22,7 @@ will show all changes since the first iteration.
\fB\-n\fR, \fB\-\-interval\fR \fIseconds\fR
Specify update interval. The command will not allow quicker than 0.1 second
interval, in which the smaller values are converted. Both '.' and ',' work
-for any locales. The WATCH_INTERVAL environment can be used to persistently
+for any locales. The \fBWATCH_INTERVAL\fR environment can be used to persistently
set a non-default interval (following the same rules and formatting).
.TP
\fB\-p\fR, \fB\-\-precise\fR
@@ -112,7 +112,7 @@ failed, or command exited up on error.
.B other
The watch will propagate command exit status as child exit status.
.SH ENVIRONMENT
-The behaviour of
+The behavior of
.B watch
is affected by the following environment variables.
@@ -121,6 +121,7 @@ is affected by the following environment variables.
Update interval, follows the same rules as the
.B \-\-interval
command line option.
+.sp
.SH NOTES
POSIX option processing is used (i.e., option processing stops at
the first non\-option argument). This means that flags after
@@ -128,6 +129,7 @@ the first non\-option argument). This means that flags after
don't get interpreted by
.BR watch
itself.
+.sp
.SH BUGS
Upon terminal resize, the screen will not be correctly repainted until the
next scheduled update. All
@@ -162,8 +164,9 @@ also can get into a state where it rapid-fires as many executions of
as it can to catch up from a previous executions running longer than
.B \-\-interval
(for example,
-.B netstat
+.BR netstat (8)
taking ages on a DNS lookup).
+.sp
.SH EXAMPLES
.PP
To watch for mail, you might do
@@ -201,3 +204,8 @@ watch uname \-r
isn't guaranteed to work across reboots, especially in the face of
.B ntpdate
(if present) or other bootup time-changing mechanisms)
+.sp
+.SH "REPORTING BUGS"
+Please send bug reports to
+.UR procps@freelists.org
+.UE