sys-utils/lsipc.1

   1 .\" Copyright 2015 Ondrej Oprala(ooprala@redhat.com)
   2 .\" May be distributed under the GNU General Public License
   3 .TH LSIPC "1" "June 2015" "util-linux" "User Commands"
   4 .SH NAME
   5 lsipc \- show information on IPC facilities currently employed in the system
   6 .SH SYNOPSIS
   7 .B lsipc
   8 [options]
   9 .SH DESCRIPTION
  10 .B lsipc
  11 shows information on the inter-process communication facilities
  12 for which the calling process has read access.
  13 .SH OPTIONS
  14 .TP
  15 \fB\-i\fR, \fB\-\-id\fR \fIid\fR
  16 Show full details on just the one resource element identified by
  17 .IR id .
  18 This option needs to be combined with one of the three resource options:
  19 .BR \-m ,
  20 .BR \-q " or"
  21 .BR \-s .
  22 The default \fB\-\-id\fR output format is possible to override by
  23 the \fB\-\-list \-\-raw \-\-json\fR or \fB\-\-export\fR options.
  24 .TP
  25 \fB\-g\fR, \fB\-\-global\fR
  26 Show system-wide usage and limits for a single IPC type.
  27 This option may be combined with one of the three resource options:
  28 .BR \-m ,
  29 .BR \-q " or"
  30 .BR \-s .
  31 The default is to show information about all resources.
  32 .TP
  33 \fB\-h\fR, \fB\-\-help\fR
  34 Display help text and exit.
  35 .TP
  36 \fB\-V\fR, \fB\-\-version\fR
  37 Display version information and exit.
  38 .SS "Resource options"
  39 .TP
  40 \fB\-m\fR, \fB\-\-shmems\fR
  41 Write information about active shared memory segments.
  42 .TP
  43 \fB\-q\fR, \fB\-\-queues\fR
  44 Write information about active message queues.
  45 .TP
  46 \fB\-s\fR, \fB\-\-semaphores\fR
  47 Write information about active semaphore sets.
  48 .SS "Output formats"
  49 .TP
  50 \fB\-c\fR, \fB\-\-creator\fR
  51 Show creator and owner.
  52 .TP
  53 \fB\-e\fR, \fB\-\-export\fR
  54 Output data in the format of NAME=VALUE.
  55 .TP
  56 \fB\-J\fR, \fB\-\-json\fR
  57 Use the JSON output format.
  58 .TP
  59 \fB\-l\fR, \fB\-\-list\fR
  60 Use the list output format. This is the default except for \fB\-\-id\fR.
  61 .TP
  62 \fB\-n\fR, \fB\-\-newline\fR
  63 Display each piece of information on a separate line.
  64 .TP
  65 \fB\-\-noheadings\fR
  66 Do not print a header line.
  67 .TP
  68 \fB\-\-notruncate\fR
  69 Don't truncate output.
  70 .TP
  71 \fB\-o\fR, \fB\-\-output \fIlist\fP
  72 Specify which output columns to print.  Use
  73 .B \-\-help
  74 to get a list of all supported columns.
  75 .TP
  76 \fB\-p\fR, \fB\-\-pid\fR
  77 Show PIDs of creator and last operator.
  78 .TP
  79 \fB\-r\fR, \fB\-\-raw\fR
  80 Raw output (no columnation).
  81 .TP
  82 \fB\-t\fR, \fB\-\-time\fR
  83 Write time information.  The time of the last control operation that changed
  84 the access permissions for all facilities, the time of the last
  85 .I msgsnd()
  86 and
  87 .I msgrcv()
  88 operations on message queues, the time of the last
  89 .I shmat()
  90 and
  91 .I shmdt()
  92 operations on shared memory, and the time of the last
  93 .I semop()
  94 operation on semaphores.
  95 .TP
  96 \fB\-\-time\-format\fR \fItype\fP
  97 Display dates in short, full or iso format.  The default is short, this time
  98 format is designed to be space efficient and human readable.
  99
 100 .SH EXIT STATUS
 101 .TP
 102 0
 103 if OK,
 104 .TP
 105 1
 106 if incorrect arguments specified,
 107 .TP
 108 2
 109 if a serious error occurs.
 110 .SH SEE ALSO
 111 .BR ipcrm (1),
 112 .BR ipcmk (1),
 113 .BR msgrcv (2),
 114 .BR msgsnd (2),
 115 .BR semget (2),
 116 .BR semop (2),
 117 .BR shmat (2),
 118 .BR shmdt (2),
 119 .BR shmget (2)
 120 .SH HISTORY
 121 The \fBlsipc\fP utility is inspired by the \fBipcs\fP utility.
 122 .SH AUTHORS
 123 .MT ooprala@redhat.com
 124 Ondrej Oprala
 125 .ME
 126 .br
 127 .MT kzak@redhat.com
 128 Karel Zak
 129 .ME
 130
 131 .SH AVAILABILITY
 132 The lsipc command is part of the util-linux package and is available from
 133 .UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
 134 Linux Kernel Archive
 135 .UE .