X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=3ac6f628e2c516ed45719418243dd9f7128f0506;hp=28a7cca0ede14c542d77413c547ca4ba290e0190;hb=92ff080be100aff15f292e2631921131c610afe7;hpb=dca348bcbb462305864526c587495a14a76bfcde diff --git a/man/systemctl.xml b/man/systemctl.xml index 28a7cca0e..3ac6f628e 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. @@ -148,9 +151,12 @@ along with systemd; If not, see . Show reverse dependencies between units with - list-dependencies, i.e. units with - dependencies of type Wants= or - Requires= on the given unit. + list-dependencies, i.e. follow + dependencies of type WantedBy=, + RequiredBy=, + RequiredByOverrridable=, + PartOf=, BoundBy=, + instead of Wants= and similar. @@ -161,10 +167,20 @@ 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. + words, recursively list units following the + After= dependency. + + Note that any After= dependency is + automatically mirrored to create a + Before= dependency. Temporal dependencies + may be specified explicitly, but are also created implicitly + for units which are WantedBy= targets + (see + systemd.target5), + and as a result of other directives (for example + RequiresMountsFor=). Both explicitly + and implicitly introduced dependencies are shown with + list-dependencies. @@ -174,10 +190,8 @@ along with systemd; If not, see . 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. + words, recursively list units following the + Before= dependency. @@ -230,8 +244,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 @@ -286,6 +302,8 @@ along with systemd; If not, see . snapshot, is-active, is-failed, + is-enabled, + is-system-running, enable and disable. @@ -315,6 +333,11 @@ along with systemd; If not, see . + + @@ -385,17 +408,17 @@ along with systemd; If not, see . 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 + 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 no or one main process, - no or one control process plus any number of additional + 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 + 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 @@ -435,7 +458,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. @@ -459,7 +482,7 @@ along with systemd; If not, see . When used with enable, - disable, + disable, edit, (and related commands), make changes only temporarily, so that they are lost on the next reboot. This will have the effect that changes are not made in subdirectories of @@ -474,6 +497,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. + + + @@ -560,7 +597,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service See also the options , - , and . + , and . @@ -574,7 +611,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service See also the options and - . + . @@ -619,8 +656,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. @@ -669,7 +705,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service Start the unit specified on the command line and its - dependencies and stop all others. + dependencies and stop all others. If a unit name with no + extension is given, an extension of + .target will be assumed. This is similar to changing the runlevel in a traditional init system. The isolate @@ -724,7 +762,7 @@ 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 system status. If - combined with also show the status of + 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. @@ -823,15 +861,30 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service - list-dependencies NAME + + list-dependencies + NAME + - Shows required and wanted units of the specified - unit. If no unit is specified, - default.target is implied. Target units - are recursively expanded. When is - passed, all other units are recursively expanded as - well. + Shows units required and wanted by the specified + unit. This recursively lists units following the + Requires=, + RequiresOverridable=, + Requisite=, + RequisiteOverridable=, + Wants=, BindsTo= + dependencies. If no unit is specified, + default.target is implied. + + By default, only target units are recursively + expanded. When is passed, all other + units are recursively expanded as well. + + Options , + , + may be used to change what types of dependencies + are shown. @@ -905,6 +958,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. @@ -963,7 +1019,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 @@ -971,7 +1027,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 @@ -979,7 +1035,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 @@ -987,12 +1043,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 @@ -1023,16 +1084,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... @@ -1042,10 +1122,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. @@ -1059,6 +1139,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... @@ -1090,6 +1189,43 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service default.target to the given unit. + + + edit NAME... + + + Edit a drop-in snippet or a whole replacement file if + is specified, to extend or override the + specified unit. + + Depending on whether (the default), + , or is specified, + this creates a drop-in file for each unit either for the system, + for the calling user or for all futures logins of all users. Then, + the editor (see the "Environment" section below) is invoked on + temporary files which will be written to the real location if the + editor exits successfully. + + If is specified, this will copy the + original units instead of creating drop-in files. + + If is specified, the changes will + be made temporarily in /run and they will be + lost on the next reboot. + + If the temporary file is empty upon exit the modification of + the related unit is canceled + + After the units have been edited, systemd configuration is + reloaded (in a way that is equivalent to daemon-reload). + + + Note that this command cannot be used to remotely edit units + and that you cannot temporarily edit units which are in + /etc since they take precedence over + /run. + + @@ -1237,10 +1373,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. @@ -1264,6 +1399,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 @@ -1272,6 +1470,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service isolate default.target. + rescue @@ -1425,7 +1624,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 @@ -1437,9 +1636,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service # systemctl start sshd and # systemctl start sshd.service are equivalent, as are - # systemctl isolate snapshot-11 + # systemctl isolate default and - # systemctl isolate snapshot-11.snapshot + # systemctl isolate default.target Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute) paths to mount unit names. @@ -1485,7 +1684,28 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service code otherwise.
- + + Environment + + + + $SYSTEMD_EDITOR + + Editor to use when editing units; overrides + $EDITOR and $VISUAL. If neither + $SYSTEMD_EDITOR nor $EDITOR nor + $VISUAL are present or if it is set to an empty + string or if their execution failed, systemctl will try to execute well + known editors in this order: + nano1, + vim1, + vi1. + + + + + + See Also @@ -1497,8 +1717,8 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service systemd.unit5, systemd.resource-management5, systemd.special7, - wall1, - systemd.preset5 + wall1, + systemd.preset5, glob7