]> granicus.if.org Git - procps-ng/commitdiff
docs: mention long options in man pgrep.1
authorSami Kerola <kerolasa@iki.fi>
Tue, 27 Sep 2011 20:42:51 +0000 (22:42 +0200)
committerSami Kerola <kerolasa@iki.fi>
Tue, 20 Dec 2011 16:17:02 +0000 (17:17 +0100)
This commit includes generic manual clean ups as well.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
pgrep.1

diff --git a/pgrep.1 b/pgrep.1
index c933b8febbb052e8caba166ed442755f04703884..06e1e7f5f2d551e7f0027416831c9386a6b4d1c5 100644 (file)
--- a/pgrep.1
+++ b/pgrep.1
 .\" Licensed under version 2 of the GNU General Public License.
 .\" Copyright 2000 Kjetil Torgrim Homme
 .\"
-.TH PGREP 1 "October 5, 2007" "Linux" "Linux User's Manual"
+.TH PGREP "1" "September 2011" "procps-ng" "User Commands"
 .SH NAME
 pgrep, pkill \- look up or signal processes based on name and other attributes
-
 .SH SYNOPSIS
-.na
-\fBpgrep\fR [\fB\-cflvx\fR] [\fB\-d\ \fIdelimiter\fR] [\fB\-n\fR|\fB\-o\fR] \
-[\fB\-P\ \fIppid\fR,...] [\fB\-g\ \fIpgrp\fR,...] [\fB\-s\ \fIsid\fR,...] \
-[\fB\-u\ \fIeuid\fR,...] [\fB\-U\ \fIuid\fR,...] [\fB\-G\ \fIgid\fR,...] \
-[\fB\-t\ \fIterm\fR,...] [\fIpattern\fR]
-
-.HP
-\fBpkill\fR [\fB\-\fIsignal\fR] [\fB\-fvx\fR] [\fB\-n\fR|\fB\-o\fR] \
-[\fB\-P\ \fIppid\fR,...] [\fB\-g\ \fIpgrp\fR,...] [\fB\-s\ \fIsid\fR,...] \
-[\fB\-u\ \fIeuid\fR,...] [\fB\-U\ \fIuid\fR,...] [\fB\-G\ \fIgid\fR,...] \
-[\fB\-t\ \fIterm\fR,...] [\fIpattern\fR]
-
+.B pgrep
+[options] pattern
+.br
+.B pkill
+[options] pattern
 .SH DESCRIPTION
-\fBpgrep\fP looks through the currently running processes and lists the
-process IDs which matches the selection criteria to stdout.  All
-the criteria have to match.  For example,
-
+.B pgrep
+looks through the currently running processes and lists the process IDs which
+matches the selection criteria to stdout.  All the criteria have to match.
+For example,
 .IP
 $ pgrep \-u root sshd
-
 .PP
-will only list the processes called \fBsshd\fP AND owned by \fBroot\fP.
+will only list the processes called
+.B sshd
+AND owned by
+.BR root .
 On the other hand,
-
 .IP
 $ pgrep \-u root,daemon
-
 .PP
-will list the processes owned by \fBroot\fP OR \fBdaemon\fP.
-
-\fBpkill\fP will send the specified signal (by default \fBSIGTERM\fP)
+will list the processes owned by
+.B root
+OR
+.BR daemon .
+.PP
+.B pkill
+will send the specified signal (by default
+.BR SIGTERM )
 to each process instead of listing them on stdout.
-
 .SH OPTIONS
-\-c
-Suppress normal output; instead print a count of matching processes.
-.TP
-\fB\-d \fIdelimiter\fP
-Sets the string used to delimit each process ID in the output (by
-default a newline).  (\fBpgrep\fP only.)
-.TP
-\fB\-f\fR
-The \fIpattern\fP is normally only matched against the process name.
-When \fB\-f\fR is set, the full command line is used.
-.TP
-\fB\-g \fIpgrp\fP,...
-Only match processes in the process group IDs listed.  Process group 0
-is translated into \fBpgrep\fP's or \fBpkill\fP's own process group.
-.TP
-\-G \fIgid\fP,...
-Only match processes whose real group ID is listed.  Either the
-numerical or symbolical value may be used.
 .TP
-\fB\-l\fR
-List the process name as well as the process ID. (\fBpgrep\fP only.)
+\fB\-\fR\fIsignal\fP
+.TQ
+\fB\-\-signal\fR \fIsignal\fR
+Defines the signal to send to each matched process.  Either the numeric or
+the symbolic signal name can be used.
+.RB ( pkill
+only.)
 .TP
-\fB\-n\fR
-Select only the newest (most recently started) of the matching
-processes.
-.TP
-\fB\-o\fR
-Select only the oldest (least recently started) of the matching
-processes.
-.TP
-\fB\-P \fIppid\fP,...
+\fB\-c\fR, \fB\-\-count\fR
+Suppress normal output; instead print a count of matching processes.
+(\fBpgrep\fP only.)
+.TP
+\fB\-d\fR, \fB\-\-delimeter\fR \fIdelimiter\fP
+Sets the string used to delimit each process ID in the output (by default a
+newline).
+.RB ( pgrep
+only.)
+.TP
+\fB\-f\fR, \fB\-\-full\fR
+The
+.I pattern
+is normally only matched against the process name.  When
+.B \-f
+is set, the full command line is used.
+.TP
+\fB\-g\fR, \fB\-\-pgroup\fR \fIpgrp\fP,...
+Only match processes in the process group IDs listed.  Process group 0 is
+translated into
+.BR pgrep 's
+or
+.BR pkill 's
+own process group.
+.TP
+\fB\-G\fR, \fB\-\-group\fR \fIgid\fP,...
+Only match processes whose real group ID is listed.  Either the numerical or
+symbolical value may be used.
+.TP
+\fB\-l\fR, \fB\-\-\fRlist\-name\fR
+List the process name as well as the process ID.
+.RB ( pgrep
+only.)
+\fB\-n\fR, \fB\-\-newest\fR
+Select only the newest (most recently started) of the matching processes.
+.TP
+\fB\-o\fR, \fB\-\-oldest\fR
+Select only the oldest (least recently started) of the matching processes.
+.TP
+\fB\-P\fR, \fB\-\-parent\fR \fIppid\fP,...
 Only match processes whose parent process ID is listed.
 .TP
