chiark / gitweb /
cryptsetup: allow configuration of LUKS disks via the kernel cmdline
[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>.</para>
64
65                 <para>For command line paramaters understood by the
66                 initial RAM disk, please see
67                 <citerefentry><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
68
69         </refsect1>
70
71         <refsect1>
72                 <title>Core OS Command Line Arguments</title>
73
74                 <variablelist>
75                         <varlistentry>
76                                 <term><varname>systemd.unit=</varname></term>
77                                 <term><varname>rd.systemd.unit=</varname></term>
78                                 <term><varname>systemd.dump_core=</varname></term>
79                                 <term><varname>systemd.crash_shell=</varname></term>
80                                 <term><varname>systemd.crash_chvt=</varname></term>
81                                 <term><varname>systemd.confirm_spawn=</varname></term>
82                                 <term><varname>systemd.show_status=</varname></term>
83                                 <term><varname>systemd.sysv_console=</varname></term>
84                                 <term><varname>systemd.log_target=</varname></term>
85                                 <term><varname>systemd.log_level=</varname></term>
86                                 <term><varname>systemd.log_color=</varname></term>
87                                 <term><varname>systemd.log_location=</varname></term>
88                                 <term><varname>systemd.default_standard_output=</varname></term>
89                                 <term><varname>systemd.default_standard_error=</varname></term>
90                                 <term><varname>systemd.setenv=</varname></term>
91                                 <listitem>
92                                         <para>Parameters understood by
93                                         the system and service manager
94                                         to control system behaviour. For details see
95                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
96                                 </listitem>
97                         </varlistentry>
98
99                         <varlistentry>
100                                 <term><varname>quiet</varname></term>
101                                 <listitem>
102                                         <para>Parameter understood by
103                                         both the kernel and the system
104                                         and service manager to control
105                                         console log verbosity. For
106                                         details see
107                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
108                                 </listitem>
109                         </varlistentry>
110
111                         <varlistentry>
112                                 <term><varname>emergency</varname></term>
113                                 <term><varname>single</varname></term>
114                                 <term><varname>s</varname></term>
115                                 <term><varname>S</varname></term>
116                                 <term><varname>1</varname></term>
117                                 <term><varname>2</varname></term>
118                                 <term><varname>3</varname></term>
119                                 <term><varname>4</varname></term>
120                                 <term><varname>5</varname></term>
121                                 <listitem>
122                                         <para>Parameters understood by
123                                         the system and service
124                                         manager, as compatibility
125                                         options. For details see
126                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
127                                 </listitem>
128                         </varlistentry>
129
130                         <varlistentry>
131                                 <term><varname>locale.LANG=</varname></term>
132                                 <term><varname>locale.LANGUAGE=</varname></term>
133                                 <term><varname>locale.LC_CTYPE=</varname></term>
134                                 <term><varname>locale.LC_NUMERIC=</varname></term>
135                                 <term><varname>locale.LC_TIME=</varname></term>
136                                 <term><varname>locale.LC_COLLATE=</varname></term>
137                                 <term><varname>locale.LC_MONETARY=</varname></term>
138                                 <term><varname>locale.LC_MESSAGES=</varname></term>
139                                 <term><varname>locale.LC_PAPER=</varname></term>
140                                 <term><varname>locale.LC_NAME=</varname></term>
141                                 <term><varname>locale.LC_ADDRESS=</varname></term>
142                                 <term><varname>locale.LC_TELEPHONE=</varname></term>
143                                 <term><varname>locale.LC_MEASUREMENT=</varname></term>
144                                 <term><varname>locale.LC_IDENTIFICATION=</varname></term>
145                                 <listitem>
146                                         <para>Parameters understood by
147                                         the system and service manager
148                                         to control locale and language
149                                         settings. For details see
150                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
151                                 </listitem>
152                         </varlistentry>
153
154                         <varlistentry>
155                                 <term><varname>fsck.mode=</varname></term>
156
157                                 <listitem>
158                                         <para>Parameter understood by
159                                         the file system checker
160                                         services. For details see
161                                         <citerefentry><refentrytitle>fsck-root.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
162                                 </listitem>
163                         </varlistentry>
164
165                         <varlistentry>
166                                 <term><varname>quotacheck.mode=</varname></term>
167
168                                 <listitem>
169                                         <para>Parameter understood by
170                                         the file quota checker
171                                         service. For details see
172                                         <citerefentry><refentrytitle>quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
173                                 </listitem>
174                         </varlistentry>
175
176                         <varlistentry>
177                                 <term><varname>systemd.journald.forward_to_syslog=</varname></term>
178                                 <term><varname>systemd.journald.forward_to_kmsg=</varname></term>
179                                 <term><varname>systemd.journald.forward_to_console=</varname></term>
180
181                                 <listitem>
182                                         <para>Parameters understood by
183                                         the journal service. For
184                                         details see
185                                         <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
186                                 </listitem>
187                         </varlistentry>
188
189                         <varlistentry>
190                                 <term><varname>vconsole.keymap=</varname></term>
191                                 <term><varname>vconsole.keymap.toggle=</varname></term>
192                                 <term><varname>vconsole.font=</varname></term>
193                                 <term><varname>vconsole.font.map=</varname></term>
194                                 <term><varname>vconsole.font.unimap=</varname></term>
195
196                                 <listitem>
197                                         <para>Parameters understood by
198                                         the virtual console setup logic. For
199                                         details see
200                                         <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
201                                 </listitem>
202                         </varlistentry>
203
204                         <varlistentry>
205                                 <term><varname>udev.log-priority=</varname></term>
206                                 <term><varname>rd.udev.log-priority=</varname></term>
207                                 <term><varname>udev.children-max=</varname></term>
208                                 <term><varname>rd.udev.children-max=</varname></term>
209                                 <term><varname>udev.udev.exec-delay=</varname></term>
210                                 <term><varname>rd.udev.udev.exec-delay=</varname></term>
211
212                                 <listitem>
213                                         <para>Parameters understood by
214                                         the device event managing daemon. For
215                                         details see
216                                         <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
217                                 </listitem>
218                         </varlistentry>
219
220                         <varlistentry>
221                                 <term><varname>plymouth.enable=</varname></term>
222
223                                 <listitem>
224                                         <para>May be used to disable
225                                         the Plymouth boot splash. For
226                                         details see
227                                         <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
228                                 </listitem>
229                         </varlistentry>
230
231                         <varlistentry>
232                                 <term><varname>luks=</varname></term>
233                                 <term><varname>rd.luks=</varname></term>
234                                 <term><varname>luks.crypttab=</varname></term>
235                                 <term><varname>rd.luks.crypttab=</varname></term>
236                                 <term><varname>luks.uuid=</varname></term>
237                                 <term><varname>rd.luks.uuid=</varname></term>
238
239                                 <listitem>
240                                         <para>Configures the LUKS
241                                         full-disk encryption logic at
242                                         boot. For details see
243                                         <citerefentry><refentrytitle>cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
244                                 </listitem>
245                         </varlistentry>
246
247                 </variablelist>
248
249         </refsect1>
250
251         <refsect1>
252                   <title>See Also</title>
253                   <para>
254                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
255                           <citerefentry><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
256                           <citerefentry><refentrytitle>fsck-root.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
257                           <citerefentry><refentrytitle>quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
258                           <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
259                           <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
260                           <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
261                   </para>
262         </refsect1>
263
264 </refentry>