X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fbusctl.xml;h=251233bb96310fa3882ce193c36ec57f3a7f63dd;hb=dd2fd155901a965ec0efa3adc460b33d2048d4c2;hp=7947c8d2c86dfcc8ed07c0482774107b0afb40f1;hpb=88ae7333ee052e64607ae6678fe0e84991fe3482;p=elogind.git
diff --git a/man/busctl.xml b/man/busctl.xml
index 7947c8d2c..251233bb9 100644
--- a/man/busctl.xml
+++ b/man/busctl.xml
@@ -1,24 +1,24 @@
-
+
.
The following options are understood:
-
-
-
-
-
- Execute the operation remotely. Specify a hostname, or
- username and hostname separated by @, to
- connect to. This will use SSH to talk to the remote systemd
- instance.
-
-
-
-
-
-
-
- Execute the operation on a local container.
- Specify a container name to connect to.
-
-
@@ -144,21 +124,127 @@ along with systemd; If not, see .
-
+
+
+
+ When used with the capture command
+ specifies the maximum bus message size to capture
+ ("snaplen"). Defaults to 4096 bytes.
+
+
+
+
+
+
+
+ When used with the tree command shows a
+ flat list of object paths instead of a tree.
+
+
+
+
+
- Do not print the legend,
- i.e. the column headers and the
- footer.
+ When used with the call command
+ suppresses display of the response message payload. Note that even
+ if this option is specified errors returned will still be
+ printed and the tool will indicate success or failure with
+ the process exit code.
+
+
+
+
+
+
+
+ When used with the call or
+ get-property command shows output in a
+ more verbose format.
+
+
+
+
+ BOOL
+
+
+ When used with the call command
+ specifies whether busctl shall wait for
+ completion of the method call, output the returned method
+ response data, and return success or failure via the process
+ exit code. If this is set to no the
+ method call will be issued but no response is expected, the
+ tool terminates immediately, and thus no response can be
+ shown, and no success or failure is returned via the exit
+ code. To only suppress output of the reply message payload
+ use above. Defaults to
+ yes.
+
+
+
+
+ BOOL
+
+
+ When used with the call command specifies
+ whether the method call should implicitly activate the
+ called service should it not be running yet but is
+ configured to be auto-started. Defaults to
+ yes.
+
+
+
+
+ BOOL
+
+
+ When used with the call command
+ specifies whether the services may enforce interactive
+ authorization while executing the operation, if the security
+ policy is configured for this. Defaults to
+ yes.
+
+
+
+
+ SECS
+
+
+ When used with the call command
+ specifies the maximum time to wait for method call
+ completion. If no time unit is specified assumes
+ seconds. The usual other units are understood, too (ms, us,
+ s, min, h, d, w, month, y). Note that this timeout does not
+ apply if is used as the
+ tool does not wait for any reply message then. When not
+ specified or when set to 0 the default of
+ 25s is assumed.
+
+
+
+
+ BOOL
+
+
+ Controls whether credential data reported by
+ list or status shall
+ be augmented with data from
+ /proc. When this is turned on the data
+ shown is possibly inconsistent, as the data read from
+ /proc might be more recent than rest of
+ the credential information. Defaults to yes.
+
+
+
+
-
@@ -171,24 +257,93 @@ along with systemd; If not, see .
list
- Show endpoints attached to the bus. This is
- the default if no command is specified.
+ Show service names on the bus. This is the
+ default if no command is specified.
+
+
+
+ statusSERVICE
+
+ Show process information and credentials of a
+ bus service (if one is specified by its unique or well-known
+ name), a process (if one is specified by its numeric PID), or
+ the owner of the bus (if no parameter is
+ specified).
- monitorNAME
+ monitorSERVICEDump messages being exchanged. If
- NAME is specified, show messages
+ SERVICE is specified, show messages
to or from this endpoint. Otherwise, show all messages on the
- bus.
+ bus. Use Ctrl-C to terminate dump.
- statusNAME
+ captureSERVICE
+
+ Similar to monitor but
+ writes the output in pcap format (for details see the Libpcap
+ File Format description. Make sure to redirect the
+ output to STDOUT to a file. Tools like
+ wireshark1
+ may be used to dissect and view the generated
+ files.
+
- Show process information and credentials of a
- bus endpoint.
+
+ treeSERVICE
+
+ Shows an object tree of one or more
+ services. If SERVICE is specified,
+ show object tree of the specified services only. Otherwise,
+ show all object trees of all services on the bus that acquired
+ at least one well-known name.
+
+
+
+ introspectSERVICEOBJECTINTERFACE
+
+ Show interfaces, methods, properties and
+ signals of the specified object (identified by its path) on
+ the specified service. If the interface argument is passed the
+ output is limited to members of the specified
+ interface.
+
+
+
+ callSERVICEOBJECTINTERFACEMETHODSIGNATUREARGUMENT
+
+ Invoke a method and show the response. Takes a
+ service name, object path, interface name and method name. If
+ parameters shall be passed to the method call a signature
+ string is required, followed by the arguments, individually
+ formatted as strings. For details on the formatting used, see
+ below. To suppress output of the returned data use the
+ option.
+
+
+
+ get-propertySERVICEOBJECTINTERFACEPROPERTY
+
+ Retrieve the current value of one or more
+ object properties. Takes a service name, object path,
+ interface name and property name. Multiple properties may be
+ specified at once in which case their values will be shown one
+ after the other, separated by newlines. The output is by
+ default in terse format. Use for a
+ more elaborate output format.
+
+
+
+ set-propertySERVICEOBJECTINTERFACEPROPERTYSIGNATUREARGUMENT
+
+ Set the current value an object
+ property. Takes a service name, object path, interface name,
+ property name, property signature, followed by a list of
+ parameters formatted as strings.
@@ -199,6 +354,113 @@ along with systemd; If not, see .
+
+ Parameter Formatting
+
+ The call and
+ set-property commands take a signature string
+ followed by a list of parameters formatted as string (for details
+ on D-Bus signature strings see the Type
+ system chapter of the D-Bus specification). For simple
+ types each parameter following the signature should simply be the
+ parameter's value formatted as string. Positive boolean values may
+ be formatted as true, yes,
+ on, 1; negative boolean
+ values may be specified as false,
+ no, off,
+ 0. For arrays, a numeric argument for the
+ number of entries followed by the entries shall be specified. For
+ variants the signature of the contents shall be specified,
+ followed by the contents. For dictionaries and structs the
+ contents of them shall be directly specified.
+
+ For example,
+ s jawoll is the formatting
+ of a single string jawoll.
+
+
+ as 3 hello world foobar
+ is the formatting of a string array with three entries,
+ hello, world and
+ foobar.
+
+
+ a{sv} 3 One s Eins Two u 2 Yes b true
+ is the formatting of a dictionary
+ array that maps strings to variants, consisting of three
+ entries. The string One is assigned the
+ string Eins. The string
+ Two is assigned the 32bit unsigned
+ integer 2. The string Yes is assigned a
+ positive boolean.
+
+ Note that the call,
+ get-property, introspect
+ commands will also generate output in this format for the returned
+ data. Since this format is sometimes too terse to be easily
+ understood, the call and
+ get-property commands may generate a more
+ verbose, multi-line output when passed the
+ option.
+
+
+
+ Examples
+
+
+ Write and Read a Property
+
+ The following two commands first write a property and then
+ read it back. The property is found on the
+ /org/freedesktop/systemd1 object of the
+ org.freedesktop.systemd1 service. The name of
+ the property is LogLevel on the
+ org.freedesktop.systemd1.Manager
+ interface. The property contains a single string:
+
+ # busctl set-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager LogLevel s debug
+# busctl get-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager LogLevel
+s "debug"
+
+
+
+
+ Terse and Verbose Output
+
+ The following two commands read a property that contains
+ an array of strings, and first show it in terse format, followed
+ by verbose format:
+
+ $ busctl get-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager Environment
+as 2 "LANG=en_US.UTF-8" "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin"
+$ busctl get-property --verbose org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager Environment
+ARRAY "s" {
+ STRING "LANG=en_US.UTF-8";
+ STRING "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin";
+};
+
+
+
+ Invoking a Method
+
+ The following command invokes a the
+ StartUnit method on the
+ org.freedesktop.systemd1.Manager
+ interface of the
+ /org/freedesktop/systemd1 object
+ of the org.freedesktop.systemd1
+ service, and passes it two strings
+ cups.service and
+ replace. As result of the method
+ call a single object path parameter is received and
+ shown:
+
+ # busctl call org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager StartUnit ss "cups.service" "replace"
+o "/org/freedesktop/systemd1/job/42684"
+
+
+
See Also
@@ -209,7 +471,8 @@ along with systemd; If not, see .
sd-bus3,
systemd1,
systemd-bus-proxyd8,
- machinectl1
+ machinectl1,
+ wireshark1