X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemctl.xml;h=5e55f29287051c154d4c5d7cae903e89096dda62;hb=f4889f656b477887b02caa5e9d27387309c75a87;hp=c7313edcc2bcb1ea57b4c41db2ae983c737d4add;hpb=63ba209d8bc64137ff1585d5878328c93cb81b61;p=elogind.git
diff --git a/man/systemctl.xml b/man/systemctl.xml
index c7313edcc..5e55f2928 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -63,19 +63,6 @@ along with systemd; If not, see .
introspect and control the state of the
systemd1
system and service manager.
-
- For unit commands, the NAME represents full name of the unit.
-
-systemctl start foo.service
-
- For unit file commands, the NAME represents the full name of the unit file, or the absolute path to the unit file.
-
-systemctl start /path/to/foo.service
-
- While working with services/service files, systemctl implicitly appends the ".service" suffix when it is missing.
-
-systemctl start foo
-
@@ -194,18 +181,6 @@ systemctl start foo
-
-
-
-
- If the requested operation conflicts with a pending
- unfinished job, fail the command. If this is not specified,
- the requested operation will replace the pending job, if
- necessary. Do not confuse with
- .
-
-
-
@@ -215,27 +190,58 @@ systemctl start foo
-
+
- Mark this transaction's jobs as irreversible. This prevents
- future conflicting transactions from replacing these jobs.
- The jobs can still be cancelled using the cancel
- command.
+ When queuing a new job, control how to deal with already
+ queued jobs. Takes one of fail,
+ replace,
+ replace-irreversibly,
+ isolate,
+ ignore-dependencies,
+ ignore-requirements or
+ flush. Defaults to
+ replace, except when the
+ isolate command is used which implies the
+ isolate job mode.
+
+ If fail is specified and a requested
+ operation conflicts with a pending job (more specifically:
+ causes an already pending start job to be reversed into a stop
+ job or vice versa), cause the operation to fail.
+
+ If replace (the default) is
+ specified, any conflicting pending job will be replaced, as
+ necessary.
+
+ 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.
+
+ isolate is only valid for start
+ operations and causes all other units to be stopped when the
+ specified unit is started. This mode is always used when the
+ isolate command is used.
+
+ flush will cause all queued jobs to
+ be canceled when the new job is enqueued.
+
+ If ignore-dependencies is specified,
+ then all unit dependencies are ignored for this new job and
+ the operation is executed immediately. If passed, no required
+ units of the unit passed will be pulled in, and no ordering
+ dependencies will be honored. This is mostly a debugging and
+ rescue tool for the administrator and should not be used by
+ applications.
+
+ ignore-requirements is similar to
+ ignore-dependencies but only causes the
+ requirement dependencies to be ignored, the ordering
+ dependencies will still be honoured.
-
-
-
-
-
- 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 honored. This is mostly a debugging and
- rescue tool for the administrator and should not be used by
- applications.
-
@@ -437,7 +443,7 @@ systemctl start foo
When used with enable,
- disable, is-enabled
+ disable,
(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
@@ -458,20 +464,19 @@ systemctl start foo
Execute the operation remotely. Specify a hostname, or
- username and hostname separated by @, to connect to. This
- will use SSH to talk to the remote systemd
+ 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.
-
+ Execute the operation on a local
+ container. Specify a container name to connect
+ to.
@@ -521,22 +526,26 @@ systemctl start foo
- list-units
+ list-units PATTERN...List known units (subject to limitations specified
- with ).
+ with ). If one or more
+ PATTERNs are specified, only
+ units matching one of them are shown.
This is the default command.
- list-sockets
+ list-sockets PATTERN...
- List socket units ordered by the listening address. Produces output
- similar to
+ List socket units ordered by the listening address.
+ If one or more PATTERNs are
+ specified, only socket units matching one of them are
+ shown. Produces output similar to
LISTEN UNIT ACTIVATES
/dev/initctl systemd-initctl.socket systemd-initctl.service
@@ -555,6 +564,20 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
+
+ list-timers PATTERN...
+
+
+ List timer units ordered by the time they elapse
+ next. If one or more PATTERNs
+ are specified, only units matching one of them are shown.
+
+
+ See also the options and
+ .
+
+
+
start NAME...
@@ -685,7 +708,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- status [NAME...|PID...]
+ statusNAME...|PID...]Show terse runtime status information about one or
@@ -701,7 +724,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- show [NAME...|JOB...]
+ showNAME...|JOB...Show properties of one or more units, jobs, or the
@@ -717,7 +740,16 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
human-readable output.
+
+ cat NAME...
+
+ Show backing files of one or more units. Prints the
+ "fragment" and "drop-ins" (source files) of units. Each
+ file is preceded by a comment which includes the file
+ name.
+
+ set-property NAMEASSIGNMENT...
@@ -789,10 +821,13 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- list-unit-files
+ list-unit-files PATTERN...
- List installed unit files.
+ List installed unit files. If one or more
+ PATTERNs are specified, only
+ units whose filename (just the last component of the path)
+ matches one of them are shown.
@@ -885,10 +920,64 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
Checks whether any of the specified unit files are
- enabled (as with enable). Returns an exit
- code of 0 if at least one is enabled, non-zero
- otherwise. Prints the current enable status. To suppress
- this output, use .
+ enabled (as with enable). Returns an
+ exit code of 0 if at least one is enabled, non-zero
+ otherwise. Prints the current enable status (see table).
+ To suppress this output, use .
+
+
+
+
+ is-enabled output
+
+
+
+
+
+ Printed string
+ Meaning
+ Return value
+
+
+
+
+ enabled
+ Enabled through a symlink in .wants directory (permanently or just in /run)
+ 0
+
+
+ enabled-runtime
+
+
+ linked
+ Made available through a symlink to the unit file (permanently or just in /run)
+ 1
+
+
+ linked-runtime
+
+
+ masked
+ Disabled entirely (permanently or just in /run)
+ 1
+
+
+ masked-runtime
+
+
+ static
+ Unit is not enabled, but has no provisions for enabling in [Install] section
+ 1
+
+
+ disabled
+ Unit is not enabled
+ 1
+
+
+
+
+
@@ -988,10 +1077,12 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- list-jobs
+ list-jobs PATTERN...
- List jobs that are in progress.
+ List jobs that are in progress. If one or more
+ PATTERNs are specified, only
+ jobs for units matching one of them are shown.
@@ -1011,7 +1102,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- snapshot [NAME]
+ snapshot NAMECreate a snapshot. If a snapshot name is specified,
@@ -1179,7 +1270,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- reboot
+ reboot argShut down and reboot the system. This is mostly
@@ -1192,6 +1283,16 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
specified twice, the operation is immediately executed
without terminating any processes or unmounting any file
systems. This may result in data loss.
+
+ If the optional argument
+ arg is given, it will be passed
+ as the optional argument to the
+ reboot2
+ system call. The value is architecture and firmware
+ specific. As an example, recovery might
+ be used to trigger system recovery, and
+ fota might be used to trigger a
+ firmware over the air update.
@@ -1246,7 +1347,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- switch-root ROOT [INIT]
+ switch-root ROOTINITSwitches to a different root directory and executes a
@@ -1268,6 +1369,28 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
+
+ Parameter Syntax
+
+ For unit commands the specified
+ NAME should be the full name of the
+ unit, or an abbreviated name which is automatically extended with
+ the .service suffix.
+ # systemctl start foo.service is equivalent to:
+ # systemctl start foo
+ Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute) paths to mount unit names.
+ # systemctl status /dev/sda
+# systemctl status /home is equivalent to:
+ # systemctl status dev-sda.device
+# systemctl status home.mount
+
+ For unit file commands the
+ specified NAME should be the full name
+ of the unit file, or the absolute path to the unit file.
+ # systemctl link /path/to/foo.service
+
+
+