X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fbusctl.xml;fp=man%2Fbusctl.xml;h=872f3f496b31396889c0ea0f5de3fe6887e6bfb6;hb=43dbecd5a31f6b247b261a5a281afecafdf1c841;hp=f56e3c14f5e051c25fa21b1d6583a3cb7992ab4d;hpb=3802a3d3d7af51ddff31943d5514382f01265770;p=elogind.git
diff --git a/man/busctl.xml b/man/busctl.xml
index f56e3c14f..872f3f496 100644
--- a/man/busctl.xml
+++ b/man/busctl.xml
@@ -345,115 +345,110 @@ 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.
+ 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
+ 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
+
+ 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:
+ 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
+ $ 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"
+
+
+
+ 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"
-
+