X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=5adee45163b3bcc61c9585ef2fb9878ec24e8290;hp=10e0f82441368eb8460b260e7692fbbb96963bd5;hb=7e115808a990199fe00de4cc2ef48fe96de3d3d0;hpb=501fc174c22aebd3181af08a4cfa65cc92bbe233 diff --git a/man/systemctl.xml b/man/systemctl.xml index 10e0f8244..5adee4516 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -44,7 +44,7 @@ systemctl - Control the systemd system and session manager + Control the systemd system and service manager @@ -59,7 +59,7 @@ systemctl may be used to introspect and control the state of the systemd1 - system and session manager. + system and service manager. @@ -102,7 +102,7 @@ When showing - unit/job/manager information, limit + unit/job/manager properties, limit display to certain properties as specified as argument. If not specified all set properties are @@ -121,11 +121,20 @@ When listing units, show all units, regardless of their state, including inactive units. When - showing unit/job/manager information, + showing unit/job/manager properties, show all properties regardless whether they are set or not. + + + + When listing units, + show only failed units. Do not confuse + with + . + + @@ -144,7 +153,24 @@ unfinished job, fail the command. If this is not specified the requested operation will replace the pending job, - if necessary. + if necessary. Do not confuse + with + . + + + + + + When enqueuing a new + job ignore all its dependencies and + 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 + mostly a debugging and rescue tool for + the administrator and should not be + used by + applications. @@ -154,7 +180,7 @@ Suppress output to STDOUT in snapshot, - check, + is-active, enable and disable. @@ -168,7 +194,23 @@ enqueued and systemctl will wait until it is completed. By passing this argument it is only verified and - enqueued. + enqueued. + + + + + + Do not print a legend, i.e. + the column headers and the footer with hints. + + + + + + + Do not pipe output into a + pager. + @@ -178,10 +220,10 @@ - + Talk to the systemd - session manager of the calling user. + manager of the calling user. @@ -224,10 +266,10 @@ When used with enable and disable, operate on the - global session configuŕation + global user configuration directory, thus enabling or disabling a unit file globally for all future - sessions of all users. + logins of all users. @@ -257,34 +299,13 @@ systemctl will query the user on the terminal for the necessary secrets. Use this option to - switch this behaviour off. In this + switch this behavior off. In this case the password must be supplied by some other means (for example graphical password agents) or the service might fail. - - - - When used with - kill, choose the - mode how to kill the selected - processes. Must be one of - , - or - to select - whether to kill the entire control - group, the process group or only the - selected process itself. If ommitted - defaults to - if - is - set, or - otherwise. You probably never need to - use this switch. - - @@ -296,22 +317,22 @@ to select whether to kill only the main process of the unit, the control process or all - processes of the unit. If ommitted + processes of the unit. If omitted defaults to . - + When used with kill, choose which signal to send to selected processes. Must be one of the well - know signal specifiers such as + known signal specifiers such as SIGTERM, SIGINT or SIGSTOP. If - ommitted defaults to + omitted defaults to . @@ -339,15 +360,51 @@ - + + + When used with + enable/disable/is-enabled (and + related commands), use alternative + root path when looking for unit + files. + + + + When used with - disable, ensures - that only the symlinks created by - enable are removed, - not all symlinks pointing to the unit - file that shall be - disabled. + enable/disable/is-enabled (and related commands), make + changes only temporarily, so that they + are dropped on the next reboot. This + will have the effect that changes are + not made in subdirectories of + /etc but in + /run, with + identical immediate effects, however, + since the latter is lost on reboot, + the changes are lost + too. + + + + + + + Execute operation + remotely. Specify a hostname, or + username and hostname separated by @, + to connect to. This will use SSH to + talk to the remote systemd + instance. + + + + + + + Acquire privileges via + PolicyKit before executing the + operation. @@ -414,23 +471,34 @@ Restart one or more units specified on the command - line. If the units are not running yet - the operation will - fail. + line if the units are running. Do + nothing if units are not running. + Note that for compatibility + with Red Hat init scripts + condrestart is + equivalent to this command. reload-or-restart [NAME...] + + Reload one or more + units if they support it. If not, + restart them instead. If the units + are not running yet they will be + started. + + reload-or-try-restart [NAME...] Reload one or more units if they support it. If not, - restart them instead. Note that for - compatibility with SysV and Red Hat - init scripts - force-reload and - condrestart may be - used as equivalent commands to - reload-or-try-restart. + restart them instead. Do nothing if + the units are not running. Note that + for compatibility with SysV init + scripts + force-reload is + equivalent to this + command. isolate [NAME] @@ -469,7 +537,7 @@ is-active [NAME...] Check whether any of - the specified units is active + the specified units are active (i.e. running). Returns an exit code 0 if at least one is active, non-zero otherwise. Unless @@ -534,6 +602,13 @@ command. + + list-unit-files + + List installed unit files. + + + enable [NAME...] @@ -569,7 +644,7 @@ administrator is free to make additional changes manually, by placing or removing symlinks in the - directory. This is particular useful + directory. This is particularly useful to create configurations that deviate from the suggested default installation. In this case the @@ -598,11 +673,11 @@ Depending on whether , - or + or is specified this enables the unit for the system, - for sessions of the calling user only - or for all future session of all + for the calling user only + or for all future logins of all users. Note that in the latter case no systemd daemon configuration is reloaded. @@ -618,14 +693,11 @@ configuration directory, and hence undoes the changes made by enable. Note - however that this by default removes + however that this removes all symlinks to the unit files (i.e. including manual additions), not just those actually created by - enable. If only the - symlinks that are suggested by default - shall be removed, pass - . This + enable. This call implicitly reloads the systemd daemon configuration after completing the disabling of the units. Note that this @@ -641,9 +713,9 @@ . - This command honours + This command honors , - , + , in a similar way as enable. @@ -657,8 +729,85 @@ (as with enable). Returns an exit code of 0 if at least one is - enabled, non-zero - otherwise. + enabled, non-zero otherwise. Prints + the current enable status. To suppress + this output use + . + + + + reenable [NAME...] + + Reenable one or more + unit files, as specified on the + command line. This is a combination of + disable and + enable and is + useful to reset the symlinks a unit is + enabled with to the defaults + configured in the + [Install] section + of the unit file. + + + + + preset [NAME...] + + 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 + enable, depending + how the unit is listed in the preset + files. + + + + + mask [NAME...] + + Mask one or more unit + files, as specified on the command + line. This will link these units to + /dev/null, making + it impossible to start them. This is a stronger version + of disable, since + it prohibits all kinds of activation + of the unit, including manual + activation. Use this option with + care. + + + + + unmask [NAME...] + + Unmask one or more + unit files, as specified on the + command line. This will undo the + effect of + mask. + + + + + link [NAME...] + + Link a unit file that + is not in the unit file search paths + into the unit file search path. This + requires an absolute path to a unit + file. The effect of this can be undone + with disable. The + effect of this command is that a unit + file is available for + start and other + commands although it isn't installed + directly in the unit search + path. + @@ -700,17 +849,7 @@ Cancel one or more jobs specified on the command line by their numeric job - IDs. If not job id is specified cancels all jobs that are pending. - - - monitor - - Monitor unit/job - changes. This is mostly useful for - debugging purposes and prints a line - each time systemd loads or unloads a - unit configuration file, or a unit - property changes. + IDs. If no job id is specified, cancel all pending jobs. dump @@ -756,7 +895,7 @@ A snapshot refers to a saved state of the systemd manager. It is - implemented itself as unit that is + implemented itself as a unit that is generated dynamically with this command and has dependencies on all units active at the time. At a later @@ -881,8 +1020,8 @@ users. If combined with shutdown of all running services is - skipped, however all processes killed - and all file systems unmounted or + skipped, however all processes are killed + and all file systems are unmounted or mounted read-only, immediately followed by the system halt. @@ -898,8 +1037,8 @@ users. If combined with shutdown of all running services is - skipped, however all processes killed - and all file systems unmounted or + skipped, however all processes are killed + and all file systems are unmounted or mounted read-only, immediately followed by the powering off. @@ -915,8 +1054,8 @@ users. If combined with shutdown of all running services is - skipped, however all processes killed - and all file systems unmounted or + skipped, however all processes are killed + and all file systems are unmounted or mounted read-only, immediately followed by the reboot. @@ -931,8 +1070,8 @@ a wall message to all users. If combined with shutdown of all running services is - skipped, however all processes killed - and all file systems unmounted or + skipped, however all processes are killed + and all file systems are unmounted or mounted read-only, immediately followed by the reboot. @@ -942,9 +1081,9 @@ Ask the systemd manager to quit. This is only - supported for session managers + supported for user service managers (i.e. in conjunction with the - option) and + option) and will fail otherwise. @@ -958,11 +1097,28 @@ code otherwise. + + Environment + + + + $SYSTEMD_PAGER + Pager to use when + is not given; + overrides $PAGER. Setting + this to an empty string or the value + cat is equivalent to passing + . + + + + See Also systemd1, systemadm1, + systemd-loginctl1, systemd.unit5, systemd.special7, wall1