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