X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=e9e3371ba8d00e6c1613aa28be77369f54b2b953;hp=63598723bbc27875950bb9fd9935825ff6f2fa5b;hb=ac3f50caa50835a429fc59d9168799bbb6e24fb9;hpb=25f63d467187693c0a821bb2b463f8faf627bcfe diff --git a/man/systemctl.xml b/man/systemctl.xml index 63598723b..e9e3371ba 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. @@ -76,6 +76,13 @@ text and exits. + + + + Prints a short version + string and exits. + + @@ -119,6 +126,15 @@ they are set or not. + + + + When listing units, + show only failed units. Do not confuse + with + . + + @@ -137,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. @@ -147,7 +180,7 @@ Suppress output to STDOUT in snapshot, - check, + is-active, enable and disable. @@ -155,13 +188,20 @@ - Do not synchronously wait for - the requested operation to finish. If this is - not specified the job will be verified, - enqueued and systemctl will - wait until it is completed. By passing this - argument it is only verified and - enqueued. + Do not synchronously wait for + the requested operation to finish. If this is + not specified the job will be verified, + enqueued and systemctl will + wait until it is completed. By passing this + argument it is only verified and + enqueued. + + + + + Do not pipe output into a + pager. + @@ -171,10 +211,10 @@ - + Talk to the systemd - session manager of the calling user. + manager of the calling user. @@ -217,10 +257,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. @@ -234,13 +274,99 @@ changes. + + + + When used with + start and related + commands, disables asking for + passwords. Background services may + require input of a password or + passphrase string, for example to + unlock system hard disks or + cryptographic certificates. Unless + this option is specified and the + command is invoked from a terminal + systemctl will + query the user on the terminal for the + necessary secrets. Use this option to + 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 or only the selected process + itself. If omitted defaults to + if + is + set, or + otherwise. You probably never need to + use this switch. + + + + + + When used with + kill, choose which + processes to kill. Must be one of + , + or + to select whether + to kill only the main process of the + unit, the control process or all + 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 + known signal specifiers such as + SIGTERM, SIGINT or SIGSTOP. If + omitted defaults to + . + + + When used with enable, override any existing conflicting symlinks. + + When used with + halt, + poweroff, + reboot or + kexec execute + selected operation without shutting + down all units. However, all processes + will be killed forcibly and all file + systems are unmounted or remounted + read-only. This is hence a drastic but + relatively safe option to request an + immediate reboot. @@ -254,6 +380,27 @@ file that shall be disabled. + + + + + + Execute operation + remotely. Specifiy a hostname, or + username and hostname seperated by @, + to connect to. This will use SSH to + talk to the remote systemd + instance. + + + + + + + Acquire privileges via + PolicyKit before executing the + operation. + The following commands are understood: @@ -319,23 +466,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] @@ -358,11 +516,23 @@ systemd.unit5 for details. + + kill [NAME...] + + Send a signal to one + or more processes of the unit. Use + to select + which process to kill. Use + to + select the kill mode and + to select + the signal to send. + 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 @@ -445,7 +615,7 @@ does not have the effect that any of the units enabled are also started at the same time. If this is desired a - seperate start + separate start command must be invoked for the unit. @@ -462,7 +632,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 @@ -491,11 +661,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. @@ -534,9 +704,9 @@ . - This command honours + This command honors , - , + , in a similar way as enable. @@ -593,7 +763,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. + IDs. If no job id is specified, cancel all pending jobs. monitor @@ -649,7 +819,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 @@ -704,16 +874,6 @@ configuration will stay accessible. - - daemon-exit - - Ask the systemd - manager to quit. This is only - supported for session managers - (i.e. in conjunction with the - option) and - will fail otherwise. - show-environment @@ -746,7 +906,34 @@ is only removed if it has the specified value. + + default + + Enter default + mode. This is mostly equivalent to + start + default.target. + + + rescue + + Enter rescue + mode. This is mostly equivalent to + isolate + rescue.target but also + prints a wall message to all + users. + + + emergency + Enter emergency + mode. This is mostly equivalent to + isolate + emergency.target but also + prints a wall message to all + users. + halt @@ -754,7 +941,14 @@ system. This is mostly equivalent to start halt.target but also prints a wall message to all - users. + users. If + combined with + shutdown of all running services is + skipped, however all processes are killed + and all file systems are unmounted or + mounted read-only, immediately + followed by the + system halt. poweroff @@ -764,7 +958,14 @@ equivalent to start poweroff.target but also prints a wall message to all - users. + users. If + combined with + shutdown of all running services is + skipped, however all processes are killed + and all file systems are unmounted or + mounted read-only, immediately + followed by the + powering off. reboot @@ -774,35 +975,40 @@ equivalent to start reboot.target but also prints a wall message to all - users. + users. If + combined with + shutdown of all running services is + skipped, however all processes are killed + and all file systems are unmounted or + mounted read-only, immediately + followed by the + reboot. - default + kexec - Enter default - mode. This is mostly equivalent to - start - default.target. - - - rescue - - Enter rescue - mode. This is mostly equivalent to - isolate - rescue.target but also - prints a wall message to all - users. + Shut down and reboot + the system via kexec. This is mostly + equivalent to start + kexec.target but also prints + a wall message to all users. If + combined with + shutdown of all running services is + skipped, however all processes are killed + and all file systems are unmounted or + mounted read-only, immediately + followed by the + reboot. - emergency + exit - Enter emergency - mode. This is mostly equivalent to - isolate - emergency.target but also - prints a wall message to all - users. + Ask the systemd + manager to quit. This is only + supported for user service managers + (i.e. in conjunction with the + option) and + will fail otherwise.