xref: /netbsd-src/usr.bin/ipcs/ipcs.1 (revision 46f5119e40af2e51998f686b2fdcc76b5488f7f3)
1.\"	$NetBSD: ipcs.1,v 1.16 2004/09/15 19:45:17 hubertf 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 March 21, 2004
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.Bk -words
36.Op Fl C Ar system
37.Ek
38.Bk -words
39.Op Fl N Ar core
40.Ek
41.Sh DESCRIPTION
42The
43.Nm
44program provides information on System V interprocess communication
45(IPC) facilities on the system.
46.Pp
47The options are as follows:
48.Bl -tag -width Ds
49.It Fl a
50Show the maximum amount of information possible when
51displaying active semaphores, message queues,
52and shared memory segments.
53(This is shorthand for specifying the
54.Fl b ,
55.Fl c ,
56.Fl o ,
57.Fl p ,
58and
59.Fl t
60options.)
61.It Fl b
62Show the maximum allowed sizes for active semaphores, message queues,
63and shared memory segments.
64The
65.Dq maximum allowed size
66is the maximum number of bytes in a message on a message queue,
67the size of a shared memory segment,
68or the number of semaphores in a set of semaphores.
69.It Fl c
70Show the creator's name and group for active semaphores, message queues,
71and shared memory segments.
72.It Fl m
73Display information about active shared memory segments.
74.It Fl o
75Show outstanding usage for active message queues,
76and shared memory segments.
77The
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.
84The
85.Dq process ID information
86is the last process to send a message to or receive a message from
87a message queue,
88the process that created a semaphore, or the last process to attach
89or detach a shared memory segment.
90.It Fl q
91Display information about active message queues.
92.It Fl s
93Display information about active semaphores.
94.It Fl t
95Show access times for active semaphores, message queues,
96and shared memory segments.
97The access times is the time
98of the last control operation on an IPC object,
99the last send or receive of a message,
100the last attach or detach of a shared memory segment,
101or the last operation on a semaphore.
102.It Fl C Ar system
103Extract the name list from the specified system instead of the
104default
105.Dq Pa /netbsd .
106.It Fl M
107Display system information about shared memory.
108.It Fl N Ar core
109Extract values associated with the name list from the specified
110core instead of the default
111.Dq Pa /dev/kmem .
112and semaphores.
113.It Fl Q
114Display system information about messages queues.
115.It Fl S
116Display system information about semaphores.
117.It Fl T
118Display system information about shared memory, message queues
119and semaphores.
120(This is shorthand for specifying the
121.Fl M ,
122.Fl Q ,
123and
124.Fl S
125options.)
126.El
127.Pp
128If none of the
129.Fl M ,
130.Fl m ,
131.Fl Q ,
132.Fl q ,
133.Fl S ,
134.Fl s ,
135or
136.Fl T
137options are specified, information about all active IPC facilities is
138listed.
139.Sh RESTRICTIONS
140System data structures may change while
141.Nm
142is running; the output of
143.Nm
144is not guaranteed to be consistent.
145.Sh FILES
146.Bl -tag -width /etc/passwd -compact
147.It Pa /dev/kmem
148default kernel memory
149.It Pa /netbsd
150default system name list
151.El
152.Sh SEE ALSO
153.Xr ipcrm 1 ,
154.Xr shmat 2 ,
155.Xr shmctl 2 ,
156.Xr shmdt 2 ,
157.Xr shmget 2
158.Sh AUTHORS
159.An Thorsten Lockert Aq tholo@sigmasoft.com
160.Sh BUGS
161This manual page is woefully incomplete, because it does not
162at all attempt to explain the information printed by
163.Nm .
164