X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fmachinectl.xml;h=eef1740f95eb37243cbd22371d25b0b06d7f84b8;hb=e7aa89f9096de9e0173260267ed3f1914f860ebc;hp=89ab47402cd4f378a6dc448cb8d3a76ee12d6b7a;hpb=6bebb0add4d7c32c503e688105c1607e5e20f979;p=elogind.git
diff --git a/man/machinectl.xml b/man/machinectl.xml
index 89ab47402..eef1740f9 100644
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -72,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 print the legend,
- i.e. the column headers and the
- footer.
-
-
-
-
-
-
- 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 machine manager
- instance.
-
-
-
-
-
-
- Execute the operation on a
- local container. Specify a container
- name to connect to.
-
-
@@ -189,6 +138,39 @@
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.
+
+
+
+
+
+
+
+ The following commands are understood:
@@ -203,7 +185,7 @@
- statusID...
+ statusNAME...Show terse runtime
status information about one or more
@@ -216,14 +198,14 @@
- showID...
+ 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
@@ -240,18 +222,49 @@
- terminateID...
+ 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.
+
+
+
+ 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.
- killID...
+ 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
@@ -266,29 +279,68 @@
- rebootID...
+ terminateNAME...
- 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.
+ Terminates a virtual
+ machine or container. This kills all
+ processes of the virtual machine or
+ container and deallocates all
+ resources attached to that
+ instance.
- loginID
+ 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.
+
- 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.
+
+ 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.
+