forked from illiliti/tinyramfs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tinyramfs.5
184 lines (184 loc) · 3.05 KB
/
tinyramfs.5
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "tinyramfs" "5" "2022-05-11" "tinyramfs" "2022-05-09"
.P
.SH NAME
.P
tinyramfs - configuration file
.P
.SH DESCRIPTION
.P
A tinyramfs configuration file is written in POSIX sh.\& Configuration is done
via variable asignment (eg.\& \fBoption=value\fR).\& Special characters and whitespace
must be quoted or escaped, more info: \fBsh\fR(1).\& By default tinyramfs looks to
\fB/etc/tinyramfs/config\fR for a configuration file.\&
.P
.SH OPTIONS
.P
Option marked with \fB(bool)\fR can hold a value of true or false.\& False if the
variable is unset or empty, true otherwise.\&
.P
Some options only apply to certain hooks and have been categorized accordingly.\&
.P
Options which expect a device as a value can also refer to the device via
\fBUUID\fR, \fBLABEL\fR, and \fBPARTUUID\fR (eg.\& LABEL=<label>).\& This requires a blkid
utility which supports that identifier.\&
.P
root
.P
.RS 4
The device your root filesystem is located on.\&
.P
.RE
hooks
.P
.RS 4
A comma separated list of hooks to include in the initramfs.\& Hooks can
be found in /lib/tinyramfs/hook.\&d/.\&
.P
.RE
monolith
.P
.RS 4
(bool) Instructs tinyramfs whether or not to include kernel modules in
the initramfs.\&
.P
.RE
compress
.P
.RS 4
The utility to use for compressing the initramfs.\& The option accepts
arbitrary commands (eg.\& '\&gzip -9'\&).\& Use '\&cat'\& for an uncompressed
initramfs.\&
.P
.RE
hostonly
.P
.RS 4
(bool) Whether or not to only copy modules specific to your system.\&
.P
.RE
root_type
.P
.RS 4
The filesystem you'\&re using for your root device (eg.\& ext4).\&
.P
.RE
.SS KEYMAP
.P
keymap_path
.P
.RS 4
Path to your keymap.\&
.P
.RE
.SS LUKS
.P
luks_discard
.P
.RS 4
(bool) Allow the use of discard (TRIM) requests for your luks device.\&
.P
\fBWARNING\fR: This option may have a negative security impact.\& For more info
read \fBcryptsetup\fR(8).\&
.P
.RE
luks_header
.P
.RS 4
Path to your LUKS header.\&
.P
.RE
luks_root
.P
.RS 4
The device your LUKS volume is located on.\&
.P
.RE
luks_name
.P
.RS 4
The name to map your LUKS device to.\&
.P
.RE
luks_key
.P
.RS 4
Path to your LUKS keyfile.\&
.P
.RE
.SS LVM
.P
lvm_config
.P
.RS 4
Path to your LVM configuration file.\&
.P
.RE
lvm_discard
.P
.RS 4
(bool) Allow the use of discard (TRIM) requests for your LVM device.\&
.P
.RE
lvm_group
.P
.RS 4
The name of your LVM volume group.\&
.P
.RE
lvm_name
.P
.RS 4
The name of your LVM logical volume.\&
.P
.RE
lvm_tag
.P
.RS 4
The tag of your LVM logical volume.\&
.P
.RE
.SS RESUME
.P
resume
.P
.RS 4
The location of your swap partition.\&
.P
.RE
.SS ZFS
.P
zfs_key
.P
.RS 4
Path to your ZFS keyfile.\&
.P
.RE
zfs_root
.P
.RS 4
The device your ZFS volume is located on.\&
.P
.RE
.SH FILES
.P
/lib/tinyramfs/hook.\&d/
.RS 4
tinyramfs hooks
.P
.RE
.SH SEE ALSO
.P
\fBtinyramfs\fR(8)
.P
.SH AUTHORS
.P
tinyramfs by illiliti \fBhttps://github.\&com/illiliti\fR
.br
man page by fluorescent_haze \fBhttps://github.\&com/fluorescent-haze\fR