man/busctl.1

   1 '\" t
   2 .TH "BUSCTL" "1" "" "systemd 217" "busctl"
   3 .\" -----------------------------------------------------------------
   4 .\" * Define some portability stuff
   5 .\" -----------------------------------------------------------------
   6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 .\" http://bugs.debian.org/507673
   8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
   9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10 .ie \n(.g .ds Aq \(aq
  11 .el       .ds Aq '
  12 .\" -----------------------------------------------------------------
  13 .\" * set default formatting
  14 .\" -----------------------------------------------------------------
  15 .\" disable hyphenation
  16 .nh
  17 .\" disable justification (adjust text to left margin only)
  18 .ad l
  19 .\" -----------------------------------------------------------------
  20 .\" * MAIN CONTENT STARTS HERE *
  21 .\" -----------------------------------------------------------------
  22 .SH "NAME"
  23 busctl \- Introspect the bus
  24 .SH "SYNOPSIS"
  25 .HP \w'\fBbusctl\fR\ 'u
  26 \fBbusctl\fR [OPTIONS...] [COMMAND] [\fINAME\fR...]
  27 .SH "DESCRIPTION"
  28 .PP
  29 \fBbusctl\fR
  30 may be used to introspect and monitor the D\-Bus bus\&.
  31 .SH "OPTIONS"
  32 .PP
  33 The following options are understood:
  34 .PP
  35 \fB\-\-address=\fR\fB\fIADDRESS\fR\fR
  36 .RS 4
  37 Connect to the bus specified by
  38 \fIADDRESS\fR
  39 instead of using suitable defaults for either the system or user bus (see
  40 \fB\-\-system\fR
  41 and
  42 \fB\-\-user\fR
  43 options)\&.
  44 .RE
  45 .PP
  46 \fB\-\-show\-machine\fR
  47 .RS 4
  48 When showing the list of endpoints, show a column containing the names of containers they belong to\&. See
  49 \fBsystemd-machined.service\fR(8)\&.
  50 .RE
  51 .PP
  52 \fB\-\-unique\fR
  53 .RS 4
  54 When showing the list of endpoints, show only "unique" names (of the form
  55 ":\fInumber\fR\&.\fInumber\fR")\&.
  56 .RE
  57 .PP
  58 \fB\-\-acquired\fR
  59 .RS 4
  60 The opposite of
  61 \fB\-\-unique\fR
  62 \(em only "well\-known" names will be shown\&.
  63 .RE
  64 .PP
  65 \fB\-\-activatable\fR
  66 .RS 4
  67 When showing the list of endpoints, show only endpoints which have actually not been activated yet, but may be started automatically if accessed\&.
  68 .RE
  69 .PP
  70 \fB\-\-match=\fR\fB\fIMATCH\fR\fR
  71 .RS 4
  72 When showing messages being exchanged, show only the subset matching
  73 \fIMATCH\fR\&.
  74 .RE
  75 .PP
  76 \fB\-\-no\-legend\fR
  77 .RS 4
  78 Do not print the legend, i\&.e\&. the column headers and the footer\&.
  79 .RE
  80 .PP
  81 \fB\-\-user\fR
  82 .RS 4
  83 Talk to the service manager of the calling user, rather than the service manager of the system\&.
  84 .RE
  85 .PP
  86 \fB\-\-system\fR
  87 .RS 4
  88 Talk to the service manager of the system\&. This is the implied default\&.
  89 .RE
  90 .PP
  91 \fB\-H\fR, \fB\-\-host=\fR
  92 .RS 4
  93 Execute the operation remotely\&. Specify a hostname, or a username and hostname separated by
  94 "@", to connect to\&. The hostname may optionally be suffixed by a container name, separated by
  95 ":", which connects directly to a specific container on the specified host\&. This will use SSH to talk to the remote machine manager instance\&. Container names may be enumerated with
  96 \fBmachinectl \-H \fR\fB\fIHOST\fR\fR\&.
  97 .RE
  98 .PP
  99 \fB\-M\fR, \fB\-\-machine=\fR
 100 .RS 4
 101 Execute operation on a local container\&. Specify a container name to connect to\&.
 102 .RE
 103 .PP
 104 \fB\-h\fR, \fB\-\-help\fR
 105 .RS 4
 106 Print a short help text and exit\&.
 107 .RE
 108 .PP
 109 \fB\-\-version\fR
 110 .RS 4
 111 Print a short version string and exit\&.
 112 .RE
 113 .PP
 114 \fB\-\-no\-pager\fR
 115 .RS 4
 116 Do not pipe output into a pager\&.
 117 .RE
 118 .SH "COMMANDS"
 119 .PP
 120 The following commands are understood:
 121 .PP
 122 \fBlist\fR
 123 .RS 4
 124 Show endpoints attached to the bus\&. This is the default if no command is specified\&.
 125 .RE
 126 .PP
 127 \fBmonitor\fR [\fINAME\fR...]
 128 .RS 4
 129 Dump messages being exchanged\&. If
 130 \fINAME\fR
 131 is specified, show messages to or from this endpoint\&. Otherwise, show all messages on the bus\&.
 132 .RE
 133 .PP
 134 \fBstatus\fR \fINAME\fR
 135 .RS 4
 136 Show process information and credentials of a bus endpoint\&.
 137 .RE
 138 .PP
 139 \fBhelp\fR
 140 .RS 4
 141 Show command syntax help\&.
 142 .RE
 143 .SH "SEE ALSO"
 144 .PP
 145 \fBdbus-daemon\fR(1),
 146 \m[blue]\fBD\-Bus\fR\m[]\&\s-2\u[1]\d\s+2,
 147 \m[blue]\fBkdbus\fR\m[]\&\s-2\u[2]\d\s+2,
 148 \fBsd-bus\fR(3),
 149 \fBsystemd\fR(1),
 150 \fBsystemd-bus-proxyd\fR(8),
 151 \fBmachinectl\fR(1)
 152 .SH "NOTES"
 153 .IP " 1." 4
 154 D-Bus
 155 .RS 4
 156 \%http://freedesktop.org/wiki/Software/dbus
 157 .RE
 158 .IP " 2." 4
 159 kdbus
 160 .RS 4
 161 \%https://code.google.com/p/d-bus/
 162 .RE