xref: /minix/usr.bin/ipcs/ipcs.1 (revision 00b67f09)
1.\"	$NetBSD: ipcs.1,v 1.20 2014/06/11 14:57:55 joerg 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 June 11, 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
34.Op Fl abcmopqstMQST
35.Sh DESCRIPTION
36The
37.Nm
38program provides information on System V interprocess communication
39(IPC) facilities on the system.
40.Pp
41The options are as follows:
42.Bl -tag -width Ds
43.It Fl a
44Show the maximum amount of information possible when
45displaying active semaphores, message queues,
46and shared memory segments.
47(This is shorthand for specifying the
48.Fl b ,
49.Fl c ,
50.Fl o ,
51.Fl p ,
52and
53.Fl t
54options.)
55.It Fl b
56Show the maximum allowed sizes for active semaphores, message queues,
57and shared memory segments.
58The
59.Dq maximum allowed size
60is the maximum number of bytes in a message on a message queue,
61the size of a shared memory segment,
62or the number of semaphores in a set of semaphores.
63.It Fl c
64Show the creator's name and group for active semaphores, message queues,
65and shared memory segments.
66.It Fl m
67Display information about active shared memory segments.
68.It Fl o
69Show outstanding usage for active message queues,
70and shared memory segments.
71The
72.Dq outstanding usage
73is the number of messages in a message queue, or the number
74of processes attached to a shared memory segment.
75.It Fl p
76Show the process ID information for active semaphores, message queues,
77and shared memory segments.
78The
79.Dq process ID information
80is the last process to send a message to or receive a message from
81a message queue,
82the process that created a semaphore, or the last process to attach
83or detach a shared memory segment.
84.It Fl q
85Display information about active message queues.
86.It Fl s
87Display information about active semaphores.
88.It Fl t
89Show access times for active semaphores, message queues,
90and shared memory segments.
91The access times is the time
92of the last control operation on an IPC object,
93the last send or receive of a message,
94the last attach or detach of a shared memory segment,
95or the last operation on a semaphore.
96.It Fl M
97Display system information about shared memory.
98.It Fl Q
99Display system information about messages queues.
100.It Fl S
101Display system information about semaphores.
102.It Fl T
103Display system information about shared memory, message queues
104and semaphores.
105(This is shorthand for specifying the
106.Fl M ,
107.Fl Q ,
108and
109.Fl S
110options.)
111.El
112.Pp
113If none of the
114.Fl M ,
115.Fl m ,
116.Fl Q ,
117.Fl q ,
118.Fl S ,
119.Fl s ,
120or
121.Fl T
122options are specified, information about all active IPC facilities is
123listed.
124.Sh RESTRICTIONS
125System data structures may change while
126.Nm
127is running; the output of
128.Nm
129is not guaranteed to be consistent.
130.Sh SEE ALSO
131.Xr ipcrm 1 ,
132.Xr shmat 2 ,
133.Xr shmctl 2 ,
134.Xr shmdt 2 ,
135.Xr shmget 2
136.Sh AUTHORS
137.An Thorsten Lockert Aq Mt tholo@sigmasoft.com
138.Sh BUGS
139This manual page is woefully incomplete, because it does not
140at all attempt to explain the information printed by
141.Nm .
142