usr.bin/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.9.2.4 2003/04/08 11:07:51 tjr Exp $
  31 .\"
  32 .Dd September 2, 2008
  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
  40 .Op Fl abcmopqstMQST
  41 .Op Fl C Ar core
  42 .Op Fl N Ar system
  43 .Op Fl g Ar group
  44 .Op Fl u Ar user
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility provides information on System V interprocess communication
  49 (IPC) facilities on the system.
  50 .Pp
  51 The options are as follows:
  52 .Bl -tag -width Ds
  53 .It Fl a
  54 Show the maximum amount of information possible when
  55 displaying active semaphores, message queues,
  56 and shared memory segments.
  57 (This is shorthand for specifying the
  58 .Fl b ,
  59 .Fl c ,
  60 .Fl o ,
  61 .Fl p ,
  62 and
  63 .Fl t
  64 options.)
  65 .It Fl b
  66 Show the maximum allowed sizes for active semaphores, message queues,
  67 and shared memory segments.  The
  68 .Dq maximum allowed size
  69 is the maximum number of bytes in a message on a message queue,
  70 the size of a shared memory segment,
  71 or the number of semaphores in a set of semaphores.
  72 .It Fl c
  73 Show the creator's name and group for active semaphores, message queues,
  74 and shared memory segments.
  75 .It Fl g Ar group
  76 Display information about IPC mechanisms owned by
  77 .Pa group .
  78 Group specification can be in the form of a numeric GID or
  79 a group name.
  80 .It Fl m
  81 Display information about active shared memory segments.
  82 .It Fl o
  83 Show outstanding usage for active message queues,
  84 and shared memory segments.  The
  85 .Dq outstanding usage
  86 is the number of messages in a message queue, or the number
  87 of processes attached to a shared memory segment.
  88 .It Fl p
  89 Show the process ID information for active semaphores, message queues,
  90 and shared memory segments.  The
  91 .Dq process ID information
  92 is the last process to send a message to or receive a message from
  93 a message queue,
  94 the process that created a semaphore, or the last process to attach
  95 or detach a shared memory segment.
  96 .It Fl q
  97 Display information about active message queues.
  98 .It Fl s
  99 Display information about active 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 .It Fl u Ar user
 108 Display information about IPC mechanisms owned by
 109 .Pa user .
 110 User specification can be in the form of a numeric UID or
 111 a user name.
 112 .It Fl C Ar core
 113 Extract values associated with the name list from the specified
 114 core instead of the default
 115 .Dq Pa /dev/kmem .
 116 .It Fl M
 117 Display system information about shared memory.
 118 .It Fl N Ar system
 119 Extract the name list from the specified system instead of the
 120 default
 121 .Dq Pa /boot/kernel .
 122 .It Fl Q
 123 Display system information about messages queues.
 124 .It Fl S
 125 Display system information about semaphores.
 126 .It Fl T
 127 Display system information about shared memory, message queues
 128 and semaphores.
 129 .El
 130 .Pp
 131 If none of the
 132 .Fl M ,
 133 .Fl m ,
 134 .Fl Q ,
 135 .Fl q ,
 136 .Fl S ,
 137 or
 138 .Fl s
 139 options are specified, information about all active IPC facilities is
 140 listed.
 141 .Sh RESTRICTIONS
 142 System data structures may change while
 143 .Nm
 144 is running; the output of
 145 .Nm
 146 is not guaranteed to be consistent.
 147 .Sh FILES
 148 .Bl -tag -width /etc/passwd -compact
 149 .It Pa /dev/kmem
 150 default kernel memory
 151 .It Pa /boot/kernel
 152 default system name list
 153 .El
 154 .Sh SEE ALSO
 155 .Xr ipcrm 1
 156 .Sh AUTHORS
 157 .An Thorsten Lockert Aq Mt tholo@sigmasoft.com
 158 .Sh BUGS
 159 This manual page is woefully incomplete, because it does not
 160 at all attempt to explain the information printed by
 161 .Nm .