From 6f984795238a4c26a919c945d26bd4f6bc88ed91 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Thu, 14 Feb 2013 13:30:19 +0000 Subject: [PATCH 2/2] Eliminate unwanted whitespace from the man pages' XML source As demanded by the git commit hook set up by autogen.sh, this eliminates trailing whitespace on each line, and blank lines at EOF. We might as well do this now, since every line in these files has changed anyway. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=59805 Signed-off-by: Simon McVittie --- doc/dbus-cleanup-sockets.1.xml.in | 7 +++---- doc/dbus-daemon.1.xml.in | 1 - doc/dbus-launch.1.xml.in | 15 +++++++-------- doc/dbus-monitor.1.xml.in | 3 +-- doc/dbus-send.1.xml.in | 17 ++++++++--------- doc/dbus-uuidgen.1.xml.in | 7 +++---- 6 files changed, 22 insertions(+), 28 deletions(-) diff --git a/doc/dbus-cleanup-sockets.1.xml.in b/doc/dbus-cleanup-sockets.1.xml.in index 5657496..6d98083 100644 --- a/doc/dbus-cleanup-sockets.1.xml.in +++ b/doc/dbus-cleanup-sockets.1.xml.in @@ -32,15 +32,15 @@ connection sockets. See h more information about the big picture. -If given no arguments, dbus-cleanup-sockets cleans up sockets +If given no arguments, dbus-cleanup-sockets cleans up sockets in the standard default socket directory for the -per-user-login-session message bus; this is usually /tmp. +per-user-login-session message bus; this is usually /tmp. Optionally, you can pass a different directory on the command line. On Linux, this program is essentially useless, because D-Bus defaults to using "abstract sockets" that exist only in memory and don't have a -corresponding file in /tmp. +corresponding file in /tmp. On most other flavors of UNIX, it's possible for the socket files to @@ -63,4 +63,3 @@ linc-cleanup-sockets written by Michael Meeks. see http://www.freedesktop.org/software/dbus/ - diff --git a/doc/dbus-daemon.1.xml.in b/doc/dbus-daemon.1.xml.in index 8bb8348..aea2514 100644 --- a/doc/dbus-daemon.1.xml.in +++ b/doc/dbus-daemon.1.xml.in @@ -887,4 +887,3 @@ for example. see http://www.freedesktop.org/software/dbus/ - diff --git a/doc/dbus-launch.1.xml.in b/doc/dbus-launch.1.xml.in index b9f0767..fde439d 100644 --- a/doc/dbus-launch.1.xml.in +++ b/doc/dbus-launch.1.xml.in @@ -35,7 +35,7 @@ DESCRIPTION -The dbus-launch command is used to start a session bus +The dbus-launch command is used to start a session bus instance of dbus-daemon from a shell script. It would normally be called from a user's login scripts. Unlike the daemon itself, dbus-launch exits, so @@ -56,7 +56,7 @@ examples. information about the new bus to standard output. When dbus-launch prints bus information to standard output, by -default it is in a simple key-value pairs format. However, you may +default it is in a simple key-value pairs format. However, you may request several alternate syntaxes using the --sh-syntax, --csh-syntax, --binary-syntax, or --auto-syntax options. Several of these cause dbus-launch to emit shell code @@ -121,14 +121,14 @@ terminated automatically on logout. AUTOMATIC LAUNCHING If DBUS_SESSION_BUS_ADDRESS is not set for a process that tries to use D-Bus, by default the process will attempt to invoke dbus-launch with -the --autolaunch option to start up a new session bus or find the +the --autolaunch option to start up a new session bus or find the existing bus address on the X display or in a file in ~/.dbus/session-bus/ Whenever an autolaunch occurs, the application that had to start a new bus will be in its own little world; it can effectively -end up starting a whole new session if it tries to use a lot of +end up starting a whole new session if it tries to use a lot of bus services. This can be suboptimal or even totally broken, depending on the app and what it tries to do. @@ -136,7 +136,7 @@ on the app and what it tries to do. There are two common reasons for autolaunch. One is ssh to a remote machine. The ideal fix for that would be forwarding of DBUS_SESSION_BUS_ADDRESS in the same way that DISPLAY is forwarded. -In the meantime, you can edit the session.conf config file to +In the meantime, you can edit the session.conf config file to have your session bus listen on TCP, and manually set DBUS_SESSION_BUS_ADDRESS, if you like. @@ -194,7 +194,7 @@ your application. -Pass --config-file=FILENAME to the bus daemon, instead of passing it +Pass --config-file=FILENAME to the bus daemon, instead of passing it the --session argument. See the man page for dbus-daemon @@ -209,7 +209,7 @@ the --session argument. See the man page for dbus-daemon -If this option is provided, a persistent "babysitter" process will be +If this option is provided, a persistent "babysitter" process will be created that watches stdin for HUP and tries to connect to the X server. If this process gets a HUP on stdin or loses its X connection, it kills the message bus daemon. @@ -269,4 +269,3 @@ own right. see http://www.freedesktop.org/software/dbus/ - diff --git a/doc/dbus-monitor.1.xml.in b/doc/dbus-monitor.1.xml.in index 79586af..af05e3a 100644 --- a/doc/dbus-monitor.1.xml.in +++ b/doc/dbus-monitor.1.xml.in @@ -20,7 +20,7 @@ - dbus-monitor + dbus-monitor --system --session --address ADDRESS --profile --monitor watchexpressions @@ -120,4 +120,3 @@ The profiling output mode was added by Olli Salli. see http://www.freedesktop.org/software/dbus/ - diff --git a/doc/dbus-send.1.xml.in b/doc/dbus-send.1.xml.in index af4f158..78f1374 100644 --- a/doc/dbus-send.1.xml.in +++ b/doc/dbus-send.1.xml.in @@ -20,7 +20,7 @@ - dbus-send + dbus-send --system --session --dest=NAME --print-reply =literal @@ -36,12 +36,12 @@ DESCRIPTION The dbus-send command is used to send a message to a D-Bus message -bus. See http://www.freedesktop.org/software/dbus/ for more +bus. See http://www.freedesktop.org/software/dbus/ for more information about the big picture. -There are two well-known message buses: the systemwide message bus -(installed on many systems as the "messagebus" service) and the +There are two well-known message buses: the systemwide message bus +(installed on many systems as the "messagebus" service) and the per-user-login-session message bus (started each time a user logs in). The and options direct dbus-send to send messages to the system or session buses respectively. @@ -55,14 +55,14 @@ which is the name of a connection on the bus to send the message to. If The object path and the name of the message to send must always be specified. Following arguments, if any, are the message contents -(message arguments). These are given as type-specified values and +(message arguments). These are given as type-specified values and may include containers (arrays, dicts, and variants) as described below. <contents> ::= <item> | <container> [ <item> | <container>...] <item> ::= <type>:<value> <container> ::= <array> | <dict> | <variant> -<array> ::= array:<type>:<value>[,<value>...] +<array> ::= array:<type>:<value>[,<value>...] <dict> ::= dict:<type>:<type>:<key>,<value>[,<key>,<value>...] <variant> ::= variant:<type>:<value> <type> ::= string | int16 | uint 16 | int32 | uint32 | int64 | uint64 | double | byte | boolean | objpath @@ -83,11 +83,11 @@ or nested containers (e.g. arrays of variants). array:string:"1st item","next item","last item" \ dict:string:int32:"one",1,"two",2,"three",3 \ variant:int32:-8 \ - objpath:/org/freedesktop/sample/object/name + objpath:/org/freedesktop/sample/object/name -Note that the interface is separated from a method or signal +Note that the interface is separated from a method or signal name by a dot, though in the actual protocol the interface and the interface member are separate fields. @@ -156,4 +156,3 @@ The default is implementation‐defined, typically 25 seconds. see http://www.freedesktop.org/software/dbus/ - diff --git a/doc/dbus-uuidgen.1.xml.in b/doc/dbus-uuidgen.1.xml.in index 88e33ad..fbd2681 100644 --- a/doc/dbus-uuidgen.1.xml.in +++ b/doc/dbus-uuidgen.1.xml.in @@ -54,8 +54,8 @@ for a single machine until the next reboot at least. The important properties of the machine UUID are that 1) it remains -unchanged until the next reboot and 2) it is different for any two -running instances of the OS kernel. That is, if two processes see the +unchanged until the next reboot and 2) it is different for any two +running instances of the OS kernel. That is, if two processes see the same UUID, they should also see the same shared memory, UNIX domain sockets, local X displays, localhost.localdomain resolution, process IDs, and so forth. @@ -88,7 +88,7 @@ because there are two different kernels. If a filename is not given, defaults to localstatedir/lib/dbus/machine-id (localstatedir is usually /var). If this file exists and is valid, the -uuid in the file is printed on stdout. Otherwise, the command exits +uuid in the file is printed on stdout. Otherwise, the command exits with a nonzero status. @@ -124,4 +124,3 @@ On success, prints no output. see http://www.freedesktop.org/software/dbus/ - -- 1.7.10.4