From 8e129f5156569e1bc858b002ca54cd447c38f4f1 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 27 Jun 2012 14:51:47 +0200 Subject: man: document systemd-cryptsetup-generator --- man/crypttab.xml | 5 ++ man/systemd-cryptsetup-generator.xml | 146 +++++++++++++++++++++++++++++++++++ man/systemd-cryptsetup@.service.xml | 14 +++- 3 files changed, 162 insertions(+), 3 deletions(-) create mode 100644 man/systemd-cryptsetup-generator.xml (limited to 'man') diff --git a/man/crypttab.xml b/man/crypttab.xml index d61ec95e4c..f3bde71b4f 100644 --- a/man/crypttab.xml +++ b/man/crypttab.xml @@ -255,6 +255,10 @@ + At early boot and when the system manager + configuration is reloaded this file is translated into + native systemd units + by systemd-cryptsetup-generator8. @@ -275,6 +279,7 @@ swap /dev/sda7 /dev/urandom swap systemd1, systemd-cryptsetup@.service8, + systemd-cryptsetup-generator8, cryptsetup8, mkswap8, mke2fs8 diff --git a/man/systemd-cryptsetup-generator.xml b/man/systemd-cryptsetup-generator.xml new file mode 100644 index 0000000000..17e0ed9a64 --- /dev/null +++ b/man/systemd-cryptsetup-generator.xml @@ -0,0 +1,146 @@ + + + + + + + + systemd-cryptsetup-generator + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-cryptsetup-generator + 8 + + + + systemd-cryptsetup-generator + Unit generated for /etc/crypttab + + + + /usr/lib/systemd/systemd-cryptsetup + + + + Description + + systemd-cryptsetup-generator + is a generator that translates + /etc/crypttab into native systemd + units early at boot and when configuration of the + system manager is reloaded. This will create + systemd-cryptsetup@.service8 + units as necessary. + + systemd-cryptsetup-generator + implements the generator + specification. + + + + Kernel Command Line + + systemd-cryptsetup-generator understands + the following kernel command line parameters: + + + + luks= + rd.luks= + + Takes a boolean + argument. Defaults to + yes. If + no disables the + generator + entirely. rd.luks= + is honoured only be initial RAM disk + (initrd) while + luks= is honoured + by both the main system and the + initrd. + + + + luks.crypttab= + rd.luks.crypttab= + + Takes a boolean + argument. Defaults to + yes. If + no causes the + generator to ignore any devices + configured in + /etc/crypttab + (luks.uuid= will + still work + however). rd.luks.crypttab= + is honoured only be initial RAM disk + (initrd) while + luks.crypttab= is + honoured by both the main system and + the initrd. + + + + luks.uuid= + rd.luks.uuid= + + Takes a LUKS super + block UUID as argument. This will + activate the specified device as part + of the boot process as if it was + listed in + /etc/fstab. This + option may be specified more than once + in order to set up multiple + devices. rd.luks.uuid= + is honoured only be initial RAM disk + (initrd) while + luks.uuid= is + honoured by both the main system and + the initrd. + + + + + + See Also + + systemd1, + crypttab5, + systemd-cryptsetup@.service8, + cryptsetup8 + + + + diff --git a/man/systemd-cryptsetup@.service.xml b/man/systemd-cryptsetup@.service.xml index 6e021d85da..abbb9d78f2 100644 --- a/man/systemd-cryptsetup@.service.xml +++ b/man/systemd-cryptsetup@.service.xml @@ -65,15 +65,23 @@ password agent logic, in order to query the user for the password using the right mechanism at boot and during runtime. + + At early boot and when the system manager + configuration is reloaded this + /etc/crypttab is translated into + systemd-cryptsetup@.service units + by + systemd-cryptsetup-generator8. See Also systemd1, - cryptsetup8, - crypttab5 - + systemd-cryptsetup-generator8, + crypttab5, + cryptsetup8 + -- cgit v1.2.3-54-g00ecf