mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-23 10:13:34 +08:00
Code Issues Packages Projects Releases Wiki Activity
d209e197f8
systemd/man/machinectl.xml

879 lines
41 KiB
XML
Raw Normal View History

man: drop mode line in file headers This is already included in .dir-locals, so we don't need it in the files themselves.
2018-07-03 05:15:39 +08:00
<?xml version='1.0'?>
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 21:40:58 +08:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 22:48:33 +08:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
man/machinectl: fix pull-raw example We do not allow machine names with "_", so the command would fail as written. Share the example with the systemd-nspawn page instead.
2020-10-27 23:01:16 +08:00
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 12:23:58 +08:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: document machinectl and systemd-machined
2013-07-07 10:22:05 +08:00
man: use xinclude to de-deduplicate common text I only tested with python-lxml. I'm not sure if xml.etree should be deprecated.
2014-02-12 13:55:38 +08:00
<refentry id="machinectl" conditional='ENABLE_MACHINED'
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>machinectl</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>machinectl</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>machinectl</refname>
<refpurpose>Control the systemd machine manager</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>machinectl</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="req">COMMAND</arg>
<arg choice="opt" rep="repeat">NAME</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>machinectl</command> may be used to introspect and
control the state of the
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
virtual machine and container registration manager
<citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
<para><command>machinectl</command> may be used to execute
operations on machines and images. Machines in this sense are
considered running instances of:</para>
<itemizedlist>
<listitem><para>Virtual Machines (VMs) that virtualize hardware
to run full operating system (OS) instances (including their kernels)
in a virtualized environment on top of the host OS.</para></listitem>
<listitem><para>Containers that share the hardware and
OS kernel with the host OS, in order to run
OS userspace instances on top the host OS.</para></listitem>
man: update the description of machinectl -M Fixes #6621. Also rework the introduction a bit.
2017-09-15 17:47:46 +08:00
<listitem><para>The host system itself.</para></listitem>
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
</itemizedlist>
<para>Machines are identified by names that follow the same rules
tree-wide: use "hostname" spelling everywhere It's not that I think that "hostname" is vastly superior to "host name". Quite the opposite — the difference is small, and in some context the two-word version does fit better. But in the tree, there are ~200 occurrences of the first, and >1600 of the other, and consistent spelling is more important than any particular spelling choice.
2020-04-14 16:37:40 +08:00
as UNIX and DNS hostnames. For details, see below.</para>
man: update the description of machinectl -M Fixes #6621. Also rework the introduction a bit.
2017-09-15 17:47:46 +08:00
<para>Machines are instantiated from disk or file system images that
frequently — but not necessarily — carry the same name as machines running
from them. Images in this sense may be:</para>
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
<itemizedlist>
man: update the description of machinectl -M Fixes #6621. Also rework the introduction a bit.
2017-09-15 17:47:46 +08:00
<listitem><para>Directory trees containing an OS, including the
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
top-level directories <filename>/usr/</filename>,
<filename>/etc/</filename>, and so on.</para></listitem>
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
man: document that machinectl is also happy with block devices these days
2018-10-11 03:25:01 +08:00
<listitem><para>btrfs subvolumes containing OS trees, similar to regular directory trees.</para></listitem>
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
man: document that machinectl is also happy with block devices these days
2018-10-11 03:25:01 +08:00
<listitem><para>Binary "raw" disk image files containing MBR or GPT partition tables and Linux file
systems.</para></listitem>
<listitem><para>Similarly, block devices containing MBR or GPT partition tables and file systems.</para></listitem>
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
<listitem><para>The file system tree of the host OS itself.</para></listitem>
</itemizedlist>
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<para>Images may be downloaded, imported and exported via the
<citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
tool.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
<refsect1>
<title>Commands</title>
<para>The following commands are understood:</para>
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<refsect2><title>Machine Commands</title>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<variablelist>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
<term><command>list</command></term>
<listitem><para>List currently running (online) virtual
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
machines and containers. To enumerate machine images that can
be started, use <command>list-images</command> (see
below). Note that this command hides the special
<literal>.host</literal> machine by default. Use the
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<option>--all</option> switch to show it.</para>
<xi:include href="version-info.xml" xpointer="v206"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>status</command> <replaceable>NAME</replaceable>…</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: tweak description of machinectl show Also, machinectl status is anything but terse. Remove "terse".
2015-11-08 22:13:45 +08:00
<listitem><para>Show runtime status information about
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
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 <command>show</command>
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
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
contents of the machine itself.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v206"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>show</command> [<replaceable>NAME</replaceable>…]</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: one more cgroup wording fix
2016-10-18 22:18:08 +08:00
<listitem><para>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 NAME is specified,
properties of this virtual machine or container are shown. By default, empty properties are suppressed. Use
<option>--all</option> to show those too. To select specific properties to show, use
<option>--property=</option>. 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 <command>status</command> if you
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
are looking for formatted human-readable output.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v206"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>start</command> <replaceable>NAME</replaceable>…</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<listitem><para>Start a container as a system service, using
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
This starts <filename>systemd-nspawn@.service</filename>,
instantiated for the specified machine name, similar to the
effect of <command>systemctl start</command> on the service
name. <command>systemd-nspawn</command> looks for a container
image by the specified name in
<filename>/var/lib/machines/</filename> (and other search
paths, see below) and runs it. Use
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
<command>list-images</command> (see below) for listing
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
available container images to start.</para>
<para>Note that
<citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
also interfaces with a variety of other container and VM
managers, <command>systemd-nspawn</command> is just one
implementation of it. Most of the commands available in
<command>machinectl</command> may be used on containers or VMs
controlled by other managers, not just
<command>systemd-nspawn</command>. Starting VMs and container
images on those managers requires manager-specific
tools.</para>
<para>To interactively start a container on the command line
with full access to the container's console, please invoke
<command>systemd-nspawn</command> directly. To stop a running
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
container use <command>machinectl poweroff</command>.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
<term><command>login</command> [<replaceable>NAME</replaceable>]</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
machinectl: add new "machinectl shell" command This makes use of machined's new OpenShell() command and allows opening a new interactive shell in any container.
2015-08-23 19:24:10 +08:00
<listitem><para>Open an interactive terminal login session in
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
a container or on the local host. If an argument is supplied,
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
it refers to the container machine to connect to. If none is
specified, or the container name is specified as the empty
string, or the special machine name <literal>.host</literal>
(see below) is specified, the connection is made to the local
host instead. This will create a TTY connection to a specific
container or the local host and asks for the execution of a
getty on it. Note that this is only supported for containers
running
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
as init system.</para>
<para>This command will open a full login prompt on the
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
container or the local host, which then asks for username and
password. Use <command>shell</command> (see below) or
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
with the <option>--machine=</option> switch to directly invoke
a single command, either interactively or in the
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
background.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
machinectl: add new "machinectl shell" command This makes use of machined's new OpenShell() command and allows opening a new interactive shell in any container.
2015-08-23 19:24:10 +08:00
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>shell</command> [[<replaceable>NAME</replaceable>@]<replaceable>NAME</replaceable> [<replaceable>PATH</replaceable> [<replaceable>ARGUMENTS</replaceable>…]]] </term>
machinectl: add new "machinectl shell" command This makes use of machined's new OpenShell() command and allows opening a new interactive shell in any container.
2015-08-23 19:24:10 +08:00
<listitem><para>Open an interactive shell session in a
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
container or on the local host. The first argument refers to
the container machine to connect to. If none is specified, or
the machine name is specified as the empty string, or the
special machine name <literal>.host</literal> (see below) is
specified, the connection is made to the local host
man: similar → similarly Something *is* similar Something *works* similarly Something does something, similarly to how something else does something See https://sites.ulethbridge.ca/roussel/2017/11/29/similar-and-similarly-are-they-similar/ for a clear explanation.
2022-08-23 18:12:28 +08:00
instead. This works similarly to <command>login</command>, but
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
immediately invokes a user process. This command runs the
machined: use getent to get default shell for machinectl shell (#7684) Closes: https://github.com/systemd/systemd/issues/1395
2018-01-16 02:17:51 +08:00
specified executable with the specified arguments, or the
default shell for the user if none is specified, or
<filename>/bin/sh</filename> if no default shell is found. By default,
machinectl: extend the "shell" syntax to take user@container names In order to make "machinectl shell" more similar to ssh, allow the following syntax to connect to a container under a specific username: machinectl shell lennart@fedora Also beefs up related man page documentation.
2015-08-25 04:44:54 +08:00
<option>--uid=</option>, or by prefixing the machine name with
a username and an <literal>@</literal> character, a different
user may be selected. Use <option>--setenv=</option> to set
environment variables for the executed process.</para>
man: document that "systemd-run -M" propagates exit codes, and "machinectl shell" does not This adds a brief explanation, suggesting the use of "systemd-run -M" to acquire exit status/code information for the invoked process. My original plan was to propagate the exit code/status in "machinectl shell" too, but this would mean we'd have to actively watch the shell's runtime status, and thus would need full, highly privileged and continious access to the container's system manager, the way "systemd-run" does it. This would be quite a departure from the simplistic, low-priviliged OpenShell() bus call implementation of the current code, that really just acquires a PTY device with a shell connected. Moreover it would blur the lines between the two commands even further, which I think is not desirable. Hence, from now on: "machinectl shell" is the full-session, interactive shell for human users "systemd-run -M …" is the low-level tool, that supports on-interactive mode, and is more configurable and suitable for streaming. Fixes: #4215
2016-12-24 08:08:15 +08:00
<para>Note that <command>machinectl shell</command> does not propagate the exit code/status of the invoked
shell process. Use <command>systemd-run</command> instead if that information is required (see below).</para>
man: similar → similarly Something *is* similar Something *works* similarly Something does something, similarly to how something else does something See https://sites.ulethbridge.ca/roussel/2017/11/29/similar-and-similarly-are-they-similar/ for a clear explanation.
2022-08-23 18:12:28 +08:00
<para>Using the <command>shell</command> command without arguments (thus invoking the executed shell
or command on the local host), is in many ways similar to a <citerefentry
project='die-net'><refentrytitle>su</refentrytitle><manvolnum>1</manvolnum></citerefentry> session,
but, unlike <command>su</command>, completely isolates the new session from the originating session,
so that it shares no process or session properties and is in a clean well-defined state. It will be
tracked in a new utmp, login, audit, security, and keyring sessions, and will not inherit any
environment variables or resource limits, among other properties.</para>
<para>Note that
<citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry> with
its <option>--machine=</option> switch may be used in place of the <command>machinectl
shell</command> command, and allows non-interactive operation, more detailed and low-level
configuration of the invoked unit, as well as access to runtime and exit code/status information of
the invoked shell process. In particular, use <command>systemd-run</command>'s
<option>--wait</option> switch to propagate exit status information of the invoked process. Use
<command>systemd-run</command>'s <option>--pty</option> switch to acquire an interactive shell,
similarly to <command>machinectl shell</command>. In general, <command>systemd-run</command> is
preferable for scripting purposes. However, note that <command>systemd-run</command> might require
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
higher privileges than <command>machinectl shell</command>.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v225"/></listitem>
machinectl: add new "machinectl shell" command This makes use of machined's new OpenShell() command and allows opening a new interactive shell in any container.
2015-08-23 19:24:10 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>enable</command> <replaceable>NAME</replaceable>…</term>
<term><command>disable</command> <replaceable>NAME</replaceable>…</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: similar → similarly Something *is* similar Something *works* similarly Something does something, similarly to how something else does something See https://sites.ulethbridge.ca/roussel/2017/11/29/similar-and-similarly-are-they-similar/ for a clear explanation.
2022-08-23 18:12:28 +08:00
<listitem><para>Enable or disable a container as a system service to start at system boot, using
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
man: similar → similarly Something *is* similar Something *works* similarly Something does something, similarly to how something else does something See https://sites.ulethbridge.ca/roussel/2017/11/29/similar-and-similarly-are-they-similar/ for a clear explanation.
2022-08-23 18:12:28 +08:00
This enables or disables <filename>systemd-nspawn@.service</filename>, instantiated for the specified
machine name, similarly to the effect of <command>systemctl enable</command> or <command>systemctl
machinectl: add --now to start/stop containers when enabling/disabling Closes #26154
2023-01-24 01:20:14 +08:00
disable</command> on the service name.</para>
<para>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.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
If this is desired, combine the command with the <option>--now</option> switch.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>poweroff</command> <replaceable>NAME</replaceable>…</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<listitem><para>Power off one or more containers. This will
man: `machinectl(1)`: Fix description of subcommand `poweroff`
2024-10-08 21:20:26 +08:00
trigger a shutdown by sending SIGRTMIN+4 to the container's init
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
process, which causes systemd-compatible init systems to shut
machinectl: Added stop as alias for poweroff (#3406)
2016-06-06 23:06:20 +08:00
down cleanly. Use <command>stop</command> as alias for <command>poweroff</command>.
This operation does not work on containers that do not run a
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>-compatible
init system, such as sysvinit. Use
<command>terminate</command> (see below) to immediately
terminate a container or VM, without cleanly shutting it
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
down.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v212"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>reboot</command> <replaceable>NAME</replaceable>…</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<listitem><para>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
machinectl: support vmspawn as a backend
2024-02-20 21:14:52 +08:00
containers running any system manager. Use <command>restart</command> as alias
machinectl: add `restart` convenience alias (#30625)
2023-12-28 06:09:42 +08:00
for <command>reboot</command>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>terminate</command> <replaceable>NAME</replaceable>…</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<listitem><para>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
<command>poweroff</command> to issue a clean shutdown
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
request.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v206"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>kill</command> <replaceable>NAME</replaceable>…</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<listitem><para>Send a signal to one or more processes of the
virtual machine or container. This means processes as seen by
the host, not the processes inside the virtual machine or
tree-wide: change --kill-who to --kill-whom getopt allows non-ambiguous abbreviations, so backwards-compat is maintained, and people can use --kill-who (or even shorter abbreviations). English is flexible, so in common speach people would use both forms, even if "whom" is technically more correct. The advantage of using the longer form in the code is that we effectively allow both forms, so we stop punishing people who DTGCT¹, but still allow people to use the spoken form if they prefer. 1. Do the gramatically correct thing
2022-08-24 16:41:30 +08:00
container. Use <option>--kill-whom=</option> to select which
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
process to kill. Use <option>--signal=</option> to select the
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
signal to send.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v206"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><command>bind</command> <replaceable>NAME</replaceable> <replaceable>PATH</replaceable> [<replaceable>PATH</replaceable>]</term>
machined: support "machinectl bind" on non-directories (#7349) Fixes: #7195
2017-11-19 21:23:29 +08:00
<listitem><para>Bind mounts a file or directory from the host into the specified container. The first path
argument is the source file or directory on the host, the second path argument is the destination file or
directory in the container. 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 <option>--read-only</option> switch, a ready-only bind
mount is created. When combined with the <option>--mkdir</option> switch, the destination path is first created
before the mount is applied. Note that this option is currently only supported for
machined: refuse bind mounts on containers that have user namespaces applied As the kernel won't map the UIDs this is simply not safe, and hence we should generate a clean error and refuse it. We can restore this feature later should a "shiftfs" become available in the kernel.
2017-02-16 20:59:13 +08:00
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> containers,
machined: support "machinectl bind" on non-directories (#7349) Fixes: #7195
2017-11-19 21:23:29 +08:00
and only if user namespacing (<option>--private-users</option>) is not used. This command supports bind
mounting directories, regular files, device nodes, <constant>AF_UNIX</constant> socket nodes, as well as
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
FIFOs.</para>
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
machinectl: Add plumbing for a `--force` flag for file copy machine: Add APIs CopyTo[Machine]WithFlags + CopyFrom[Machine]WithFlags - Same API to those without `WithFlags` (except this can take flags) - Initially, only a flag to allow replacing a file if it already exists
2022-07-22 19:08:11 +08:00
<term><command>copy-to</command> <replaceable>NAME</replaceable> <replaceable>PATH</replaceable> [<replaceable>PATH</replaceable>] <option>--force</option></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<listitem><para>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
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
path in the container. If the destination path is omitted, the
machined: when copying files from/to userns containers chown to root This changes the file copy logic of machined to set the UID/GID of all copied files to 0 if the host and container do not share the same user namespace. Fixes: #4078
2017-02-14 02:24:01 +08:00
same as the source path is used.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
machined: when copying files from/to userns containers chown to root This changes the file copy logic of machined to set the UID/GID of all copied files to 0 if the host and container do not share the same user namespace. Fixes: #4078
2017-02-14 02:24:01 +08:00
<para>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
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
user and group (UID/GID 0).</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
machined: when copying files from/to userns containers chown to root This changes the file copy logic of machined to set the UID/GID of all copied files to 0 if the host and container do not share the same user namespace. Fixes: #4078
2017-02-14 02:24:01 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
machinectl: Add plumbing for a `--force` flag for file copy machine: Add APIs CopyTo[Machine]WithFlags + CopyFrom[Machine]WithFlags - Same API to those without `WithFlags` (except this can take flags) - Initially, only a flag to allow replacing a file if it already exists
2022-07-22 19:08:11 +08:00
<term><command>copy-from</command> <replaceable>NAME</replaceable> <replaceable>PATH</replaceable> [<replaceable>PATH</replaceable>] <option>--force</option></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<listitem><para>Copies files or directories from a container
into the host system. Takes a container name, followed by the
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
source path in the container and the destination path on the host.
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
If the destination path is omitted, the same as the source path
machined: when copying files from/to userns containers chown to root This changes the file copy logic of machined to set the UID/GID of all copied files to 0 if the host and container do not share the same user namespace. Fixes: #4078
2017-02-14 02:24:01 +08:00
is used.</para>
<para>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
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
user and group (UID/GID 0).</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
</variablelist></refsect2>
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<refsect2><title>Image Commands</title>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<variablelist>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
<term><command>list-images</command></term>
<listitem><para>Show a list of locally installed container and
VM images. This enumerates all raw disk images and container
directories and subvolumes in
<filename>/var/lib/machines/</filename> (and other search
paths, see below). Use <command>start</command> (see above) to
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
run a container off one of the listed images. Note that, by
default, containers whose name begins with a dot
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
(<literal>.</literal>) are not shown. To show these too,
specify <option>--all</option>. Note that a special image
<literal>.host</literal> always implicitly exists and refers
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
to the image the host itself is booted from.</para>
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>image-status</command> [<replaceable>NAME</replaceable>…]</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<listitem><para>Show terse status information about one or
more container or VM images. This function is intended to
generate human-readable output. Use
<command>show-image</command> (see below) to generate
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
computer-parsable output instead.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>show-image</command> [<replaceable>NAME</replaceable>…]</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<listitem><para>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
man: fix indefinite articles (#3694)
2016-07-12 17:58:14 +08:00
shown. If a NAME is specified, properties of this virtual
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
machine or container image are shown. By default, empty
properties are suppressed. Use <option>--all</option> to show
those too. To select specific properties to show, use
<option>--property=</option>. This command is intended to be
used whenever computer-parsable output is required. Use
<command>image-status</command> if you are looking for
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
formatted human-readable output.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
machinectl: add verb edit and cat to operate on .nspawn files This allows operating on .nspawn files using machinectl. Closes #26246
2023-03-12 00:56:13 +08:00
<varlistentry>
<term><command>edit</command> <replaceable>NAME|FILE</replaceable></term>
man: more hyperlinks and other fixes Closes https://github.com/systemd/systemd/issues/29814.
2023-11-06 21:59:00 +08:00
<listitem><para>Edit the settings file of the specified machines. For the format of the settings
file, refer to
<citerefentry project='man-pages'><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
If an existing settings file of the given machine can't be found, <command>edit</command>
man: correct the path for location of "machinectl edit" setting file The correct path where setting file located should be "under /etc/systemd/nspawn", not "under /etc".
2023-12-07 21:58:58 +08:00
automatically create a new settings file from scratch under
<filename>/etc/systemd/nspawn/</filename>.
man: more hyperlinks and other fixes Closes https://github.com/systemd/systemd/issues/29814.
2023-11-06 21:59:00 +08:00
</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
machinectl: add verb edit and cat to operate on .nspawn files This allows operating on .nspawn files using machinectl. Closes #26246
2023-03-12 00:56:13 +08:00
</varlistentry>
<varlistentry>
<term><command>cat</command> <replaceable>NAME|FILE</replaceable></term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<listitem><para>Show the settings file of the specified machines.</para>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
machinectl: add verb edit and cat to operate on .nspawn files This allows operating on .nspawn files using machinectl. Closes #26246
2023-03-12 00:56:13 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
<term><command>clone</command> <replaceable>NAME</replaceable> <replaceable>NAME</replaceable></term>
man: slightly extend the machinectl clone documentation
2016-05-02 17:14:46 +08:00
<listitem><para>Clones a container or VM 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 btrfs subvolume
images with this command, if the underlying file system supports this. Note that cloning a container or VM
nspawn: add fallback top normal copy/reflink when we cannot btrfs snapshot Given that other file systems (notably: xfs) support reflinks these days, let's extend the file system snapshotting logic to fall back to plan copies or reflinks when full btrfs subvolume snapshots are not available. This essentially makes "systemd-nspawn --ephemeral" and "systemd-nspawn --template=" available on non-btrfs subvolumes. Of course, both operations will still be slower on non-btrfs than on btrfs (simply because reflinking each file individually in a directory tree is still slower than doing this in one step for a whole subvolume), but it's probably good enough for many cases, and we should provide the users with the tools, they have to figure out what's good for them. Note that "machinectl clone" already had a fallback like this in place, this patch generalizes this, and adds similar support to our other cases.
2016-11-22 03:02:43 +08:00
image is optimized for file systems that support copy-on-write, and might not be efficient on others, due to
file system limitations.</para>
man: document that nspawn -x, --template= and machinectl clone leave hostname and machine id unmodified
2015-05-06 04:48:28 +08:00
tree-wide: use "hostname" spelling everywhere It's not that I think that "hostname" is vastly superior to "host name". Quite the opposite — the difference is small, and in some context the two-word version does fit better. But in the tree, there are ~200 occurrences of the first, and >1600 of the other, and consistent spelling is more important than any particular spelling choice.
2020-04-14 16:37:40 +08:00
<para>Note that this command leaves hostname, machine ID and
man: document that nspawn -x, --template= and machinectl clone leave hostname and machine id unmodified
2015-05-06 04:48:28 +08:00
all other settings that could identify the instance
unmodified. The original image and the cloned copy will hence
share these credentials, and it might be necessary to manually
machinectl: add new "machinectl clean" command This new command removes all, or all hidden container images that have been downloaded.
2016-04-11 23:24:08 +08:00
change them in the copy.</para>
<para>If combined with the <option>--read-only</option> switch a read-only cloned image is
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
created.</para>
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><command>rename</command> <replaceable>NAME</replaceable> <replaceable>NAME</replaceable></term>
machined,machinectl: add calls for changing container/VM quotas
2015-02-25 06:50:37 +08:00
<listitem><para>Renames a container or VM image. The
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
arguments specify the name of the image to rename and the new
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
name of the image.</para>
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><command>read-only</command> <replaceable>NAME</replaceable> [<replaceable>BOOL</replaceable>]</term>
machined,machinectl: add calls for changing container/VM quotas
2015-02-25 06:50:37 +08:00
<listitem><para>Marks or (unmarks) a container or VM image
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
read-only. Takes a VM or container image name, followed by a
boolean as arguments. If the boolean is omitted, positive is
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
implied, i.e. the image is marked read-only.</para>
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
<term><command>remove</command> <replaceable>NAME</replaceable>…</term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
machined,machinectl: add calls for changing container/VM quotas
2015-02-25 06:50:37 +08:00
<listitem><para>Removes one or more container or VM images.
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
The special image <literal>.host</literal>, which refers to
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
the host's own directory tree, may not be
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
removed.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
machined,machinectl: add calls for changing container/VM quotas
2015-02-25 06:50:37 +08:00
<varlistentry>
<term><command>set-limit</command> [<replaceable>NAME</replaceable>] <replaceable>BYTES</replaceable></term>
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 13:11:37 +08:00
<listitem><para>Sets the maximum size in bytes that a specific
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
container or VM image, or all images, may grow up to on disk
man: document that machinectl set-limit creates a btrfs loopback too
2015-03-03 02:35:50 +08:00
(disk quota). Takes either one or two parameters. The first,
machined,machinectl: add calls for changing container/VM quotas
2015-02-25 06:50:37 +08:00
optional parameter refers to a container or VM image name. If
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
specified, the size limit of the specified image is changed. If
omitted, the overall size limit of the sum of all images stored
man: document that machinectl set-limit creates a btrfs loopback too
2015-03-03 02:35:50 +08:00
locally is changed. The final argument specifies the size
limit in bytes, possibly suffixed by the usual K, M, G, T
units. If the size limit shall be disabled, specify
<literal>-</literal> as size.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<para>Note that per-container size limits are only supported on btrfs file systems.</para>
<xi:include href="version-info.xml" xpointer="v220"/></listitem>
machined,machinectl: add calls for changing container/VM quotas
2015-02-25 06:50:37 +08:00
</varlistentry>
machinectl: add new "machinectl clean" command This new command removes all, or all hidden container images that have been downloaded.
2016-04-11 23:24:08 +08:00
<varlistentry>
<term><command>clean</command></term>
<listitem><para>Remove hidden VM or container images (or all). This command removes all hidden machine images
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
from <filename>/var/lib/machines/</filename>, i.e. those whose name begins with a dot. Use <command>machinectl
machinectl: add new "machinectl clean" command This new command removes all, or all hidden container images that have been downloaded.
2016-04-11 23:24:08 +08:00
list-images --all</command> to see a list of all machine images, including the hidden ones.</para>
<para>When combined with the <option>--all</option> switch removes all images, not just hidden ones. This
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
command effectively empties <filename>/var/lib/machines/</filename>.</para>
machinectl: add new "machinectl clean" command This new command removes all, or all hidden container images that have been downloaded.
2016-04-11 23:24:08 +08:00
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<para>Note that commands such as <command>importctl pull-tar</command> or <command>importctl
machinectl: add new "machinectl clean" command This new command removes all, or all hidden container images that have been downloaded.
2016-04-11 23:24:08 +08:00
pull-raw</command> 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 <command>machinectl clean</command> to remove old, hidden images created this
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
way.</para>
<xi:include href="version-info.xml" xpointer="v230"/></listitem>
machinectl: add new "machinectl clean" command This new command removes all, or all hidden container images that have been downloaded.
2016-04-11 23:24:08 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</variablelist></refsect2>
</refsect1>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-p</option></term>
<term><option>--property=</option></term>
<listitem><para>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
<literal>Name</literal>. If specified more than once, all
properties with the specified names are
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
shown.</para>
<xi:include href="version-info.xml" xpointer="v206"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
machinectl: add -P
2024-03-02 19:25:22 +08:00
<varlistentry>
<term><option>--value</option></term>
<listitem><para>When printing properties with <command>show</command>, only print the value,
and skip the property name and <literal>=</literal>.</para>
<xi:include href="version-info.xml" xpointer="v230"/></listitem>
</varlistentry>
<xi:include href="timedatectl.xml" xpointer="option-P"/>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-a</option></term>
<term><option>--all</option></term>
<listitem><para>When showing machine or image properties, show
all properties regardless of whether they are set or
not.</para>
<para>When listing VM or container images, do not suppress
images beginning in a dot character
(<literal>.</literal>).</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<para>When cleaning VM or container images, remove all images, not just hidden ones.</para>
<xi:include href="version-info.xml" xpointer="v206"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>-l</option></term>
<term><option>--full</option></term>
machinectl: do not truncate addresses when --full is specified
2020-01-10 18:17:26 +08:00
<listitem><para>Do not ellipsize process tree entries or table. This implies
<option>--max-addresses=full</option>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="version-info.xml" xpointer="v206"/>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
<varlistentry>
tree-wide: change --kill-who to --kill-whom getopt allows non-ambiguous abbreviations, so backwards-compat is maintained, and people can use --kill-who (or even shorter abbreviations). English is flexible, so in common speach people would use both forms, even if "whom" is technically more correct. The advantage of using the longer form in the code is that we effectively allow both forms, so we stop punishing people who DTGCT¹, but still allow people to use the spoken form if they prefer. 1. Do the gramatically correct thing
2022-08-24 16:41:30 +08:00
<term><option>--kill-whom=</option></term>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem><para>When used with <command>kill</command>, choose
which processes to kill. Must be one of
<option>leader</option>, or <option>all</option> to select
whether to kill only the leader process of the machine or all
processes of the machine. If omitted, defaults to
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<option>all</option>.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v206"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
systemctl,loginctl,machinectl: use a shared helper for arg_signal I seems frivolous to yet another two -util.[ch] files, but the helper should be in shared/ and it doesn't seem to fit anywhere else.
2021-02-13 22:55:10 +08:00
<xi:include href="standard-options.xml" xpointer="signal" />
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--uid=</option></term>
<listitem><para>When used with the <command>shell</command> command, chooses the user ID to
open the interactive shell session as. If the argument to the <command>shell</command>
command also specifies a user name, this option is ignored. If the name is not specified
in either way, <literal>root</literal> will be used by default. Note that this switch is
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
not supported for the <command>login</command> command (see below).</para>
<xi:include href="version-info.xml" xpointer="v225"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
machinectl: allow --setenv=FOO
2021-08-10 23:28:47 +08:00
<term><option>-E <replaceable>NAME</replaceable>[=<replaceable>VALUE</replaceable>]</option></term>
<term><option>--setenv=<replaceable>NAME</replaceable>[=<replaceable>VALUE</replaceable>]</option></term>
<listitem><para>When used with the <command>shell</command> command, sets an environment variable for
the executed shell. This option may be used more than once to set multiple variables. When
<literal>=</literal> and <replaceable>VALUE</replaceable> are omitted, the value of the variable with
the same name in the program environment will be used.</para>
<para>Note that this option is not supported for the <command>login</command> command.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v230"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>--mkdir</option></term>
<listitem><para>When used with <command>bind</command>, 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
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
a directory, but a regular file, device node, socket or FIFO.</para>
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>--read-only</option></term>
<listitem><para>When used with <command>bind</command>, creates a read-only bind mount.</para>
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<para>When used with <command>clone</command> a read-only container or VM image is created.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>-n</option></term>
<term><option>--lines=</option></term>
<listitem><para>When used with <command>status</command>,
controls the number of journal lines to show, counting from
the most recent ones. Takes a positive integer argument.
Defaults to 10.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="version-info.xml" xpointer="v219"/>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option></term>
<term><option>--output=</option></term>
<listitem><para>When used with <command>status</command>,
controls the formatting of the journal entries that are shown.
For the available choices, see
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
Defaults to <literal>short</literal>.</para>
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
machinectl: support vmspawn as a backend
2024-02-20 21:14:52 +08:00
<varlistentry>
<term><option>--runner=</option><option>nspawn</option>|<option>vmspawn</option></term>
<listitem><para>When operating on machines choose whether to use
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
or
<citerefentry><refentrytitle>systemd-vmspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
By default
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
is used.
</para>
machinectl: mention -V in --help text Follow-up for f82dcc3fc35883a73c8a03ad82d35abffc458676
2024-03-01 22:22:13 +08:00
<xi:include href="version-info.xml" xpointer="v256"/></listitem>
</varlistentry>
<varlistentry>
<term><option>-V</option></term>
<listitem><para><option>-V</option> is a shorthand for <option>--runner=vmspawn</option>.</para>
machinectl: support vmspawn as a backend
2024-02-20 21:14:52 +08:00
<xi:include href="version-info.xml" xpointer="v256"/></listitem>
</varlistentry>
machinectl: add --now to start/stop containers when enabling/disabling Closes #26154
2023-01-24 01:20:14 +08:00
<varlistentry>
<term><option>--now</option></term>
<listitem>
<para>When used with <command>enable</command> or <command>disable</command>,
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.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="version-info.xml" xpointer="v253"/>
machinectl: add --now to start/stop containers when enabling/disabling Closes #26154
2023-01-24 01:20:14 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--force</option></term>
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<listitem><para>Replace target file when copying files.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>--max-addresses=</option></term>
machinectl: allow --max-addresses=0 Sometimes the addresses are not important, so allow skipping them in output.
2022-10-20 15:38:59 +08:00
<listitem><para>When used with the <option>list-machines</option> command, limits the number of IP
addresses shown for every machine. Defaults to 1. All addresses can be requested with
<literal>all</literal>. If the limit is 0, the address column is not shown. Otherwise, if the machine
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
has more addresses than shown, <literal>…</literal> follows the last address.</para>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<term><option>--quiet</option></term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<listitem><para>Suppresses additional informational output while running.</para>
<xi:include href="version-info.xml" xpointer="v236"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<xi:include href="user-system-options.xml" xpointer="host" />
<varlistentry>
<term><option>-M</option></term>
<term><option>--machine=</option></term>
<listitem><para>Connect to
<citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
running in a local container, to perform the specified operation within
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
the container.</para>
<xi:include href="version-info.xml" xpointer="v235"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<xi:include href="standard-options.xml" xpointer="no-pager" />
<xi:include href="standard-options.xml" xpointer="no-legend" />
<xi:include href="standard-options.xml" xpointer="no-ask-password" />
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
</variablelist>
</refsect1>
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
<refsect1>
<title>Machine and Image Names</title>
<para>The <command>machinectl</command> tool operates on machines
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
and images whose names must be chosen following strict
tree-wide: use "hostname" spelling everywhere It's not that I think that "hostname" is vastly superior to "host name". Quite the opposite — the difference is small, and in some context the two-word version does fit better. But in the tree, there are ~200 occurrences of the first, and >1600 of the other, and consistent spelling is more important than any particular spelling choice.
2020-04-14 16:37:40 +08:00
rules. Machine names must be suitable for use as hostnames
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
following a conservative subset of DNS and UNIX/Linux
semantics. Specifically, they must consist of one or more
non-empty label strings, separated by dots. No leading or trailing
dots are allowed. No sequences of multiple dots are allowed. The
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 13:11:37 +08:00
label strings may only consist of alphanumeric characters as well
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
as the dash and underscore. The maximum length of a machine name
is 64 characters.</para>
<para>A special machine with the name <literal>.host</literal>
refers to the running host system itself. This is useful for execution
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 13:11:37 +08:00
operations or inspecting the host system as well. Note that
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
<command>machinectl list</command> will not show this special
machine unless the <option>--all</option> switch is specified.</para>
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 13:11:37 +08:00
<para>Requirements on image names are less strict, however, they must be
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
valid UTF-8, must be suitable as file names (hence not be the
single or double dot, and not include a slash), and may not
contain control characters. Since many operations search for an
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
image by the name of a requested machine, it is recommended to name
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
images in the same strict fashion as machines.</para>
<para>A special image with the name <literal>.host</literal>
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 13:11:37 +08:00
refers to the image of the running host system. It hence
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
conceptually maps to the special <literal>.host</literal> machine
name described above. Note that <command>machinectl
doc: use expanded forms for written style
2015-10-26 22:45:12 +08:00
list-images</command> will not show this special image either, unless
machinectl: make machine name parameters for "shell" and "login" optional If no machine name is specified, imply that we connect to ".host", i.e. the local host.
2015-08-25 04:17:52 +08:00
<option>--all</option> is specified.</para>
</refsect1>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refsect1>
<title>Files and Directories</title>
<para>Machine images are preferably stored in
<filename>/var/lib/machines/</filename>, but are also searched for
in <filename>/usr/local/lib/machines/</filename> and
doc: correct punctuation and improve typography in documentation
2014-08-03 13:11:12 +08:00
<filename>/usr/lib/machines/</filename>. For compatibility reasons,
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
the directory <filename>/var/lib/container/</filename> is
searched, too. Note that images stored below
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<filename>/usr/</filename> are always considered read-only. It is
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
possible to symlink machines images from other directories into
<filename>/var/lib/machines/</filename> to make them available for
control with <command>machinectl</command>.</para>
import: drop logic of setting up /var/lib/machines as btrfs loopback mount Let's simplify things and drop the logic that /var/lib/machines is setup as auto-growing btrfs loopback file /var/lib/machines.raw. THis was done in order to make quota available for machine management, but quite frankly never really worked properly, as we couldn't grow the file system in sync with its use properly. Moreover philosophically it's problematic overriding the admin's choice of file system like this. Let's hence drop this, and simplify things. Deleting code is a good feeling. Now that regular file systems provide project quota we could probably add per-machine quota support based on that, hence the btrfs quota argument is not that interesting anymore (though btrfs quota is a bit more powerful as it allows recursive quota, i.e. that the machine pool gets an overall quota in addition to per-machine quota).
2018-10-11 16:27:59 +08:00
<para>Note that some image operations are only supported, efficient or atomic on btrfs file systems.</para>
man: document that machinectl set-limit creates a btrfs loopback too
2015-03-03 02:35:50 +08:00
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<para>Disk images are understood by
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
and <command>machinectl</command> in three formats:</para>
<itemizedlist>
<listitem><para>A simple directory tree, containing the files
and directories of the container to boot.</para></listitem>
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 13:11:37 +08:00
<listitem><para>Subvolumes (on btrfs file systems), which are
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
similar to the simple directories, described above. However,
they have additional benefits, such as efficient cloning and
quota reporting.</para></listitem>
<listitem><para>"Raw" disk images, i.e. binary images of disks
with a GPT or MBR partition table. Images of this type are
regular files with the suffix
<literal>.raw</literal>.</para></listitem>
</itemizedlist>
<para>See
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 13:11:37 +08:00
for more information on image formats, in particular its
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<option>--directory=</option> and <option>--image=</option>
options.</para>
</refsect1>
<refsect1>
<title>Examples</title>
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<xi:include href="importctl.xml" xpointer="example-import-raw" />
machinectl: extend the "shell" syntax to take user@container names In order to make "machinectl shell" more similar to ssh, allow the following syntax to connect to a container under a specific username: machinectl shell lennart@fedora Also beefs up related man page documentation.
2015-08-25 04:44:54 +08:00
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure code
otherwise.</para>
</refsect1>
man: rename less-variables→common-variables Some are not about less, e.g. $SYSTEMD_URLIFY.
2021-02-28 19:18:25 +08:00
<xi:include href="common-variables.xml" />
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-23 02:09:32 +08:00
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
man: document new importctl/importd functionality This also replaces the Fedora download example with another one from Ubuntu, since Fedora's images these days no longer qualify as DDIs, they have no distinctive partition type UUIDs set for multiple of their partitions, hence the images cannot be booted. A bit sad. Let's provide a command that just works in its place.
2024-02-27 16:39:57 +08:00
<member><citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-23 02:09:32 +08:00
<member><citerefentry project='die-net'><refentrytitle>tar</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry project='die-net'><refentrytitle>xz</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry project='die-net'><refentrytitle>gzip</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry project='die-net'><refentrytitle>bzip2</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
</simplelist></para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
man: document machinectl and systemd-machined
2013-07-07 10:22:05 +08:00
</refentry>
Reference in New Issue Copy Permalink