]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: fix markup
authorDavid Tardon <dtardon@redhat.com>
Sat, 23 Dec 2023 16:34:30 +0000 (17:34 +0100)
committerDavid Tardon <dtardon@redhat.com>
Tue, 26 Dec 2023 12:10:35 +0000 (13:10 +0100)
<arg> is not allowed inside <term>.

man/systemd-creds.xml
man/systemd-cryptenroll.xml
man/systemd-journal-remote.service.xml
man/systemd-pcrlock.xml
man/systemd-repart.xml

index 7d99b6b895892a07bfe3dec2decaa4cb0af02538..60f38f6bd997263bf93a9f3299a43734017ba8e5 100644 (file)
       </varlistentry>
 
       <varlistentry>
-        <term><option>--tpm2-pcrs=</option><arg rep="repeat">PCR</arg></term>
+        <term><option>--tpm2-pcrs=</option><replaceable>PCR<optional>+PCR...</optional></replaceable></term>
 
         <listitem><para>Configures the TPM2 PCRs (Platform Configuration Registers) to bind the encryption
         key to. Takes a <literal>+</literal> separated list of numeric PCR indexes in the range 0…23. If not
       </varlistentry>
 
       <varlistentry>
-        <term><option>--tpm2-public-key=</option><arg>PATH</arg></term>
-        <term><option>--tpm2-public-key-pcrs=</option><arg rep="repeat">PCR</arg></term>
+        <term><option>--tpm2-public-key=</option><replaceable>PATH</replaceable></term>
+        <term><option>--tpm2-public-key-pcrs=</option><replaceable>PCR<optional>+PCR...</optional></replaceable></term>
 
         <listitem><para>Configures a TPM2 signed PCR policy to bind encryption to, for use with the
         <command>encrypt</command> command. The <option>--tpm2-public-key=</option> option accepts a path to
       </varlistentry>
 
       <varlistentry>
-        <term><option>--tpm2-signature=</option><arg>PATH</arg></term>
+        <term><option>--tpm2-signature=</option><replaceable>PATH</replaceable></term>
 
         <listitem><para>Takes a path to a TPM2 PCR signature file as generated by the
         <citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry>
index 465461766541989fd4ffdca135cce6cc2aeebe2f..a308a2ebdc7ae96f2bb54e8d099f0cf949a1b26a 100644 (file)
       </varlistentry>
 
       <varlistentry>
-        <term><option>--tpm2-pcrs=</option><arg rep="repeat">PCR</arg></term>
+        <term><option>--tpm2-pcrs=</option><replaceable>PCR<optional>+PCR...</optional></replaceable></term>
 
         <listitem><para>Configures the TPM2 PCRs (Platform Configuration Registers) to bind to when
         enrollment is requested via <option>--tpm2-device=</option>. Takes a list of PCR entries, where each
       </varlistentry>
 
       <varlistentry>
-        <term><option>--tpm2-public-key=</option><arg>PATH</arg></term>
-        <term><option>--tpm2-public-key-pcrs=</option><arg rep="repeat">PCR</arg></term>
-        <term><option>--tpm2-signature=</option><arg>PATH</arg></term>
+        <term><option>--tpm2-public-key=</option><replaceable>PATH</replaceable></term>
+        <term><option>--tpm2-public-key-pcrs=</option><replaceable>PCR<optional>+PCR...</optional></replaceable></term>
+        <term><option>--tpm2-signature=</option><replaceable>PATH</replaceable></term>
 
         <listitem><para>Configures a TPM2 signed PCR policy to bind encryption to. The
         <option>--tpm2-public-key=</option> option accepts a path to a PEM encoded RSA public key, to bind
       </varlistentry>
 
       <varlistentry>
-        <term><option>--tpm2-pcrlock=</option><arg>PATH</arg></term>
+        <term><option>--tpm2-pcrlock=</option><replaceable>PATH</replaceable></term>
 
         <listitem><para>Configures a TPM2 pcrlock policy to bind encryption to. Expects a path to a pcrlock
         policy file as generated by the
       </varlistentry>
 
       <varlistentry>
