chiark / gitweb /
man: fix localectl set-x11-keymap syntax description
[elogind.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 project='man-pages'><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 project='die-net'><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>systemd.mask=</varname></term>
103                                 <term><varname>systemd.wants=</varname></term>
104                                 <term><varname>systemd.debug-shell</varname></term>
105                                 <listitem>
106                                         <para>Additional parameters
107                                         understood by
108                                         <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
109                                         to mask or start specific
110                                         units at boot, or invoke a
111                                         debug shell on tty9.</para>
112                                 </listitem>
113                         </varlistentry>
114
115                         <varlistentry>
116                                 <term><varname>systemd.restore_state=</varname></term>
117                                 <listitem>
118                                         <para>This parameter is understood by
119                                         several system tools to control
120                                         whether or not they should restore
121                                         system state from the previous boot.
122                                         For details, see
123                                         <citerefentry><refentrytitle>systemd-backlight@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
124                                         and
125                                         <citerefentry><refentrytitle>systemd-rfkill@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
126                                         </para>
127                                 </listitem>
128                         </varlistentry>
129
130                         <varlistentry>
131                                 <term><varname>quiet</varname></term>
132                                 <listitem>
133                                         <para>Parameter understood by
134                                         both the kernel and the system
135                                         and service manager to control
136                                         console log verbosity. For
137                                         details, see
138                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
139                                 </listitem>
140                         </varlistentry>
141
142                         <varlistentry>
143                                 <term><varname>debug</varname></term>
144                                 <listitem>
145                                         <para>Parameter understood by
146                                         both the kernel and the system
147                                         and service manager to control
148                                         console log verbosity. For
149                                         details, see
150                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
151                                 </listitem>
152                         </varlistentry>
153
154                         <varlistentry>
155                                 <term><varname>-b</varname></term>
156                                 <term><varname>emergency</varname></term>
157                                 <term><varname>rescue</varname></term>
158                                 <term><varname>single</varname></term>
159                                 <term><varname>s</varname></term>
160                                 <term><varname>S</varname></term>
161                                 <term><varname>1</varname></term>
162                                 <term><varname>2</varname></term>
163                                 <term><varname>3</varname></term>
164                                 <term><varname>4</varname></term>
165                                 <term><varname>5</varname></term>
166                                 <listitem>
167                                         <para>Parameters understood by
168                                         the system and service
169                                         manager, as compatibility
170                                         options. For details, see
171                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
172                                 </listitem>
173                         </varlistentry>
174
175                         <varlistentry>
176                                 <term><varname>locale.LANG=</varname></term>
177                                 <term><varname>locale.LANGUAGE=</varname></term>
178                                 <term><varname>locale.LC_CTYPE=</varname></term>
179                                 <term><varname>locale.LC_NUMERIC=</varname></term>
180                                 <term><varname>locale.LC_TIME=</varname></term>
181                                 <term><varname>locale.LC_COLLATE=</varname></term>
182                                 <term><varname>locale.LC_MONETARY=</varname></term>
183                                 <term><varname>locale.LC_MESSAGES=</varname></term>
184                                 <term><varname>locale.LC_PAPER=</varname></term>
185                                 <term><varname>locale.LC_NAME=</varname></term>
186                                 <term><varname>locale.LC_ADDRESS=</varname></term>
187                                 <term><varname>locale.LC_TELEPHONE=</varname></term>
188                                 <term><varname>locale.LC_MEASUREMENT=</varname></term>
189                                 <term><varname>locale.LC_IDENTIFICATION=</varname></term>
190                                 <listitem>
191                                         <para>Parameters understood by
192                                         the system and service manager
193                                         to control locale and language
194                                         settings. For details, see
195                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
196                                 </listitem>
197                         </varlistentry>
198
199                         <varlistentry>
200                                 <term><varname>fsck.mode=</varname></term>
201                                 <term><varname>fsck.repair=</varname></term>
202
203                                 <listitem>
204                                         <para>Parameters understood by
205                                         the file system checker
206                                         services. For details, see
207                                         <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
208                                 </listitem>
209                         </varlistentry>
210
211                         <varlistentry>
212                                 <term><varname>quotacheck.mode=</varname></term>
213
214                                 <listitem>
215                                         <para>Parameter understood by
216                                         the file quota checker
217                                         service. For details, see
218                                         <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
219                                 </listitem>
220                         </varlistentry>
221
222                         <varlistentry>
223                                 <term><varname>systemd.journald.forward_to_syslog=</varname></term>
224                                 <term><varname>systemd.journald.forward_to_kmsg=</varname></term>
225                                 <term><varname>systemd.journald.forward_to_console=</varname></term>
226                                 <term><varname>systemd.journald.forward_to_wall=</varname></term>
227
228                                 <listitem>
229                                         <para>Parameters understood by
230                                         the journal service. For
231                                         details, see
232                                         <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
233                                 </listitem>
234                         </varlistentry>
235
236                         <varlistentry>
237                                 <term><varname>vconsole.keymap=</varname></term>
238                                 <term><varname>vconsole.keymap.toggle=</varname></term>
239                                 <term><varname>vconsole.font=</varname></term>
240                                 <term><varname>vconsole.font.map=</varname></term>
241                                 <term><varname>vconsole.font.unimap=</varname></term>
242
243                                 <listitem>
244                                         <para>Parameters understood by
245                                         the virtual console setup logic. For
246                                         details, see
247                                         <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
248                                 </listitem>
249                         </varlistentry>
250
251                         <varlistentry>
252                                 <term><varname>udev.log-priority=</varname></term>
253                                 <term><varname>rd.udev.log-priority=</varname></term>
254                                 <term><varname>udev.children-max=</varname></term>
255                                 <term><varname>rd.udev.children-max=</varname></term>
256                                 <term><varname>udev.exec-delay=</varname></term>
257                                 <term><varname>rd.udev.exec-delay=</varname></term>
258                                 <term><varname>net.ifnames=</varname></term>
259
260                                 <listitem>
261                                         <para>Parameters understood by
262                                         the device event managing daemon. For
263                                         details, see
264                                         <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
265                                 </listitem>
266                         </varlistentry>
267
268                         <varlistentry>
269                                 <term><varname>plymouth.enable=</varname></term>
270
271                                 <listitem>
272                                         <para>May be used to disable
273                                         the Plymouth boot splash. For
274                                         details, see
275                                         <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
276                                 </listitem>
277                         </varlistentry>
278
279                         <varlistentry>
280                                 <term><varname>luks=</varname></term>
281                                 <term><varname>rd.luks=</varname></term>
282                                 <term><varname>luks.crypttab=</varname></term>
283                                 <term><varname>rd.luks.crypttab=</varname></term>
284                                 <term><varname>luks.uuid=</varname></term>
285                                 <term><varname>rd.luks.uuid=</varname></term>
286                                 <term><varname>luks.options=</varname></term>
287                                 <term><varname>rd.luks.options=</varname></term>
288                                 <term><varname>luks.key=</varname></term>
289                                 <term><varname>rd.luks.key=</varname></term>
290
291                                 <listitem>
292                                         <para>Configures the LUKS
293                                         full-disk encryption logic at
294                                         boot. For details, see
295                                         <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
296                                 </listitem>
297                         </varlistentry>
298
299                         <varlistentry>
300                                 <term><varname>fstab=</varname></term>
301                                 <term><varname>rd.fstab=</varname></term>
302
303                                 <listitem>
304                                         <para>Configures the
305                                         <filename>/etc/fstab</filename>
306                                         logic at boot. For details, see
307                                         <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
308                                 </listitem>
309                         </varlistentry>
310
311                         <varlistentry>
312                                 <term><varname>root=</varname></term>
313                                 <term><varname>rootfstype=</varname></term>
314                                 <term><varname>rootfsflags=</varname></term>
315                                 <term><varname>ro</varname></term>
316                                 <term><varname>rw</varname></term>
317
318                                 <listitem>
319                                         <para>Configures the root file
320                                         system and its file system
321                                         type and mount options, as
322                                         well as whether it shall be
323                                         mounted read-only or
324                                         read-writable initially. For
325                                         details, see
326                                         <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
327                                 </listitem>
328                         </varlistentry>
329
330                         <varlistentry>
331                                 <term><varname>systemd.gpt_auto=</varname></term>
332                                 <term><varname>rd.systemd.gpt_auto=</varname></term>
333
334                                 <listitem>
335                                         <para>Configures whether GPT
336                                         based partition auto-discovery
337                                         shall be attempted. For
338                                         details, see
339                                         <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
340                                 </listitem>
341                         </varlistentry>
342
343                         <varlistentry>
344                                 <term><varname>modules-load=</varname></term>
345                                 <term><varname>rd.modules-load=</varname></term>
346
347                                 <listitem>
348                                         <para>Load a specific kernel
349                                         module early at boot. For
350                                         details, see
351                                         <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
352                                 </listitem>
353                         </varlistentry>
354
355                         <varlistentry>
356                                 <term><varname>resume=</varname></term>
357
358                                 <listitem>
359                                         <para>Enables resume from hibernation
360                                         using the specified device.
361                                         All <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-like
362                                         paths are supported. For details, see
363                                         <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
364                                 </listitem>
365                         </varlistentry>
366                 </variablelist>
367
368         </refsect1>
369
370         <refsect1>
371                   <title>See Also</title>
372                   <para>
373                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
374                           <citerefentry project='man-pages'><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
375                           <citerefentry project='die-net'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
376                           <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
377                           <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
378                           <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
379                           <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
380                           <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
381                           <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
382                           <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
383                           <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
384                           <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
385                           <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
386                           <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
387                           <citerefentry><refentrytitle>systemd-backlight@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
388                           <citerefentry><refentrytitle>systemd-rfkill@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
389                           <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
390                   </para>
391         </refsect1>
392
393 </refentry>