man/systemd-cryptsetup-generator.8

   1 '\" t
   2 .TH "SYSTEMD\-CRYPTSETUP\-GENERATOR" "8" "" "systemd 217" "systemd-cryptsetup-generator"
   3 .\" -----------------------------------------------------------------
   4 .\" * Define some portability stuff
   5 .\" -----------------------------------------------------------------
   6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 .\" http://bugs.debian.org/507673
   8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
   9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10 .ie \n(.g .ds Aq \(aq
  11 .el       .ds Aq '
  12 .\" -----------------------------------------------------------------
  13 .\" * set default formatting
  14 .\" -----------------------------------------------------------------
  15 .\" disable hyphenation
  16 .nh
  17 .\" disable justification (adjust text to left margin only)
  18 .ad l
  19 .\" -----------------------------------------------------------------
  20 .\" * MAIN CONTENT STARTS HERE *
  21 .\" -----------------------------------------------------------------
  22 .SH "NAME"
  23 systemd-cryptsetup-generator \- Unit generator for /etc/crypttab
  24 .SH "SYNOPSIS"
  25 .PP
  26 /usr/lib/systemd/system\-generators/systemd\-cryptsetup\-generator
  27 .SH "DESCRIPTION"
  28 .PP
  29 systemd\-cryptsetup\-generator
  30 is a generator that translates
  31 /etc/crypttab
  32 into native systemd units early at boot and when configuration of the system manager is reloaded\&. This will create
  33 \fBsystemd-cryptsetup@.service\fR(8)
  34 units as necessary\&.
  35 .PP
  36 systemd\-cryptsetup\-generator
  37 implements the
  38 \m[blue]\fBgenerator specification\fR\m[]\&\s-2\u[1]\d\s+2\&.
  39 .SH "KERNEL COMMAND LINE"
  40 .PP
  41 systemd\-cryptsetup\-generator
  42 understands the following kernel command line parameters:
  43 .PP
  44 \fIluks=\fR, \fIrd\&.luks=\fR
  45 .RS 4
  46 Takes a boolean argument\&. Defaults to
  47 "yes"\&. If
  48 "no", disables the generator entirely\&.
  49 \fIrd\&.luks=\fR
  50 is honored only by initial RAM disk (initrd) while
  51 \fIluks=\fR
  52 is honored by both the main system and the initrd\&.
  53 .RE
  54 .PP
  55 \fIluks\&.crypttab=\fR, \fIrd\&.luks\&.crypttab=\fR
  56 .RS 4
  57 Takes a boolean argument\&. Defaults to
  58 "yes"\&. If
  59 "no", causes the generator to ignore any devices configured in
  60 /etc/crypttab
  61 (\fIluks\&.uuid=\fR
  62 will still work however)\&.
  63 \fIrd\&.luks\&.crypttab=\fR
  64 is honored only by initial RAM disk (initrd) while
  65 \fIluks\&.crypttab=\fR
  66 is honored by both the main system and the initrd\&.
  67 .RE
  68 .PP
  69 \fIluks\&.uuid=\fR, \fIrd\&.luks\&.uuid=\fR
  70 .RS 4
  71 Takes a LUKS superblock UUID as argument\&. This will activate the specified device as part of the boot process as if it was listed in
  72 /etc/fstab\&. This option may be specified more than once in order to set up multiple devices\&.
  73 \fIrd\&.luks\&.uuid=\fR
  74 is honored only by initial RAM disk (initrd) while
  75 \fIluks\&.uuid=\fR
  76 is honored by both the main system and the initrd\&.
  77 .sp
  78 If /etc/crypttab contains entries with the same UUID, then the options for this entry will be used\&.
  79 .sp
  80 If /etc/crypttab exists, only those UUID specified on the kernel command line will be activated in the initrd or the real root\&.
  81 .RE
  82 .PP
  83 \fIluks\&.options=\fR, \fIrd\&.luks\&.options=\fR
  84 .RS 4
  85 Takes a LUKS super block UUID followed by an \*(Aq=\*(Aq and a string of options separated by commas as argument\&. This will override the options for the given UUID\&.
  86 .sp
  87 If only a list of options, without an UUID, is specified, they apply to any UUIDs not specified elsewhere, and without an entry in /etc/crypttab\&.
  88 .sp
  89 \fIrd\&.luks\&.options=\fR
  90 is honored only by initial RAM disk (initrd) while
  91 \fIluks\&.options=\fR
  92 is honored by both the main system and the initrd\&.
  93 .RE
  94 .PP
  95 \fIluks\&.key=\fR, \fIrd\&.luks\&.key=\fR
  96 .RS 4
  97 Takes a password file as argument\&.
  98 .sp
  99 For those entries specified with
 100 \fIrd\&.luks\&.uuid=\fR
 101 or
 102 \fIluks\&.uuid=\fR, the password file will be set to the password file specified by
 103 \fIrd\&.luks\&.key=\fR
 104 or
 105 \fIluks\&.key\fR
 106 .sp
 107 \fIrd\&.luks\&.key=\fR
 108 is honored only by initial RAM disk (initrd) while
 109 \fIluks\&.key=\fR
 110 is honored by both the main system and the initrd\&.
 111 .RE
 112 .SH "SEE ALSO"
 113 .PP
 114 \fBsystemd\fR(1),
 115 \fBcrypttab\fR(5),
 116 \fBsystemd-cryptsetup@.service\fR(8),
 117 \fBcryptsetup\fR(8),
 118 \fBsystemd-fstab-generator\fR(8)
 119 .SH "NOTES"
 120 .IP " 1." 4
 121 generator specification
 122 .RS 4
 123 \%http://www.freedesktop.org/wiki/Software/systemd/Generators
 124 .RE