usr.bin/ipcs/ipcs.1

   1 .\"     $NetBSD: ipcs.1,v 1.15 2004/03/21 18:48:20 snj Exp $
   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 .\"
  26 .Dd March 21, 2004
  27 .Dt IPCS 1
  28 .Os
  29 .Sh NAME
  30 .Nm ipcs
  31 .Nd report System V interprocess communication facilities status
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Op Fl abcmopqstMQST
  35 .Bk -words
  36 .Op Fl C Ar system
  37 .Ek
  38 .Bk -words
  39 .Op Fl N Ar core
  40 .Ek
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 program 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.
  64 The
  65 .Dq maximum allowed size
  66 is the maximum number of bytes in a message on a message queue,
  67 the size of a shared memory segment,
  68 or the number of semaphores in a set of semaphores.
  69 .It Fl c
  70 Show the creator's name and group for active semaphores, message queues,
  71 and shared memory segments.
  72 .It Fl m
  73 Display information about active shared memory segments.
  74 .It Fl o
  75 Show outstanding usage for active message queues,
  76 and shared memory segments.
  77 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.
  84 The
  85 .Dq process ID information
  86 is the last process to send a message to or receive a message from
  87 a message queue,
  88 the process that created a semaphore, or the last process to attach
  89 or detach a shared memory segment.
  90 .It Fl q
  91 Display information about active message queues.
  92 .It Fl s
  93 Display information about active semaphores.
  94 .It Fl t
  95 Show access times for active semaphores, message queues,
  96 and shared memory segments.
  97 The access times is the time
  98 of the last control operation on an IPC object,
  99 the last send or receive of a message,
 100 the last attach or detach of a shared memory segment,
 101 or the last operation on a semaphore.
 102 .It Fl C Ar system
 103 Extract the name list from the specified system instead of the
 104 default
 105 .Dq Pa /netbsd .
 106 .It Fl M
 107 Display system information about shared memory.
 108 .It Fl N Ar core
 109 Extract values associated with the name list from the specified
 110 core instead of the default
 111 .Dq Pa /dev/kmem .
 112 and semaphores.
 113 .It Fl Q
 114 Display system information about messages queues.
 115 .It Fl S
 116 Display system information about semaphores.
 117 .It Fl T
 118 Display system information about shared memory, message queues
 119 and semaphores.
 120 (This is shorthand for specifying the
 121 .Fl M ,
 122 .Fl Q ,
 123 and
 124 .Fl S
 125 options.)
 126 .El
 127 .Pp
 128 If none of the
 129 .Fl M ,
 130 .Fl m ,
 131 .Fl Q ,
 132 .Fl q ,
 133 .Fl S ,
 134 .Fl s ,
 135 or
 136 .Fl T
 137 options are specified, information about all active IPC facilities is
 138 listed.
 139 .Sh RESTRICTIONS
 140 System data structures may change while
 141 .Nm
 142 is running; the output of
 143 .Nm
 144 is not guaranteed to be consistent.
 145 .Sh FILES
 146 .Bl -tag -width /etc/passwd -compact
 147 .It Pa /dev/kmem
 148 default kernel memory
 149 .It Pa /netbsd
 150 default system name list
 151 .El
 152 .Sh SEE ALSO
 153 .Xr ipcrm 1 ,
 154 .Xr shmat 2 ,
 155 .Xr shmctl 2 ,
 156 .Xr shmdt 2 ,
 157 .Xr shmget 2
 158 .Sh AUTHORS
 159 .An Thorsten Lockert Aq tholo@sigmasoft.com
 160 .Sh BUGS
 161 This manual page is woefully incomplete, because it does not
 162 at all attempt to explain the information printed by
 163 .Nm .