]> granicus.if.org Git - procps-ng/commitdiff
docs: clean up kill and skill man pages
authorSami Kerola <kerolasa@iki.fi>
Sat, 1 Oct 2011 23:15:12 +0000 (01:15 +0200)
committerSami Kerola <kerolasa@iki.fi>
Tue, 20 Dec 2011 16:17:03 +0000 (17:17 +0100)
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
kill.1
skill.1

diff --git a/kill.1 b/kill.1
index 5df66a1465c7a0847a2066e2a93db3d0fdd880a9..b8a8d0e3ce22ebf6ae3539efeac4ef7494f3a0be 100644 (file)
--- a/kill.1
+++ b/kill.1
@@ -5,73 +5,57 @@
 .\" 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 "November 21, 1999" "Linux" "Linux User's Manual"
+.TH KILL 1 "October 2011" "procps-ng" "User Commands"
 .SH NAME
 kill \- send a signal to a process
-
 .SH SYNOPSIS
-\fBkill\fR [ \-\fBsignal\fR | \-s \fBsignal\fR ] \fBpid\fR ...
-.br
-\fBkill\fR [ \-L | -V, \-\-version ]
-.br
-\fBkill\fR \-l  [ \fBsignal\fR ]
-
+.B kill
+[options] <pid> [...]
 .SH DESCRIPTION
-The default signal for kill is TERM. Use \-l or \-L 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.
-Negative PID values may be used to choose whole process groups; see the
-PGID column in ps command output. A PID of \-1 is special; it indicates
-all processes except the kill process itself and init.
-
+The default signal for kill is TERM.  Use
+.B \-l
+or
+.B \-L
+to list available signals.  Particularly useful signals include HUP,
+INT, KILL, STOP, CONT, and 0.  Alternate signals may be specified in
+three ways:
+.BR \-9 ", " \-SIGKILL
+or
+.BR \-KILL .
+Negative PID values may be used to choose whole process groups; see
+the PGID column in ps command output.  A PID of
+.B \-1
+is special; it indicates all processes except the kill process itself
+and init.
+.SH OPTIONS
+.TP
+.B <pid> [...]
+Send signal to every <pid> listed.
+.TP
+.B \-<signal>
+.TQ
+.B \-s <signal>
+Specify the
+.B signal
+to be sent.  The signal can be specified by using name or number.
+.TP
+.B \-l
+List signal names.
+.TP
+.B \-L
+List signal names in a nice table.
+.TP
+.B \-l <signal>
+Convert in between signal name and number.
+.PD
 .SH SIGNALS
-The signals listed below may be available for use with kill.
-When known constant, numbers and default behavior are shown.
-
-.TS
-lB rB lB lB
-lfCW r l l.
-Name   Num     Action  Description
-0      0       n/a     exit code indicates if a signal may be sent
-ALRM   14      exit
-HUP    1       exit
-INT    2       exit
-KILL   9       exit    cannot be blocked
-PIPE   13      exit
-POLL           exit
-PROF           exit
-TERM   15      exit
-USR1           exit
-USR2           exit
-VTALRM         exit
-STKFLT         exit    might not be implemented
-PWR            ignore  might exit on some systems
-WINCH          ignore
-CHLD           ignore
-URG            ignore
-TSTP           stop    might interact with the shell
-TTIN           stop    might interact with the shell
-TTOU           stop    might interact with the shell
-STOP           stop    cannot be blocked
-CONT           restart continue if stopped, otherwise ignore
-ABRT   6       core
-FPE    8       core
-ILL    4       core
-QUIT   3       core
-SEGV   11      core
-TRAP   5       core
-SYS            core    might not be implemented
-EMT            core    might not be implemented
-BUS            core    core dump might fail
-XCPU           core    core dump might fail
-XFSZ           core    core dump might fail
-.TE
-
+The behavior of signals is explained in
+.BR signal (7)
+manual page.
 .SH NOTES
