summaryrefslogtreecommitdiffstats
path: root/sys-utils/ipcrm.1
diff options
context:
space:
mode:
authorSami Kerola2011-09-05 21:29:54 +0200
committerSami Kerola2011-09-17 14:25:20 +0200
commit9a9ff6bd59629d09f7b3e001cc84aa3d01936fe2 (patch)
tree1a185220929cd96815a4b8d82ebe92c5ed2a0bf7 /sys-utils/ipcrm.1
parentdocs: add long options to ipcmk.1 man page (diff)
downloadkernel-qcow2-util-linux-9a9ff6bd59629d09f7b3e001cc84aa3d01936fe2.tar.gz
kernel-qcow2-util-linux-9a9ff6bd59629d09f7b3e001cc84aa3d01936fe2.tar.xz
kernel-qcow2-util-linux-9a9ff6bd59629d09f7b3e001cc84aa3d01936fe2.zip
docs: add long options to ipcrm.1 man page
Includes few style fixes from Documentation/howto-man-page.txt Signed-off-by: Sami Kerola <kerolasa@iki.fi>
Diffstat (limited to 'sys-utils/ipcrm.1')
-rw-r--r--sys-utils/ipcrm.157
1 files changed, 19 insertions, 38 deletions
diff --git a/sys-utils/ipcrm.1 b/sys-utils/ipcrm.1
index d55574516..02bff1bbc 100644
--- a/sys-utils/ipcrm.1
+++ b/sys-utils/ipcrm.1
@@ -1,42 +1,22 @@
.\" Copyright 2002 Andre C. Mazzone (linuxdev@karagee.com)
.\" May be distributed under the GNU General Public License
-.TH IPCRM 1 "March 2002" "util-linux" "User Commands"
+.TH IPCRM "1" "September 2011" "util-linux" "User Commands"
.SH NAME
ipcrm \- remove a message queue, semaphore set or shared memory id
.SH SYNOPSIS
.B ipcrm
-[
-.B \-M
-.I key
-|
-.B \-m
-.I id
-|
-.B \-Q
-.I key
-|
-.B \-q
-.I id
-|
-.B \-S
-.I key
-|
-.B \-s
-.I id
-] ...
-
-deprecated usage
-
-.BI ipcrm
-.RB { shm | msg | sem }
-.IR id ...
+[options]
+.br
+.B ipcrm
+.I <shm|msg|sem> <id>
+[...]
.SH DESCRIPTION
.I ipcrm
removes System V interprocess communication (IPC) objects
and associated data structures from the system.
In order to delete such objects, you must be superuser, or
the creator or owner of the object.
-
+.PP
System V IPC objects are of three types: shared memory,
message queues, and semaphores.
Deletion of a message queue or semaphore object is immediate
@@ -46,43 +26,42 @@ A shared memory object is only removed
after all currently attached processes have detached
.RB ( shmdt (2))
the object from their virtual address space.
-
+.PP
Two syntax styles are supported. The old Linux historical syntax specifies
a three letter keyword indicating which class of object is to be deleted,
followed by one or more IPC identifiers for objects of this type.
-
+.PP
The SUS-compliant syntax allows the specification of
zero or more objects of all three types in a single command line,
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').
-
.SH OPTIONS
.TP
-.BI \-M " shmkey"
-removes the shared memory segment created with
+\fB\-M\fR, \fB\-\-shmem\-key\fR \fIshmkey\fR
+removes the shared memorysegment created with
.I shmkey
after the last detach is performed.
.TP
-.BI \-m " shmid"
+\fB\-m\fR, \fB\-\-shmem\-id\fR \fIshmid\fR
removes the shared memory segment identified by
.I shmid
after the last detach is performed.
.TP
-.BI \-Q " msgkey"
+\fB\-Q\fR, \fB\-\-queue\-key\fR \fImsgkey\fR
removes the message queue created with
.IR msgkey .
.TP
-.BI \-q " msgid"
+\fB\-q\fR, \fB\-\-queue\-id\fR \fImsgid\fR
removes the message queue identified by
.IR msgid .
.TP
-.BI \-S " semkey"
+\fB\-S\fR, \fB\-\-semaphore\-key\fR \fIsemkey\fR
removes the semaphore created with
.IR semkey .
.TP
-.BI \-s " semid"
+\fB\-s\fR, \fB\-\-semaphore\-id\fR \fIsemid\fR
removes the semaphore identified by
.IR semid .
.LP
@@ -119,4 +98,6 @@ compatibility the previous syntax is still supported.
.BR ftok (3)
.SH AVAILABILITY
The ipcrm command is part of the util-linux package and is available from
-ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
+.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+Linux Kernel Archive
+.UE .