diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2021-07-31 09:16:52 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2021-08-03 16:02:55 +0200 |
commit | d53285d551d883bb9f097eca0942e8c585e33470 (patch) | |
tree | acace4eda28f3409198e769c2a33c23dd67afd00 | |
parent | veritysetup: print help for --help/-h/help (diff) | |
download | systemd-d53285d551d883bb9f097eca0942e8c585e33470.tar.xz systemd-d53285d551d883bb9f097eca0942e8c585e33470.zip |
man: describe veritysetup command syntax
It makes it easier to diagnose what the generated units actually do.
-rw-r--r-- | man/systemd-veritysetup@.service.xml | 47 | ||||
-rw-r--r-- | src/veritysetup/veritysetup.c | 2 |
2 files changed, 48 insertions, 1 deletions
diff --git a/man/systemd-veritysetup@.service.xml b/man/systemd-veritysetup@.service.xml index c9554b087ae..70f08374e22 100644 --- a/man/systemd-veritysetup@.service.xml +++ b/man/systemd-veritysetup@.service.xml @@ -36,6 +36,53 @@ <para>At early boot and when the system manager configuration is reloaded kernel command line configuration for integrity protected block devices is translated into <filename>systemd-veritysetup@.service</filename> units by <citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + + <para><filename>systemd-veritysetup@.service</filename> calls <command>systemd-veritysetup</command>.</para> + </refsect1> + + <refsect1> + <title>Commands</title> + + <para>The following commands are understood by <command>systemd-veritysetup</command>:</para> + + <variablelist> + <varlistentry> + <term> + <option>attach</option> + <replaceable>volume</replaceable> + <replaceable>datadevice</replaceable> + <replaceable>hashdevice</replaceable> + <replaceable>roothash</replaceable> + [<replaceable>option</replaceable>...] + </term> + + <listitem><para>Create a block device <replaceable>volume</replaceable> using + <replaceable>datadevice</replaceable> and <replaceable>hashdevice</replaceable> as the backing + devices. <replaceable>roothash</replaceable> forms the root of the tree of hashes stored on + <replaceable>hashdevice</replaceable>. See + <ulink url="https://www.kernel.org/doc/html/latest/admin-guide/device-mapper/verity.html"> + Kernel dm-verity</ulink> documentation for details. + </para></listitem> + </varlistentry> + + <varlistentry> + <term> + <option>detach</option> + <replaceable>volume</replaceable> + </term> + + <listitem><para>Detach (destroy) the block device + <replaceable>volume</replaceable>.</para></listitem> + </varlistentry> + + <varlistentry> + <term> + <option>help</option> + </term> + + <listitem><para>Print short information about command syntax.</para></listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1> diff --git a/src/veritysetup/veritysetup.c b/src/veritysetup/veritysetup.c index 14d7462ddbc..e58bae45d22 100644 --- a/src/veritysetup/veritysetup.c +++ b/src/veritysetup/veritysetup.c @@ -30,7 +30,7 @@ static int help(void) { printf("%s attach VOLUME DATADEVICE HASHDEVICE ROOTHASH [OPTIONS]\n" "%s detach VOLUME\n\n" - "Attaches or detaches an integrity protected block device.\n" + "Attach or detach an integrity protected block device.\n" "\nSee the %s for details.\n", program_invocation_short_name, program_invocation_short_name, |