Annotation of src/usr.bin/ipcs/ipcs.1, Revision 1.6
1.6 ! aaron 1: .\" $OpenBSD: ipcs.1,v 1.5 1998/09/26 19:54:54 aaron Exp $
1.1 deraadt 2: .\" $NetBSD: ipcs.1,v 1.4 1995/04/15 02:31:16 cgd Exp $
3: .\"
4: .\" Copyright (c) 1994 SigmaSoft, Th. Lockert
5: .\" All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by SigmaSoft, Th. Lockert.
18: .\" 4. The name of the author may not be used to endorse or promote products
19: .\" derived from this software without specific prior written permission
20: .\"
21: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31: .\"
32: .Dd June 18, 1994
1.5 aaron 33: .Dt IPCS 1
1.4 michaels 34: .Os
1.1 deraadt 35: .Sh NAME
36: .Nm ipcs
37: .Nd report System V interprocess communication facilities status
38: .Sh SYNOPSIS
39: .Nm ipcs
40: .Op Fl abcmopqstMQST
41: .Op Fl C Ar system
42: .Op Fl N Ar core
43: .Sh DESCRIPTION
44: The
45: .Nm ipcs
46: program provides information on System V interprocess communication
47: (IPC) facilities on the system.
48: .Pp
49: The options are as follows:
50: .Bl -tag -width Ds
51: .It Fl a
52: Show the maximum amount of information possible when
53: displaying active semaphores, message queues,
54: and shared memory segments.
55: (This is shorthand for specifying the
56: .Fl b ,
57: .Fl c ,
58: .Fl o ,
59: .Fl p ,
60: and
61: .Fl t
62: options.)
63: .It Fl b
64: Show the maximum allowed sizes for active semaphores, message queues,
65: and shared memory segments. The
66: .Dq maximum allowed size
67: is the maximum number of bytes in a message on a message queue,
68: the size of a shared memory segment,
1.6 ! aaron 69: or the number of semaphores in a set of semaphores.
1.1 deraadt 70: .It Fl c
71: Show the creator's name and group for active semaphores, message queues,
72: and shared memory segments.
73: .It Fl m
74: Display information about active shared memory segments.
75: .It Fl o
76: Show outstanding usage for active message queues,
77: and shared memory segments. The
78: .Dq outstanding usage
79: is the number of messages in a message queue, or the number
80: of processes attached to a shared memory segment.
81: .It Fl p
82: Show the process ID information for active semaphores, message queues,
83: and shared memory segments. The
84: .Dq process ID information
85: is the last process to send a message to or receive a message from
86: a message queue,
87: the process that created a semaphore, or the last process to attach
88: or detach a shared memory segment.
89: .It Fl q
90: Display information about active message queues.
91: .It Fl s
92: Display information about active semaphores.
93: .It Fl t
94: Show access times for active semaphores, message queues,
95: and shared memory segments. The access times is the time
96: of the last control operation on an IPC object,
97: the last send or receive of a message,
98: the last attach or detach of a shared memory segment,
99: or the last operation on a semaphore.
100: .It Fl C Ar system
101: Extract the name list from the specified system instead of the
102: default
1.3 ccappuc 103: .Dq Pa /bsd .
1.1 deraadt 104: .It Fl M
105: Display system information about shared memory.
106: .It Fl N Ar core
107: Extract values associated with the name list from the specified
108: core instead of the default
109: .Dq Pa /dev/kmem .
110: .It Fl Q
111: Display system information about messages queues.
112: .It Fl S
113: Display system information about semaphores.
114: .It Fl T
115: Display system information about shared memory, message queues
116: .El
117: .Pp
118: If none of the
119: .Fl M ,
120: .Fl m ,
121: .Fl Q ,
122: .Fl q ,
123: .Fl S ,
124: or
125: .Fl s
126: options are specified, information about all active IPC facilities is
127: listed.
128: .Sh RESTRICTIONS
129: System data structures may change while
130: .Nm ipcs
131: is running; the output of
132: .Nm ipcs
133: is not guaranteed to be consistent.
134: .Sh BUGS
135: This manual page is woefully incomplete, because it does not
136: at all attempt to explain the information printed by
137: .Nm ipcs .
138: .Sh FILES
139: .Bl -tag -width /etc/passwd -compact
140: .It Pa /dev/kmem
141: default kernel memory
1.3 ccappuc 142: .It Pa /bsd
1.1 deraadt 143: default system name list
144: .El
145: .Sh SEE ALSO
146: .Xr ipcrm 1
147: .Sh AUTHOR
148: .Bl -tag
149: Thorsten Lockert <tholo@sigmasoft.com>
150: .El