X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fmachinectl.xml;h=baa0e17e3679bad93c0a3d2310214f80286488cc;hb=8b0cc9a36c8f92f010f2e8465942d2cd7c580d78;hp=c06d0c7abb9def6720b4619c533787ca9c597df8;hpb=04d39279245834494baccfdb9349db8bf80abd13;p=elogind.git
diff --git a/man/machinectl.xml b/man/machinectl.xml
index c06d0c7ab..baa0e17e3 100644
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -21,7 +21,8 @@
along with systemd; If not, see .
-->
-
+machinectl
@@ -71,57 +72,6 @@
The following options are understood:
-
-
-
-
- Prints a short help
- text and exits.
-
-
-
-
-
- Prints a short version
- string and exits.
-
-
-
-
-
- Do not pipe output into a
- pager.
-
-
-
-
-
- Do not query the user
- for authentication for privileged
- operations.
-
-
-
-
-
-
- Execute operation
- remotely. Specify a hostname, or
- username and hostname separated by @,
- to connect to. This will use SSH to
- talk to the remote machine manager
- instance.
-
-
-
-
-
-
- Execute operation on a
- local container. Specify a container
- name to connect to.
-
-
@@ -162,7 +112,7 @@
When used with
- kill-machine,
+ kill,
choose which processes to kill. Must
be one of , or
to select whether
@@ -177,7 +127,7 @@
When used with
- kill-machine, choose
+ kill, choose
which signal to send to selected
processes. Must be one of the
well-known signal specifiers, such as
@@ -188,6 +138,67 @@
SIGTERM.
+
+
+
+ Do not print the legend,
+ i.e. the column headers and the
+ footer.
+
+
+
+
+
+ When used with
+ bind creates the
+ destination directory before applying
+ the bind mount.
+
+
+
+
+
+
+ When used with
+ bind applies a
+ read-only bind
+ mount.
+
+
+
+
+
+
+
+ When used with
+ status, controls
+ the number of journal lines to show,
+ counting from the most recent
+ ones. Takes a positive integer
+ argument. Defaults to 10.
+
+
+
+
+
+
+
+ When used with
+ status, controls
+ the formatting of the journal entries
+ that are shown. For the available
+ choices, see
+ journalctl1.
+ Defaults to
+ short.
+
+
+
+
+
+
+
+ The following commands are understood:
@@ -202,27 +213,34 @@
- status [ID...]
+ statusNAME...Show terse runtime
status information about one or more
- virtual machines and containers. This
- function is intended to generate
- human-readable output. If you are
- looking for computer-parsable output,
- use show instead.
-
+ virtual machines and containers,
+ followed by the most recent log data
+ from the journal. This function is
+ intended to generate human-readable
+ output. If you are looking for
+ computer-parsable output, use
+ show instead. Note
+ that the log data shown is reported by
+ the virtual machine or container
+ manager, and frequently contains
+ console output of the machine, but not
+ necessarily journal contents of the
+ machine itself.
- show [ID...]
+ showNAME...Show properties of one
or more registered virtual machines or
containers or the manager itself. If
no argument is specified, properties
of the manager will be shown. If an
- ID is specified, properties of this
+ NAME is specified, properties of this
virtual machine or container are
shown. By default, empty properties
are suppressed. Use
@@ -239,18 +257,49 @@
- terminate [ID...]
+ loginNAME
- Terminates a virtual
- machine or container. This kills all
- processes of the virtual machine or
- container and deallocates all
- resources attached to that
- instance.
+ Open a terminal login
+ session to a container. This will
+ create a TTY connection to a specific
+ container and asks for the execution of a
+ getty on it. Note that this is only
+ supported for containers running
+ systemd1
+ as init system.
- kill [ID...]
+ rebootNAME...
+
+ Reboot one or more
+ containers. This will trigger a reboot
+ by sending SIGINT to the container's
+ init process, which is roughly
+ equivalent to pressing Ctrl+Alt+Del on
+ a non-containerized system, and is
+ compatible with containers running any
+ init system.
+
+
+
+ poweroffNAME...
+
+ Power off one or more
+ containers. This will trigger a reboot
+ by sending SIGRTMIN+4 to the
+ container's init process, which causes
+ systemd-compatible init systems to
+ shut down cleanly. This operation does
+ not work on containers that do not run
+ a
+ systemd1-compatible
+ init system, such as
+ sysvinit.
+
+
+
+ killNAME...Send a signal to one
or more processes of the virtual
@@ -265,17 +314,68 @@
- login [ID]
+ terminateNAME...
- Open a terminal login
- session to a container. This will
- create a TTY connection to a specific
- container and asks for execution of a
- getty on it. Note that this is only
- supported for containers running
- systemd1
- as init system.
+ Terminates a virtual
+ machine or container. This kills all
+ processes of the virtual machine or
+ container and deallocates all
+ resources attached to that
+ instance.
+
+
+
+ bindNAMEPATH [PATH]
+
+ Bind mounts a
+ directory from the host into the
+ specified container. The first
+ directory argument is the source
+ directory on the host, the second
+ directory argument the source
+ directory on the host. When the latter
+ is omitted the destination path in the
+ container is the same as the source
+ path on the host. When combined with
+ the
+ switch a ready-only bind mount is
+ created. When combined with the
+ switch the
+ destination path is first created
+ before the mount is applied. Note that
+ this option is currently only
+ supported for
+ systemd-nspawn1
+ containers.
+
+
+ copy-toNAMEPATH [PATH]
+
+ Copies files or
+ directories from the host system into
+ a running container. Takes a container
+ name, followed by the source path on
+ the host and the destination path in
+ the container. If the destination path
+ is omitted the same as the source path
+ is used.
+
+
+
+
+ copy-fromNAMEPATH [PATH]
+
+ Copies files or
+ directories from a container into the
+ host system. Takes a container name,
+ followed by the source path in the
+ container the destination path on the
+ host. If the destination path is
+ omitted the same as the source path is
+ used.
+
+
@@ -287,21 +387,7 @@
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