ipcs/ipcs.1

   1 .\"
   2 .\" Copyright (c) 1994 SigmaSoft, Th. Lockert
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"      This product includes software developed by SigmaSoft, Th. Lockert.
  16 .\" 3. The name of the author may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD: src/usr.bin/ipcs/ipcs.1,v 1.16 2003/05/21 21:07:28 ru Exp $
  31 .\"
  32 .Dd June 18, 1994
  33 .Dt "IPCS" 1
  34 .Os
  35 .Sh NAME
  36 .Nm ipcs
  37 .Nd report System V interprocess communication facilities status
  38 .Sh SYNOPSIS
  39 .Nm ipcs
  40 .Op Fl abcMmopQqSsTt
  41 .Sh DESCRIPTION
  42 The
  43 .Nm ipcs
  44 utility provides information on System V interprocess communication
  45 (IPC) facilities on the system.
  46 .Pp
  47 The options are as follows:
  48 .Bl -tag -width Ds
  49 .It Fl a
  50 Show the maximum amount of information possible when
  51 displaying active semaphores, message queues,
  52 and shared memory segments.
  53 (This is shorthand for specifying the
  54 .Fl b ,
  55 .Fl c ,
  56 .Fl o ,
  57 .Fl p ,
  58 and
  59 .Fl t
  60 options.)
  61 .It Fl b
  62 Show the maximum allowed sizes for active semaphores, message queues,
  63 and shared memory segments.  The
  64 .Dq maximum allowed size
  65 is the maximum number of bytes in a message on a message queue,
  66 the size of a shared memory segment,
  67 or the number of semaphores in a set of semaphores.
  68 .It Fl c
  69 Show the creator's name and group for active semaphores, message queues,
  70 and shared memory segments.
  71 .It Fl M
  72 Display system information about shared memory.
  73 .It Fl m
  74 Display information about active shared memory segments.
  75 .It Fl o
  76 Show outstanding usage for active message queues,
  77 and shared memory segments.  The
  78 .Dq outstanding usage
  79 is the number of messages in a message queue, or the number
  80 of processes attached to a shared memory segment.
  81 .It Fl p
  82 Show the process ID information for active semaphores, message queues,
  83 and shared memory segments.  The
  84 .Dq process ID information
  85 is the last process to send a message to or receive a message from
  86 a message queue,
  87 the process that created a semaphore, or the last process to attach
  88 or detach a shared memory segment.
  89 .It Fl Q
  90 Display system information about messages queues.
  91 .It Fl q
  92 Display information about active message queues.
  93 .It Fl S
  94 Display system information about semaphores.
  95 .It Fl s
  96 Display information about active semaphores.
  97 .It Fl T
  98 Display system information about shared memory, message queues
  99 and semaphores.
 100 .It Fl t
 101 Show access times for active semaphores, message queues,
 102 and shared memory segments.  The access times is the time
 103 of the last control operation on an IPC object,
 104 the last send or receive of a message,
 105 the last attach or detach of a shared memory segment,
 106 or the last operation on a semaphore.
 107 .El
 108 .Pp
 109 If none of the
 110 .Fl M ,
 111 .Fl m ,
 112 .Fl Q ,
 113 .Fl q ,
 114 .Fl S ,
 115 or
 116 .Fl s
 117 options are specified, information about all active IPC facilities is
 118 listed.
 119 .Sh RESTRICTIONS
 120 System data structures may change while
 121 .Nm ipcs
 122 is running; the output of
 123 .Nm ipcs
 124 is not guaranteed to be consistent.
 125 .Sh BUGS
 126 This manual page is woefully incomplete, because it does not
 127 at all attempt to explain the information printed by
 128 .Nm ipcs .
 129 .Sh SEE ALSO
 130 .Xr ipcrm 1
 131 .Sh AUTHORS
 132 .An Thorsten Lockert Aq tholo@sigmasoft.com