X-Git-Url: http://git.ipfire.org/?a=blobdiff_plain;f=man%2Fbusctl.xml;h=eebc42105d3fa27a381954e5595977cabdbb959c;hb=5650ec7a11beb18390f4db081128eb3756abf064;hp=2446a8caa440020e6461828cc5adf3994cb2dc4d;hpb=4ff971ac084526e12e6234abf8f9e4312d17e36c;p=thirdparty%2Fsystemd.git diff --git a/man/busctl.xml b/man/busctl.xml index 2446a8caa44..eebc42105d3 100644 --- a/man/busctl.xml +++ b/man/busctl.xml @@ -1,27 +1,7 @@ - - - - + + + @@ -29,15 +9,6 @@ busctl systemd - - - - A monkey with a typewriter - Zbigniew - Jędrzejewski-Szmek - zbyszek@in.waw.pl - - @@ -66,6 +37,126 @@ introspect and monitor the D-Bus bus. + + Commands + + The following commands are understood: + + + + list + + Show all peers on the bus, by their service + names. By default, shows both unique and well-known names, but + this may be changed with the and + switches. This is the default + operation if no command is specified. + + + + status SERVICE + + 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). + + + + monitor SERVICE + + Dump messages being exchanged. If + SERVICE is specified, show messages + to or from this peer, identified by its well-known or unique + name. Otherwise, show all messages on the bus. Use + CtrlC + to terminate the dump. + + + + capture SERVICE + + Similar to monitor but + writes the output in pcap format (for details, see the Libpcap + File Format description). Make sure to redirect + standard output to a file. Tools like + wireshark1 + may be used to dissect and view the resulting + files. + + + + tree SERVICE + + 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. + + + + introspect SERVICE OBJECT INTERFACE + + 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. + + + + call SERVICE OBJECT INTERFACE METHOD SIGNATURE ARGUMENT + + 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. + + + + emit OBJECT INTERFACE SIGNAL SIGNATURE ARGUMENT + + Emit a signal. Takes a object path, interface name and method name. If parameters + shall be passed, a signature string is required, followed by the arguments, individually formatted as + strings. For details on the formatting used, see below. To specify the destination of the signal, + use the option. + + + + get-property SERVICE OBJECT INTERFACE PROPERTY + + 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-property SERVICE OBJECT INTERFACE PROPERTY SIGNATURE ARGUMENT + + Set the current value of an object + property. Takes a service name, object path, interface name, + property name, property signature, followed by a list of + parameters formatted as strings. + + + + help + + Show command syntax help. + + + + Options @@ -147,6 +238,7 @@ + @@ -168,6 +260,38 @@ + + + + + When used with the introspect call, dump the XML description received from + the D-Bus org.freedesktop.DBus.Introspectable.Introspect call instead of the + normal output. + + + + + MODE + + + When used with the call or get-property command, shows output + formatted as JSON. Expects one of short (for the shortest possible output without any + redundant whitespace or line breaks) or pretty (for a pretty version of the same, with + indentation and line breaks). Note that transformation from D-Bus marshalling to JSON is done in a loss-less + way, which means type information is embedded into the JSON object tree. + + + + + + + + Equivalent to when invoked interactively from a terminal. Otherwise + equivalent to , in particular when the output is piped to some other + program. + + + BOOL @@ -190,7 +314,7 @@ BOOL - When used with the call command, specifies + When used with the call or emit 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 @@ -240,125 +364,43 @@ - - - - - - - - - - - - - - Commands - - The following commands are understood: - - - - list - - Show all peers on the bus, by their service - names. By default, shows both unique and well-known names, but - this may be changed with the and - switches. This is the default - operation if no command is specified. - - - - status SERVICE - - 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). - - - - monitor SERVICE - - Dump messages being exchanged. If - SERVICE is specified, show messages - to or from this peer, identified by its well-known or unique - name. Otherwise, show all messages on the bus. Use Ctrl-C to - terminate the dump. - - - capture SERVICE + BOOL - Similar to monitor but - writes the output in pcap format (for details, see the Libpcap - File Format description). Make sure to redirect - standard output to a file. Tools like - wireshark1 - may be used to dissect and view the resulting - files. - - - - tree SERVICE - - 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. - - - - introspect SERVICE OBJECT INTERFACE - - 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. + + Controls whether to wait for the specified AF_UNIX bus socket to appear in the + file system before connecting to it. Defaults to off. When enabled, the tool will watch the file system until + the socket is created and then connect to it. + - call SERVICE OBJECT INTERFACE METHOD SIGNATURE ARGUMENT + SERVICE - 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. + + Takes a service name. When used with the emit command, a signal is + emitted to the specified service. + - - get-property SERVICE OBJECT INTERFACE PROPERTY - - 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-property SERVICE OBJECT INTERFACE PROPERTY SIGNATURE ARGUMENT + + - Set the current value of an object - property. Takes a service name, object path, interface name, - property name, property signature, followed by a list of - parameters formatted as strings. + + Do not ellipsize the output in list command. + - - help - - Show command syntax help. - + + + +