-Your shell (command line interpreter) may have a built-in kill command.
-You may need to run the command described here as /bin/kill to solve
-the conflict.
-
+Your shell (command line interpreter) may have a built-in kill
+command.  You may need to run the command described here as /bin/kill
+to solve the conflict.
 .SH EXAMPLES
 .TP
 .B kill \-9 \-1
@@ -85,22 +69,25 @@ List the available signal choices in a nice table.
 .TP
 .B kill 123 543 2341 3453
 Send the default signal, SIGTERM, to all those processes.
-
 .SH "SEE ALSO"
-.BR pkill (1),
-.BR skill (1),
 .BR kill (2),
-.BR renice (1),
+.BR killall (1),
 .BR nice (1),
+.BR pkill (1),
+.BR renice (1),
 .BR signal (7),
-.BR killall (1).
-
+.BR skill (1)
 .SH STANDARDS
-This command meets appropriate standards. The \-L flag is Linux-specific.
-
+This command meets appropriate standards. The
+.B \-L
+flag is Linux-specific.
 .SH AUTHOR
-Albert Cahalan <albert@users.sf.net> wrote kill in 1999 to replace a
-bsdutils one that was not standards compliant. The util-linux one might
-also work correctly.
-
-Please send bug reports to <procps@freelists.org>
+.UR albert\@users.sf.net
+Albert Cahalan
+.UE
+wrote kill in 1999 to replace a bsdutils one that was not standards
+compliant.  The util-linux one might also work correctly.
+.SH "REPORTING BUGS"
+Please send bug reports to
+.UR procps\@freelists.org
+.UE
diff --git a/skill.1 b/skill.1
index 9289cc1990be52b22c62f00f01a1d7086537bbca..f71b036fc0fa74d4bcfde1255eb6f043ee3b2218 100644 (file)
--- a/skill.1
+++ b/skill.1
 .\" Written by Albert Cahalan, converted to a man page by
 .\" Michael K. Johnson
 .\"
-.TH SKILL 1 "March 12, 1999" "Linux" "Linux User's Manual"
+.TH SKILL 1 "October 2011" "procps-ng" "User Commands"
 .SH NAME
 skill, snice \- send a signal or report process status
-
 .SH SYNOPSIS
 .B skill
-.RI [ "signal to send" ]
+.RI [ signal ]
 .RI [ options ]
-.I process selection criteria
+.I expression
 .br
 .B snice
 .RI [ "new priority" ]
 .RI [ options ]
-.I process selection criteria
-
+.I expression
 .SH DESCRIPTION
-These tools are probably obsolete and unportable. The command
-syntax is poorly defined. Consider using the killall, pkill,
-and pgrep commands instead.
-
-The default signal for skill is TERM. Use \-l or \-L 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.
-
-The default priority for snice is +4. (snice +4 ...)
-Priority numbers range from +20 (slowest) to \-20 (fastest).
-Negative priority numbers are restricted to administrative users.
-
-.SH "GENERAL OPTIONS"
-.TS
-lB l l.
-\-f    fast mode       This is not currently useful.
-\-i    interactive use You will be asked to approve each action.
-\-v    verbose output  Display information about selected processes.
-\-w    warnings enabled        This is not currently useful.
-\-n    no action       This only displays the process ID.
-\-V    show version    Displays version of program.
-.TE
-
+These tools are probably obsolete and unportable.  The command syntax
+is poorly defined.  Consider using the killall, pkill, and pgrep
+commands instead.
+.PP
+The default signal for skill is TERM.  Use \-l or \-L 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.
+.PP
+The default priority for snice is +4.  Priority numbers range from
++20 (slowest) to \-20 (fastest).  Negative priority numbers are
+restricted to administrative users.
+.SH OPTIONS
+.TP
+.B \-f
+Fast mode.  This option has not been implemented.
+.TP
+.B \-i
+Bnteractive move.
+.TP
+.B \-l
+List all signal names.
+.TP
+.B \-L
+List all signal names in a nice table.
+.TP
+.B \-n
+No action; perform a simulation of events that would occur but do not
+actually change the system.
+.TP
+.B \-v
+Verbose; explain what is being done.
+.TP
+.B \-w
+Enable warnings.  This option has not been implemented.
+.TP
+.B \-V, \-\-verbose
+Display version information and exit.
+.PD
 .SH "PROCESS SELECTION OPTIONS"
