usr.bin/ipcs/ipcs.1

   1 .\"     $NetBSD: ipcs.1,v 1.20 2014/06/11 14:57:55 joerg 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 June 11, 2014
  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 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 program provides information on System V interprocess communication
  39 (IPC) facilities on the system.
  40 .Pp
  41 The options are as follows:
  42 .Bl -tag -width Ds
  43 .It Fl a
  44 Show the maximum amount of information possible when
  45 displaying active semaphores, message queues,
  46 and shared memory segments.
  47 (This is shorthand for specifying the
  48 .Fl b ,
  49 .Fl c ,
  50 .Fl o ,
  51 .Fl p ,
  52 and
  53 .Fl t
  54 options.)
  55 .It Fl b
  56 Show the maximum allowed sizes for active semaphores, message queues,
  57 and shared memory segments.
  58 The
  59 .Dq maximum allowed size
  60 is the maximum number of bytes in a message on a message queue,
  61 the size of a shared memory segment,
  62 or the number of semaphores in a set of semaphores.
  63 .It Fl c
  64 Show the creator's name and group for active semaphores, message queues,
  65 and shared memory segments.
  66 .It Fl m
  67 Display information about active shared memory segments.
  68 .It Fl o
  69 Show outstanding usage for active message queues,
  70 and shared memory segments.
  71 The
  72 .Dq outstanding usage
  73 is the number of messages in a message queue, or the number
  74 of processes attached to a shared memory segment.
  75 .It Fl p
  76 Show the process ID information for active semaphores, message queues,
  77 and shared memory segments.
  78 The
  79 .Dq process ID information
  80 is the last process to send a message to or receive a message from
  81 a message queue,
  82 the process that created a semaphore, or the last process to attach
  83 or detach a shared memory segment.
  84 .It Fl q
  85 Display information about active message queues.
  86 .It Fl s
  87 Display information about active semaphores.
  88 .It Fl t
  89 Show access times for active semaphores, message queues,
  90 and shared memory segments.
  91 The access times is the time
  92 of the last control operation on an IPC object,
  93 the last send or receive of a message,
  94 the last attach or detach of a shared memory segment,
  95 or the last operation on a semaphore.
  96 .It Fl M
  97 Display system information about shared memory.
  98 .It Fl Q
  99 Display system information about messages queues.
 100 .It Fl S
 101 Display system information about semaphores.
 102 .It Fl T
 103 Display system information about shared memory, message queues
 104 and semaphores.
 105 (This is shorthand for specifying the
 106 .Fl M ,
 107 .Fl Q ,
 108 and
 109 .Fl S
 110 options.)
 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 .Fl s ,
 120 or
 121 .Fl T
 122 options are specified, information about all active IPC facilities is
 123 listed.
 124 .Sh RESTRICTIONS
 125 System data structures may change while
 126 .Nm
 127 is running; the output of
 128 .Nm
 129 is not guaranteed to be consistent.
 130 .Sh SEE ALSO
 131 .Xr ipcrm 1 ,
 132 .Xr shmat 2 ,
 133 .Xr shmctl 2 ,
 134 .Xr shmdt 2 ,
 135 .Xr shmget 2
 136 .Sh AUTHORS
 137 .An Thorsten Lockert Aq Mt tholo@sigmasoft.com
 138 .Sh BUGS
 139 This manual page is woefully incomplete, because it does not
 140 at all attempt to explain the information printed by
 141 .Nm .