Annotation of src/usr.bin/ipcs/ipcs.1, Revision 1.14
1.14 ! miod 1: .\" $OpenBSD: ipcs.1,v 1.13 2001/09/27 19:22:04 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.
1.12 tholo 14: .\" 3. The name of the author may not be used to endorse or promote products
1.1 deraadt 15: .\" derived from this software without specific prior written permission
16: .\"
17: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27: .\"
28: .Dd June 18, 1994
1.5 aaron 29: .Dt IPCS 1
1.4 michaels 30: .Os
1.1 deraadt 31: .Sh NAME
32: .Nm ipcs
33: .Nd report System V interprocess communication facilities status
34: .Sh SYNOPSIS
35: .Nm ipcs
36: .Op Fl abcmopqstMQST
1.8 millert 37: .Op Fl C Ar core
38: .Op Fl N Ar system
1.1 deraadt 39: .Sh DESCRIPTION
40: The
1.7 aaron 41: .Nm
1.1 deraadt 42: program provides information on System V interprocess communication
43: (IPC) facilities on the system.
44: .Pp
45: The options are as follows:
46: .Bl -tag -width Ds
47: .It Fl a
48: Show the maximum amount of information possible when
49: displaying active semaphores, message queues,
50: and shared memory segments.
51: (This is shorthand for specifying the
52: .Fl b ,
53: .Fl c ,
54: .Fl o ,
55: .Fl p ,
56: and
57: .Fl t
58: options.)
59: .It Fl b
60: Show the maximum allowed sizes for active semaphores, message queues,
1.10 aaron 61: and shared memory segments.
62: The
1.1 deraadt 63: .Dq maximum allowed size
64: is the maximum number of bytes in a message on a message queue,
65: the size of a shared memory segment,
1.6 aaron 66: or the number of semaphores in a set of semaphores.
1.1 deraadt 67: .It Fl c
68: Show the creator's name and group for active semaphores, message queues,
69: and shared memory segments.
70: .It Fl m
71: Display information about active shared memory segments.
72: .It Fl o
73: Show outstanding usage for active message queues,
1.10 aaron 74: and shared memory segments.
75: The
1.1 deraadt 76: .Dq outstanding usage
77: is the number of messages in a message queue, or the number
78: of processes attached to a shared memory segment.
79: .It Fl p
80: Show the process ID information for active semaphores, message queues,
1.10 aaron 81: and shared memory segments.
82: The
1.1 deraadt 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,
1.10 aaron 94: and shared memory segments.
95: The access times is the time
1.1 deraadt 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.
1.8 millert 100: .It Fl C Ar core
101: Extract values associated with the name list from the specified
1.14 ! miod 102: core instead of the running kernel.
1.8 millert 103: .It Fl M
104: Display system information about shared memory.
105: .It Fl N Ar system
1.14 ! miod 106: Extract the name list from the specified system instead of the running kernel.
1.1 deraadt 107: .It Fl Q
108: Display system information about messages queues.
109: .It Fl S
110: Display system information about semaphores.
111: .It Fl T
1.13 millert 112: Display system information about shared memory, message queues and semaphores.
1.1 deraadt 113: .El
114: .Pp
115: If none of the
116: .Fl M ,
117: .Fl m ,
118: .Fl Q ,
119: .Fl q ,
120: .Fl S ,
121: or
122: .Fl s
123: options are specified, information about all active IPC facilities is
124: listed.
125: .Sh RESTRICTIONS
126: System data structures may change while
1.7 aaron 127: .Nm
1.1 deraadt 128: is running; the output of
1.7 aaron 129: .Nm
1.1 deraadt 130: is not guaranteed to be consistent.
131: .Sh SEE ALSO
132: .Xr ipcrm 1
1.11 aaron 133: .Sh AUTHORS
1.1 deraadt 134: Thorsten Lockert <tholo@sigmasoft.com>
1.11 aaron 135: .Sh BUGS
136: This manual page is woefully incomplete, because it does not
137: at all attempt to explain the information printed by
138: .Nm ipcs .