summaryrefslogtreecommitdiffstats
path: root/sys-utils/ipcs.1
diff options
context:
space:
mode:
authorBenno Schulenberg2014-07-16 23:09:50 +0200
committerKarel Zak2014-07-17 14:01:04 +0200
commitd179d01950df5902ca4bc2ef1589b666300518a3 (patch)
tree03d8404288a818b6425dd0d6f91c71c2a4bb41d0 /sys-utils/ipcs.1
parentfstrim: avoid TOCTOU race (diff)
downloadkernel-qcow2-util-linux-d179d01950df5902ca4bc2ef1589b666300518a3.tar.gz
kernel-qcow2-util-linux-d179d01950df5902ca4bc2ef1589b666300518a3.tar.xz
kernel-qcow2-util-linux-d179d01950df5902ca4bc2ef1589b666300518a3.zip
docs: bring four more man pages closer to standard formatting
In the IPC man pages strictly adhere to the memory, queue, semaphore order, to reduce disorientation. And for 'ipcmk', the arguments for -M and -S and -p are not optional. Add --version for 'mountpoint'. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
Diffstat (limited to 'sys-utils/ipcs.1')
-rw-r--r--sys-utils/ipcs.126
1 files changed, 14 insertions, 12 deletions
diff --git a/sys-utils/ipcs.1 b/sys-utils/ipcs.1
index 453ce5c01..6c925802f 100644
--- a/sys-utils/ipcs.1
+++ b/sys-utils/ipcs.1
@@ -1,24 +1,26 @@
.\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
.\" May be distributed under the GNU General Public License
-.TH IPCS "1" "January 2013" "util-linux" "User Commands"
+.TH IPCS "1" "July 2014" "util-linux" "User Commands"
.SH NAME
-ipcs \- provide information on IPC facilities
+ipcs \- show information on IPC facilities
.SH SYNOPSIS
.B ipcs
-.RB [ resource\-option "] [" output\-format ]
-.br
-.B ipcs
-.RB [ resource\-option ]
-.BI \-i " id"
+[options]
.SH DESCRIPTION
.B ipcs
-provides information on the inter-process communication facilities
+shows information on the inter-process communication facilities
for which the calling process has read access.
+By default it shows information about all three resources:
+shared memory segments, message queues, and semaphore arrays.
.SH OPTIONS
.TP
\fB\-i\fR, \fB\-\-id\fR \fIid\fR
-Print details only on the resource identified by
+Show full details on just the one resource element identified by
.IR id .
+This option needs to be combined with one of the three resource options:
+.BR \-m ,
+.BR \-q " or"
+.BR \-s .
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help text and exit.
@@ -27,12 +29,12 @@ Display help text and exit.
Display version information and exit.
.SS "Resource options"
.TP
-\fB\-q\fR, \fB\-\-queues\fR
-Write information about active message queues.
-.TP
\fB\-m\fR, \fB\-\-shmems\fR
Write information about active shared memory segments.
.TP
+\fB\-q\fR, \fB\-\-queues\fR
+Write information about active message queues.
+.TP
\fB\-s\fR, \fB\-\-semaphores\fR
Write information about active semaphore sets.
.TP