Annotation of src/usr.bin/ipcs/ipcs.1, Revision 1.11
1.11 ! aaron 1: .\" $OpenBSD: ipcs.1,v 1.10 2000/03/08 03:11:29 aaron 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,
1.10 aaron 64: and shared memory segments.
65: The
1.1 deraadt 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,
1.10 aaron 77: and shared memory segments.
78: The
1.1 deraadt 79: .Dq outstanding usage
80: is the number of messages in a message queue, or the number
81: of processes attached to a shared memory segment.
82: .It Fl p
83: Show the process ID information for active semaphores, message queues,
1.10 aaron 84: and shared memory segments.
85: The
1.1 deraadt 86: .Dq process ID information
87: is the last process to send a message to or receive a message from
88: a message queue,
89: the process that created a semaphore, or the last process to attach
90: or detach a shared memory segment.
91: .It Fl q
92: Display information about active message queues.
93: .It Fl s
94: Display information about active semaphores.
95: .It Fl t
96: Show access times for active semaphores, message queues,
1.10 aaron 97: and shared memory segments.
98: The access times is the time
1.1 deraadt 99: of the last control operation on an IPC object,
100: the last send or receive of a message,
101: the last attach or detach of a shared memory segment,
102: or the last operation on a semaphore.
1.8 millert 103: .It Fl C Ar core
104: Extract values associated with the name list from the specified
105: core instead of the default
106: .Pa /dev/kmem .
107: .It Fl M
108: Display system information about shared memory.
109: .It Fl N Ar system
1.1 deraadt 110: Extract the name list from the specified system instead of the
111: default
1.8 millert 112: .Pa /dev/ksyms
113: (or
114: .Pa /bsd
115: if
116: .Pa /dev/ksyms
117: is not available).
1.1 deraadt 118: .It Fl Q
119: Display system information about messages queues.
120: .It Fl S
121: Display system information about semaphores.
122: .It Fl T
123: Display system information about shared memory, message queues
124: .El
125: .Pp
126: If none of the
127: .Fl M ,
128: .Fl m ,
129: .Fl Q ,
130: .Fl q ,
131: .Fl S ,
132: or
133: .Fl s
134: options are specified, information about all active IPC facilities is
135: listed.
136: .Sh RESTRICTIONS
137: System data structures may change while
1.7 aaron 138: .Nm
1.1 deraadt 139: is running; the output of
1.7 aaron 140: .Nm
1.1 deraadt 141: is not guaranteed to be consistent.
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
1.11 ! aaron 151: .Sh AUTHORS
1.1 deraadt 152: Thorsten Lockert <tholo@sigmasoft.com>
1.11 ! aaron 153: .Sh BUGS
! 154: This manual page is woefully incomplete, because it does not
! 155: at all attempt to explain the information printed by
! 156: .Nm ipcs .