]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
docs: add long options to ipcs.1 man page
authorSami Kerola <kerolasa@iki.fi>
Mon, 5 Sep 2011 20:05:37 +0000 (22:05 +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
and align information by what is being said by The Open Group.

http://pubs.opengroup.org/onlinepubs/009604599/utilities/ipcs.html

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

index 652c0f33066690b2c4d0ff11d1d2493903da3038..7c094c832ed6cb9c6ae9907604edbe4712495876 100644 (file)
@@ -1,64 +1,80 @@
 .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
 .\" May be distributed under the GNU General Public License
-.TH IPCS 1 "February 2008" "util-linux" "User Commands"
+.TH IPCS "1" "September 2011" "util-linux" "User Commands"
 .SH NAME
 ipcs \- provide information on ipc facilities
 .SH SYNOPSIS
 .B ipcs
-.RB [ \-asmq ]
-.RB [ \-tclup ]
+[resource] [...] [output\-format]
 .br
 .B ipcs
-.RB [ \-smq ]
-.BI \-i " id"
-.br
-.B ipcs \-h
+[resource]
+.I \-i id
 .SH DESCRIPTION
 .B ipcs
 provides information on the ipc facilities for which the calling process
 has read access.
-
-The
-.B \-i
-option allows a specific resource
-.I id
-to be specified.  Only information on this
-.I id
-will be printed.
-
-Resources may be specified as follows:
+.SH OPTIONS
 .TP
-.B \-m
-shared memory segments
+\fB\-i\fR, \fB\-\-id\fR \fIid\fR
+Print details only on resource identified by
+.IR id .
 .TP
-.B \-q
-message queues
+\fB\-h\fR, \fB\-\-help\fR
+Display this help and exit.
 .TP
-.B \-s
-semaphore arrays
+\fB\-V\fR, \fB\-\-version\fR
+Output version information and exit.
+.SH "RESOURCE OPTIONS"
 .TP
-.B \-a
-all (this is the default)
-.PP
-The output format may be specified as follows:
+\fB\-m\fR, \fB\-\-shmems\fR
+Write information about active shared memory segments.
 .TP
-.B \-t
-time
+\fB\-q\fR, \fB\-\-queues\fR
+Write information about active message queues.
 .TP
-.B \-p
-pid
+\fB\-s\fR, \fB\-\-semaphores\fR
+Write information about active semaphore sets.
 .TP
-.B \-c
-creator
+\fB\-a\fR, \fB\-\-all\fR
+Write information about all resources (default).
+.SH "OUTPUT FORMATS"
 .TP
-.B \-l
-limits
+\fB\-t\fR, \fB\-\-time\fR
+Write time information. Time of the last control operation that changed the
+access permissions for all facilities, time of the last
+.I msgsnd()
+and
+.I msgrcv()
+operations on message queues, time of the last
+.I shmat()
+and
+.I shmdt()
+operations on shared memory, and time of the last
+.I semop()
+operation on semaphores.
 .TP
-.B \-u
-summary
+\fB\-p\fR, \fB\-\-pid\fR
+Show creator and last operations PIDs.
+.TP
+\fB\-c\fR, \fB\-\-creator\fR
+Show creator and owner.
+.TP
+\fB\-l\fR, \fB\-\-limits\fR
+Show resource limits.
+.TP
+\fB\-u\fR, \fB\-\-summary\fR
+Show status summary.
 .SH SEE ALSO
 .BR ipcrm (1),
-.BR ipcmk (1)
+.BR ipcmk (1),
+.BR msgrcv (2),
+.BR msgsnd (2),
+.BR semget (2),
+.BR semop (2),
+.BR shmat (2),
+.BR shmdt (2),
+.BR shmget (2)
 .SH CONFORMING TO
 The Linux ipcs utility is not fully compatible to the POSIX ipcs utility.
 The Linux version does not support the
@@ -70,7 +86,6 @@ options, but does support the
 and
 .B \-u
 options not defined by POSIX. The portable application shall not use the
-.BR \-a ,
 .BR \-b ,
 .BR \-o ,
 .BR \-l ,
@@ -78,7 +93,11 @@ and
 .B \-u
 options.
 .SH AUTHOR
-krishna balasubramanian (balasub@cis.ohio-state.edu)
+.UR balasub@cis.ohio-state.edu
+Krishna Balasubramanian
+.UE
 .SH AVAILABILITY
 The ipcs 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 .