diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:52:03 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:52:03 +0000 |
commit | 932e4432596447eb9331cc2a2bb74a26a35b4efc (patch) | |
tree | 95161711ea07fd64f0c82d6e7943024c033dd5a8 /upstream/opensuse-tumbleweed/man1/machinectl.1 | |
parent | Adding debian version 4.22.0-1. (diff) | |
download | manpages-l10n-932e4432596447eb9331cc2a2bb74a26a35b4efc.tar.xz manpages-l10n-932e4432596447eb9331cc2a2bb74a26a35b4efc.zip |
Merging upstream version 4.23.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/opensuse-tumbleweed/man1/machinectl.1')
-rw-r--r-- | upstream/opensuse-tumbleweed/man1/machinectl.1 | 126 |
1 files changed, 119 insertions, 7 deletions
diff --git a/upstream/opensuse-tumbleweed/man1/machinectl.1 b/upstream/opensuse-tumbleweed/man1/machinectl.1 index f4ba529b..af1ac2b0 100644 --- a/upstream/opensuse-tumbleweed/man1/machinectl.1 +++ b/upstream/opensuse-tumbleweed/man1/machinectl.1 @@ -1,5 +1,5 @@ '\" t -.TH "MACHINECTL" "1" "" "systemd 254" "machinectl" +.TH "MACHINECTL" "1" "" "systemd 255" "machinectl" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -142,6 +142,8 @@ List currently running (online) virtual machines and containers\&. To enumerate machine by default\&. Use the \fB\-\-all\fR switch to show it\&. +.sp +Added in version 206\&. .RE .PP \fBstatus\fR \fINAME\fR\&... @@ -149,6 +151,8 @@ switch to show it\&. Show runtime status information about one or more 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 \fBshow\fR 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\&. +.sp +Added in version 206\&. .RE .PP \fBshow\fR [\fINAME\fR\&...] @@ -159,6 +163,8 @@ to show those too\&. To select specific properties to show, use \fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required, and does not print the control group tree or journal entries\&. Use \fBstatus\fR if you are looking for formatted human\-readable output\&. +.sp +Added in version 206\&. .RE .PP \fBstart\fR \fINAME\fR\&... @@ -188,6 +194,8 @@ To interactively start a container on the command line with full access to the c \fBsystemd\-nspawn\fR directly\&. To stop a running container use \fBmachinectl poweroff\fR\&. +.sp +Added in version 219\&. .RE .PP \fBlogin\fR [\fINAME\fR] @@ -205,6 +213,8 @@ This command will open a full login prompt on the container or the local host, w with the \fB\-\-machine=\fR switch to directly invoke a single command, either interactively or in the background\&. +.sp +Added in version 209\&. .RE .PP \fBshell\fR [[\fINAME\fR@]\fINAME\fR [\fIPATH\fR [\fIARGUMENTS\fR\&...]]] @@ -253,6 +263,8 @@ is preferable for scripting purposes\&. However, note that \fBsystemd\-run\fR might require higher privileges than \fBmachinectl shell\fR\&. +.sp +Added in version 225\&. .RE .PP \fBenable\fR \fINAME\fR\&..., \fBdisable\fR \fINAME\fR\&... @@ -268,6 +280,8 @@ on the service name\&. This command implicitly reloads the system manager configuration after completing the operation\&. Note that this command does not implicitly start or power off the containers that are being operated on\&. If this is desired, combine the command with the \fB\-\-now\fR switch\&. +.sp +Added in version 219\&. .RE .PP \fBpoweroff\fR \fINAME\fR\&... @@ -279,11 +293,15 @@ as alias for \fBsystemd\fR(1)\-compatible init system, such as sysvinit\&. Use \fBterminate\fR (see below) to immediately terminate a container or VM, without cleanly shutting it down\&. +.sp +Added in version 212\&. .RE .PP \fBreboot\fR \fINAME\fR\&... .RS 4 Reboot one or more containers\&. This will trigger a reboot by sending SIGINT to the container\*(Aqs 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\&. +.sp +Added in version 209\&. .RE .PP \fBterminate\fR \fINAME\fR\&... @@ -291,6 +309,8 @@ Reboot one or more containers\&. This will trigger a reboot by sending SIGINT to 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 \fBpoweroff\fR to issue a clean shutdown request\&. +.sp +Added in version 206\&. .RE .PP \fBkill\fR \fINAME\fR\&... @@ -300,6 +320,8 @@ Send a signal to one or more processes of the virtual machine or container\&. Th to select which process to kill\&. Use \fB\-\-signal=\fR to select the signal to send\&. +.sp +Added in version 206\&. .RE .PP \fBbind\fR \fINAME\fR \fIPATH\fR [\fIPATH\fR] @@ -313,6 +335,8 @@ switch, the destination path is first created before the mount is applied\&. Not containers, and only if user namespacing (\fB\-\-private\-users\fR) is not used\&. This command supports bind mounting directories, regular files, device nodes, \fBAF_UNIX\fR socket nodes, as well as FIFOs\&. +.sp +Added in version 219\&. .RE .PP \fBcopy\-to\fR \fINAME\fR \fIPATH\fR [\fIPATH\fR] \fB\-\-force\fR @@ -320,6 +344,8 @@ socket nodes, as well as FIFOs\&. 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\&. .sp If host and container share the same user and group namespace, file ownership by numeric user ID and group ID is preserved for the copy, otherwise all files and directories in the copy will be owned by the root user and group (UID/GID 0)\&. +.sp +Added in version 219\&. .RE .PP \fBcopy\-from\fR \fINAME\fR \fIPATH\fR [\fIPATH\fR] \fB\-\-force\fR @@ -327,6 +353,8 @@ If host and container share the same user and group namespace, file ownership by Copies files or directories from a container into the host system\&. Takes a container name, followed by the source path in the container and the destination path on the host\&. If the destination path is omitted, the same as the source path is used\&. .sp If host and container share the same user and group namespace, file ownership by numeric user ID and group ID is preserved for the copy, otherwise all files and directories in the copy will be owned by the root user and group (UID/GID 0)\&. +.sp +Added in version 219\&. .RE .SS "Image Commands" .PP @@ -340,6 +368,8 @@ Show a list of locally installed container and VM images\&. This enumerates all \fB\-\-all\fR\&. Note that a special image "\&.host" always implicitly exists and refers to the image the host itself is booted from\&. +.sp +Added in version 219\&. .RE .PP \fBimage\-status\fR [\fINAME\fR\&...] @@ -347,6 +377,8 @@ always implicitly exists and refers to the image the host itself is booted from\ Show terse status information about one or more container or VM images\&. This function is intended to generate human\-readable output\&. Use \fBshow\-image\fR (see below) to generate computer\-parsable output instead\&. +.sp +Added in version 219\&. .RE .PP \fBshow\-image\fR [\fINAME\fR\&...] @@ -357,6 +389,8 @@ to show those too\&. To select specific properties to show, use \fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use \fBimage\-status\fR if you are looking for formatted human\-readable output\&. +.sp +Added in version 219\&. .RE .PP \fBedit\fR \fINAME|FILE\fR @@ -365,12 +399,16 @@ Edit the settings file of the specified machines\&. For the format of the settin \fBsystemd.nspawn\fR(5)\&. If an existing settings file of the given machine can\*(Aqt be found, \fBedit\fR automatically create a new settings file from scratch under -/etc/systemd/nspawn/ +/etc/systemd/nspawn/\&. +.sp +Added in version 254\&. .RE .PP \fBcat\fR \fINAME|FILE\fR .RS 4 Show the settings file of the specified machines\&. +.sp +Added in version 254\&. .RE .PP \fBclone\fR \fINAME\fR \fINAME\fR @@ -382,22 +420,30 @@ Note that this command leaves hostname, machine ID and all other settings that c If combined with the \fB\-\-read\-only\fR switch a read\-only cloned image is created\&. +.sp +Added in version 219\&. .RE .PP \fBrename\fR \fINAME\fR \fINAME\fR .RS 4 Renames a container or VM image\&. The arguments specify the name of the image to rename and the new name of the image\&. +.sp +Added in version 219\&. .RE .PP \fBread\-only\fR \fINAME\fR [\fIBOOL\fR] .RS 4 Marks or (unmarks) a container or VM 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\&. +.sp +Added in version 219\&. .RE .PP \fBremove\fR \fINAME\fR\&... .RS 4 Removes one or more container or VM images\&. The special image "\&.host", which refers to the host\*(Aqs own directory tree, may not be removed\&. +.sp +Added in version 219\&. .RE .PP \fBset\-limit\fR [\fINAME\fR] \fIBYTES\fR @@ -407,6 +453,8 @@ Sets the maximum size in bytes that a specific container or VM image, or all ima as size\&. .sp Note that per\-container size limits are only supported on btrfs file systems\&. +.sp +Added in version 220\&. .RE .PP \fBclean\fR @@ -428,6 +476,8 @@ or usually create hidden, read\-only, unmodified machine images from the downloaded image first, before cloning a writable working copy of it, in order to avoid duplicate downloads in case of images that are reused multiple times\&. Use \fBmachinectl clean\fR to remove old, hidden images created this way\&. +.sp +Added in version 230\&. .RE .SS "Image Transfer Commands" .PP @@ -484,6 +534,8 @@ is passed\&. .sp Note that pressing C\-c during execution of this command will not abort the download\&. Use \fBcancel\-transfer\fR, described below\&. +.sp +Added in version 219\&. .RE .PP \fBpull\-raw\fR \fIURL\fR [\fINAME\fR] @@ -522,6 +574,8 @@ is passed\&. .sp Note that pressing C\-c during execution of this command will not abort the download\&. Use \fBcancel\-transfer\fR, described below\&. +.sp +Added in version 219\&. .RE .PP \fBimport\-tar\fR \fIFILE\fR [\fINAME\fR], \fBimport\-raw\fR \fIFILE\fR [\fINAME\fR] @@ -543,6 +597,8 @@ Much like image downloads, ongoing imports may be listed with \fBlist\-transfers\fR and aborted with \fBcancel\-transfer\fR\&. +.sp +Added in version 220\&. .RE .PP \fBimport\-fs\fR \fIDIRECTORY\fR [\fINAME\fR] @@ -552,6 +608,8 @@ Imports a container image stored in a local directory into \fBimport\-tar\fR or \fBimport\-raw\fR, but the first argument is the source directory\&. If supported, this command will create a btrfs snapshot or subvolume for the new image\&. +.sp +Added in version 240\&. .RE .PP \fBexport\-tar\fR \fINAME\fR [\fIFILE\fR], \fBexport\-raw\fR \fINAME\fR [\fIFILE\fR] @@ -569,17 +627,23 @@ and aborted with \fBcancel\-transfer\fR\&. .sp Note that, currently, only directory and subvolume images may be exported as TAR images, and only raw disk images as RAW images\&. +.sp +Added in version 220\&. .RE .PP \fBlist\-transfers\fR .RS 4 Shows a list of container or VM image downloads, imports and exports that are currently in progress\&. +.sp +Added in version 219\&. .RE .PP \fBcancel\-transfer\fR \fIID\fR\&... .RS 4 Aborts a download, import or export of the container or VM image with the specified ID\&. To list ongoing transfers and their IDs, use \fBlist\-transfers\fR\&. +.sp +Added in version 219\&. .RE .SH "OPTIONS" .PP @@ -589,6 +653,8 @@ The following options are understood: .RS 4 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\&. +.sp +Added in version 206\&. .RE .PP \fB\-a\fR, \fB\-\-all\fR @@ -598,6 +664,8 @@ When showing machine or image properties, show all properties regardless of whet When listing VM or container images, do not suppress images beginning in a dot character ("\&.")\&. .sp When cleaning VM or container images, remove all images, not just hidden ones\&. +.sp +Added in version 206\&. .RE .PP \fB\-\-value\fR @@ -605,12 +673,16 @@ When cleaning VM or container images, remove all images, not just hidden ones\&. When printing properties with \fBshow\fR, only print the value, and skip the property name and "="\&. +.sp +Added in version 230\&. .RE .PP \fB\-l\fR, \fB\-\-full\fR .RS 4 Do not ellipsize process tree entries or table\&. This implies \fB\-\-max\-addresses=full\fR\&. +.sp +Added in version 206\&. .RE .PP \fB\-\-kill\-whom=\fR @@ -621,6 +693,8 @@ When used with \fBall\fR to select whether to kill only the leader process of the machine or all processes of the machine\&. If omitted, defaults to \fBall\fR\&. +.sp +Added in version 206\&. .RE .PP \fB\-s\fR, \fB\-\-signal=\fR @@ -651,6 +725,8 @@ command also specifies a user name, this option is ignored\&. If the name is not will be used by default\&. Note that this switch is not supported for the \fBlogin\fR command (see below)\&. +.sp +Added in version 225\&. .RE .PP \fB\-E \fR\fB\fINAME\fR\fR\fB[=\fR\fB\fIVALUE\fR\fR\fB]\fR, \fB\-\-setenv=\fR\fB\fINAME\fR\fR\fB[=\fR\fB\fIVALUE\fR\fR\fB]\fR @@ -666,12 +742,16 @@ are omitted, the value of the variable with the same name in the program environ Note that this option is not supported for the \fBlogin\fR command\&. +.sp +Added in version 230\&. .RE .PP \fB\-\-mkdir\fR .RS 4 When used with \fBbind\fR, creates the destination file or directory before applying the bind mount\&. Note that even though the name of this option suggests that it is suitable only for directories, this option also creates the destination file node to mount over if the object to mount is not a directory, but a regular file, device node, socket or FIFO\&. +.sp +Added in version 219\&. .RE .PP \fB\-\-read\-only\fR @@ -685,12 +765,16 @@ When used with or \fBimport\-tar\fR a read\-only container or VM image is created\&. +.sp +Added in version 219\&. .RE .PP \fB\-n\fR, \fB\-\-lines=\fR .RS 4 When used with \fBstatus\fR, controls the number of journal lines to show, counting from the most recent ones\&. Takes a positive integer argument\&. Defaults to 10\&. +.sp +Added in version 219\&. .RE .PP \fB\-o\fR, \fB\-\-output=\fR @@ -699,6 +783,8 @@ When used with \fBstatus\fR, controls the formatting of the journal entries that are shown\&. For the available choices, see \fBjournalctl\fR(1)\&. Defaults to "short"\&. +.sp +Added in version 219\&. .RE .PP \fB\-\-verify=\fR @@ -716,6 +802,8 @@ is specified, the checksum is verified and the image\*(Aqs signature is checked "signature" if the server and protocol support this\&. Defaults to "signature"\&. +.sp +Added in version 219\&. .RE .PP \fB\-\-now\fR @@ -724,11 +812,15 @@ When used with \fBenable\fR or \fBdisable\fR, the containers will also be started or powered off\&. The start or poweroff operation is only carried out when the respective enable or disable operation has been successful\&. +.sp +Added in version 253\&. .RE .PP \fB\-\-force\fR .RS 4 When downloading a container or VM image, and a local copy by the specified local machine name already exists, delete it first and replace it by the newly downloaded image\&. +.sp +Added in version 219\&. .RE .PP \fB\-\-format=\fR @@ -742,6 +834,8 @@ commands, specifies the compression format to use for the resulting file\&. Take "xz", "gzip", "bzip2"\&. By default, the format is determined automatically from the image file name passed\&. +.sp +Added in version 220\&. .RE .PP \fB\-\-max\-addresses=\fR @@ -752,11 +846,15 @@ command, limits the number of IP addresses shown for every machine\&. Defaults t "all"\&. If the limit is 0, the address column is not shown\&. Otherwise, if the machine has more addresses than shown, "\&..." follows the last address\&. +.sp +Added in version 232\&. .RE .PP \fB\-q\fR, \fB\-\-quiet\fR .RS 4 Suppresses additional informational output while running\&. +.sp +Added in version 236\&. .RE .PP \fB\-H\fR, \fB\-\-host=\fR @@ -773,6 +871,8 @@ Execute the operation remotely\&. Specify a hostname, or a username and hostname Connect to \fBsystemd-machined.service\fR(8) running in a local container, to perform the specified operation within the container\&. +.sp +Added in version 235\&. .RE .PP \fB\-\-no\-pager\fR @@ -916,13 +1016,13 @@ to open a shell in it\&. .\} .nf # machinectl pull\-raw \-\-verify=no \e - https://download\&.fedoraproject\&.org/pub/fedora/linux/releases/37/Cloud/x86_64/images/Fedora\-Cloud\-Base\-37\-1\&.7\&.x86_64\&.raw\&.xz \e - Fedora\-Cloud\-Base\-37\-1\&.7\&.x86\-64 -# systemd\-nspawn \-M Fedora\-Cloud\-Base\-37\-1\&.7\&.x86\-64 + https://download\&.fedoraproject\&.org/pub/fedora/linux/releases/40/Cloud/x86_64/images/Fedora\-Cloud\-Base\-40\-1\&.6\&.x86_64\&.raw\&.xz \e + Fedora\-Cloud\-Base\-40\-1\&.6\&.x86\-64 +# systemd\-nspawn \-M Fedora\-Cloud\-Base\-40\-1\&.6\&.x86\-64 # passwd # exit -# machinectl start Fedora\-Cloud\-Base\-37\-1\&.7\&.x86\-64 -# machinectl login Fedora\-Cloud\-Base\-37\-1\&.7\&.x86\-64 +# machinectl start Fedora\-Cloud\-Base\-40\-1\&.6\&.x86\-64 +# machinectl login Fedora\-Cloud\-Base\-40\-1\&.6\&.x86\-64 .fi .if n \{\ .RE @@ -1101,6 +1201,12 @@ will be ignored by the executable, and needs to be handled by the pager\&. This option instructs the pager to not send termcap initialization and deinitialization strings to the terminal\&. It is set by default to allow command output to remain visible in the terminal even after the pager exits\&. Nevertheless, this prevents some pager functionality from working, in particular paged output cannot be scrolled with the mouse\&. .RE .sp +Note that setting the regular +\fI$LESS\fR +environment variable has no effect for +\fBless\fR +invocations by systemd tools\&. +.sp See \fBless\fR(1) for more discussion\&. @@ -1112,6 +1218,12 @@ Override the charset passed to \fBless\fR (by default "utf\-8", if the invoking terminal is determined to be UTF\-8 compatible)\&. +.sp +Note that setting the regular +\fI$LESSCHARSET\fR +environment variable has no effect for +\fBless\fR +invocations by systemd tools\&. .RE .PP \fI$SYSTEMD_PAGERSECURE\fR |