]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
docs: add long options to ipcmk.1 man page
authorSami Kerola <kerolasa@iki.fi>
Mon, 5 Sep 2011 19:16:08 +0000 (21:16 +0200)
committerSami Kerola <kerolasa@iki.fi>
Sat, 17 Sep 2011 12:25:20 +0000 (14:25 +0200)
Includes few style fixes from Documentation/howto-man-page.txt

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
sys-utils/ipcmk.1

index eada9bbc37df4b0e8ec1ea591968a96ac2c0ae27..cbabd00ceb91017bead5826b03e44689a9c0e92c 100644 (file)
@@ -1,51 +1,51 @@
 .\" Copyright 2008 Hayden A. James (hayden.james@gmail.com)
 .\" May be distributed under the GNU General Public License
-.TH IPCMK 1 "March 2008" "util-linux" "User Commands"
+.TH IPCMK "1" "September 2011" "util-linux" "User Commands"
 .SH "NAME"
 ipcmk \- create various ipc resources
 .SH "SYNOPSIS"
-.B ipcmk \-h
-.br
 .B ipcmk
-.RB [ \-M
-.IR size ]
-.RB [ \-S
-.IR nsems ]
-.RB [ \-Q ]
-.RB [ \-p
-.IR mode ]
+<resource options>
+[additional options]
 .SH "DESCRIPTION"
 .B ipcmk
 allows you to create shared memory segments, message queues or semaphore arrays.
-.SH "OPTIONS"
+.SH "RESOURCE OPTIONS"
 .TP
 Resources may be specified as follows:
 .TP
-.BI \-M " size"
-shared memory segment of size
+\fB\-M\fR, \fB\-\-shmem\fR [\fIsize\fR]
+Shared memory segment of
 .I size
+bytes.
 .TP
-.BI \-S " nsems"
-semaphore array with
-.I nsems
-elements
+\fB\-S\fR, \fB\-\-semaphore\fR [\fInumber\fR]
+Semaphore array with
+.I number
+of elements.
 .TP
-.BI \-Q
-message queue
+\fB\-Q\fR, \fB\-\-queue\fR
+Message queue.
+.SH "ADDITIONAL OPTIONS"
 .TP
-Other options
+\fB\-p\fR, \fB\-\-mode\fR [\fImode\fR]
+Permission for the resource. Default is 0644.
 .TP
-.BI \-p " mode"
-permission for the resource (default is 0644)
+\fB\-h\fR, \fB\-\-help\fR
+Display a short help message and exit.
 .TP
-.B \-h
-display a short help message and exit
+\fB\-V\fR, \fB\-\-version\fR
+Output version information and exit.
 .PP
 .SH "SEE ALSO"
 .BR ipcrm (1),
 .BR ipcs (1)
 .SH "AUTHOR"
-Hayden A. James (hayden.james@gmail.com)
+.UR hayden.james\@gmail.com
+Hayden A. James
+.UE
 .SH "AVAILABILITY"
 The ipcmk 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 .