xref: /freebsd/usr.bin/ipcs/ipcs.1 (revision 7f3dea244c40159a41ab22da77a434d7c5b5e85a)
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.\"	$Id: ipcs.1,v 1.7 1997/07/15 09:55:58 charnier Exp $
31.\"
32.Dd June 18, 1994
33.Dt "IPCS" 1
34.Os FreeBSD 2.0
35.Sh NAME
36.Nm ipcs
37.Nd report System V interprocess communication facilities status
38.Sh SYNOPSIS
39.Nm
40.Op Fl abcmopqstMQST
41.Op Fl C Ar system
42.Op Fl N Ar core
43.Sh DESCRIPTION
44The
45.Nm
46program provides information on System V interprocess communication
47(IPC) facilities on the system.
48.Pp
49The options are as follows:
50.Bl -tag -width Ds
51.It Fl a
52Show the maximum amount of information possible when
53displaying active semaphores, message queues,
54and shared memory segments.
55(This is shorthand for specifying the
56.Fl b ,
57.Fl c ,
58.Fl o ,
59.Fl p ,
60and
61.Fl t
62options.)
63.It Fl b
64Show the maximum allowed sizes for active semaphores, message queues,
65and shared memory segments.  The
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.  The
78.Dq outstanding usage
79is the number of messages in a message queue, or the number
80of processes attached to a shared memory segment.
81.It Fl p
82Show the process ID information for active semaphores, message queues,
83and shared memory segments.  The
84.Dq process ID information
85is the last process to send a message to or receive a message from
86a message queue,
87the process that created a semaphore, or the last process to attach
88or detach a shared memory segment.
89.It Fl q
90Display information about active message queues.
91.It Fl s
92Display information about active semaphores.
93.It Fl t
94Show access times for active semaphores, message queues,
95and shared memory segments.  The access times is the time
96of the last control operation on an IPC object,
97the last send or receive of a message,
98the last attach or detach of a shared memory segment,
99or the last operation on a semaphore.
100.It Fl C Ar system
101Extract the name list from the specified system instead of the
102default
103.Dq Pa /kernel .
104.It Fl M
105Display system information about shared memory.
106.It Fl N Ar core
107Extract values associated with the name list from the specified
108core instead of the default
109.Dq Pa /dev/kmem .
110.It Fl Q
111Display system information about messages queues.
112.It Fl S
113Display system information about semaphores.
114.It Fl T
115Display system information about shared memory, message queues
116and semaphores.
117.El
118.Pp
119If none of the
120.Fl M ,
121.Fl m ,
122.Fl Q ,
123.Fl q ,
124.Fl S ,
125or
126.Fl s
127options are specified, information about all active IPC facilities is
128listed.
129.Sh RESTRICTIONS
130System data structures may change while
131.Nm
132is running; the output of
133.Nm
134is not guaranteed to be consistent.
135.Sh BUGS
136This manual page is woefully incomplete, because it does not
137at all attempt to explain the information printed by
138.Nm ipcs .
139.Sh FILES
140.Bl -tag -width /etc/passwd -compact
141.It Pa /dev/kmem
142default kernel memory
143.It Pa /kernel
144default system name list
145.El
146.Sh SEE ALSO
147.Xr ipcrm 1
148.Sh AUTHORS
149.An Thorsten Lockert Aq tholo@sigmasoft.com
150