xref: /netbsd/usr.bin/ipcs/ipcs.1 (revision c4a72b64)
1.\"	$NetBSD: ipcs.1,v 1.12 2002/06/16 22:43:30 wiz 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.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"      This product includes software developed by SigmaSoft, Th. Lockert.
17.\" 4. The name of the author may not be used to endorse or promote products
18.\"    derived from this software without specific prior written permission
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.Dd June 17, 2002
32.Dt IPCS 1
33.Os
34.Sh NAME
35.Nm ipcs
36.Nd report System V interprocess communication facilities status
37.Sh SYNOPSIS
38.Nm
39.Op Fl abcmopqstMQST
40.Bk -words
41.Op Fl C Ar system
42.Ek
43.Bk -words
44.Op Fl N Ar core
45.Ek
46.Sh DESCRIPTION
47The
48.Nm
49program provides information on System V interprocess communication
50(IPC) facilities on the system.
51.Pp
52The options are as follows:
53.Bl -tag -width Ds
54.It Fl a
55Show the maximum amount of information possible when
56displaying active semaphores, message queues,
57and shared memory segments.
58(This is shorthand for specifying the
59.Fl b ,
60.Fl c ,
61.Fl o ,
62.Fl p ,
63and
64.Fl t
65options.)
66.It Fl b
67Show the maximum allowed sizes for active semaphores, message queues,
68and shared memory segments.  The
69.Dq maximum allowed size
70is the maximum number of bytes in a message on a message queue,
71the size of a shared memory segment,
72or the number of semaphores in a set of semaphores.
73.It Fl c
74Show the creator's name and group for active semaphores, message queues,
75and shared memory segments.
76.It Fl m
77Display information about active shared memory segments.
78.It Fl o
79Show outstanding usage for active message queues,
80and shared memory segments.  The
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.  The
87.Dq process ID information
88is the last process to send a message to or receive a message from
89a message queue,
90the process that created a semaphore, or the last process to attach
91or detach a shared memory segment.
92.It Fl q
93Display information about active message queues.
94.It Fl s
95Display information about active semaphores.
96.It Fl t
97Show access times for active semaphores, message queues,
98and shared memory segments.  The 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 system
104Extract the name list from the specified system instead of the
105default
106.Dq Pa /netbsd .
107.It Fl M
108Display system information about shared memory.
109.It Fl N Ar core
110Extract values associated with the name list from the specified
111core instead of the default
112.Dq Pa /dev/kmem .
113and semaphores.
114.It Fl Q
115Display system information about messages queues.
116.It Fl S
117Display system information about semaphores.
118.It Fl T
119Display system information about shared memory, message queues
120and semaphores.
121.El
122.Pp
123If none of the
124.Fl M ,
125.Fl m ,
126.Fl Q ,
127.Fl q ,
128.Fl S ,
129or
130.Fl s
131options are specified, information about all active IPC facilities is
132listed.
133.Sh RESTRICTIONS
134System data structures may change while
135.Nm
136is running; the output of
137.Nm
138is not guaranteed to be consistent.
139.Sh FILES
140.Bl -tag -width /etc/passwd -compact
141.It Pa /dev/kmem
142default kernel memory
143.It Pa /netbsd
144default system name list
145.El
146.Sh SEE ALSO
147.Xr ipcrm 1 ,
148.Xr shmat 2 ,
149.Xr shmctl 2 ,
150.Xr shmdt 2 ,
151.Xr shmget 2
152.Sh AUTHORS
153.An Thorsten Lockert Aq tholo@sigmasoft.com
154.Sh BUGS
155This manual page is woefully incomplete, because it does not
156at all attempt to explain the information printed by
157.Nm "" .
158