1
0
mirror of https://github.com/systemd/systemd.git synced 2024-10-30 23:21:22 +03:00

Merge pull request #20372 from keszybz/veritysetup-help

Document veritysetup syntax
This commit is contained in:
Luca Boccassi 2021-08-04 00:05:28 +01:00 committed by GitHub
commit 42a45446bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 52 additions and 2 deletions

View File

@ -36,6 +36,53 @@
<para>At early boot and when the system manager configuration is reloaded kernel command line configuration for <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 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> <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>
<refsect1> <refsect1>

View File

@ -30,7 +30,7 @@ static int help(void) {
printf("%s attach VOLUME DATADEVICE HASHDEVICE ROOTHASH [OPTIONS]\n" printf("%s attach VOLUME DATADEVICE HASHDEVICE ROOTHASH [OPTIONS]\n"
"%s detach VOLUME\n\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", "\nSee the %s for details.\n",
program_invocation_short_name, program_invocation_short_name,
program_invocation_short_name, program_invocation_short_name,
@ -130,7 +130,10 @@ static int run(int argc, char *argv[]) {
_cleanup_(crypt_freep) struct crypt_device *cd = NULL; _cleanup_(crypt_freep) struct crypt_device *cd = NULL;
int r; int r;
if (argc <= 1) if (argc <= 1 ||
strv_contains(strv_skip(argv, 1), "--help") ||
strv_contains(strv_skip(argv, 1), "-h") ||
streq(argv[1], "help"))
return help(); return help();
if (argc < 3) if (argc < 3)