xref: /dragonfly/usr.bin/ipcs/ipcs.1 (revision 2cd2d2b5)
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: src/usr.bin/ipcs/ipcs.1,v 1.9.2.4 2003/04/08 11:07:51 tjr Exp $
31.\" $DragonFly: src/usr.bin/ipcs/ipcs.1,v 1.2 2003/06/17 04:29:27 dillon Exp $
32.\"
33.Dd June 18, 1994
34.Dt "IPCS" 1
35.Os
36.Sh NAME
37.Nm ipcs
38.Nd report System V interprocess communication facilities status
39.Sh SYNOPSIS
40.Nm
41.Op Fl abcmopqstMQST
42.Op Fl C Ar core
43.Op Fl N Ar system
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.  The
67.Dq maximum allowed size
68is the maximum number of bytes in a message on a message queue,
69the size of a shared memory segment,
70or the number of semaphores in a set of semaphores.
71.It Fl c
72Show the creator's name and group for active semaphores, message queues,
73and shared memory segments.
74.It Fl m
75Display information about active shared memory segments.
76.It Fl o
77Show outstanding usage for active message queues,
78and shared memory segments.  The
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.  The
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.  The access times is the time
97of the last control operation on an IPC object,
98the last send or receive of a message,
99the last attach or detach of a shared memory segment,
100or the last operation on a semaphore.
101.It Fl C Ar core
102Extract values associated with the name list from the specified
103core instead of the default
104.Dq Pa /dev/kmem .
105.It Fl M
106Display system information about shared memory.
107.It Fl N Ar system
108Extract the name list from the specified system instead of the
109default
110.Dq Pa /kernel .
111.It Fl Q
112Display system information about messages queues.
113.It Fl S
114Display system information about semaphores.
115.It Fl T
116Display system information about shared memory, message queues
117and semaphores.
118.El
119.Pp
120If none of the
121.Fl M ,
122.Fl m ,
123.Fl Q ,
124.Fl q ,
125.Fl S ,
126or
127.Fl s
128options are specified, information about all active IPC facilities is
129listed.
130.Sh RESTRICTIONS
131System data structures may change while
132.Nm
133is running; the output of
134.Nm
135is not guaranteed to be consistent.
136.Sh BUGS
137This manual page is woefully incomplete, because it does not
138at all attempt to explain the information printed by
139.Nm .
140.Sh FILES
141.Bl -tag -width /etc/passwd -compact
142.It Pa /dev/kmem
143default kernel memory
144.It Pa /kernel
145default system name list
146.El
147.Sh SEE ALSO
148.Xr ipcrm 1
149.Sh AUTHORS
150.An Thorsten Lockert Aq tholo@sigmasoft.com
151