]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/kernel-command-line.xml
travis: use UBSan checks from OSS-Fuzz
[thirdparty/systemd.git] / man / kernel-command-line.xml
CommitLineData
c66e7bc7 1<?xml version='1.0'?> <!--*-nxml-*-->
3a54a157 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
0307f791 4<!-- SPDX-License-Identifier: LGPL-2.1+ -->
c66e7bc7
LP
5
6<refentry id="kernel-command-line">
7
798d3a52
ZJS
8 <refentryinfo>
9 <title>kernel-command-line</title>
10 <productname>systemd</productname>
798d3a52
ZJS
11 </refentryinfo>
12
13 <refmeta>
14 <refentrytitle>kernel-command-line</refentrytitle>
15 <manvolnum>7</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>kernel-command-line</refname>
20 <refpurpose>Kernel command line parameters</refpurpose>
21 </refnamediv>
22
23 <refsynopsisdiv>
24 <para><filename>/proc/cmdline</filename></para>
25 </refsynopsisdiv>
26
27 <refsect1>
28 <title>Description</title>
29
30 <para>The kernel, the initial RAM disk (initrd) and
31 basic userspace functionality may be configured at boot via
32 kernel command line arguments.</para>
33
34 <para>For command line parameters understood by the kernel, please
ab1f7245
ZJS
35 see
36 <ulink url="https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html"><filename>kernel-parameters.html</filename></ulink>
798d3a52
ZJS
37 and
38 <citerefentry project='man-pages'><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
39
40 <para>For command line parameters understood by the initial RAM
41 disk, please see
af105d03 42 <citerefentry project='man-pages'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
798d3a52
ZJS
43 or the documentation of the specific initrd implementation of your
44 installation.</para>
45 </refsect1>
46
47 <refsect1>
48 <title>Core OS Command Line Arguments</title>
49
50 <variablelist class='kernel-commandline-options'>
51 <varlistentry>
52 <term><varname>systemd.unit=</varname></term>
53 <term><varname>rd.systemd.unit=</varname></term>
770c4777 54 <term><varname>systemd.dump_core</varname></term>
c6885f5f 55 <term><varname>systemd.early_core_pattern=</varname></term>
770c4777
ZJS
56 <term><varname>systemd.crash_chvt</varname></term>
57 <term><varname>systemd.crash_shell</varname></term>
58 <term><varname>systemd.crash_reboot</varname></term>
59 <term><varname>systemd.confirm_spawn</varname></term>
2a12e32e 60 <term><varname>systemd.service_watchdogs</varname></term>
770c4777 61 <term><varname>systemd.show_status</varname></term>
798d3a52
ZJS
62 <term><varname>systemd.log_target=</varname></term>
63 <term><varname>systemd.log_level=</varname></term>
798d3a52 64 <term><varname>systemd.log_location=</varname></term>
770c4777 65 <term><varname>systemd.log_color</varname></term>
798d3a52
ZJS
66 <term><varname>systemd.default_standard_output=</varname></term>
67 <term><varname>systemd.default_standard_error=</varname></term>
68 <term><varname>systemd.setenv=</varname></term>
ee48dbd5 69 <term><varname>systemd.machine_id=</varname></term>
ee075513
ZJS
70 <term><varname>systemd.unified_cgroup_hierarchy</varname></term>
71 <term><varname>systemd.legacy_systemd_cgroup_controller</varname></term>
798d3a52
ZJS
72 <listitem>
73 <para>Parameters understood by the system and service
74 manager to control system behavior. For details, see
75 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
76 </listitem>
77 </varlistentry>
78
79 <varlistentry>
80 <term><varname>systemd.mask=</varname></term>
81 <term><varname>systemd.wants=</varname></term>
1d84ad94 82 <term><varname>systemd.debug_shell</varname></term>
798d3a52
ZJS
83 <listitem>
84 <para>Additional parameters understood by
85 <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
86 to mask or start specific units at boot, or invoke a debug
87 shell on tty9.</para>
88 </listitem>
89 </varlistentry>
90
565f3d91
LP
91 <varlistentry>
92 <term><varname>systemd.run=</varname></term>
93 <term><varname>systemd.run_success_action=</varname></term>
94 <term><varname>systemd.run_failure_action=</varname></term>
95 <listitem>
96 <para>Additional parameters understood by
97 <citerefentry><refentrytitle>systemd-run-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, to
98 run a command line specified on the kernel command line as system service after booting up.</para>
99 </listitem>
100 </varlistentry>
101
c6885f5f
FB
102 <varlistentry>
103 <term><varname>systemd.early_core_pattern=</varname></term>
104 <listitem>
105 <para>During early boot, the generation of core dump files is disabled until a core dump handler (if any)
106 takes over. This parameter allows to specifies an absolute path where core dump files should be stored until
107 a handler is installed. The path should be absolute and may contain specifiers, see
108 <citerefentry><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para>
109 </listitem>
110 </varlistentry>
111
798d3a52
ZJS
112 <varlistentry>
113 <term><varname>systemd.restore_state=</varname></term>
114 <listitem>
115 <para>This parameter is understood by several system tools
116 to control whether or not they should restore system state
117 from the previous boot. For details, see
118 <citerefentry><refentrytitle>systemd-backlight@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
119 and
af105d03 120 <citerefentry><refentrytitle>systemd-rfkill.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
798d3a52
ZJS
121 </para>
122 </listitem>
123 </varlistentry>
124
91214a37
LP
125 <varlistentry>
126 <term><varname>systemd.volatile=</varname></term>
127 <listitem>
128 <para>This parameter controls whether the system shall boot up in volatile mode. Takes a boolean argument, or
129 the special value <literal>state</literal>. If false (the default), normal boot mode is selected, the root
130 directory and <filename>/var</filename> are mounted as specified on the kernel command line or
131 <filename>/etc/fstab</filename>, or otherwise configured. If true, full state-less boot mode is selected. In
132 this case the root directory is mounted as volatile memory file system (<literal>tmpfs</literal>), and only
133 <filename>/usr</filename> is mounted from the file system configured as root device, in read-only mode. This
134 enables fully state-less boots were the vendor-supplied OS is used as shipped, with only default
135 configuration and no stored state in effect, as <filename>/etc</filename> and <filename>/var</filename> (as
136 well as all other resources shipped in the root file system) are reset at boot and lost on shutdown. If this
13070a70 137 setting is set to <literal>state</literal> the root file system is mounted read-only, however
91214a37 138 <filename>/var</filename> is mounted as a volatile memory file system (<literal>tmpfs</literal>), so that the
13070a70
LP
139 system boots up with the normal configuration applied, but all state reset at boot and lost at shutdown. If
140 this setting is set to <literal>overlay</literal> the root file system is set up as
141 <literal>overlayfs</literal> mount combining the read-only root directory with a writable
142 <literal>tmpfs</literal>, so that no modifications are made to disk, but the file system may be modified
143 nonetheless with all changes being lost at reboot. For details, see
91214a37
LP
144 <citerefentry><refentrytitle>systemd-volatile-root.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
145 and
146 <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
147 </listitem>
148 </varlistentry>
149
798d3a52
ZJS
150 <varlistentry>
151 <term><varname>quiet</varname></term>
152 <listitem>
153 <para>Parameter understood by both the kernel and the system
154 and service manager to control console log verbosity. For
155 details, see
156 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
157 </listitem>
158 </varlistentry>
159
160 <varlistentry>
161 <term><varname>debug</varname></term>
162 <listitem>
163 <para>Parameter understood by both the kernel and the system
164 and service manager to control console log verbosity. For
165 details, see
166 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
167 </listitem>
168 </varlistentry>
169
170 <varlistentry>
171 <term><varname>-b</varname></term>
dcd61450 172 <term><varname>rd.emergency</varname></term>
798d3a52 173 <term><varname>emergency</varname></term>
dcd61450 174 <term><varname>rd.rescue</varname></term>
798d3a52
ZJS
175 <term><varname>rescue</varname></term>
176 <term><varname>single</varname></term>
177 <term><varname>s</varname></term>
178 <term><varname>S</varname></term>
179 <term><varname>1</varname></term>
180 <term><varname>2</varname></term>
181 <term><varname>3</varname></term>
182 <term><varname>4</varname></term>
183 <term><varname>5</varname></term>
184 <listitem>
185 <para>Parameters understood by the system and service
dcd61450 186 manager, as compatibility and convenience options. For details, see
798d3a52
ZJS
187 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
188 </listitem>
189 </varlistentry>
190
191 <varlistentry>
192 <term><varname>locale.LANG=</varname></term>
193 <term><varname>locale.LANGUAGE=</varname></term>
194 <term><varname>locale.LC_CTYPE=</varname></term>
195 <term><varname>locale.LC_NUMERIC=</varname></term>
196 <term><varname>locale.LC_TIME=</varname></term>
197 <term><varname>locale.LC_COLLATE=</varname></term>
198 <term><varname>locale.LC_MONETARY=</varname></term>
199 <term><varname>locale.LC_MESSAGES=</varname></term>
200 <term><varname>locale.LC_PAPER=</varname></term>
201 <term><varname>locale.LC_NAME=</varname></term>
202 <term><varname>locale.LC_ADDRESS=</varname></term>
203 <term><varname>locale.LC_TELEPHONE=</varname></term>
204 <term><varname>locale.LC_MEASUREMENT=</varname></term>
205 <term><varname>locale.LC_IDENTIFICATION=</varname></term>
206 <listitem>
207 <para>Parameters understood by the system and service
208 manager to control locale and language settings. For
209 details, see
210 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
211 </listitem>
212 </varlistentry>
213
214 <varlistentry>
215 <term><varname>fsck.mode=</varname></term>
216 <term><varname>fsck.repair=</varname></term>
217
218 <listitem>
219 <para>Parameters understood by the file system checker
220 services. For details, see
221 <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry>
226 <term><varname>quotacheck.mode=</varname></term>
227
228 <listitem>
229 <para>Parameter understood by the file quota checker
230 service. For details, see
231 <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry>
236 <term><varname>systemd.journald.forward_to_syslog=</varname></term>
237 <term><varname>systemd.journald.forward_to_kmsg=</varname></term>
238 <term><varname>systemd.journald.forward_to_console=</varname></term>
239 <term><varname>systemd.journald.forward_to_wall=</varname></term>
240
241 <listitem>
242 <para>Parameters understood by the journal service. For
243 details, see
244 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry>
249 <term><varname>vconsole.keymap=</varname></term>
72ccee50 250 <term><varname>vconsole.keymap_toggle=</varname></term>
798d3a52 251 <term><varname>vconsole.font=</varname></term>
72ccee50
ZJS
252 <term><varname>vconsole.font_map=</varname></term>
253 <term><varname>vconsole.font_unimap=</varname></term>
798d3a52
ZJS
254
255 <listitem>
72ccee50
ZJS
256 <para>Parameters understood by the virtual console setup logic. For details, see
257 <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
798d3a52
ZJS
258 </listitem>
259 </varlistentry>
260
261 <varlistentry>
1d84ad94
LP
262 <term><varname>udev.log_priority=</varname></term>
263 <term><varname>rd.udev.log_priority=</varname></term>
264 <term><varname>udev.children_max=</varname></term>
265 <term><varname>rd.udev.children_max=</varname></term>
266 <term><varname>udev.exec_delay=</varname></term>
267 <term><varname>rd.udev.exec_delay=</varname></term>
268 <term><varname>udev.event_timeout=</varname></term>
269 <term><varname>rd.udev.event_timeout=</varname></term>
798d3a52 270 <term><varname>net.ifnames=</varname></term>
f7e81fd9 271 <term><varname>net.naming-scheme=</varname></term>
798d3a52
ZJS
272
273 <listitem>
274 <para>Parameters understood by the device event managing
275 daemon. For details, see
276 <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry>
281 <term><varname>plymouth.enable=</varname></term>
282
283 <listitem>
284 <para>May be used to disable the Plymouth boot splash. For
285 details, see
286 <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
287 </listitem>
288 </varlistentry>
289
290 <varlistentry>
291 <term><varname>luks=</varname></term>
292 <term><varname>rd.luks=</varname></term>
293 <term><varname>luks.crypttab=</varname></term>
294 <term><varname>rd.luks.crypttab=</varname></term>
295 <term><varname>luks.name=</varname></term>
296 <term><varname>rd.luks.name=</varname></term>
297 <term><varname>luks.uuid=</varname></term>
298 <term><varname>rd.luks.uuid=</varname></term>
299 <term><varname>luks.options=</varname></term>
300 <term><varname>rd.luks.options=</varname></term>
301 <term><varname>luks.key=</varname></term>
302 <term><varname>rd.luks.key=</varname></term>
303
304 <listitem>
305 <para>Configures the LUKS full-disk encryption logic at
306 boot. For details, see
307 <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry>
312 <term><varname>fstab=</varname></term>
313 <term><varname>rd.fstab=</varname></term>
314
315 <listitem>
316 <para>Configures the <filename>/etc/fstab</filename> logic
317 at boot. For details, see
318 <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry>
323 <term><varname>root=</varname></term>
324 <term><varname>rootfstype=</varname></term>
d6a12e7c 325 <term><varname>rootflags=</varname></term>
798d3a52
ZJS
326 <term><varname>ro</varname></term>
327 <term><varname>rw</varname></term>
328
329 <listitem>
330 <para>Configures the root file system and its file system
331 type and mount options, as well as whether it shall be
17ec531f 332 mounted read-only or read-write initially. For details,
798d3a52
ZJS
333 see
334 <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
335 </listitem>
336 </varlistentry>
337
6dfcea32
TH
338 <varlistentry>
339 <term><varname>mount.usr=</varname></term>
340 <term><varname>mount.usrfstype=</varname></term>
341 <term><varname>mount.usrflags=</varname></term>
342
343 <listitem>
344 <para>Configures the /usr file system (if required) and
345 its file system type and mount options. For details, see
346 <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
347 </listitem>
348 </varlistentry>
349
2f3dfc6f
LP
350 <varlistentry>
351 <term><varname>roothash=</varname></term>
352 <term><varname>systemd.verity=</varname></term>
353 <term><varname>rd.systemd.verity=</varname></term>
354 <term><varname>systemd.verity_root_data=</varname></term>
355 <term><varname>systemd.verity_root_hash=</varname></term>
356 <listitem>
357 <para>Configures the integrity protection root hash for the root file system, and other related
358 parameters. For details, see
359 <citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
360 </listitem>
361 </varlistentry>
362
798d3a52
ZJS
363 <varlistentry>
364 <term><varname>systemd.gpt_auto=</varname></term>
365 <term><varname>rd.systemd.gpt_auto=</varname></term>
366
367 <listitem>
368 <para>Configures whether GPT based partition auto-discovery
369 shall be attempted. For details, see
370 <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
371 </listitem>
372 </varlistentry>
373
959718c6
TB
374 <varlistentry>
375 <term><varname>systemd.default_timeout_start_sec=</varname></term>
376
377 <listitem>
378 <para>Overwrites the default start job timeout <varname>DefaultTimeoutStartSec=</varname> at boot. For details,
379 see <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
c75396c3
EJ
380 </listitem>
381 </varlistentry>
382
383 <varlistentry>
384 <term><varname>systemd.watchdog_device=</varname></term>
385
386 <listitem>
387 <para>Overwrites the watchdog device path <varname>WatchdogDevice=</varname>. For details, see
388 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
959718c6
TB
389 </listitem>
390 </varlistentry>
391
798d3a52 392 <varlistentry>
1d84ad94
LP
393 <term><varname>modules_load=</varname></term>
394 <term><varname>rd.modules_load=</varname></term>
798d3a52
ZJS
395
396 <listitem>
397 <para>Load a specific kernel module early at boot. For
398 details, see
399 <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry>
404 <term><varname>resume=</varname></term>
405
406 <listitem>
407 <para>Enables resume from hibernation using the specified
408 device. All
3ba3a79d 409 <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-like
798d3a52
ZJS
410 paths are supported. For details, see
411 <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
412 </listitem>
413 </varlistentry>
f582cbca
LP
414
415 <varlistentry>
416 <term><varname>systemd.firstboot=</varname></term>
417
418 <listitem><para>Takes a boolean argument, defaults to on. If off,
419 <citerefentry><refentrytitle>systemd-firstboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
420 will not query the user for basic system settings, even if the system boots up for the first time and the
421 relevant settings are not initialized yet.</para></listitem>
422 </varlistentry>
798d3a52
ZJS
423 </variablelist>
424
425 </refsect1>
426
427 <refsect1>
428 <title>See Also</title>
429 <para>
430 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
d1698b82 431 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
798d3a52 432 <citerefentry project='man-pages'><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
af105d03 433 <citerefentry project='man-pages'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
798d3a52
ZJS
434 <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
435 <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
436 <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
437 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
438 <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
439 <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
440 <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
441 <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2f3dfc6f 442 <citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
798d3a52
ZJS
443 <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
444 <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
91214a37 445 <citerefentry><refentrytitle>systemd-volatile-root.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
798d3a52
ZJS
446 <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
447 <citerefentry><refentrytitle>systemd-backlight@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
af105d03 448 <citerefentry><refentrytitle>systemd-rfkill.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
f582cbca
LP
449 <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
450 <citerefentry><refentrytitle>systemd-firstboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
451 </para>
452 </refsect1>
c66e7bc7
LP
453
454</refentry>