]> git.ipfire.org Git - thirdparty/util-linux.git/blobdiff - sys-utils/ipcs.1
scriptreplay: check for EOF
[thirdparty/util-linux.git] / sys-utils / ipcs.1
index 652c0f33066690b2c4d0ff11d1d2493903da3038..93c35e323809b6638aee5a753f2f2e16cfd16573 100644 (file)
@@ -1,67 +1,95 @@
 .\" 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" "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 [ \-asmq ]
-.RB [ \-tclup ]
-.br
-.B ipcs
-.RB [ \-smq ]
-.BI \-i " id"
-.br
-.B ipcs \-h
+[options]
 .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:
+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
-.B \-m
-shared memory segments
+\fB\-i\fR, \fB\-\-id\fR \fIid\fR
+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
-.B \-q
-message queues
+\fB\-h\fR, \fB\-\-help\fR
+Display help text and exit.
 .TP
-.B \-s
-semaphore arrays
+\fB\-V\fR, \fB\-\-version\fR
+Display version information and exit.
+.SS "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 three resources (default).
+.SS "Output formats"
+Of these options only one takes effect: the last one specified.
 .TP
-.B \-l
-limits
+\fB\-c\fR, \fB\-\-creator\fR
+Show creator and owner.
 .TP
-.B \-u
-summary
+\fB\-l\fR, \fB\-\-limits\fR
+Show resource limits.
+.TP
+\fB\-p\fR, \fB\-\-pid\fR
+Show PIDs of creator and last operator.
+.TP
+\fB\-t\fR, \fB\-\-time\fR
+Write time information.  The time of the last control operation that changed
+the access permissions for all facilities, the time of the last
+.BR msgsnd (2)
+and
+.BR msgrcv (2)
+operations on message queues, the time of the last
+.BR shmat (2)
+and
+.BR shmdt (2)
+operations on shared memory, and the time of the last
+.BR semop (2)
+operation on semaphores.
+.TP
+\fB\-u\fR, \fB\-\-summary\fR
+Show status summary.
+.SS "Representation"
+These affect only the \fB\-l\fR (\fB\-\-limits\fR) option.
+.TP
+\fB\-b\fR, \fB\-\-bytes\fR
+Print sizes in bytes.
+.TP
+.B \-\-human
+Print sizes in human-readable format.
 .SH SEE ALSO
+.BR ipcmk (1),
 .BR ipcrm (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
+The Linux version does not support the POSIX
+.BR \-a ,
 .B \-b
 and
 .B \-o
@@ -69,7 +97,7 @@ options, but does support the
 .B \-l
 and
 .B \-u
-options not defined by POSIX. The portable application shall not use the
+options not defined by POSIX.  A portable application shall not use the
 .BR \-a ,
 .BR \-b ,
 .BR \-o ,
@@ -78,7 +106,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 https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+Linux Kernel Archive
+.UE .