-        <term><option>--wipe-slot=</option><arg rep="repeat">SLOT</arg></term>
+        <term><option>--wipe-slot=</option><replaceable>SLOT<optional>,SLOT...</optional></replaceable></term>
 
         <listitem><para>Wipes one or more LUKS2 key slots. Takes a comma separated list of numeric slot
         indexes, or the special strings <literal>all</literal> (for wiping all key slots),
index 18a075e3b1236011dd37bed8f9335c0cda1992b3..a8e83967181ada7a04f51ce4a133a3fb76310698 100644 (file)
@@ -87,7 +87,7 @@
 
     <variablelist>
       <varlistentry>
-        <term><arg choice="opt" rep="repeat">SOURCES</arg></term>
+        <term><optional>SOURCES</optional></term>
 
         <listitem><para>When <option>-</option> is given as a
         positional argument, events will be read from standard input.
       </varlistentry>
 
       <varlistentry>
-        <term><option>--getter='<replaceable>PROG</replaceable> <arg choice="opt" rep="repeat">OPTIONS</arg>'</option></term>
+        <term><option>--getter='<replaceable>PROG</replaceable> <optional>OPTIONS</optional>'</option></term>
 
         <listitem><para>Program to invoke to retrieve data. The journal
         event stream must be generated on standard output.</para>
index 63d536f17fa5557b04d29be1f07da0cf85a67979..b3f332303346070cafad70ec201fa010731c24fc 100644 (file)
       </varlistentry>
 
       <varlistentry>
-        <term><command>lock-gpt</command> <arg choice="opt"><replaceable>DEVICE</replaceable></arg></term>
+        <term><command>lock-gpt</command> <optional><replaceable>DEVICE</replaceable></optional></term>
         <term><command>unlock-gpt</command></term>
 
         <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on the GPT partition
       </varlistentry>
 
       <varlistentry>
-        <term><command>lock-pe</command> <arg choice="opt"><replaceable>BINARY</replaceable></arg></term>
+        <term><command>lock-pe</command> <optional><replaceable>BINARY</replaceable></optional></term>
         <term><command>unlock-pe</command></term>
 
         <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on the specified PE
       </varlistentry>
 
       <varlistentry>
-        <term><command>lock-uki</command> <arg choice="opt"><replaceable>UKI</replaceable></arg></term>
+        <term><command>lock-uki</command> <optional><replaceable>UKI</replaceable></optional></term>
         <term><command>unlock-uki</command></term>
 
         <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on the specified UKI PE
       </varlistentry>
 
       <varlistentry>
-        <term><command>lock-file-system</command> <arg choice="opt"><replaceable>PATH</replaceable></arg></term>
-        <term><command>unlock-file-system</command> <arg choice="opt"><replaceable>PATH</replaceable></arg></term>
+        <term><command>lock-file-system</command> <optional><replaceable>PATH</replaceable></optional></term>
+        <term><command>unlock-file-system</command> <optional><replaceable>PATH</replaceable></optional></term>
 
         <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on file system
         identity. This is useful for predicting measurements
       </varlistentry>
 
       <varlistentry>
-        <term><command>lock-kernel-cmdline</command> <arg choice="opt"><replaceable>FILE</replaceable></arg></term>
+        <term><command>lock-kernel-cmdline</command> <optional><replaceable>FILE</replaceable></optional></term>
         <term><command>unlock-kernel-cmdline</command></term>
 
         <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on
       </varlistentry>
 
       <varlistentry>
-        <term><command>lock-raw</command> <arg choice="opt"><replaceable>FILE</replaceable></arg></term>
+        <term><command>lock-raw</command> <optional><replaceable>FILE</replaceable></optional></term>
         <term><command>unlock-raw</command></term>
 
         <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on raw binary data. The
index 76d1279b1a2e5ceab9dd14a5d4ebac2371b2e605..b645027ee3609d10d744563010a9531774b88036 100644 (file)
       </varlistentry>
 
       <varlistentry>
