From 909f413d3c572baadf9b13e36e1e90beba42af86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 26 Jun 2013 08:03:53 -0400 Subject: [PATCH] man: always supply quotes around literals When manpages are displayed on a terminal, s are indistinguishable from surrounding text. Add quotes everywhere, remove duplicate quotes, and tweak a few lists for consistent formatting. https://bugzilla.redhat.com/show_bug.cgi?id=874631 --- man/crypttab.xml | 2 +- man/custom-html.xsl | 6 ++ man/custom-man.xsl | 9 +++ man/daemon.xml | 2 +- man/journalctl.xml | 21 +++--- man/systemd-analyze.xml | 2 +- man/systemd-halt.service.xml | 10 +-- man/systemd-suspend.service.xml | 14 ++-- man/systemd.device.xml | 2 +- man/systemd.journal-fields.xml | 12 ++-- man/systemd.service.xml | 24 +++---- man/systemd.unit.xml | 8 +-- man/udev.xml | 117 ++++++++++++++++---------------- 13 files changed, 123 insertions(+), 106 deletions(-) diff --git a/man/crypttab.xml b/man/crypttab.xml index deb577b9de..1063b46e06 100644 --- a/man/crypttab.xml +++ b/man/crypttab.xml @@ -68,7 +68,7 @@ describes encrypted block devices that are set up during system boot. - Empty lines and lines starting with the # + Empty lines and lines starting with the # character are ignored. Each of the remaining lines describes one encrypted block device, fields on the line are delimited by white space. The first two diff --git a/man/custom-html.xsl b/man/custom-html.xsl index dde9d7af0e..060af2e56a 100644 --- a/man/custom-html.xsl +++ b/man/custom-html.xsl @@ -172,6 +172,12 @@
+ + " + + " + + diff --git a/man/custom-man.xsl b/man/custom-man.xsl index 753e5715e3..e1b8d3618a 100644 --- a/man/custom-man.xsl +++ b/man/custom-man.xsl @@ -52,4 +52,13 @@ + + + + + " + + " + + diff --git a/man/daemon.xml b/man/daemon.xml index 1283799473..de362c1b71 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -547,7 +547,7 @@ systemd, kernel devices appearing in the sysfs/udev device tree can be exposed as units if they are tagged with the string - "systemd". Like any other + systemd. Like any other kind of unit they may then pull in other units when activated (i.e. Plugged in) and thus implement device-based activation. Systemd diff --git a/man/journalctl.xml b/man/journalctl.xml index 564634b757..fa29c4103c 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -84,7 +84,7 @@ alternatives, i.e. the resulting output will show entries matching any of the specified matches for the same field. Finally, if the character - "+" appears as separate word on the + + appears as separate word on the command line all matches before and after are combined in a disjunction (i.e. logical OR). @@ -415,14 +415,15 @@ Start showing entries on or newer than the specified date, or on or older than the specified - date, respectively. Date specifications should be of - the format "2012-10-30 18:17:16". If - the time part is omitted, 00:00:00 is - assumed. If only the seconds component - is omitted, :00 is assumed. If the - date component is omitted, the - current day is assumed. Alternatively - the strings + date, respectively. Date specifications + should be of the format + 2012-10-30 18:17:16. + If the time part is omitted, + 00:00:00 is assumed. + If only the seconds component is omitted, + :00 is assumed. If the + date component is omitted, the current + day is assumed. Alternatively the strings yesterday, today, tomorrow are @@ -681,7 +682,7 @@ journalctl _SYSTEMD_UNIT=avahi-daemon.service _SYSTEMD_UNIT=dbus.service - If the separator "+" is used + If the separator + is used two expressions may be combined in a logical OR. The following will show all messages from the Avahi service process with the PID 28097 plus all messages diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index ae7a3377c6..cecf1bf4d3 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -243,7 +243,7 @@ Examples This plots all dependencies of any unit whose - name starts with "avahi-daemon.": + name starts with avahi-daemon.: $ systemd-analyze dot 'avahi-daemon.*' | dot -Tsvg > avahi.svg $ eog avahi.svg diff --git a/man/systemd-halt.service.xml b/man/systemd-halt.service.xml index 6a6bfdc7d7..812281e60d 100644 --- a/man/systemd-halt.service.xml +++ b/man/systemd-halt.service.xml @@ -89,10 +89,10 @@ executables in /usr/lib/systemd/system-shutdown/ and pass one arguments to them: either - "halt", - "poweroff", - "reboot" or - "kexec", depending on the chosen + halt, + poweroff, + reboot or + kexec, depending on the chosen action. All executables in this directory are executed in parallel, and execution of the action is not continued before all executables finished. @@ -101,7 +101,7 @@ systemd-halt.service (and the related units) should never be executed directly. Instead, trigger system shutdown with a - command such as "systemctl halt" or + command such as systemctl halt or suchlike. diff --git a/man/systemd-suspend.service.xml b/man/systemd-suspend.service.xml index 4a4ed5cbdb..9b08f04939 100644 --- a/man/systemd-suspend.service.xml +++ b/man/systemd-suspend.service.xml @@ -80,14 +80,14 @@ executables in /usr/lib/systemd/system-sleep/ and pass two arguments to them. The first argument - will be "pre", the second either - "suspend", - "hibernate", or - "hybrid-sleep" depending on the + will be pre, the second either + suspend, + hibernate, or + hybrid-sleep depending on the chosen action. Immediately after leaving system suspend and/or hibernation the same executables are run, but the first argument is now - "post". All executables in this + post. All executables in this directory are executed in parallel, and execution of the action is not continued until all executables have finished. @@ -105,11 +105,11 @@ systemd-hybrid-sleep.service should never be executed directly. Instead, trigger system sleep states with a command such as - "systemctl suspend" or + systemctl suspend or similar. Internally, this service will echo a string like - "mem" into + mem into /sys/power/state, to trigger the actual system suspend. What exactly is written where can be configured in the [Sleep] diff --git a/man/systemd.device.xml b/man/systemd.device.xml index 7dffa236cf..1c29aa4e79 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -107,7 +107,7 @@ available. Note that this and the other tags are not taken into account unless the device is tagged with the - "systemd" string in + systemd string in the udev database, because otherwise the device is not exposed as systemd unit. diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml index beb2fd6584..de01dc236b 100644 --- a/man/systemd.journal-fields.xml +++ b/man/systemd.journal-fields.xml @@ -375,15 +375,15 @@ name. If the entry is associated to a block device, the major and minor of the - device node, separated by ':' - and prefixed by 'b'. Similar + device node, separated by : + and prefixed by b. Similar for character devices, but - prefixed by 'c'. For network + prefixed by c. For network devices the interface index, - prefixed by 'n'. For all other - devices '+' followed by the + prefixed by n. For all other + devices + followed by the subsystem name, followed by - ':', followed by the kernel + :, followed by the kernel device name. diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 0454cf292e..dcf57c30bb 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -319,7 +319,7 @@ suitable for XDG .desktop files. Lone semicolons may be escaped as - '\;'. If the empty + \;. If the empty string is assigned to this option the list of commands to start is reset, prior assignments of this option will @@ -330,7 +330,7 @@ one by one sequentially in the order they appear in the unit file. If one of the commands fails (and is not - prefixed with '-'), + prefixed with -), other lines are not executed and the unit is considered failed. @@ -341,7 +341,7 @@ main process of the daemon. The command line accepts - '%' specifiers as + % specifiers as described in systemd.unit5. Note that the first argument of the command @@ -370,19 +370,19 @@ Optionally, if the absolute file name is prefixed with - '@', the second token + @, the second token will be passed as argv[0] to the executed process, followed by the further arguments specified. If the absolute file name is prefixed with - '-' an exit code of + - an exit code of the command normally considered a failure (i.e. non-zero exit status or abnormal exit due to signal) is ignored and considered success. If both - '-' and - '@' are used they + - and + @ are used they can appear in either order. Note that this setting does not @@ -417,7 +417,7 @@ after the other, serially. If any of those commands (not - prefixed with '-') + prefixed with -) fail, the rest are not executed and the unit is considered failed. @@ -662,8 +662,8 @@ definitions can either be numeric exit codes or termination signal names, separated by spaces. Example: - "SuccessExitStatus=1 2 8 - SIGKILL", ensures that exit + SuccessExitStatus=1 2 8 + SIGKILL, ensures that exit codes 1, 2, 8 and the termination signal SIGKILL are considered clean service terminations. This option may @@ -692,8 +692,8 @@ that by default no exit status is excluded from the configured restart logic. Example: - "RestartPreventExitStatus=1 6 - SIGABRT", ensures that exit + RestartPreventExitStatus=1 6 + SIGABRT, ensures that exit codes 1 and 6 and the termination signal SIGABRT will not result in automatic service restarting. This diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 6a5eefb6db..1cfdac9267 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -646,7 +646,7 @@ Lists one or more units that are activated when this unit enters the - 'failed' + failed state. @@ -812,7 +812,7 @@ time. If this time limit is reached the job will be cancelled, the unit however will not change state or even - enter the 'failed' + enter the failed mode. This value defaults to 0 (job timeouts disabled), except for device units. NB: this timeout is independent @@ -871,7 +871,7 @@ to ConditionPathExists= is prefixed with an exclamation mark - ('!'), the test is negated, and the unit + (!), the test is negated, and the unit is only started if the path does not exist. @@ -940,7 +940,7 @@ exclamation mark unset). The argument must either be a single word, or an assignment (i.e. two words, separated - '='). In the former + =). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an diff --git a/man/udev.xml b/man/udev.xml index 964aeda802..2353b10023 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -73,7 +73,7 @@ extensions are ignored. Every line in the rules file contains at least one key-value pair. - Except for empty lines or lines beginning with '#', which are ignored. + Except for empty lines or lines beginning with #, which are ignored. There are two kinds of keys: match and assignment. If all match keys match against their values, the rule gets applied and the assignment keys get the specified values assigned. @@ -130,28 +130,28 @@ one and the same parent device. - + ACTION Match the name of the event action. - + DEVPATH Match the devpath of the event device. - + KERNEL Match the name of the event device. - + NAME Match the name of a network interface. It can be used once the NAME key has been set in one of the preceding rules. @@ -159,7 +159,7 @@ - + SYMLINK Match the name of a symlink targeting the node. It can be used once a SYMLINK key has been set in one of the preceding @@ -169,20 +169,20 @@ - + SUBSYSTEM Match the subsystem of the event device. - + DRIVER Match the driver name of the event device. Only set this key for devices which are bound to a driver at the time the event is generated. - + ATTR{filename} Match sysfs attribute values of the event device. Trailing whitespace in the attribute values is ignored unless the specified match @@ -192,59 +192,59 @@ - + KERNELS Search the devpath upwards for a matching device name. - + SUBSYSTEMS Search the devpath upwards for a matching device subsystem name. - + DRIVERS Search the devpath upwards for a matching device driver name. - + ATTRS{filename} Search the devpath upwards for a device with matching sysfs attribute values. - If multiple matches are specified, all of them + If multiple ATTRS matches are specified, all of them must match on the same device. Trailing whitespace in the attribute values is ignored unless the specified match value itself contains trailing whitespace. - + TAGS Search the devpath upwards for a device with matching tag. - + ENV{key} Match against a device property value. - + TAG Match against a device tag. - + TEST{octal mode mask} Test the existence of a file. An octal mode mask can be specified if needed. @@ -252,7 +252,7 @@ - + PROGRAM Execute a program to determine whether there is a match; the key is true if the program returns @@ -260,12 +260,12 @@ executed program in the environment. The program's stdout is available in the RESULT key. This can only be used for very short-running foreground tasks. For details - see . + see RUN. - + RESULT Match the returned string of the last PROGRAM call. This key can be used in the same or in any later rule after a PROGRAM call. @@ -292,11 +292,12 @@ [] Matches any single character specified within the brackets. For - example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'. - Ranges are also supported via the '-' character. + example, the pattern string tty[SR] + would match either ttyS or ttyR. + Ranges are also supported via the - character. For example, to match on the range of all digits, the pattern [0-9] could - be used. If the first character following the '[' is a '!', any characters - not enclosed are matched. + be used. If the first character following the [ is a + !, any characters not enclosed are matched. @@ -304,7 +305,7 @@ The following keys can get values assigned: - + NAME The name to use for a network interface. The name of a device node cannot be changed by udev, only additional symlinks can be created. @@ -312,14 +313,14 @@ - + SYMLINK The name of a symlink targeting the node. Every matching rule adds this value to the list of symlinks to be created. The set of characters to name a symlink is limited. Allowed - characters are [0-9A-Za-z#+-.:=@_/], valid UTF-8 character sequences, - and "\x00" hex encoding. All other characters are replaced by - a '_' character. + characters are 0-9A-Za-z#+-.:=@_/, valid UTF-8 character + sequences, and \x00 hex encoding. All other + characters are replaced by a _ character. Multiple symlinks may be specified by separating the names by the space character. In case multiple devices claim the same name, the link always points to the device with the highest link_priority. If the current @@ -334,7 +335,7 @@ - , , + OWNER, GROUP, MODE The permissions for the device node. Every specified value overrides the compiled-in default value. @@ -342,7 +343,7 @@ - + ATTR{key} The value that should be written to a sysfs attribute of the event device. @@ -350,16 +351,16 @@ - + ENV{key} - Set a device property value. Property names with a leading '.' + Set a device property value. Property names with a leading . are neither stored in the database nor exported to events or external tools (run by, say, the PROGRAM match key). - + TAG Attach a tag to a device. This is used to filter events for users of libudev's monitor functionality, or to enumerate a group of tagged @@ -372,7 +373,7 @@ - + RUN{type} Add a program to the list of programs to be executed after processing all the rules for a specific event, depending on type: @@ -390,7 +391,7 @@ builtin - As , but use one of the built-in programs rather + As program, but use one of the built-in programs rather than an external one. @@ -407,21 +408,21 @@ - + LABEL A named label to which a GOTO may jump. - + GOTO Jumps to the next LABEL with a matching name. - + IMPORT{type} Import a set of variables as device properties, depending on type: @@ -432,14 +433,14 @@ Execute an external program specified as the assigned value and import its output, which must be in environment key format. Path specification, command/argument separation, - and quoting work like in . + and quoting work like in RUN. builtin - As , but use one of the built-in programs rather - than an external one. + Similar to program, but use one of the + built-in programs rather than an external one. @@ -461,7 +462,7 @@ cmdline Import a single property from the kernel command line. For simple flags - the value of the property is set to '1'. + the value of the property is set to 1. @@ -481,7 +482,7 @@ - + WAIT_FOR Wait for a file to become available or until a timeout of 10 seconds expires. The path is relative to the sysfs device; @@ -490,7 +491,7 @@ - + OPTIONS Rule and device options: @@ -543,9 +544,9 @@ - The , , , - , , and - fields support simple string substitutions. The + The NAME, SYMLINK, PROGRAM, + OWNER, GROUP, MODE and RUN + fields support simple string substitutions. The RUN substitutions are performed after all rules have been processed, right before the program is executed, allowing for the use of device properties set by earlier matching rules. For all other fields, substitutions are performed while the individual rule is @@ -561,8 +562,8 @@ , - The kernel number for this device. For example, 'sda3' has - kernel number of '3' + The kernel number for this device. For example, + sda3 has kernel number 3. @@ -630,9 +631,9 @@ The string returned by the external program requested with PROGRAM. A single part of the string, separated by a space character, may be selected - by specifying the part number as an attribute: . - If the number is followed by the '+' character, this part plus all remaining parts - of the result string are substituted: + by specifying the part number as an attribute: %c{N}. + If the number is followed by the + character, this part plus all remaining parts + of the result string are substituted: %c{N+}. @@ -681,16 +682,16 @@ - %% + - The '%' character itself. + The % character itself. - $$ + - The '$' character itself. + The $ character itself.