docs: Minor manpage fixes

References:
 procps-ng/procps#230
This commit is contained in:
Craig Small
2023-01-16 18:29:50 +11:00
parent dbde44b528
commit aa461df0a7
8 changed files with 68 additions and 48 deletions

View File

@@ -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