xref: /dragonfly/usr.bin/ipcs/ipcs.1 (revision 19fe1c42)
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.7 2008/09/02 11:50:45 matthias Exp $
32.\"
33.Dd September 2, 2008
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.Op Fl g Ar group
45.Op Fl u Ar user
46.Sh DESCRIPTION
47The
48.Nm
49utility 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 g Ar group
77Display information about IPC mechanisms owned by
78.Pa group .
79Group specification can be in the form of a numeric GID or
80a group name.
81.It Fl m
82Display information about active shared memory segments.
83.It Fl o
84Show outstanding usage for active message queues,
85and shared memory segments.  The
86.Dq outstanding usage
87is the number of messages in a message queue, or the number
88of processes attached to a shared memory segment.
89.It Fl p
90Show the process ID information for active semaphores, message queues,
91and shared memory segments.  The
92.Dq process ID information
93is the last process to send a message to or receive a message from
94a message queue,
95the process that created a semaphore, or the last process to attach
96or detach a shared memory segment.
97.It Fl q
98Display information about active message queues.
99.It Fl s
100Display information about active semaphores.
101.It Fl t
102Show access times for active semaphores, message queues,
103and shared memory segments.  The access times is the time
104of the last control operation on an IPC object,
105the last send or receive of a message,
106the last attach or detach of a shared memory segment,
107or the last operation on a semaphore.
108.It Fl u Ar user
109Display information about IPC mechanisms owned by
110.Pa user .
111User specification can be in the form of a numeric UID or
112a user name.
113.It Fl C Ar core
114Extract values associated with the name list from the specified
115core instead of the default
116.Dq Pa /dev/kmem .
117.It Fl M
118Display system information about shared memory.
119.It Fl N Ar system
120Extract the name list from the specified system instead of the
121default
122.Dq Pa /boot/kernel .
123.It Fl Q
124Display system information about messages queues.
125.It Fl S
126Display system information about semaphores.
127.It Fl T
128Display system information about shared memory, message queues
129and semaphores.
130.El
131.Pp
132If none of the
133.Fl M ,
134.Fl m ,
135.Fl Q ,
136.Fl q ,
137.Fl S ,
138or
139.Fl s
140options are specified, information about all active IPC facilities is
141listed.
142.Sh RESTRICTIONS
143System data structures may change while
144.Nm
145is running; the output of
146.Nm
147is not guaranteed to be consistent.
148.Sh FILES
149.Bl -tag -width /etc/passwd -compact
150.It Pa /dev/kmem
151default kernel memory
152.It Pa /boot/kernel
153default system name list
154.El
155.Sh SEE ALSO
156.Xr ipcrm 1
157.Sh AUTHORS
158.An Thorsten Lockert Aq tholo@sigmasoft.com
159.Sh BUGS
160This manual page is woefully incomplete, because it does not
161at all attempt to explain the information printed by
162.Nm .
163