-        <term><option>--tpm2-device-key=</option><arg>PATH</arg></term>
-        <term><option>--tpm2-seal-key-handle=</option><arg>HANDLE</arg></term>
+        <term><option>--tpm2-device-key=</option><replaceable>PATH</replaceable></term>
+        <term><option>--tpm2-seal-key-handle=</option><replaceable>HANDLE</replaceable></term>
 
         <listitem><para>Configures a TPM2 SRK key to bind encryption to. See
         <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry>
       </varlistentry>
 
       <varlistentry>
-        <term><option>--tpm2-public-key=</option><arg>PATH</arg></term>
-        <term><option>--tpm2-public-key-pcrs=</option><arg rep="repeat">PCR</arg></term>
+        <term><option>--tpm2-public-key=</option><replaceable>PATH</replaceable></term>
+        <term><option>--tpm2-public-key-pcrs=</option><replaceable>PCR<optional>+PCR...</optional></replaceable></term>
 
         <listitem><para>Configures a TPM2 signed PCR policy to bind encryption to. See
         <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry>
       </varlistentry>
 
       <varlistentry>
-        <term><option>--tpm2-pcrlock=</option><arg>PATH</arg></term>
+        <term><option>--tpm2-pcrlock=</option><replaceable>PATH</replaceable></term>
 
         <listitem><para>Configures a TPM2 pcrlock policy to bind encryption to. See
         <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry>
       </varlistentry>
 
       <varlistentry>
-        <term><option>--split=</option><arg>BOOL</arg></term>
+        <term><option>--split=</option><replaceable>BOOL</replaceable></term>
 
         <listitem><para>Enables generation of split artifacts from partitions configured with
         <varname>SplitName=</varname>. If enabled, for each partition with <varname>SplitName=</varname> set,
       </varlistentry>
 
       <varlistentry>
-        <term><option>--include-partitions=</option><arg rep="repeat">PARTITION</arg></term>
-        <term><option>--exclude-partitions=</option><arg rep="repeat">PARTITION</arg></term>
+        <term><option>--include-partitions=</option><replaceable>PARTITIONS</replaceable></term>
+        <term><option>--exclude-partitions=</option><replaceable>PARTITIONS</replaceable></term>
 
         <listitem><para>These options specify which partition types <command>systemd-repart</command> should
         operate on. If <option>--include-partitions=</option> is used, all partitions that aren't specified
       </varlistentry>
 
       <varlistentry>
-        <term><option>--defer-partitions=</option><arg rep="repeat">PARTITION</arg></term>
+        <term><option>--defer-partitions=</option><replaceable>PARTITIONS</replaceable></term>
 
         <listitem><para>This option specifies for which partition types <command>systemd-repart</command>
         should defer. All partitions that are deferred using this option are still taken into account when
       </varlistentry>
 
       <varlistentry>
-        <term><option>--sector-size=</option><arg>BYTES</arg></term>
+        <term><option>--sector-size=</option><replaceable>BYTES</replaceable></term>
 
         <listitem><para>This option allows configuring the sector size of the image produced by
         <command>systemd-repart</command>. It takes a value that is a power of <literal>2</literal> between
       </varlistentry>
 
       <varlistentry>
-        <term><option>--architecture=</option><arg>ARCH</arg></term>
+        <term><option>--architecture=</option><replaceable>ARCH</replaceable></term>
 
         <listitem><para>This option allows overriding the architecture used for architecture specific
         partition types. For example, if set to <literal>arm64</literal> a partition type of
       </varlistentry>
 
       <varlistentry>
-        <term><option>--offline=</option><arg>BOOL</arg></term>
+        <term><option>--offline=</option><replaceable>BOOL</replaceable></term>
 
         <listitem><para>Instructs <command>systemd-repart</command> to build the image offline. Takes a
         boolean or <literal>auto</literal>. Defaults to <literal>auto</literal>. If enabled, the image is
       </varlistentry>
 
       <varlistentry>
-        <term><option>--copy-from=</option><arg>IMAGE</arg></term>
+        <term><option>--copy-from=</option><replaceable>IMAGE</replaceable></term>
 
         <listitem><para>Instructs <command>systemd-repart</command> to synthesize partition definitions from
         the partition table in the given image. This option can be specified multiple times to synthesize