X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=f86952c683092e73ea50e95affd13bc63cdee136;hp=9e113eb0fe34714bad9de761b1d760387925dc43;hb=1a0fce458d3b45624c5817006735d59a5689ef83;hpb=6edd7d0a09171ea5ae8e01b7b1cbcb0bdfbfeb16 diff --git a/man/systemctl.xml b/man/systemctl.xml index 9e113eb0f..f86952c68 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -87,14 +87,31 @@ - When listing units, - limit display to certain unit - types. If not specified units of all - types will be shown. The argument - should be a unit type name such as - , - and - similar. + The argument should + be a unit type name such as + and + , + or a unit load state such as + and + . + + + If the argument is a unit type, + when listing units, limit display to + certain unit types. If not specified + units of all types will be shown. + + If the argument is a unit load state, + when listing units, limit display to + certain unit types. If not specified + units of in all load states will be + shown. + + As a special case, if the argument + is , a list of + allowed values will be printed and the + program will exit. + @@ -166,7 +183,7 @@ execute it immediately. If passed no required units of the unit passed will be pulled in, and no ordering - dependencies will be honoured. This is + dependencies will be honored. This is mostly a debugging and rescue tool for the administrator and should not be used by @@ -181,6 +198,7 @@ STDOUT in snapshot, is-active, + is-failed, enable and disable. @@ -200,17 +218,17 @@ - Do not print a legend, i.e. + Do not print a legend, i.e. the column headers and the footer with hints. - - + + - Do not pipe output into a - pager. - + Do not pipe output into a + pager. + @@ -343,7 +361,7 @@ When used with - enable, override any + enable, overwrite any existing conflicting symlinks. @@ -430,17 +448,6 @@ 10. - - - - - When used with - status continously - prints new journal entries as they are - appended to the - journal. - - @@ -594,6 +601,18 @@ this will also print the current unit state to STDOUT. + + is-failed [NAME...] + + Check whether any of + the specified units are failed. + Returns an exit code + 0 if at least one is failed, non-zero + otherwise. Unless + is specified + this will also print the current unit + state to STDOUT. + status [NAME...|PID...] @@ -632,7 +651,15 @@ looking for formatted human-readable output. + + help [NAME...|PID...] + Show manual pages for + one or more units, if available. If a + PID is passed the manual pages for the + unit the process of the PID belongs to + is shown. + reset-failed [NAME...] @@ -662,24 +689,29 @@ enable [NAME...] - Enable one or more - unit files, as specified on the + Enable one or + more unit files or unit file + instances, as specified on the command line. This will create a - number of symlinks as encoded in the - [Install] sections - of the unit files. After the symlinks - have been created the systemd - configuration is reloaded (in a way - that is equivalent to - daemon-reload) to - ensure the changes are taken into + number of symlinks as encoded in + the [Install] + sections of the unit files. After + the symlinks have been created the + systemd configuration is reloaded + (in a way that is equivalent to + daemon-reload) + to ensure the changes are taken into account immediately. Note that this does not have the effect that any of the units enabled are also started at - the same time. If this is desired a - separate start - command must be invoked for the - unit. + the same time. If this is desired + a separate start + command must be invoked for the unit. + Also note that in case of instance + enablement, symlinks named same as + instances are created in install + location, however they all point to + the same template unit file. This command will print the actions executed. This @@ -752,9 +784,9 @@ configuration after completing the disabling of the units. Note that this command does not implicitly stop the - units that is being disabled. If this + units that are being disabled. If this is desired an additional - stopcommand should + stop command should be executed afterwards. This command will print the @@ -775,7 +807,7 @@ is-enabled [NAME...] Checks whether any of - the specified unit files is enabled + the specified unit files are enabled (as with enable). Returns an exit code of 0 if at least one is @@ -806,12 +838,19 @@ Reset one or more unit files, as specified on the command - line, to the defaults configured in a - preset file. This has the same effect - as disable or + line, to the defaults configured in + the preset policy files. This has the + same effect as + disable or enable, depending how the unit is listed in the preset - files. + files. For more information on preset + policy format see + systemd.preset5. For + more information on the concept of + presets please consult the Preset + document. @@ -1075,7 +1114,7 @@ mounted read-only, immediately followed by the system halt. If is specified - twice the the operation is immediately + twice the operation is immediately executed without terminating any processes or unmounting any file systems. This may result in data @@ -1096,7 +1135,7 @@ unmounted or mounted read-only, immediately followed by the powering off. If is - specified twice the the operation is + specified twice the operation is immediately executed without terminating any processes or unmounting any file systems. This may @@ -1117,7 +1156,7 @@ unmounted or mounted read-only, immediately followed by the reboot. If is specified - twice the the operation is immediately + twice the operation is immediately executed without terminating any processes or unmounting any file systems. This may result in data @@ -1152,12 +1191,56 @@ suspend - Suspend the system. + Suspend the + system. This will trigger activation + of the special + suspend.target + target. hibernate - Hibernate the system. + Hibernate the + system. This will trigger activation + of the special + hibernate.target + target. + + + hybrid-sleep + + Hibernate and suspend + the system. This will trigger + activation of the special + hybrid-sleep.target + target. + + + switch-root [ROOT] [INIT] + + Switches to a + different root directory and executes + a new system manager process below + it. This is intended for usage in + initial RAM disks ("initrd"), and will + transition from the initrd's system + manager process (a.k.a "init" process) + to the main system manager + process. Takes two arguments: the + directory to make the new root + directory, and the path to the new + system manager binary below it to + execute as PID 1. If the latter is + omitted or the empty string, a + systemd binary will automatically be + searched for and used as init. If the + system manager path is omitted or + equal the empty string the state of + the initrd's system manager process is + passed to the main system manager, + which allows later introspection of the + state of the services involved in the + initrd boot. @@ -1195,7 +1278,8 @@ loginctl1, systemd.unit5, systemd.special7, - wall1 + wall1, + systemd.preset5