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$
  31 .\"
  32 .Dd March 24, 2004
  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 abcmopqstMQSTy
  41 .Op Fl C Ar core
  42 .Op Fl N Ar system
  43 .Op Fl u Ar user
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility provides information on System V interprocess communication
  48 (IPC) facilities on the system.
  49 .Pp
  50 The options are as follows:
  51 .Bl -tag -width Ds
  52 .It Fl a
  53 Show the maximum amount of information possible when
  54 displaying active semaphores, message queues,
  55 and shared memory segments.
  56 (This is shorthand for specifying the
  57 .Fl b ,
  58 .Fl c ,
  59 .Fl o ,
  60 .Fl p ,
  61 and
  62 .Fl t
  63 options.)
  64 .It Fl b
  65 Show the maximum allowed sizes for active semaphores, message queues,
  66 and shared memory segments.
  67 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 m
  76 Display information about active shared memory segments.
  77 .It Fl o
  78 Show outstanding usage for active message queues,
  79 and shared memory segments.
  80 The
  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,
  86 and shared memory segments.
  87 The
  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.
  93 .It Fl q
  94 Display information about active message queues.
  95 .It Fl s
  96 Display information about active semaphores.
  97 .It Fl t
  98 Show access times for active semaphores, message queues,
  99 and shared memory segments.
 100 The access times is the time
 101 of the last control operation on an IPC object,
 102 the last send or receive of a message,
 103 the last attach or detach of a shared memory segment,
 104 or the last operation on a semaphore.
 105 .It Fl C Ar core
 106 Extract values associated with the name list from the specified
 107 core instead of the default
 108 .Pa /dev/kmem .
 109 Implies
 110 .Fl y .
 111 .It Fl M
 112 Display system information about shared memory.
 113 .It Fl N Ar system
 114 Extract the name list from the specified system instead of the
 115 default
 116 .Pa /boot/kernel/kernel .
 117 Implies
 118 .Fl y .
 119 .It Fl Q
 120 Display system information about messages queues.
 121 .It Fl S
 122 Display system information about semaphores.
 123 .It Fl T
 124 Display system information about shared memory, message queues
 125 and semaphores.
 126 .It Fl y
 127 Use the
 128 .Xr kvm 3
 129 interface instead of the
 130 .Xr sysctl 3
 131 interface to extract the required information.
 132 If
 133 .Nm
 134 is to operate on the running system,
 135 using
 136 .Xr kvm 3
 137 will require read privileges to
 138 .Pa /dev/kmem .
 139 .It Fl u Ar user
 140 Display information about IPC mechanisms owned by
 141 .Pa user .
 142 User specification can be in the form of a numeric UID or
 143 a login name.
 144 .El
 145 .Pp
 146 If none of the
 147 .Fl M ,
 148 .Fl m ,
 149 .Fl Q ,
 150 .Fl q ,
 151 .Fl S ,
 152 or
 153 .Fl s
 154 options are specified, information about all active IPC facilities is
 155 listed.
 156 .Sh RESTRICTIONS
 157 System data structures may change while
 158 .Nm
 159 is running; the output of
 160 .Nm
 161 is not guaranteed to be consistent.
 162 .Sh FILES
 163 .Bl -tag -width /boot/kernel/kernel -compact
 164 .It Pa /dev/kmem
 165 default kernel memory
 166 .It Pa /boot/kernel/kernel
 167 default system name list
 168 .El
 169 .Sh SEE ALSO
 170 .Xr ipcrm 1
 171 .Sh AUTHORS
 172 .An Thorsten Lockert Aq tholo@sigmasoft.com
 173 .Sh BUGS
 174 This manual page is woefully incomplete, because it does not
 175 at all attempt to explain the information printed by
 176 .Nm .