xref: /openbsd/usr.bin/ipcs/ipcs.1 (revision a6445c1d)
1.\"	$OpenBSD: ipcs.1,v 1.23 2014/03/22 08:02:03 jmc Exp $
2.\"
3.\" Copyright (c) 1994 SigmaSoft, Th. Lockert
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd $Mdocdate: March 22 2014 $
27.Dt IPCS 1
28.Os
29.Sh NAME
30.Nm ipcs
31.Nd report System V interprocess communication facilities status
32.Sh SYNOPSIS
33.Nm ipcs
34.Op Fl abcMmopQqSsTt
35.Op Fl C Ar core
36.Op Fl N Ar system
37.Sh DESCRIPTION
38The
39.Nm
40program provides information on System V interprocess communication
41(IPC) facilities on the system.
42.Pp
43The options are as follows:
44.Bl -tag -width Ds
45.It Fl a
46Show the maximum amount of information possible when
47displaying active semaphores, message queues,
48and shared memory segments.
49(This is shorthand for specifying the
50.Fl b ,
51.Fl c ,
52.Fl o ,
53.Fl p ,
54and
55.Fl t
56options.)
57.It Fl b
58Show the maximum allowed sizes for active semaphores, message queues,
59and shared memory segments.
60The
61.Dq maximum allowed size
62is the maximum number of bytes in a message on a message queue,
63the size of a shared memory segment,
64or the number of semaphores in a set of semaphores.
65.It Fl C Ar core
66Extract values associated with the name list from the specified
67core instead of the running kernel.
68.It Fl c
69Show the creator's name and group for active semaphores, message queues,
70and shared memory segments.
71.It Fl M
72Display system information about shared memory.
73.It Fl m
74Display information about active shared memory segments.
75.It Fl N Ar system
76Extract the name list from the specified system instead of the running kernel.
77.It Fl o
78Show outstanding usage for active message queues,
79and shared memory segments.
80The
81.Dq outstanding usage
82is the number of messages in a message queue, or the number
83of processes attached to a shared memory segment.
84.It Fl p
85Show the process ID information for active semaphores, message queues,
86and shared memory segments.
87The
88.Dq process ID information
89is the last process to send a message to or receive a message from
90a message queue,
91the process that created a semaphore, or the last process to attach
92or detach a shared memory segment.
93.It Fl Q
94Display system information about messages queues.
95.It Fl q
96Display information about active message queues.
97.It Fl S
98Display system information about semaphores.
99.It Fl s
100Display information about active semaphores.
101.It Fl T
102Display system information about shared memory, message queues and semaphores.
103.It Fl t
104Show access times for active semaphores, message queues,
105and shared memory segments.
106The access times is the time
107of the last control operation on an IPC object,
108the last send or receive of a message,
109the last attach or detach of a shared memory segment,
110or the last operation on a semaphore.
111.El
112.Pp
113If none of the
114.Fl M ,
115.Fl m ,
116.Fl Q ,
117.Fl q ,
118.Fl S ,
119or
120.Fl s
121options are specified, information about all active IPC facilities is
122listed.
123.Sh RESTRICTIONS
124System data structures may change while
125.Nm
126is running; the output of
127.Nm
128is not guaranteed to be consistent.
129.Sh EXIT STATUS
130.Ex -std ipcs
131.Sh SEE ALSO
132.Xr ipcrm 1
133.Sh STANDARDS
134The
135.Nm
136utility is compliant with the
137X/Open System Interfaces option of the
138.St -p1003.1-2008
139specification.
140.Pp
141The flags
142.Op Fl CMNQST
143are extensions to that specification.
144.Sh AUTHORS
145.An Thorsten Lockert Aq Mt tholo@sigmasoft.com
146.Sh BUGS
147This manual page is woefully incomplete, because it does not
148at all attempt to explain the information printed by
149.Nm ipcs .
150