From 30247ea76e72ed89a5d86ec9b78ca8f89a989258 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= <zbyszek@in.waw.pl>
Date: Tue, 7 Nov 2023 21:36:46 +0100
Subject: [PATCH] man: many fixes systemd-vmspawn(1)
- version information
- indentation and missing tags
- mkosi and qemu don't need root
---
man/systemctl.xml | 8 +--
man/systemd-vmspawn.xml | 118 +++++++++++++++++++++++-----------------
2 files changed, 72 insertions(+), 54 deletions(-)
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 2204bee9172..1d791b44fd3 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -2736,15 +2736,15 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<listitem><para>When used with <command>bind</command>, creates a read-only bind mount.</para>
- <xi:include href="version-info.xml" xpointer="v248"/></listitem>
+ <xi:include href="version-info.xml" xpointer="v248"/>
+ </listitem>
</varlistentry>
<varlistentry>
<term><option>--drop-in=</option><replaceable>NAME</replaceable></term>
- <listitem>
- <para>When used with <command>edit</command>, use <replaceable>NAME</replaceable> as the drop-in
- file name instead of <filename>override.conf</filename>.</para>
+ <listitem><para>When used with <command>edit</command>, use <replaceable>NAME</replaceable> as the
+ drop-in file name instead of <filename>override.conf</filename>.</para>
<xi:include href="version-info.xml" xpointer="v253"/>
</listitem>
diff --git a/man/systemd-vmspawn.xml b/man/systemd-vmspawn.xml
index bf3aaf028ea..4ca6f1a74fd 100644
--- a/man/systemd-vmspawn.xml
+++ b/man/systemd-vmspawn.xml
@@ -44,59 +44,73 @@
<para>The following options are understood:</para>
<refsect2>
- <title>Image Options</title>
+ <title>Image Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-i</option></term>
- <term><option>--image=</option></term>
+ <variablelist>
+ <varlistentry>
+ <term><option>-i</option></term>
+ <term><option>--image=</option></term>
- <listitem><para>Root file system disk image (or device node) for the virtual machine.</para></listitem>
- </varlistentry>
- </variablelist>
+ <listitem><para>Root file system disk image (or device node) for the virtual machine.</para>
+
+ <xi:include href="version-info.xml" xpointer="v255"/>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect2>
<refsect2>
- <title>Host Configuration</title>
+ <title>Host Configuration</title>
- <variablelist>
- <varlistentry>
- <term><option>--qemu-smp=</option><replaceable>SMP</replaceable></term>
+ <variablelist>
+ <varlistentry>
+ <term><option>--qemu-smp=</option><replaceable>SMP</replaceable></term>
- <listitem><para>Configures the number of CPUs to start the virtual machine with.</para>
- <para>Defaults to 1.</para></listitem>
- </varlistentry>
+ <listitem><para>Configures the number of CPUs to start the virtual machine with.
+ Defaults to 1.</para>
- <varlistentry>
- <term><option>--qemu-mem=</option><replaceable>MEM</replaceable></term>
+ <xi:include href="version-info.xml" xpointer="v255"/>
+ </listitem>
+ </varlistentry>
- <listitem><para>Configures the amount of memory to start the virtual machine with.</para>
- <para>Defaults to 2G.</para></listitem>
- </varlistentry>
+ <varlistentry>
+ <term><option>--qemu-mem=</option><replaceable>MEM</replaceable></term>
- <varlistentry>
- <term><option>--qemu-kvm=</option></term>
+ <listitem><para>Configures the amount of memory to start the virtual machine with.
+ Defaults to 2G.</para>
- <para>Configure whether to use KVM.</para>
- <para>If the option is not specified KVM support will be detected automatically.
- If yes is specified KVM is always used, and vice versa if no is set KVM is never used.</para>
- </varlistentry>
+ <xi:include href="version-info.xml" xpointer="v255"/>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><option>--qemu-gui</option></term>
+ <varlistentry>
+ <term><option>--qemu-kvm=</option></term>
- <listitem><para>Start QEMU in graphical mode.</para></listitem>
- </varlistentry>
+ <listitem><para>Configures whether to use KVM. If the option is not specified KVM support will be
+ detected automatically. If true, KVM is always used, and if false, KVM is never used.</para>
- <varlistentry>
- <term><option>--secboot=</option></term>
+ <xi:include href="version-info.xml" xpointer="v255"/></listitem>
+ </varlistentry>
- <listitem><para>Configure whether to search for firmware which supports secure boot.</para></listitem>
- <para>If the option is not specified the first firmware which is detected will be used.
- If the option is set to yes then the first firmware with secure boot support will be selected.
- If no is specified then the first firmware without secure boot will be selected.</para>
- </varlistentry>
- </variablelist>
+ <varlistentry>
+ <term><option>--qemu-gui</option></term>
+
+ <listitem><para>Start QEMU in graphical mode.</para>
+
+ <xi:include href="version-info.xml" xpointer="v255"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--secboot=</option></term>
+
+ <listitem><para>Configures whether to search for firmware which supports secure boot. If the option
+ is not specified, the first firmware which is detected will be used. If true, then the first
+ firmware with secure boot support will be selected. If false, then the first firmware without
+ secure boot will be selected.</para>
+
+ <xi:include href="version-info.xml" xpointer="v255"/></listitem>
+ </varlistentry>
+ </variablelist>
</refsect2>
<refsect2>
@@ -116,19 +130,21 @@
use C-style escaping (i.e. <literal>\n</literal> to embed a newline, or <literal>\x00</literal> to
embed a <constant>NUL</constant> byte). Note that the invoking shell might already apply unescaping
once, hence this might require double escaping!.</para>
- </listitem>
+
+ <xi:include href="version-info.xml" xpointer="v255"/></listitem>
</varlistentry>
</variablelist>
- </refsect2><refsect2>
- <title>Other</title>
+ </refsect2>
+ <refsect2>
+ <title>Other</title>
- <variablelist>
- <xi:include href="standard-options.xml" xpointer="no-pager" />
- <xi:include href="standard-options.xml" xpointer="help" />
- <xi:include href="standard-options.xml" xpointer="version" />
- </variablelist>
- </refsect2>
+ <variablelist>
+ <xi:include href="standard-options.xml" xpointer="no-pager" />
+ <xi:include href="standard-options.xml" xpointer="help" />
+ <xi:include href="standard-options.xml" xpointer="version" />
+ </variablelist>
+ </refsect2>
</refsect1>
<xi:include href="common-variables.xml" />
@@ -139,8 +155,10 @@
<example>
<title>Run an Arch Linux VM image generated by mkosi</title>
- <programlisting># mkosi -d arch -p systemd -p linux --autologin -o image.raw -f build
- # systemd-vmspawn --image=image.raw</programlisting>
+ <programlisting>
+$ mkosi -d arch -p systemd -p linux --autologin -o image.raw -f build
+$ systemd-vmspawn --image=image.raw
+ </programlisting>
</example>
</refsect1>
@@ -155,7 +173,7 @@
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>mkosi</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>mkosi</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>