-\fB\-s \fIsid\fP,...
+\fB\-s\fR, \fB\-\-session\fR \fIsid\fP,...
 Only match processes whose process session ID is listed.  Session ID 0
-is translated into \fBpgrep\fP's or \fBpkill\fP's own session ID.
+is translated into
+.BR pgrep 's
+or
+.BR pkill 's
+own session ID.
 .TP
-\fB\-t \fIterm\fP,...
-Only match processes whose controlling terminal is listed.  The
-terminal name should be specified without the "/dev/" prefix.
+\fB\-t\fR, \fB\-\-terminal\fR \fIterm\fP,...
+Only match processes whose controlling terminal is listed.  The terminal name
+should be specified without the "/dev/" prefix.
 .TP
-\fB\-u \fIeuid\fP,...
-Only match processes whose effective user ID is listed.  Either the
-numerical or symbolical value may be used.
+\fB\-u\fR, \fB\-\-euid\fR \fIeuid\fP,...
+Only match processes whose effective user ID is listed.  Either the numerical
+or symbolical value may be used.
 .TP
-\fB\-U \fIuid\fP,...
-Only match processes whose real user ID is listed.  Either the
-numerical or symbolical value may be used.
+\fB\-U\fR, \fB\-\-uid\fR \fIuid\fP,...
+Only match processes whose real user ID is listed.  Either the numerical or
+symbolical value may be used.
 .TP
-\fB\-v\fR
+\fB\-v\fR, \fB\-\-inverse\fR\fR
 Negates the matching.
 .TP
-\fB\-x\fR
+\fB\-x\fR, \fB\-\-exact\fR\fR
 Only match processes whose name (or command line if \-f is specified)
-\fBexactly\fP match the \fIpattern\fP.
-.TP
-\-\fIsignal\fP
-Defines the signal to send to each matched process.  Either the
-numeric or the symbolic signal name can be used.  (\fBpkill\fP only.)
-
+.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
+.B pkill
+than
+.BR pgrep .
+.TP
+\fB\-L\fR, \fB\-\-logpidfile\fR
+Fail if pidfile (see -F) not locked.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Display version information and exit.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display help and exit.
+.PD
 .SH OPERANDS
 .TP
-\fIpattern\fP
-Specifies an Extended Regular Expression for matching against the
-process names or command lines.
-
+.I pattern
+Specifies an Extended Regular Expression for matching against the process
+names or command lines.
 .SH EXAMPLES
-Example 1: Find the process ID of the \fBnamed\fP daemon:
-
+Example 1: Find the process ID of the
+.B named
+daemon:
 .IP
 $ pgrep \-u root named
-
 .PP
-Example 2: Make \fBsyslog\fP reread its configuration file:
-
+Example 2: Make
+.B syslog
+reread its configuration file:
 .IP
 $ pkill \-HUP syslogd
-
 .PP
-Example 3: Give detailed information on all \fBxterm\fP processes:
-
+Example 3: Give detailed information on all
+.B xterm
+processes:
 .IP
 $ ps \-fp $(pgrep \-d, \-x xterm)
-
 .PP
-Example 4: Make all \fBnetscape\fP processes run nicer:
-
+Example 4: Make all
+.B netscape
+processes run nicer:
 .IP
-$ renice +4 `pgrep netscape`
-
+$ renice +4 $(pgrep netscape)
 .SH "EXIT STATUS"
 .PD 0
 .TP
-.I 0
+0
 One or more processes matched the criteria.
 .TP
-.I 1
+1
 No processes matched.
 .TP
-.I 2
+2
 Syntax error in the command line.
 .TP
-.I 3
+3
 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 complete command line, /proc/\fIpid\fP/cmdline.
-
-The running \fBpgrep\fP or \fBpkill\fP process will never report
-itself as a match.
-
+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
+complete command line, /proc/\fIpid\fP/cmdline.
+.PP
+The running
+.B pgrep
+or
+.B pkill
+process will never report itself as a
+match.
 .SH BUGS
-The options \fB\-n\fP and \fB\-o\fP and \fB\-v\fP can not be combined.
-Let me know if you need to do this.
-
+The options
+.B \-n
+and
+.B \-o
+and
+.B \-v
+can not be combined.  Let
+me know if you need to do this.
+.PP
 Defunct processes are reported.
 
 .SH "SEE ALSO"
@@ -168,12 +209,16 @@ Defunct processes are reported.
 .BR skill (1),
 .BR kill (1),
 .BR kill (2)
-
 .SH STANDARDS
-\fBpkill\fP and \fBpgrep\fP were introduced in Sun's Solaris 7.  This
-implementation is fully compatible.
-
+.B pkill
+and
+.B pgrep
+were introduced in Sun's Solaris 7.  This implementation is fully compatible.
 .SH AUTHOR
-Kjetil Torgrim Homme <kjetilho@ifi.uio.no>
-
-Please send bug reports to <procps@freelists.org>
+.UR kjetilho\@ifi.uio.no
+Kjetil Torgrim Homme
+.UE
+.SH "REPORTING BUGS"
+Please send bug reports to
+.UR procps\@freelists.org
+.UE