[BACK]Return to ipcs.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / ipcs

Annotation of src/usr.bin/ipcs/ipcs.1, Revision 1.19

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