diff --git a/man/systemd-bus-proxyd.xml b/man/systemd-bus-proxyd.xml index d53f966ab3..e75815fb4a 100644 --- a/man/systemd-bus-proxyd.xml +++ b/man/systemd-bus-proxyd.xml @@ -61,7 +61,7 @@ along with systemd; If not, see . systemd-bus-proxyd will proxy D-Bus messages to and from a bus. The will be either the system bus or the bus specified with when that option - is given. Messages will be proxied to/from stdin and stdout, or + is given. Messages will be proxied to/from STDIN and STDOUT, or the socket received through socket activation. This program can be used to connect a program using classic @@ -103,7 +103,7 @@ along with systemd; If not, see . - PLACEHOLDER if given must be a string + PLACEHOLDER, if given, must be a string of x and will be used to display information about the process that systemd-bus-proxyd is forwarding messages for. diff --git a/man/systemd-coredumpctl.xml b/man/systemd-coredumpctl.xml index 67f75d1c53..c096f6d7b1 100644 --- a/man/systemd-coredumpctl.xml +++ b/man/systemd-coredumpctl.xml @@ -135,7 +135,7 @@ Extract the last coredump matching specified characteristics. - Coredump will be written on stdout, unless + Coredump will be written on STDOUT, unless an output file is specified with . @@ -200,8 +200,8 @@ Exit status - On success, 0 is returned, a non-zero failure - code otherwise. Not finding any matching coredumps is treated + On success, 0 is returned; otherwise, a non-zero failure + code is returned. Not finding any matching coredumps is treated as failure. diff --git a/man/systemd-udevd.service.xml b/man/systemd-udevd.service.xml index 7fce3000f5..50a10764bf 100644 --- a/man/systemd-udevd.service.xml +++ b/man/systemd-udevd.service.xml @@ -70,7 +70,7 @@ - Print debug messages to stderr. + Print debug messages to STDERR. @@ -82,7 +82,6 @@ - Delay the execution of RUN instruction by the given number of seconds. This option might be useful when debugging system crashes during coldplug caused by loading @@ -158,7 +157,7 @@ net.ifnames= Network interfaces are renamed to give them predictable names - when possible. It is enabled by default, specifying 0 disables it. + when possible. It is enabled by default; specifying 0 disables it. diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 01356e4c45..8b7645c4d6 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -491,8 +491,8 @@ TTYPath= Sets the terminal - device node to use if standard input, - output or stderr are connected to a + device node to use if STDIN, STDOUT, + or STDERR are connected to a TTY (see above). Defaults to /dev/console. diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 6e9b6696fc..be9bdcaf99 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -103,7 +103,7 @@ script. This is useful for compatibility with SysV. Note that this compatibility is quite comprehensive but not 100%. For details about the - incompatibilities see the Incompatibilities with SysV document. @@ -172,13 +172,13 @@ PIDFile= option, so that systemd can identify the main process of the daemon. systemd will - proceed starting follow-up units as - soon as the parent process + proceed with starting follow-up units + as soon as the parent process exits. Behavior of is similar - to , however + to ; however, it is expected that the process has to exit before systemd starts follow-up units. RemainAfterExit= @@ -187,13 +187,13 @@ Behavior of is similar to - , however it is + ; however, it is expected that the daemon acquires a name on the D-Bus bus, as configured by BusName=. systemd - will proceed starting follow-up units - after the D-Bus bus name has been + will proceed with starting follow-up + units after the D-Bus bus name has been acquired. Service units with this option configured implicitly gain dependencies on the @@ -204,12 +204,12 @@ Behavior of is similar to - , however it is + ; however, it is expected that the daemon sends a notification message via sd_notify3 - or an equivalent call when it finished - starting up. systemd will proceed + or an equivalent call when it has finished + starting up. systemd will proceed with starting follow-up units after this notification message has been sent. If this option is used, @@ -227,7 +227,7 @@ Behavior of is very similar - to , however + to ; however, actual execution of the service binary is delayed until all jobs are dispatched. This may be used to avoid @@ -260,7 +260,7 @@ is set and is unset because for the other types or with an explicitly configured PID - file the main PID is always known. The + file, the main PID is always known. The guessing algorithm might come to incorrect conclusions if a daemon consists of more than one process. If @@ -292,14 +292,13 @@ BusName= Takes a D-Bus bus - name, that this service is reachable + name that this service is reachable as. This option is mandatory for services where Type= is set to , but its use - is otherwise recommended as well if - the process takes a name on the D-Bus - bus. + is otherwise recommended if the process + takes a name on the D-Bus bus. @@ -318,7 +317,7 @@ Type=oneshot is used, more than one command may be specified. Multiple command lines may - be concatenated in a single directive, + be concatenated in a single directive by separating them with semicolons (these semicolons must be passed as separate words). Alternatively, this @@ -362,12 +361,12 @@ If more than one command is specified, the commands are invoked - one by one sequentially in the order - they appear in the unit file. If one - of the commands fails (and is not - prefixed with -), - other lines are not executed and the - unit is considered failed. + sequentially in the order they appear + in the unit file. If one of the + commands fails (and is not prefixed + with -), other lines + are not executed, and the unit is + considered failed. Unless Type=forking is @@ -387,7 +386,7 @@ Basic environment variable substitution is supported. Use ${FOO} as part of a - word, or as a word of its own on the + word, or as a word of its own, on the command line, in which case it will be replaced by the value of the environment variable including all @@ -410,12 +409,12 @@ fashion may be defined through Environment= and EnvironmentFile=. - In addition, variables listed in + In addition, variables listed in the section "Environment variables in spawned processes" in - systemd.exec5 + systemd.exec5, which are considered "static - configuration" may used (this includes + configuration", may be used (this includes e.g. $USER, but not $TERM). @@ -447,10 +446,10 @@ ExecStart=/bin/echo one ; /bin/echo "two two" This will execute /bin/echo two - times, each time with one argument, + times, each time with one argument: one and two two, - respectively. Since two commands are + respectively. Because two commands are specified, Type=oneshot must be used. @@ -512,8 +511,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} here following the same scheme as for ExecStart=. - One additional special - environment variables is set: if known + One additional, special + environment variable is set: if known, $MAINPID is set to the main process of the daemon, and may be used for command lines like the @@ -532,15 +531,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} following the same scheme as described for ExecStart= above. Use of this setting is - optional. All processes remaining for - a service after the commands - configured in this option are run are + optional. After the commands configured + in this option are run, all processes + remaining for a service are terminated according to the KillMode= setting (see systemd.kill5). If this option is not specified, the - process is terminated right-away when + process is terminated immediately when service stop is requested. Specifier and environment variable substitution is supported (including @@ -586,14 +585,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} daemon service does not signal start-up completion within the configured time, the service will be - considered failed and be shut down - again. + considered failed and will be shut + down again. Takes a unit-less value in seconds, or a time span value such as "5min - 20s". Pass 0 to disable the timeout - logic. Defaults to TimeoutStartSec= from the - manager configuration file, except when - Type=oneshot is + 20s". Pass 0 to + disable the timeout logic. Defaults to + TimeoutStartSec= from + the manager configuration file, except + when Type=oneshot is used, in which case the timeout is disabled by default. @@ -603,17 +603,18 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} TimeoutStopSec= Configures the time to wait for stop. If a service is asked - to stop but does not terminate in the + to stop, but does not terminate in the specified time, it will be terminated - forcibly via SIGTERM, and after - another delay of this time with - SIGKILL (See + forcibly via SIGTERM, + and after another timeout of equal duration + with SIGKILL (see KillMode= in systemd.kill5). Takes a unit-less value in seconds, or a time span value such as "5min - 20s". Pass 0 to disable the timeout - logic. Defaults to TimeoutStartSec= from the + 20s". Pass 0 to disable + the timeout logic. Defaults to + TimeoutStartSec= from the manager configuration file. @@ -634,11 +635,11 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} watchdog is activated when the start-up is completed. The service must call sd_notify3 - regularly with "WATCHDOG=1" (i.e. the - "keep-alive ping"). If the time + regularly with WATCHDOG=1 + (i.e. the "keep-alive ping"). If the time between two such calls is larger than the configured time, then the service - is placed in a failure state. By + is placed in a failed state. By setting Restart= to or , the service @@ -669,8 +670,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} service process exits, is killed, or a timeout is reached. The service process may be the main service - process, but also one of the processes - specified with + process, but it may also be one of the + processes specified with ExecStartPre=, ExecStartPost=, ExecStopPre=, @@ -698,12 +699,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} exits cleanly. In this context, a clean exit means an exit code of 0, or one of the signals - SIGHUP, SIGINT, SIGTERM, or SIGPIPE, and + SIGHUP, + SIGINT, + SIGTERM, + or SIGPIPE, and additionally, exit statuses and signals specified in SuccessExitStatus=. If set to , the service will be restarted when the - process exits with an nonzero exit code, + process exits with a non-zero exit code, is terminated by a signal (including on core dump), when an operation (such as service reload) times out, and when the @@ -722,7 +726,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} , the service will be restarted regardless of whether it exited cleanly or not, got - terminated abnormally by a signal or + terminated abnormally by a signal, or hit a timeout. In addition to the above settings, @@ -777,7 +781,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} Takes a list of exit status definitions that when returned by the main service process will - prevent automatic service restarts + prevent automatic service restarts, regardless of the restart setting configured with Restart=. Exit @@ -785,19 +789,20 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} numeric exit codes or termination signal names, and are separated by spaces. Defaults to the empty list, so - that by default no exit status is + that, by default, no exit status is excluded from the configured restart logic. Example: RestartPreventExitStatus=1 6 SIGABRT, ensures that exit codes 1 and 6 and the termination - signal SIGABRT will not result in - automatic service restarting. This - option may appear more than once in - which case the list of restart preventing + signal SIGABRT will + not result in automatic service + restarting. This + option may appear more than once, in + which case the list of restart-preventing statuses is merged. If the empty string is assigned to this option, the - list is reset, all prior assignments + list is reset and all prior assignments of this option will have no effect. @@ -805,20 +810,20 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} PermissionsStartOnly= Takes a boolean - argument. If true, the permission - related execution options as + argument. If true, the permission-related + execution options, as configured with User= and similar options (see systemd.exec5 - for more information) are only applied + for more information), are only applied to the process started with ExecStart=, and not to the various other ExecStartPre=, ExecStartPost=, ExecReload=, - ExecStop=, + ExecStop=, and ExecStopPost= commands. If false, the setting is applied to all configured commands the @@ -829,19 +834,19 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} RootDirectoryStartOnly= Takes a boolean - argument. If true, the root directory + argument. If true, the root directory, as configured with the RootDirectory= option (see systemd.exec5 - for more information) is only applied + for more information), is only applied to the process started with ExecStart=, and not to the various other ExecStartPre=, ExecStartPost=, ExecReload=, - ExecStop=, + ExecStop=, and ExecStopPost= commands. If false, the setting is applied to all configured commands the @@ -851,12 +856,14 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} NonBlocking= - Set O_NONBLOCK flag + Set the + O_NONBLOCK flag for all file descriptors passed via socket-based activation. If true, all file descriptors >= 3 (i.e. all except STDIN/STDOUT/STDERR) will have - the O_NONBLOCK flag set and hence are in + the O_NONBLOCK flag + set and hence are in non-blocking mode. This option is only useful in conjunction with a socket unit, as described in @@ -912,8 +919,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} passed to multiple processes at the same time. Also note that a different service may be activated on incoming - traffic than inherits the sockets. Or - in other words: the + traffic than that which inherits the + sockets. Or in other words: the Service= setting of .socket units does not have to match the inverse of @@ -926,7 +933,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} once, in which case the list of socket units is merged. If the empty string is assigned to this option, the list of - sockets is reset, all prior uses of + sockets is reset, and all prior uses of this setting will have no effect. @@ -937,10 +944,10 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} Configure service start rate limiting. By default, - services which are started more often - than 5 times within 10s are not + services which are started more + than 5 times within 10 seconds are not permitted to start any more times - until the 10s interval ends. With + until the 10 second interval ends. With these two options, this rate limiting may be modified. Use StartLimitInterval= @@ -955,18 +962,18 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} manager configuration file). These configuration options are particularly useful in conjunction with - Restart=, however - apply to all kinds of starts + Restart=; however, + they apply to all kinds of starts (including manual), not just those triggered by the Restart= logic. Note that units which are configured for Restart= and which reach the start limit are not - attempted to be restarted anymore, - however they may still be restarted - manually at a later point from which - point on the restart logic is again + attempted to be restarted anymore; + however, they may still be restarted + manually at a later point, from which + point on, the restart logic is again activated. Note that systemctl reset-failed will cause the @@ -990,18 +997,17 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} hit. Takes one of , , - or + , or . If is set, hitting the rate limit will trigger no action besides that the start will not - be - permitted. + be permitted. causes a reboot following the normal shutdown procedure (i.e. equivalent to - systemctl reboot), + systemctl reboot). causes - an forced reboot which will terminate + a forced reboot which will terminate all processes forcibly but should cause no dirty file systems on reboot (i.e. equivalent to systemctl @@ -1010,7 +1016,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} causes immediate execution of the reboot2 system call, which might result in - data loss. Defaults to + data loss. Defaults to . @@ -1040,22 +1046,21 @@ ExecStart=/bin/echo $ONE $TWO ${TWO} in relation to SysV services lacking LSB headers. This option is only necessary to fix ordering in relation - to legacy SysV services, that have no + to legacy SysV services that have no ordering information encoded in the - script headers. As such it should only - be used as temporary compatibility - option, and not be used in new unit - files. Almost always it is a better + script headers. As such, it should only + be used as a temporary compatibility + option and should not be used in new unit + files. Almost always, it is a better choice to add explicit ordering directives via After= or Before=, - instead. For more details see - systemd.unit5. If - used, pass an integer value in the + instead. For more details, see + systemd.unit5. + If used, pass an integer value in the range 0-99. - diff --git a/man/udev.xml b/man/udev.xml index 32a520e7b8..9ea1cae4a3 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -255,9 +255,9 @@ Execute a program to determine whether there is a match; the key is true if the program returns successfully. The device properties are made available to the - 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 + 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 RUN. @@ -265,8 +265,9 @@ 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. + 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. @@ -293,9 +294,10 @@ 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. + 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. @@ -360,7 +362,8 @@ 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). + external tools (run by, for example, the PROGRAM + match key). @@ -380,24 +383,26 @@ 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: + Add a program to the list of programs to be executed after + processing all the rules for a specific event, depending on + type: program Execute an external program specified as the assigned - value. If no absolute path is given, the program is expected to live in - /usr/lib/udev, otherwise the absolute path must be specified. - This is the default if no type is - specified. + value. If no absolute path is given, the program is expected + to live in /usr/lib/udev; otherwise, the + absolute path must be specified. + This is the default if no type + is specified. builtin - As program, but use one of the built-in programs rather - than an external one. + As program, but use one of the + built-in programs rather than an external one. @@ -406,7 +411,7 @@ This can only be used for very short-running foreground tasks. Running an event process for a long period of time may block all further events for this or a dependent device. - Starting daemons or other long running processes is not appropriate + Starting daemons or other long-running processes is not appropriate for udev; the forked processes, detached or not, will be unconditionally killed after the event handling has finished. @@ -415,14 +420,14 @@ LABEL - A named label to which a GOTO may jump. + A named label to which a GOTO may jump. GOTO - Jumps to the next LABEL with a matching name. + Jumps to the next LABEL with a matching name. @@ -525,21 +530,24 @@ - Apply the permissions specified in this rule to the static device node with - the specified name. Also, for every tag specified in this rule, create a symlink + Apply the permissions specified in this rule to the + static device node with the specified name. Also, for every + tag specified in this rule, create a symlink in the directory /run/udev/static_node-tags/tag - pointing at the static device node with the specified name. Static device node - creation is performed by systemd-tmpfiles before systemd-udevd is started. The - static nodes might not have a corresponding kernel device; they are used to - trigger automatic kernel module loading when they are accessed. + pointing at the static device node with the specified name. + Static device node creation is performed by systemd-tmpfiles + before systemd-udevd is started. The static nodes might not + have a corresponding kernel device; they are used to trigger + automatic kernel module loading when they are accessed. - Watch the device node with inotify; when the node is closed after being opened for - writing, a change uevent is synthesized. + Watch the device node with inotify; when the node is + closed after being opened for writing, a change uevent is + synthesized. @@ -553,13 +561,15 @@ - 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 - being processed. The available substitutions are: + 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 being + processed. The available substitutions are: , @@ -572,7 +582,8 @@ , The kernel number for this device. For example, - sda3 has kernel number 3. + sda3 has kernel number 3. + @@ -586,8 +597,9 @@ , - The name of the device matched while searching the devpath upwards for - , , and . + The name of the device matched while searching the devpath + upwards for , , + , and . @@ -595,8 +607,10 @@ - The driver name of the device matched while searching the devpath upwards for - , , and . + The driver name of the device matched while searching the + devpath upwards for , + , , and + . @@ -605,12 +619,15 @@ , The value of a sysfs attribute found at the device where - all keys of the rule have matched. If the matching device does not have - such an attribute, and a previous KERNELS, SUBSYSTEMS, DRIVERS, or - ATTRS test selected a parent device, then the attribute from that - parent device is used. - If the attribute is a symlink, the last element of the symlink target is - returned as the value. + all keys of the rule have matched. If the matching device does not + have such an attribute, and a previous , + , , or + test selected a parent device, then the + attribute from that parent device is used. + + If the attribute is a symlink, the last element of the + symlink target is returned as the value. + @@ -638,7 +655,8 @@ , - The string returned by the external program requested with PROGRAM. + 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: %c{N}. If the number is followed by the + character, this part plus all remaining parts @@ -816,22 +834,28 @@ MACAddressPolicy - The policy by which the MAC address should be set. The available policies are: + The policy by which the MAC address should be set. The + available policies are: + persistent - If the hardware has a persistent MAC address, as most hardware should, and this is used by - the kernel, nothing is done. Otherwise, a new MAC address is generated which is guaranteed to be - the same on every boot for the given machine and the given device, but which is otherwise random. + If the hardware has a persistent MAC address, as most + hardware should, and this is used by the kernel, nothing is + done. Otherwise, a new MAC address is generated which is + guaranteed to be the same on every boot for the given + machine and the given device, but which is otherwise random. random - If the kernel is using a random MAC address, nothing is done. Otherwise, a new address is - randomly generated each time the device appears, typically at boot. + If the kernel is using a random MAC address, nothing is + done. Otherwise, a new address is randomly generated each + time the device appears, typically at boot. + @@ -840,44 +864,58 @@ MACAddress - The MAC address to use, if no MACAddressPolicy is specified. + The MAC address to use, if no MACAddressPolicy + is specified. + NamePolicy - An ordered, space-separated list of policies by which the interface name should be set. - NamePolicy may be disabeld by specifying net.ifnames=0 on the - kernel commandline. Each of the policies may fail, and the first successfull one is used. The name - is not set directly, but exported to udev as the property ID_NET_NAME, which is - by default used by an udev rule to set NAME. The available policies are: + An ordered, space-separated list of policies by which the + interface name should be set. NamePolicy may + be disabeld by specifying net.ifnames=0 on the + kernel commandline. Each of the policies may fail, and the first + successfull one is used. The name is not set directly, but + is exported to udev as the property ID_NET_NAME, + which is, by default, used by a udev rule to set + NAME. The available policies are: + onboard - The name is set based on information given by the firmware for on-board devices, as - exported by the udev property ID_NET_NAME_ONBOARD. + The name is set based on information given by the + firmware for on-board devices, as exported by the udev + property ID_NET_NAME_ONBOARD. + slot - The name is set based on information given by the firmware for hot-plug devices, as - exported by the udev property ID_NET_NAME_SLOT. + The name is set based on information given by the + firmware for hot-plug devices, as exported by the udev + property ID_NET_NAME_SLOT. + path - The name is set based on the device's physical location, as exported by the udev - property ID_NET_NAME_PATH. + The name is set based on the device's physical location, + as exported by the udev property + ID_NET_NAME_PATH. + mac - The name is set based on the device's persistent MAC address, as exported by the udev - property ID_NET_NAME_MAC. + The name is set based on the device's persistent MAC + address, as exported by the udev property + ID_NET_NAME_MAC. + @@ -886,8 +924,10 @@ Name - The interface name to use in case all the policies specified in NamePolicy - fail, or in case NamePolicy is missing or disabled. + The interface name to use in case all the policies specified + in NamePolicy fail, or in case + NamePolicy is missing or disabled. + @@ -905,14 +945,17 @@ Duplex - The duplex mode to set for the device. The accepted values are half and - full. + The duplex mode to set for the device. The accepted values + are half and full. + WakeOnLan - The Wake-On-Lan policy to set for the device. The supported values are: + The Wake-on-LAN policy to set for the device. The supported + values are: + phy @@ -923,7 +966,7 @@ magic - Wake on receipt of magic packet. + Wake on receipt of a magic packet. @@ -940,11 +983,13 @@ See Also - + + systemd-udevd.service8 , udevadm8 - + + diff --git a/man/udevadm.xml b/man/udevadm.xml index f5aafe50ba..e437c243c5 100644 --- a/man/udevadm.xml +++ b/man/udevadm.xml @@ -72,7 +72,7 @@ - Print debug messages to stderr. + Print debug messages to STDERR.