X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=033160329e41941e6806b8b1a7248153432686eb;hp=174988c55b2137ccb709996dd03bab31fbd6db36;hb=3802a3d3d7af51ddff31943d5514382f01265770;hpb=0d292f5e7597a729365644edfbcdf2e5fac8beb4 diff --git a/man/systemctl.xml b/man/systemctl.xml index 174988c55..033160329 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -1,4 +1,4 @@ - + @@ -60,10 +60,12 @@ along with systemd; If not, see . Description - systemctl may be used to - introspect and control the state of the + systemctl may be used to introspect and + control the state of the systemd system and + service manager. Please refer to systemd1 - system and service manager. + for an introduction into the basic concepts and functionality this + tool manages. @@ -96,9 +98,10 @@ along with systemd; If not, see . - The argument should be a comma-separated list of unit LOAD, - SUB, or ACTIVE states. When listing units, show only those - in specified states. + The argument should be a comma-separated list of unit + LOAD, SUB, or ACTIVE states. When listing units, show only + those in specified states. Use + to show only failed units. @@ -131,6 +134,18 @@ along with systemd; If not, see . + + + + + + When listing units, also show units of local + containers. Units of local containers will be prefixed with + the container name, separated by a single colon character + (:). + + + @@ -145,12 +160,27 @@ along with systemd; If not, see . + + + With list-dependencies, show the + units that are ordered before the specified unit. In other + words, list the units that are in the After= + directive of the specified unit, have the specified unit in + their Before= directive, or are otherwise + implicit dependencies of the specified unit. + + + + - Show after (before) which units the specified unit is started - with list-dependencies. - + With list-dependencies, show the + units that are ordered after the specified unit. In other + words, list the units that are in the Before= + directive of the specified unit, have the specified unit in + their After= directive, or otherwise depend + on the specified unit. @@ -203,8 +233,10 @@ along with systemd; If not, see . If replace-irreversibly is specified, operate like replace, but also mark the new jobs as irreversible. This prevents future conflicting - transactions from replacing these jobs. The jobs can still be - cancelled using the cancel command. + transactions from replacing these jobs (or even being enqueued + while the irreversible jobs are still pending). Irreversible + jobs can still be cancelled using the cancel + command. isolate is only valid for start operations and causes all other units to be stopped when the @@ -259,6 +291,8 @@ along with systemd; If not, see . snapshot, is-active, is-failed, + is-enabled, + is-system-running, enable and disable. @@ -288,6 +322,11 @@ along with systemd; If not, see . + + @@ -344,11 +383,36 @@ along with systemd; If not, see . 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 . + processes to send a signal to. Must be one of + , or + to select whether to kill only the main + process, the control process or all processes of the + unit. The main process of the unit is the one that defines + the life-time of it. A control process of a unit is one that + is invoked by the manager to induce state changes of it. For + example, all processes started due to the + ExecStartPre=, + ExecStop= or + ExecReload= settings of service units are + control processes. Note that there is only one control + process per unit at a time, as only one state change is + executed at a time. For services of type + Type=forking, the initial process started + by the manager for ExecStart= is a + control process, while the process ultimately forked off by + that one is then considered the main process of the unit (if + it can be determined). This is different for service units + of other types, where the process forked off by the manager + for ExecStart= is always the main process + itself. A service unit consists of zero or one main process, + zero or one control process plus any number of additional + processes. Not all unit types manage processes of these + types however. For example, for mount units, control processes + are defined (which are the invocations of + /usr/bin/mount and + /usr/bin/umount), but no main process + is defined. If omitted, defaults to + . @@ -383,7 +447,7 @@ along with systemd; If not, see . safe option to request an immediate reboot. If is specified twice for these operations, they will be executed immediately without - terminating any processes or umounting any file + terminating any processes or unmounting any file systems. Warning: specifying twice with any of these operations might result in data loss. @@ -422,6 +486,20 @@ along with systemd; If not, see . + + + + + Takes one of full (the default), + enable-only, + disable-only. When used with the + preset or preset-all + commands, controls whether units shall be disabled and + enabled according to the preset rules, or only enabled, or + only disabled. + + + @@ -508,7 +586,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service See also the options , - , and . + , and . @@ -522,7 +600,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service See also the options and - . + . @@ -567,8 +645,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service file. This command should not be confused with the - daemon-reload or load - commands. + daemon-reload command. @@ -637,9 +714,8 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service 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. + process to kill. Use to select + the signal to send. @@ -672,10 +748,11 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service Show terse runtime status information about one or more units, followed by most recent log data from the - journal. If no units are specified, show all units (subject - to limitations specified with ). If a PID - is passed, show information about the unit the process - belongs to. + journal. If no units are specified, show system status. If + combined with , also show the status of + all units (subject to limitations specified with + ). If a PID is passed, show information + about the unit the process belongs to. This function is intended to generate human-readable output. If you are looking for computer-parsable output, @@ -853,6 +930,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service the system, or for all future logins of all users, or only this boot. Note that in the last case, no systemd daemon configuration is reloaded. + + Using enable on masked units + results in an error. @@ -911,7 +991,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service enabled - Enabled through a symlink in .wants directory (permanently or just in /run) + Enabled through a symlink in .wants directory (permanently or just in /run). 0 @@ -919,7 +999,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service linked - Made available through a symlink to the unit file (permanently or just in /run) + Made available through a symlink to the unit file (permanently or just in /run). 1 @@ -927,7 +1007,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service masked - Disabled entirely (permanently or just in /run) + Disabled entirely (permanently or just in /run). 1 @@ -935,12 +1015,17 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service static - Unit is not enabled, but has no provisions for enabling in [Install] section + Unit file is not enabled, and has no provisions for enabling in the [Install] section. + 0 + + + indirect + Unit file itself is not enabled, but it has a non-empty Also= setting in the [Install] section, listing other unit files that might be enabled. 0 disabled - Unit is not enabled + Unit file is not enabled. 1 @@ -971,16 +1056,35 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service command 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. For - more information on the preset policy format, see + depending how the unit is listed in the preset files. + + Use to control + whether units shall be enabled and disabled, or only + enabled, or only disabled. + + For more information on the preset policy format, + see systemd.preset5. For more information on the concept of presets, please - consult the - Preset + consult the Preset document. + + preset-all + + + Resets all installed unit files to the defaults + configured in the preset policy file (see above). + + Use to control + whether units shall be enabled and disabled, or only + enabled, or only disabled. + + + mask NAME... @@ -990,10 +1094,10 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service /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. This honors the + activation of the unit, including enablement and manual + activation. Use this option with care. This honors the option to only mask temporarily - until the next reoobt of the system. + until the next reboot of the system. @@ -1007,6 +1111,25 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service + + add-wants TARGET + NAME... + add-requires TARGET + NAME... + + + Adds Wants= resp. Requires= + dependency to the specified TARGET for + one or more units. + + This command honors , + , and + in a similar way as + enable. + + + + link FILENAME... @@ -1185,10 +1308,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service Reload systemd manager configuration. This will reload all unit files and recreate the entire dependency tree. While the daemon is being reloaded, all sockets systemd - listens on on behalf of user configuration will stay + listens on behalf of user configuration will stay accessible. This command should not be confused - with the load or - reload commands. + with the reload command. @@ -1212,6 +1334,69 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service System Commands + + is-system-running + + + Checks whether the system is operational. This + returns success when the system is fully up and running, + meaning not in startup, shutdown or maintenance + mode. Failure is returned otherwise. In addition, the + current state is printed in a short string to standard + output, see table below. Use to + suppress this output. + + + Manager Operational States + + + + + + Name + Description + + + + + initializing + Early bootup, before + basic.target is reached + or the maintenance state entered. + + + + starting + Late bootup, before the job queue + becomes idle for the first time, or one of the + rescue targets are reached. + + + running + The system is fully + operational. + + + degraded + The system is operational but one or more + units failed. + + + maintenance + The rescue or emergency target is + active. + + + stopping + The manager is shutting + down. + + + +
+ + + default @@ -1220,6 +1405,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service isolate default.target. + rescue @@ -1373,7 +1559,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service Parameter Syntax - Unit ommands listed above take either a single unit name + Unit commands listed above take either a single unit name (designated as NAME), or multiple unit specifications (designated as PATTERN...). In the first case, the @@ -1445,7 +1631,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service systemd.unit5, systemd.resource-management5, systemd.special7, - wall1, + wall1, systemd.preset5 glob7