summaryrefslogtreecommitdiffstats
path: root/sys-utils/ipcrm.1
diff options
context:
space:
mode:
authorBenno Schulenberg2014-07-25 14:55:01 +0200
committerKarel Zak2014-07-28 11:16:53 +0200
commit5e43af7e345310f734cbfb5a0bd6ee040cf178a7 (patch)
tree66ebfcc75105d5cba715f2526b1f528c14b9aba8 /sys-utils/ipcrm.1
parentcfdisk: reenable cursor when quitting (diff)
downloadkernel-qcow2-util-linux-5e43af7e345310f734cbfb5a0bd6ee040cf178a7.tar.gz
kernel-qcow2-util-linux-5e43af7e345310f734cbfb5a0bd6ee040cf178a7.tar.xz
kernel-qcow2-util-linux-5e43af7e345310f734cbfb5a0bd6ee040cf178a7.zip
docs: fix some things that were overlooked during the first pass
Mainly more option sorting, some formatting adjustments, and the adding of a missing --version here and there. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
Diffstat (limited to 'sys-utils/ipcrm.1')
-rw-r--r--sys-utils/ipcrm.148
1 files changed, 27 insertions, 21 deletions
diff --git a/sys-utils/ipcrm.1 b/sys-utils/ipcrm.1
index bdec3b831..6f58d0fcf 100644
--- a/sys-utils/ipcrm.1
+++ b/sys-utils/ipcrm.1
@@ -37,49 +37,55 @@ with objects specified either by key or by identifier (see below).
Both keys and identifiers may be specified in decimal, hexadecimal
(specified with an initial '0x' or '0X'), or octal (specified with
an initial '0').
+.PP
+The details of the removes are described in
+.BR shmctl (2),
+.BR msgctl (2),
+and
+.BR semctl (2).
+The identifiers and keys can be found by using
+.BR ipcs (1).
.SH OPTIONS
.TP
-\fB\-M\fR, \fB\-\-shmem\-key\fR \fIshmkey\fR
+\fB-a\fR, \fB\-\-all\fR [\fBshm\fR] [\fBmsg\fR] [\fBsem\fR]
+Remove all resources. When an option argument is provided, the removal is
+performed only for the specified resource types. \fIWarning!\fR Do not use
+.B \-a
+if you are unsure how the software using the resources might react to missing
+objects. Some programs create these resources at startup and may not have
+any code to deal with an unexpected disappearance.
+.TP
+.BR \-M , " \-\-shmem-key " \fIshmkey
Remove the shared memory segment created with
.I shmkey
after the last detach is performed.
.TP
-\fB\-m\fR, \fB\-\-shmem\-id\fR \fIshmid\fR
+.BR \-m , " \-\-shmem-id " \fIshmid
Remove the shared memory segment identified by
.I shmid
after the last detach is performed.
.TP
-\fB\-Q\fR, \fB\-\-queue\-key\fR \fImsgkey\fR
+.BR \-Q , " \-\-queue-key " \fImsgkey
Remove the message queue created with
.IR msgkey .
.TP
-\fB\-q\fR, \fB\-\-queue\-id\fR \fImsgid\fR
+.BR \-q , " \-\-queue-id " \fImsgid
Remove the message queue identified by
.IR msgid .
.TP
-\fB\-S\fR, \fB\-\-semaphore\-key\fR \fIsemkey\fR
+.BR \-S , " \-\-semaphore-key " \fIsemkey
Remove the semaphore created with
.IR semkey .
.TP
-\fB\-s\fR, \fB\-\-semaphore\-id\fR \fIsemid\fR
+.BR \-s , " \-\-semaphore-id " \fIsemid
Remove the semaphore identified by
.IR semid .
.TP
-\fB-a\fR, \fB\-\-all\fR [\fBshm\fR] [\fBmsg\fR] [\fBsem\fR]
-Remove all resources. When an option argument is provided, the removal is
-performed only for the specified resource types. \fIWarning!\fR Do not use
-.B \-a
-if you are unsure how the software using the resources might react to missing
-objects. Some programs create these resources at startup and may not have
-any code to deal with an unexpected disappearance.
-.LP
-The details of the removes are described in
-.BR shmctl (2),
-.BR msgctl (2),
-and
-.BR semctl (2).
-The identifiers and keys can be found by using
-.BR ipcs (1).
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
.SH NOTES
In its first Linux implementation, \fBipcrm\fR used the deprecated syntax
shown in the second line of the