-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkinitramfs.cmdline.7
152 lines (152 loc) · 3.66 KB
/
mkinitramfs.cmdline.7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
.\" mkinitramfs.cmdline(7) manual page
.\" See COPYING and COPYRIGHT files for corresponding information.
.Dd May 22, 2024
.Dt MKINITRAMFS.CMDLINE 7
.Os
.\" ==================================================================
.Sh NAME
.Nm mkinitramfs.cmdline
.Nd mkinitramfs' kernel command-line parameters
.\" ==================================================================
.Sh DESCRIPTION
The
.Xr mkinitramfs 8
utility provides a way to control configuration dynamically via kernel
parameters without needing to regenerate initramfs image.
.\" ------------------------------------------------------------------
.Ss General Parameters
.Bl -tag -width Ds -compact
.It Sy debug Ns = Ns Aq 0 | 1
Enable debug mode.
.Pp
.It Sy break Ns = Ns Aq BREAKPOINT
Specify breakpoint where shell should be invoked.
Useful for debugging.
.Pp
List of builtin breakpoints:
.Bl -tag -width XX -compact -offset XX
.It \(bu boot
.It \(bu root
.El
.Pp
Hooks can provide their own breakpoints.
See source code of hooks for more information.
.Pp
.It Sy root Ns = Ns Aq UUID | LABEL | /dev/* | PARTUUID
Specify which way initramfs will use to look up root filesystem.
.Pp
.Bl -tag -width PARTUUID -compact
.It UUID
Lookup device by uuid.
.It LABEL
Lookup device by label.
.It /dev/*
Lookup device by full path.
.It PARTUUID
Lookup device by partition uuid.
.El
.Pp
Initramfs must contain
.Sy blkid
utility for ability to use UUID, LABEL, PARTUUID.
.Sy Note :
PARTUUID only supported in
.Sy util-linux Ns '
.Xr blkid 8 .
.Pp
.It Sy root_type Ns = Ns Aq TYPE
.It Sy rootfstype Ns = Ns Aq TYPE
Explicitly set root filesystem type.
Kernel must support specified type.
.Pp
.It Sy rootdelay Ns = Ns Aq DELAY
Specify maximum number of seconds to wait for root device instead of
the default 30 seconds.
.Pp
.It Sy root_opts Ns = Ns Aq OPTS
.It Sy rootflags Ns = Ns Aq OPTS
See
.Xr fstab 5
fourth field.
.El
.\" ------------------------------------------------------------------
.Ss Hooks Parameters
Initramfs must contain appropriate hooks for ability to use below
parameters.
.Pp
The parameters for
.Sy LVM
hook are as follows:
.Bl -tag -width Ds
.It Sy lvm_tag Ns = Ns Aq TAG
Specify LVM tag which will be used to trigger LVM.
.Pp
This option will be ignored if
.Sy lvm_name Ns / Ns Sy lvm_group
was specified.
.It Sy lvm_name Ns = Ns Aq NAME
Specify LVM name which will be used to trigger LVM.
.Pp
.Sy lvm_group
(see below) must be specified.
.It Sy lvm_group Ns = Ns Aq GROUP
Specify LVM group which will be used to trigger LVM.
.It Sy lvm_discard Ns = Ns Aq 0 | 1
Pass
.Em issue_discards
to LVM.
Leave empty to disable.
Useful for SSD's.
.El
.Pp
The parameters for
.Sy LUKS
hook are as follows:
.Bl -tag -width Ds
.It Sy luks_name Ns = Ns Aq NAME
Specify which name will be registered to mapping table after
.Xr cryptsetup 8
unlocks LUKS root.
.It Sy luks_root Ns = Ns Aq UUID | LABEL | /dev/* | PARTUUID
See
.Sy root
(above) for details.
.It Sy luks_discard Ns = Ns Aq 0 | 1
Pass
.Dq --allow-discards
to
.Xr cryptsetup 8 .
Leave empty to disable.
.Pp
Useful for SSD's, but you must know that security will be decreased.
.El
.\" ==================================================================
.Sh EXAMPLES
Specify
.Sy root
option argument:
.Bd -literal -offset indent
vmlinuz initrd=\einitramfs root=/dev/sda1 [...]
.Ed
.Pp
Disable
.Dq discards
for
.Sy LUKS
and
.Sy LVM :
.Bd -literal -offset indent
vmlinuz initrd=\einitramfs luks_discard= lvm_discard= [...]
.Ed
.Pp
Pass arguments to real init:
.Bd -literal -offset indent
vmlinuz initrd=\einitramfs [...] -- arguments
.Ed
.\" ==================================================================
.Sh SEE ALSO
.Xr mkinitramfs.config 5 ,
.Xr mkinitramfs.hooks 7 ,
.Xr mkinitramfs 8
.\" vim: cc=72 tw=70
.\" End of file.