X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fmachinectl.xml;h=9d8a94aab4335fac91803631c2d402a371288bc1;hp=2606180d123d70890d217502e5099d6f4777b547;hb=785890acf6d629ff881a1f065f431df1b7fc8c7a;hpb=19887cd06a3af2f045e763986eda19e208bd3f85 diff --git a/man/machinectl.xml b/man/machinectl.xml index 2606180d1..9d8a94aab 100644 --- a/man/machinectl.xml +++ b/man/machinectl.xml @@ -21,7 +21,8 @@ along with systemd; If not, see . --> - + machinectl @@ -71,29 +72,14 @@ The following options are understood: - - - - - Prints a short help - text and exits. - - - - - - Prints a short version - string and exits. - - When showing - session/user properties, limit - display to certain properties as - specified as argument. If not + 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 @@ -108,8 +94,8 @@ When showing - unit/job/manager properties, show all - properties regardless whether they are + machine properties, show all + properties regardless of whether they are set or not. @@ -117,37 +103,22 @@ - Do not ellipsize cgroup - members. + Do not ellipsize + process tree entries. - - - - Do not pipe output into a - pager. - - - - - - Do not query the user - for authentication for privileged - operations. - - When used with - kill-session, + kill, choose which processes to kill. Must be one of , or to select whether to kill only the leader process of the - session or all processes of the - session. If omitted, defaults to + machine or all processes of the + machine. If omitted, defaults to . @@ -156,11 +127,10 @@ When used with - kill-session or - kill-user, choose + kill, choose which signal to send to selected - processes. Must be one of the well - known signal specifiers, such as + processes. Must be one of the + well-known signal specifiers, such as SIGTERM, SIGINT or SIGSTOP. If @@ -169,25 +139,38 @@ - - - - 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. + + + 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. + - - + - Acquire privileges via - PolicyKit before executing the - operation. + When used with + bind applies a + read-only bind + mount. + + + + + + + The following commands are understood: @@ -202,7 +185,7 @@ - status [ID...] + status ID... Show terse runtime status information about one or more @@ -215,13 +198,13 @@ - show [ID...] + show ID... 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 a an + of the manager will be shown. If an ID is specified, properties of this virtual machine or container are shown. By default, empty properties @@ -239,18 +222,49 @@ - terminate [ID...] + login ID + + 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. + - Terminates a virtual - machine or container. This kills all - processes of the virtual machine or - container and deallocates all - resources attached to that - instance. + + reboot ID... + + 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. - kill [ID...] + poweroff ID... + + 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. + + + + kill ID... Send a signal to one or more processes of the virtual @@ -263,6 +277,43 @@ to select the signal to send. + + + terminate ID... + + 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 ID DIRECTORY [DIRECTORY] + + 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. + + @@ -274,27 +325,14 @@ 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 systemd-machined.service8, - systemd-logind.service8 + systemd-nspawn1, + systemd.special7