| blob | d029b52b529292743a9ba153be7c7130c3d430f6 |
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH IPCS 1 "Jan 17, 2008"
8 .SH NAME
9 ipcs \- report inter-process communication facilities status
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBipcs\fR [\fB-aAbciJmopqstZ\fR] [\fB-D\fR \fImtype\fR] [\fB-z\fR \fIzone\fR]
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 The \fBipcs\fR utility prints information about active inter-process
20 communication facilities. The information that is displayed is controlled by
21 the options supplied. Without options, information is printed in short format
22 for message queues, shared memory, and semaphores that are currently active in
23 the system.
24 .SH OPTIONS
25 .sp
26 .LP
27 The following options are supported:
28 .sp
29 .ne 2
30 .na
31 \fB\fB-m\fR\fR
32 .ad
33 .RS 6n
34 Prints information about active shared memory segments.
35 .RE
37 .sp
38 .ne 2
39 .na
40 \fB\fB-q\fR\fR
41 .ad
42 .RS 6n
43 Prints information about active message queues.
44 .RE
46 .sp
47 .ne 2
48 .na
49 \fB\fB-s\fR\fR
50 .ad
51 .RS 6n
52 Prints information about active semaphores.
53 .RE
55 .sp
56 .LP
57 If \fB-m\fR, \fB-q\fR, or \fB-s\fR are specified, information about only those
58 indicated is printed. If none of these three is specified, information about
59 all three is printed subject to these options:
60 .sp
61 .ne 2
62 .na
63 \fB\fB-a\fR\fR
64 .ad
65 .RS 12n
66 Uses all XCU5 print options. (This is a shorthand notation for \fB-b\fR,
67 \fB-c\fR, \fB-o\fR, \fB-p\fR, and \fB-t\fR.)
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fB\fB-A\fR\fR
74 .ad
75 .RS 12n
76 Uses all print options. (This is a shorthand notation for \fB-b\fR, \fB-c\fR,
77 \fB-i\fR, \fB-J\fR, \fB-o\fR, \fB-p\fR, and \fB-t\fR.)
78 .RE
80 .sp
81 .ne 2
82 .na
83 \fB\fB-b\fR\fR
84 .ad
85 .RS 12n
86 Prints information on biggest allowable size: maximum number of bytes in
87 messages on queue for message queues, size of segments for shared memory, and
88 number of semaphores in each set for semaphores. See below for meaning of
89 columns in a listing.
90 .RE
92 .sp
93 .ne 2
94 .na
95 \fB\fB-c\fR\fR
96 .ad
97 .RS 12n
98 Prints creator's login name and group name. See below.
99 .RE
101 .sp
102 .ne 2
103 .na
104 \fB\fB-D\fR \fImtype\fR\fR
105 .ad
106 .RS 12n
107 Displays, in hexadecimal and \fBASCII\fR, the contents of all messages of type
108 \fImtype\fR found on any message queue that the user invoking \fBipcs\fR has
109 permission to read. If \fImtype\fR is \fB0\fR, all messages are displayed. If
110 \fImtype\fR is negative, all messages with type less than or equal to the
111 absolute value of \fImtype\fR are displayed. (See \fBmsgrcv\fR(2) and
112 \fBmsgsnap\fR(2)).
113 .RE
115 .sp
116 .ne 2
117 .na
118 \fB\fB-i\fR\fR
119 .ad
120 .RS 12n
121 Prints number of \fBISM\fR attaches to shared memory segments.
122 .RE
124 .sp
125 .ne 2
126 .na
127 \fB\fB-J\fR\fR
128 .ad
129 .RS 12n
130 Prints the creator's project.
131 .RE
133 .sp
134 .ne 2
135 .na
136 \fB\fB-o\fR\fR
137 .ad
138 .RS 12n
139 Prints information on outstanding usage: number of messages on queue and total
140 number of bytes in messages on queue for message queues and number of processes
141 attached to shared memory segments.
142 .RE
144 .sp
145 .ne 2
146 .na
147 \fB\fB-p\fR\fR
148 .ad
149 .RS 12n
150 Prints process number information: process \fBID\fR of last process to send a
151 message, process \fBID\fR of last process to receive a message on message
152 queues, process \fBID\fR of creating process, and process \fBID\fR of last
153 process to attach or detach on shared memory segments. See below.
154 .RE
156 .sp
157 .ne 2
158 .na
159 \fB\fB-t\fR\fR
160 .ad
161 .RS 12n
162 Prints time information: time of the last control operation that changed the
163 access permissions for all facilities, time of last \fBmsgsnd\fR(2) and last
164 \fBmsgrcv\fR(2) on message queues, time of last \fBshmat\fR(2) and last
165 \fBshmdt\fR(2) on shared memory (see \fBshmop\fR(2)), time of last
166 \fBsemop\fR(2) on semaphores. See below.
167 .RE
169 .sp
170 .ne 2
171 .na
172 \fB\fB-z\fR \fIzone\fR\fR
173 .ad
174 .RS 12n
175 Prints information about facilities associated with the specified zone (see
176 \fBzones\fR(5)). The zone can be specified as either a name or a numeric id.
177 The default is to display information about the zone in which the command is
178 executing. Notice that this option is only useful when executing in the global
179 zone.
180 .RE
182 .sp
183 .ne 2
184 .na
185 \fB\fB-Z\fR\fR
186 .ad
187 .RS 12n
188 When executing in the global zone, prints information about all zones.
189 Otherwise, prints information about the zone in which the command is executing.
190 The output includes the zone associated with each facility.
191 .RE
193 .sp
194 .LP
195 The column headings and the meaning of the columns in an \fBipcs\fR listing are
196 given below. The letters in parentheses indicate the options that cause the
197 corresponding heading to appear and "all" means that the heading always
198 appears. \fBNote:\fR These options only determine what information is provided
199 for each facility; they do not determine which facilities are listed.
200 .sp
201 .ne 2
202 .na
203 \fB\fBT\fR (all)\fR
204 .ad
205 .RS 19n
206 Type of the facility:
207 .sp
208 .ne 2
209 .na
210 \fB\fBq\fR\fR
211 .ad
212 .RS 5n
213 message queue
214 .RE
216 .sp
217 .ne 2
218 .na
219 \fB\fBm\fR\fR
220 .ad
221 .RS 5n
222 shared memory segment
223 .RE
225 .sp
226 .ne 2
227 .na
228 \fB\fBs\fR\fR
229 .ad
230 .RS 5n
231 semaphore
232 .RE
234 .RE
236 .sp
237 .ne 2
238 .na
239 \fB\fBID\fR (all)\fR
240 .ad
241 .RS 19n
242 The identifier for the facility entry.
243 .RE
245 .sp
246 .ne 2
247 .na
248 \fB\fBKEY\fR (all)\fR
249 .ad
250 .RS 19n
251 The key used as an argument to \fBmsgget\fR(2), \fBsemget\fR(2), or
252 \fBshmget\fR(2) to create the facility entry. (\fBNote:\fR The key of a shared
253 memory segment is changed to \fBIPC_PRIVATE\fR when the segment has been
254 removed until all processes attached to the segment detach it.)
255 .RE
257 .sp
258 .ne 2
259 .na
260 \fB\fBMODE\fR (all)\fR
261 .ad
262 .RS 19n
263 The facility access modes and flags: The mode consists of 11 characters that
264 are interpreted as follows. The first two characters are:
265 .sp
266 .ne 2
267 .na
268 \fB\fBR\fR\fR
269 .ad
270 .RS 5n
271 A process is waiting on a \fBmsgrcv\fR(2).
272 .RE
274 .sp
275 .ne 2
276 .na
277 \fB\fBS\fR\fR
278 .ad
279 .RS 5n
280 A process is waiting on a \fBmsgsnd\fR(2).
281 .RE
283 .sp
284 .ne 2
285 .na
286 \fB\fB-\fR\fR
287 .ad
288 .RS 5n
289 The corresponding special flag is not set.
290 .RE
292 The next nine characters are interpreted as three sets of three bits each. The
293 first set refers to the owner's permissions; the next to permissions of others
294 in the user-group of the facility entry; and the last to all others. Within
295 each set, the first character indicates permission to read, the second
296 character indicates permission to write or alter the facility entry, and the
297 last character is currently unused.
298 .sp
299 The permissions are indicated as follows:
300 .sp
301 .ne 2
302 .na
303 \fB\fBr\fR\fR
304 .ad
305 .RS 8n
306 Read permission is granted.
307 .RE
309 .sp
310 .ne 2
311 .na
312 \fB\fBw\fR\fR
313 .ad
314 .RS 8n
315 Write permission is granted.
316 .RE
318 .sp
319 .ne 2
320 .na
321 \fB\fBa\fR\fR
322 .ad
323 .RS 8n
324 Alter permission is granted.
325 .RE
327 .sp
328 .ne 2
329 .na
330 \fB\fB\(mi\fR\fR
331 .ad
332 .RS 8n
333 The indicated permission is not granted.
334 .RE
336 .RE
338 .sp
339 .ne 2
340 .na
341 \fB\fBOWNER\fR (all)\fR
342 .ad
343 .RS 19n
344 The login name of the owner of the facility entry.
345 .RE
347 .sp
348 .ne 2
349 .na
350 \fB\fBGROUP\fR (all)\fR
351 .ad
352 .RS 19n
353 The group name of the group of the owner of the facility entry.
354 .RE
356 .sp
357 .ne 2
358 .na
359 \fB\fBCREATOR\fR (a,A,c)\fR
360 .ad
361 .RS 19n
362 The login name of the creator of the facility entry.
363 .RE
365 .sp
366 .ne 2
367 .na
368 \fB\fBCGROUP\fR (a,A,c)\fR
369 .ad
370 .RS 19n
371 The group name of the group of the creator of the facility entry.
372 .RE
374 .sp
375 .ne 2
376 .na
377 \fB\fBCBYTES\fR (a,A,o)\fR
378 .ad
379 .RS 19n
380 The number of bytes in messages currently outstanding on the associated message
381 queue.
382 .RE
384 .sp
385 .ne 2
386 .na
387 \fB\fBQNUM\fR (a,A,o)\fR
388 .ad
389 .RS 19n
390 The number of messages currently outstanding on the associated message queue.
391 .RE
393 .sp
394 .ne 2
395 .na
396 \fB\fBQBYTES\fR (a,A,b)\fR
397 .ad
398 .RS 19n
399 The maximum number of bytes allowed in messages outstanding on the associated
400 message queue.
401 .RE
403 .sp
404 .ne 2
405 .na
406 \fB\fBLSPID\fR (a,A,p)\fR
407 .ad
408 .RS 19n
409 The process \fBID\fR of the last process to send a message to the associated
410 queue.
411 .RE
413 .sp
414 .ne 2
415 .na
416 \fB\fBLRPID\fR (a,A,p)\fR
417 .ad
418 .RS 19n
419 The process \fBID\fR of the last process to receive a message from the
420 associated queue.
421 .RE
423 .sp
424 .ne 2
425 .na
426 \fB\fBSTIME\fR (a,A,t)\fR
427 .ad
428 .RS 19n
429 The time the last message was sent to the associated queue.
430 .RE
432 .sp
433 .ne 2
434 .na
435 \fB\fBRTIME\fR (a,A,t)\fR
436 .ad
437 .RS 19n
438 The time the last message was received from the associated queue.
439 .RE
441 .sp
442 .ne 2
443 .na
444 \fB\fBCTIME\fR (a,A,t)\fR
445 .ad
446 .RS 19n
447 The time when the associated entry was created or changed.
448 .RE
450 .sp
451 .ne 2
452 .na
453 \fB\fBISMATTCH\fR (a,i)\fR
454 .ad
455 .RS 19n
456 The number of \fBISM\fR attaches to the associated shared memory segments.
457 .RE
459 .sp
460 .ne 2
461 .na
462 \fB\fBNATTCH\fR (a,A,o)\fR
463 .ad
464 .RS 19n
465 The number of processes attached to the associated shared memory segment.
466 .RE
468 .sp
469 .ne 2
470 .na
471 \fB\fBSEGSZ\fR (a,A,b)\fR
472 .ad
473 .RS 19n
474 The size of the associated shared memory segment.
475 .RE
477 .sp
478 .ne 2
479 .na
480 \fB\fBCPID\fR (a,A,p)\fR
481 .ad
482 .RS 19n
483 The process \fBID\fR of the creator of the shared memory entry.
484 .RE
486 .sp
487 .ne 2
488 .na
489 \fB\fBLPID\fR (a,A,p)\fR
490 .ad
491 .RS 19n
492 The process \fBID\fR of the last process to attach or detach the shared memory
493 segment.
494 .RE
496 .sp
497 .ne 2
498 .na
499 \fB\fBATIME\fR (a,A,t)\fR
500 .ad
501 .RS 19n
502 The time the last attach was completed to the associated shared memory segment.
503 .RE
505 .sp
506 .ne 2
507 .na
508 \fB\fBDTIME\fR (a,A,t)\fR
509 .ad
510 .RS 19n
511 The time the last detach was completed on the associated shared memory segment.
512 .RE
514 .sp
515 .ne 2
516 .na
517 \fB\fBNSEMS\fR (a,A,b)\fR
518 .ad
519 .RS 19n
520 The number of semaphores in the set associated with the semaphore entry.
521 .RE
523 .sp
524 .ne 2
525 .na
526 \fB\fBOTIME\fR (a,A,t)\fR
527 .ad
528 .RS 19n
529 The time the last semaphore operation was completed on the set associated with
530 the semaphore entry.
531 .RE
533 .sp
534 .ne 2
535 .na
536 \fB\fBPROJECT\fR (J,A)\fR
537 .ad
538 .RS 19n
539 The project name of the creator of the facility entry.
540 .RE
542 .sp
543 .ne 2
544 .na
545 \fB\fBZONE\fR (Z)\fR
546 .ad
547 .RS 19n
548 The zone with which the facility is associated.
549 .RE
551 .SH ENVIRONMENT VARIABLES
552 .sp
553 .LP
554 See \fBenviron\fR(5) for descriptions of the following environment variables
555 that affect the execution of \fBipcs\fR: \fBLANG\fR, \fBLC_ALL\fR,
556 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
557 .sp
558 .ne 2
559 .na
560 \fB\fBTZ\fR\fR
561 .ad
562 .RS 6n
563 Determine the timezone for the time strings written by \fBipcs\fR.
564 .RE
566 .SH FILES
567 .sp
568 .ne 2
569 .na
570 \fB\fB/etc/group\fR\fR
571 .ad
572 .RS 15n
573 group names
574 .RE
576 .sp
577 .ne 2
578 .na
579 \fB\fB/etc/passwd\fR\fR
580 .ad
581 .RS 15n
582 user names
583 .RE
585 .SH ATTRIBUTES
586 .sp
587 .LP
588 See \fBattributes\fR(5) for descriptions of the following attributes:
589 .sp
591 .sp
592 .TS
593 box;
594 c | c
595 l | l .
596 ATTRIBUTE TYPE ATTRIBUTE VALUE
597 _
598 Interface Stability Committed
599 _
600 Standard See \fBstandards\fR(5).
601 .TE
603 .SH SEE ALSO
604 .sp
605 .LP
606 \fBipcrm\fR(1), \fBmsgget\fR(2), \fBmsgids\fR(2), \fBmsgrcv\fR(2),
607 \fBmsgsnap\fR(2), \fBmsgsnd\fR(2), \fBsemget\fR(2), \fBsemids\fR(2),
608 \fBsemop\fR(2), \fBshmctl\fR(2), \fBshmget\fR(2), \fBshmids\fR(2),
609 \fBshmop\fR(2), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5),
610 \fBzones\fR(5)
611 .SH NOTES
612 .sp
613 .LP
614 Things can change while \fBipcs\fR is running. The information it gives is
615 guaranteed to be accurate only when it was retrieved.