Annotation of src/usr.bin/ipcs/ipcs.1, Revision 1.9
1.9 ! aaron 1: .\" $OpenBSD: ipcs.1,v 1.8 1999/09/07 12:50:32 millert Exp $
1.1 deraadt 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 18, 1994
1.5 aaron 32: .Dt IPCS 1
1.4 michaels 33: .Os
1.1 deraadt 34: .Sh NAME
35: .Nm ipcs
36: .Nd report System V interprocess communication facilities status
37: .Sh SYNOPSIS
38: .Nm ipcs
39: .Op Fl abcmopqstMQST
1.8 millert 40: .Op Fl C Ar core
41: .Op Fl N Ar system
1.1 deraadt 42: .Sh DESCRIPTION
43: The
1.7 aaron 44: .Nm
1.1 deraadt 45: program provides information on System V interprocess communication
46: (IPC) facilities on the system.
47: .Pp
48: The options are as follows:
49: .Bl -tag -width Ds
50: .It Fl a
51: Show the maximum amount of information possible when
52: displaying active semaphores, message queues,
53: and shared memory segments.
54: (This is shorthand for specifying the
55: .Fl b ,
56: .Fl c ,
57: .Fl o ,
58: .Fl p ,
59: and
60: .Fl t
61: options.)
62: .It Fl b
63: Show the maximum allowed sizes for active semaphores, message queues,
64: and shared memory segments. The
65: .Dq maximum allowed size
66: is the maximum number of bytes in a message on a message queue,
67: the size of a shared memory segment,
1.6 aaron 68: or the number of semaphores in a set of semaphores.
1.1 deraadt 69: .It Fl c
70: Show the creator's name and group for active semaphores, message queues,
71: and shared memory segments.
72: .It Fl m
73: Display information about active shared memory segments.
74: .It Fl o
75: Show outstanding usage for active message queues,
76: and shared memory segments. The
77: .Dq outstanding usage
78: is the number of messages in a message queue, or the number
79: of processes attached to a shared memory segment.
80: .It Fl p
81: Show the process ID information for active semaphores, message queues,
82: and shared memory segments. The
83: .Dq process ID information
84: is the last process to send a message to or receive a message from
85: a message queue,
86: the process that created a semaphore, or the last process to attach
87: or detach a shared memory segment.
88: .It Fl q
89: Display information about active message queues.
90: .It Fl s
91: Display information about active semaphores.
92: .It Fl t
93: Show access times for active semaphores, message queues,
94: and shared memory segments. The access times is the time
95: of the last control operation on an IPC object,
96: the last send or receive of a message,
97: the last attach or detach of a shared memory segment,
98: or the last operation on a semaphore.
1.8 millert 99: .It Fl C Ar core
100: Extract values associated with the name list from the specified
101: core instead of the default
102: .Pa /dev/kmem .
103: .It Fl M
104: Display system information about shared memory.
105: .It Fl N Ar system
1.1 deraadt 106: Extract the name list from the specified system instead of the
107: default
1.8 millert 108: .Pa /dev/ksyms
109: (or
110: .Pa /bsd
111: if
112: .Pa /dev/ksyms
113: is not available).
1.1 deraadt 114: .It Fl Q
115: Display system information about messages queues.
116: .It Fl S
117: Display system information about semaphores.
118: .It Fl T
119: Display system information about shared memory, message queues
120: .El
121: .Pp
122: If none of the
123: .Fl M ,
124: .Fl m ,
125: .Fl Q ,
126: .Fl q ,
127: .Fl S ,
128: or
129: .Fl s
130: options are specified, information about all active IPC facilities is
131: listed.
132: .Sh RESTRICTIONS
133: System data structures may change while
1.7 aaron 134: .Nm
1.1 deraadt 135: is running; the output of
1.7 aaron 136: .Nm
1.1 deraadt 137: is not guaranteed to be consistent.
138: .Sh BUGS
139: This manual page is woefully incomplete, because it does not
140: at all attempt to explain the information printed by
141: .Nm ipcs .
142: .Sh FILES
143: .Bl -tag -width /etc/passwd -compact
144: .It Pa /dev/kmem
145: default kernel memory
1.8 millert 146: .It Pa /dev/ksyms
1.1 deraadt 147: default system name list
148: .El
149: .Sh SEE ALSO
150: .Xr ipcrm 1
151: .Sh AUTHOR
152: Thorsten Lockert <tholo@sigmasoft.com>