-Selection criteria can be: terminal, user, pid, command.
-The options below may be used to ensure correct interpretation.
-Do not blame Albert for this interesting interface.
-.TS
-lB l.
-\-t    The next argument is a terminal (tty or pty).
-\-u    The next argument is a username.
-\-p    The next argument is a process ID number.
-\-c    The next argument is a command name.
-.TE
-
+Selection criteria can be: terminal, user, pid, command.  The options
+below may be used to ensure correct interpretation.
+.TP
+.B \-t
+The next expression is a terminal (tty or pty).
+.TP
+.B \-u
+The next expression is a username.
+.TP
+.B \-p
+The next expression is a process ID number.
+.TP
+.B \-c
+The next expression is a command name.
+.PD
 .SH SIGNALS
-The signals listed below may be available for use with skill.
-When known, numbers and default behavior are shown.
-.TS
-lB rB lB lB
-lfCW r l l.
-Name   Num     Action  Description
-0      0       n/a     exit code indicates if a signal may be sent
-ALRM   14      exit
-HUP    1       exit
-INT    2       exit
-KILL   9       exit    this signal may not be blocked
-PIPE   13      exit
-POLL           exit
-PROF           exit
-TERM   15      exit
-USR1           exit
-USR2           exit
-VTALRM         exit
-STKFLT         exit    may not be implemented
-PWR            ignore  may exit on some systems
-WINCH          ignore
-CHLD           ignore
-URG            ignore
-TSTP           stop    may interact with the shell
-TTIN           stop    may interact with the shell
-TTOU           stop    may interact with the shell
-STOP           stop    this signal may not be blocked
-CONT           restart continue if stopped, otherwise ignore
-ABRT   6       core
-FPE    8       core
-ILL    4       core
-QUIT   3       core
-SEGV   11      core
-TRAP   5       core
-SYS            core    may not be implemented
-EMT            core    may not be implemented
-BUS            core    core dump may fail
-XCPU           core    core dump may fail
-XFSZ           core    core dump may fail
-.TE
-
+The behavior of signals is explained in
+.BR signal (7)
+manual page.
 .SH EXAMPLES
-.TS
-lB lB
-lfCW l.
-Command        Description
-snice seti crack +7    Slow down seti and crack
-skill \-KILL \-v /dev/pts/*    Kill users on new-style PTY devices
-skill \-STOP viro lm davem     Stop 3 users
-snice \-17 root bash   Give priority to root's shell
-.TE
-
+.TP
+.B snice seti crack +7
+Slow down seti and crack commands.
+.TP
+.B skill \-KILL \-v /dev/pts/*
+Kill users on PTY devices.
+.TP
+.B skill \-STOP viro lm davem
+Stop three users.
+.TP
+.B snice \-17 root bash
+Give priority to root's shell
 .SH "SEE ALSO"
+.BR kill (1),
+.BR kill (2),
 .BR killall (1),
+.BR nice (1),
 .BR pkill (1),
-.BR kill (1),
 .BR renice (1),
-.BR nice (1),
-.BR kill (2),
 .BR signal (7)
-
 .SH STANDARDS
 No standards apply.
-
 .SH AUTHOR
-Albert Cahalan <albert@users.sf.net> wrote skill and snice in 1999 as a
-replacement for a non-free version.
-
-Please send bug reports to <procps@freelists.org>.
+.UR albert\@users.sf.net
+Albert Cahalan
+.UE
+wrote skill and snice in 1999 as a replacement for a non-free
+version.
+.SH "REPORTING BUGS"
+Please send bug reports to
+.UR procps\@freelists.org
+.UE