xref: /freebsd/usr.bin/ipcs/ipcs.1 (revision a35d88931c87cfe6bd38f01d7bad22140b3b38f3)
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.\" $FreeBSD$
31.\"
32.Dd March 24, 2004
33.Dt "IPCS" 1
34.Os
35.Sh NAME
36.Nm ipcs
37.Nd report System V interprocess communication facilities status
38.Sh SYNOPSIS
39.Nm
40.Op Fl abcmopqstMQSTy
41.Op Fl C Ar core
42.Op Fl N Ar system
43.Op Fl u Ar user
44.Sh DESCRIPTION
45The
46.Nm
47utility provides information on System V interprocess communication
48(IPC) facilities on the system.
49.Pp
50The options are as follows:
51.Bl -tag -width Ds
52.It Fl a
53Show the maximum amount of information possible when
54displaying active semaphores, message queues,
55and shared memory segments.
56(This is shorthand for specifying the
57.Fl b ,
58.Fl c ,
59.Fl o ,
60.Fl p ,
61and
62.Fl t
63options.)
64.It Fl b
65Show the maximum allowed sizes for active semaphores, message queues,
66and shared memory segments.
67The
68.Dq maximum allowed size
69is the maximum number of bytes in a message on a message queue,
70the size of a shared memory segment,
71or the number of semaphores in a set of semaphores.
72.It Fl c
73Show the creator's name and group for active semaphores, message queues,
74and shared memory segments.
75.It Fl m
76Display information about active shared memory segments.
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 information about active message queues.
95.It Fl s
96Display information about active semaphores.
97.It Fl t
98Show access times for active semaphores, message queues,
99and shared memory segments.
100The access times is the time
101of the last control operation on an IPC object,
102the last send or receive of a message,
103the last attach or detach of a shared memory segment,
104or the last operation on a semaphore.
105.It Fl C Ar core
106Extract values associated with the name list from the specified
107core instead of the default
108.Pa /dev/kmem .
109Implies
110.Fl y .
111.It Fl M
112Display system information about shared memory.
113.It Fl N Ar system
114Extract the name list from the specified system instead of the
115default
116.Pa /boot/kernel/kernel .
117Implies
118.Fl y .
119.It Fl Q
120Display system information about messages queues.
121.It Fl S
122Display system information about semaphores.
123.It Fl T
124Display system information about shared memory, message queues
125and semaphores.
126.It Fl y
127Use the
128.Xr kvm 3
129interface instead of the
130.Xr sysctl 3
131interface to extract the required information.
132If
133.Nm
134is to operate on the running system,
135using
136.Xr kvm 3
137will require read privileges to
138.Pa /dev/kmem .
139.It Fl u Ar user
140Display information about IPC mechanisms owned by
141.Pa user .
142User specification can be in the form of a numeric UID or
143a login name.
144.El
145.Pp
146If none of the
147.Fl M ,
148.Fl m ,
149.Fl Q ,
150.Fl q ,
151.Fl S ,
152or
153.Fl s
154options are specified, information about all active IPC facilities is
155listed.
156.Sh RESTRICTIONS
157System data structures may change while
158.Nm
159is running; the output of
160.Nm
161is not guaranteed to be consistent.
162.Sh BUGS
163This manual page is woefully incomplete, because it does not
164at all attempt to explain the information printed by
165.Nm .
166.Sh FILES
167.Bl -tag -width /boot/kernel/kernel -compact
168.It Pa /dev/kmem
169default kernel memory
170.It Pa /boot/kernel/kernel
171default system name list
172.El
173.Sh SEE ALSO
174.Xr ipcrm 1
175.Sh AUTHORS
176.An Thorsten Lockert Aq tholo@sigmasoft.com
177