From e45fc5e738b0b7700e8b4f3c4b25c58a49b44b27 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 8 Jan 2015 19:14:08 +0100 Subject: [PATCH] man: bring machinectl man page up-to-date --- man/machinectl.xml | 295 +++++++++++++++++++++++++++++++++------ src/machine/machinectl.c | 2 +- 2 files changed, 252 insertions(+), 45 deletions(-) diff --git a/man/machinectl.xml b/man/machinectl.xml index ebe8e3b9d..91bdb5e11 100644 --- a/man/machinectl.xml +++ b/man/machinectl.xml @@ -76,27 +76,31 @@ - When showing - machine properties, limit the - output to certain properties as - specified by the argument. If not - specified, all set properties are - shown. The argument should be a - property name, such as - Name. If - specified more than once, all - properties with the specified names - are shown. + When showing machine + or image properties, limit the output + to certain properties as specified by + the argument. If not specified, all + set properties are shown. The argument + should be a property name, such as + Name. If specified + more than once, all properties with + the specified names are + shown. - When showing - machine properties, show all - properties regardless of whether they are - set or not. + When showing machine + or image properties, show all + properties regardless of whether they + are set or not. + + When listing VM or container + images, do not suppress images + beginning in a dot character + (.). @@ -208,16 +212,24 @@ + + + + Commands The following commands are understood: - + Machine Commands + list List currently running - virtual machines and containers. - + (online) virtual machines and + containers. To enumerate container + images that can be started, + use list-images + (see below). @@ -264,30 +276,92 @@ output. + + start NAME... + + Start a container as a + system service, using + systemd-nspawn1. + This starts + systemd-nspawn@.service, + instantiated for the specified machine + name, similar to the effect of + systemctl start on + the service + name. systemd-nspawn + looks for a container image by the + specified name in + /var/lib/container + and runs it. Use + list-images (see + below), for listing available + container images to start. + + Note that + systemd-machined.service8 + also interfaces with a variety of + other container and VM managers, + systemd-nspawn is + just one implementation of it. Most of + the commands available in + machinectl may be + used on containers or VMs controlled + by other managers, not just + systemd-nspawn. Starting + VMs and container images on those + managers requires manager-specific + tools. + + To interactively start a + container on the command line with + full access to the container's + console, please invoke + systemd-nspawn + directly. To stop a running container + use machinectl + poweroff, see + below. + + login NAME - Open a terminal login + Open an interactive 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. + as init system. + + This command will open a full + login prompt on the container, which + then asks for username and + password. Use + systemd-run1 + with the + switch to invoke a single command, + either interactively or in the + background within a local + container. - reboot NAME... - - 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. + enable NAME... + disable NAME... + + Enable or disable a + container as a system service to start + at system boot, using + systemd-nspawn1. + This enables or disables + systemd-nspawn@.service, + instantiated for the specified machine + name, similar to the effect of + systemctl enable or + systemctl disable + on the service name. @@ -302,8 +376,38 @@ not work on containers that do not run a systemd1-compatible - init system, such as - sysvinit. + init system, such as sysvinit. Use + terminate (see + below) to immediately terminate a + container or VM, without cleanly + shutting it down. + + + + reboot NAME... + + 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 + system manager. + + + + terminate NAME... + + Immediately terminates + a virtual machine or container, + without cleanly shutting it down. This + kills all processes of the virtual + machine or container and deallocates + all resources attached to that + instance. Use + poweroff to issue a + clean shutdown request. @@ -321,17 +425,6 @@ the signal to send. - - terminate NAME... - - Terminates a virtual - machine or container. This kills all - processes of the virtual machine or - container and deallocates all - resources attached to that - instance. - - bind NAME PATH [PATH] @@ -383,8 +476,122 @@ omitted the same as the source path is used. + - + Image Commands + + + list-images + + Show a list of locally + installed container and VM + images. This enumerates all raw disk + images and container directories and + subvolumes in + /var/lib/container/. Use + start (see above) + to run a container off one of the + listed images. Note that by default + containers whose name begins with a + dot (.) are not + shown. To show these too, specify + . Note that a + special image .host + always implicitly exists and refers to + the image the host itself is booted + from. + + + + image-status NAME... + + Show terse status + information about one or more + container or VM images. This function + is intended to generate human-readable + output. Use + show-image (see + below) to generate computer-parsable + output instead. + + + + show-image NAME... + + Show properties of one + or more registered virtual machine or + container images, or the manager + itself. If no argument is specified, + properties of the manager will be + shown. If an NAME is specified, + properties of this virtual machine or + container image are shown. By default, + empty properties are suppressed. Use + to show those + too. To select specific properties to + show, use + . This + command is intended to be used + whenever computer-parsable output is + required. Use + image-status if you + are looking for formatted + human-readable + output. + + + + clone NAME NAME + + Clones a container or + disk image. The arguments specify the + name of the image to clone and the + name of the newly cloned image. Note + that plain directory container images + are cloned into subvolume images with + this command. Note that cloning a + container or VM image is optimized for + btrfs file systems, and might not be + efficient on others, due to file + system limitations. + + + + rename NAME NAME + + Renames a container or + disk image. The arguments specify the + name of the image to rename and the + new name of the + image. + + + + read-only NAME [BOOL] + + Marks or (unmarks) a + container or disk image + read-only. Takes a VM or container + image name, followed by a boolean as + arguments. If the boolean is omitted, + positive is implied, i.e. the image is + marked read-only. + + + + + remove NAME... + + Removes one or more + container or disk images. The special + image .host, which + refers to the host's own directory + tree may not be + removed. + + + + diff --git a/src/machine/machinectl.c b/src/machine/machinectl.c index 939b64815..dbfc24541 100644 --- a/src/machine/machinectl.c +++ b/src/machine/machinectl.c @@ -1760,8 +1760,8 @@ static int help(int argc, char *argv[], void *userdata) { " list List running VMs and containers\n" " status NAME... Show VM/container details\n" " show NAME... Show properties of one or more VMs/containers\n" - " login NAME Get a login prompt on a container\n" " start NAME... Start container as a service\n" + " login NAME Get a login prompt on a container\n" " enable NAME... Enable automatic container start at boot\n" " disable NAME... Disable automatic container start at boot\n" " poweroff NAME... Power off one or more containers\n" -- 2.30.2