]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/kernel-command-line.xml
man: document luks.options kernel commandline
[thirdparty/systemd.git] / man / kernel-command-line.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6 This file is part of systemd.
7
8 Copyright 2012 Lennart Poettering
9
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
14
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="kernel-command-line">
25
26 <refentryinfo>
27 <title>kernel-command-line</title>
28 <productname>systemd</productname>
29
30 <authorgroup>
31 <author>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
36 </author>
37 </authorgroup>
38 </refentryinfo>
39
40 <refmeta>
41 <refentrytitle>kernel-command-line</refentrytitle>
42 <manvolnum>7</manvolnum>
43 </refmeta>
44
45 <refnamediv>
46 <refname>kernel-command-line</refname>
47 <refpurpose>Kernel command line parameters</refpurpose>
48 </refnamediv>
49
50 <refsynopsisdiv>
51 <para><filename>/proc/cmdline</filename></para>
52 </refsynopsisdiv>
53
54 <refsect1>
55 <title>Description</title>
56
57 <para>The kernel, the initial RAM disk (initrd) and
58 basic userspace functionality may be configured at boot via
59 kernel command line arguments.</para>
60
61 <para>For command line parameters understood by the
62 kernel, please see <ulink
63 url="https://www.kernel.org/doc/Documentation/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
64 and
65 <citerefentry><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
66
67 <para>For command line parameters understood by the
68 initial RAM disk, please see
69 <citerefentry><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
70 or the documentation of the specific initrd
71 implementation of your installation.</para>
72 </refsect1>
73
74 <refsect1>
75 <title>Core OS Command Line Arguments</title>
76
77 <variablelist class='kernel-commandline-options'>
78 <varlistentry>
79 <term><varname>systemd.unit=</varname></term>
80 <term><varname>rd.systemd.unit=</varname></term>
81 <term><varname>systemd.dump_core=</varname></term>
82 <term><varname>systemd.crash_shell=</varname></term>
83 <term><varname>systemd.crash_chvt=</varname></term>
84 <term><varname>systemd.confirm_spawn=</varname></term>
85 <term><varname>systemd.show_status=</varname></term>
86 <term><varname>systemd.log_target=</varname></term>
87 <term><varname>systemd.log_level=</varname></term>
88 <term><varname>systemd.log_color=</varname></term>
89 <term><varname>systemd.log_location=</varname></term>
90 <term><varname>systemd.default_standard_output=</varname></term>
91 <term><varname>systemd.default_standard_error=</varname></term>
92 <term><varname>systemd.setenv=</varname></term>
93 <listitem>
94 <para>Parameters understood by
95 the system and service manager
96 to control system behavior. For details, see
97 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
98 </listitem>
99 </varlistentry>
100
101 <varlistentry>
102 <term><varname>quiet</varname></term>
103 <listitem>
104 <para>Parameter understood by
105 both the kernel and the system
106 and service manager to control
107 console log verbosity. For
108 details, see
109 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
110 </listitem>
111 </varlistentry>
112
113 <varlistentry>
114 <term><varname>debug</varname></term>
115 <listitem>
116 <para>Parameter understood by
117 both the kernel and the system
118 and service manager to control
119 console log verbosity. For
120 details, see
121 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
122 </listitem>
123 </varlistentry>
124
125 <varlistentry>
126 <term><varname>emergency</varname></term>
127 <term><varname>single</varname></term>
128 <term><varname>s</varname></term>
129 <term><varname>S</varname></term>
130 <term><varname>1</varname></term>
131 <term><varname>2</varname></term>
132 <term><varname>3</varname></term>
133 <term><varname>4</varname></term>
134 <term><varname>5</varname></term>
135 <listitem>
136 <para>Parameters understood by
137 the system and service
138 manager, as compatibility
139 options. For details, see
140 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
141 </listitem>
142 </varlistentry>
143
144 <varlistentry>
145 <term><varname>locale.LANG=</varname></term>
146 <term><varname>locale.LANGUAGE=</varname></term>
147 <term><varname>locale.LC_CTYPE=</varname></term>
148 <term><varname>locale.LC_NUMERIC=</varname></term>
149 <term><varname>locale.LC_TIME=</varname></term>
150 <term><varname>locale.LC_COLLATE=</varname></term>
151 <term><varname>locale.LC_MONETARY=</varname></term>
152 <term><varname>locale.LC_MESSAGES=</varname></term>
153 <term><varname>locale.LC_PAPER=</varname></term>
154 <term><varname>locale.LC_NAME=</varname></term>
155 <term><varname>locale.LC_ADDRESS=</varname></term>
156 <term><varname>locale.LC_TELEPHONE=</varname></term>
157 <term><varname>locale.LC_MEASUREMENT=</varname></term>
158 <term><varname>locale.LC_IDENTIFICATION=</varname></term>
159 <listitem>
160 <para>Parameters understood by
161 the system and service manager
162 to control locale and language
163 settings. For details, see
164 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
165 </listitem>
166 </varlistentry>
167
168 <varlistentry>
169 <term><varname>fsck.mode=</varname></term>
170
171 <listitem>
172 <para>Parameter understood by
173 the file system checker
174 services. For details, see
175 <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
176 </listitem>
177 </varlistentry>
178
179 <varlistentry>
180 <term><varname>quotacheck.mode=</varname></term>
181
182 <listitem>
183 <para>Parameter understood by
184 the file quota checker
185 service. For details, see
186 <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
187 </listitem>
188 </varlistentry>
189
190 <varlistentry>
191 <term><varname>systemd.journald.forward_to_syslog=</varname></term>
192 <term><varname>systemd.journald.forward_to_kmsg=</varname></term>
193 <term><varname>systemd.journald.forward_to_console=</varname></term>
194
195 <listitem>
196 <para>Parameters understood by
197 the journal service. For
198 details, see
199 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
200 </listitem>
201 </varlistentry>
202
203 <varlistentry>
204 <term><varname>vconsole.keymap=</varname></term>
205 <term><varname>vconsole.keymap.toggle=</varname></term>
206 <term><varname>vconsole.font=</varname></term>
207 <term><varname>vconsole.font.map=</varname></term>
208 <term><varname>vconsole.font.unimap=</varname></term>
209
210 <listitem>
211 <para>Parameters understood by
212 the virtual console setup logic. For
213 details, see
214 <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry>
219 <term><varname>udev.log-priority=</varname></term>
220 <term><varname>rd.udev.log-priority=</varname></term>
221 <term><varname>udev.children-max=</varname></term>
222 <term><varname>rd.udev.children-max=</varname></term>
223 <term><varname>udev.exec-delay=</varname></term>
224 <term><varname>rd.udev.exec-delay=</varname></term>
225 <term><varname>net.ifnames=</varname></term>
226
227 <listitem>
228 <para>Parameters understood by
229 the device event managing daemon. For
230 details, see
231 <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry>
236 <term><varname>plymouth.enable=</varname></term>
237
238 <listitem>
239 <para>May be used to disable
240 the Plymouth boot splash. For
241 details, see
242 <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry>
247 <term><varname>luks=</varname></term>
248 <term><varname>rd.luks=</varname></term>
249 <term><varname>luks.crypttab=</varname></term>
250 <term><varname>rd.luks.crypttab=</varname></term>
251 <term><varname>luks.uuid=</varname></term>
252 <term><varname>rd.luks.uuid=</varname></term>
253 <term><varname>luks.options=</varname></term>
254 <term><varname>rd.luks.options=</varname></term>
255 <term><varname>luks.key=</varname></term>
256 <term><varname>rd.luks.key=</varname></term>
257
258 <listitem>
259 <para>Configures the LUKS
260 full-disk encryption logic at
261 boot. For details, see
262 <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry>
267 <term><varname>fstab=</varname></term>
268 <term><varname>rd.fstab=</varname></term>
269
270 <listitem>
271 <para>Configures the
272 <filename>/etc/fstab</filename>
273 logic at boot. For details, see
274 <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
275 </listitem>
276 </varlistentry>
277
278 <varlistentry>
279 <term><varname>modules-load=</varname></term>
280 <term><varname>rd.modules-load=</varname></term>
281
282 <listitem>
283 <para>Load a specific kernel
284 module early at boot. For
285 details, see
286 <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
287 </listitem>
288 </varlistentry>
289
290 </variablelist>
291
292 </refsect1>
293
294 <refsect1>
295 <title>See Also</title>
296 <para>
297 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
298 <citerefentry><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
299 <citerefentry><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
300 <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
301 <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
302 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
303 <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
304 <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
305 <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
306 <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
307 <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
308 <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
309 </para>
310 </refsect1>
311
312 </refentry>