Blame view

Documentation/admin-guide/kernel-parameters.rst 8.07 KB
9b9355a26   Andrew Clayton   docs: process/4.C...
1
  .. _kernelparameters:
7358bb2f3   Jonathan Corbet   docs: Clean up an...
2
3
  The kernel's command-line parameters
  ====================================
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
4

5888bcc5d   Rusty Russell   Documentation: Up...
5
6
7
8
9
  The following is a consolidated list of the kernel parameters as
  implemented by the __setup(), core_param() and module_param() macros
  and sorted into English Dictionary order (defined as ignoring all
  punctuation and sorting digits before letters in a case insensitive
  manner), and with descriptions where known.
62ee81b56   Stephen Kitt   docs: format kern...
10
  The kernel parses parameters from the kernel command line up to "``--``";
5888bcc5d   Rusty Russell   Documentation: Up...
11
12
13
  if it doesn't recognize a parameter and it doesn't contain a '.', the
  parameter gets passed to init: parameters with '=' go into init's
  environment, others are passed as command line arguments to init.
62ee81b56   Stephen Kitt   docs: format kern...
14
  Everything after "``--``" is passed as an argument to init.
5888bcc5d   Rusty Russell   Documentation: Up...
15
16
  
  Module parameters can be specified in two ways: via the kernel command
684adc0aa   Mauro Carvalho Chehab   Documentation/ker...
17
  line with a module name prefix, or via modprobe, e.g.::
5888bcc5d   Rusty Russell   Documentation: Up...
18
19
20
21
22
23
24
25
26
  
  	(kernel command line) usbcore.blinkenlights=1
  	(modprobe command line) modprobe usbcore blinkenlights=1
  
  Parameters for modules which are built into the kernel need to be
  specified on the kernel command line.  modprobe looks through the
  kernel command line (/proc/cmdline) and collects module parameters
  when it loads a module, so the kernel command line can be used for
  loadable modules too.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
27

684adc0aa   Mauro Carvalho Chehab   Documentation/ker...
28
  Hyphens (dashes) and underscores are equivalent in parameter names, so::
ca1eda2d7   Randy Dunlap   doc: small kernel...
29
  	log_buf_len=1M print-fatal-signals=1
684adc0aa   Mauro Carvalho Chehab   Documentation/ker...
30
31
  
  can also be entered as::
ca1eda2d7   Randy Dunlap   doc: small kernel...
32
  	log-buf-len=1M print_fatal_signals=1
684adc0aa   Mauro Carvalho Chehab   Documentation/ker...
33
  Double-quotes can be used to protect spaces in values, e.g.::
5888bcc5d   Rusty Russell   Documentation: Up...
34
  	param="spaces in here"
ca1eda2d7   Randy Dunlap   doc: small kernel...
35

2d13e6ca4   Noam Camus   lib/bitmap.c: enh...
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
  cpu lists:
  ----------
  
  Some kernel parameters take a list of CPUs as a value, e.g.  isolcpus,
  nohz_full, irqaffinity, rcu_nocbs.  The format of this list is:
  
  	<cpu number>,...,<cpu number>
  
  or
  
  	<cpu number>-<cpu number>
  	(must be a positive range in ascending order)
  
  or a mixture
  
  <cpu number>,...,<cpu number>-<cpu number>
  
  Note that for the special case of a range one can split the range into equal
  sized groups and for each group use some amount from the beginning of that
  group:
  
  	<cpu number>-cpu number>:<used size>/<group size>
  
  For example one can add to the command line following parameter:
  
  	isolcpus=1,2,10-20,100-2000:2/25
  
  where the final item represents CPUs 100,101,125,126,150,151,...
a901ebb90   Stefan Richter   Doc/kernel-parame...
64
65
66
67
68
  This document may not be entirely up to date and comprehensive. The command
  "modinfo -p ${modulename}" shows a current list of all parameters of a loadable
  module. Loadable modules, after being loaded into the running kernel, also
  reveal their parameters in /sys/module/${modulename}/parameters/. Some of these
  parameters may be changed at runtime by the command
684adc0aa   Mauro Carvalho Chehab   Documentation/ker...
69
  ``echo -n ${value} > /sys/module/${modulename}/parameters/${parm}``.
a901ebb90   Stefan Richter   Doc/kernel-parame...
70

6585fa8aa   Stefan Richter   Doc/kernel-parame...
71
72
73
  The parameters listed below are only valid if certain kernel build options were
  enabled and if respective hardware is present. The text in square brackets at
  the beginning of each description states the restrictions within which a
684adc0aa   Mauro Carvalho Chehab   Documentation/ker...
74
  parameter is applicable::
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
75
76
  
  	ACPI	ACPI support is enabled.
c99c108ac   Chuck Ebbert   AGP: document boo...
77
  	AGP	AGP (Accelerated Graphics Port) is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
78
79
80
  	ALSA	ALSA sound support is enabled.
  	APIC	APIC support is enabled.
  	APM	Advanced Power Management support is enabled.
162902466   Randy Dunlap   Documentation: ke...
81
  	ARM	ARM architecture is enabled.
4ad499c94   Josh Poimboeuf   Documentation: Ad...
82
  	ARM64	ARM64 architecture is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
83
  	AX25	Appropriate AX.25 support is enabled.
1e435256d   Olof Johansson   clk: add clk_igno...
84
  	CLK	Common clock infrastructure is enabled.
5c71d6181   Robert Tivy   ARM: davinci: da8...
85
  	CMA	Contiguous Memory Area support is enabled.
9cfe268ec   Alan Cox   Documentation: Fi...
86
87
  	DRM	Direct Rendering Management support is enabled.
  	DYNAMIC_DEBUG Build in debug messages and enable them at runtime
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
88
89
90
  	EDD	BIOS Enhanced Disk Drive Services (EDD) is enabled
  	EFI	EFI Partitioning (GPT) is enabled
  	EIDE	EIDE/ATAPI support is enabled.
7102ebcd6   Mimi Zohar   evm: permit only ...
91
  	EVM	Extended Verification Module
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
92
  	FB	The frame buffer device is enabled.
162902466   Randy Dunlap   Documentation: ke...
93
  	FTRACE	Function tracing enabled.
2521f2c22   Peter Oberparleiter   gcov: add gcov pr...
94
  	GCOV	GCOV profiling is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
95
  	HW	Appropriate hardware is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
96
  	IA-64	IA-64 architecture is enabled.
6146f0d5e   Mimi Zohar   integrity: IMA hooks
97
  	IMA     Integrity measurement architecture is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
98
  	IOSCHED	More than one I/O scheduler is enabled.
41e2e8bec   Adrian Bunk   [PATCH] Documenta...
99
  	IP_PNP	IP DHCP, BOOTP, or RARP is enabled.
b0f83b280   Brian Haley   doc: document IPv...
100
  	IPV6	IPv6 support is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
101
102
  	ISAPNP	ISA PnP code is enabled.
  	ISDN	Appropriate ISDN support is enabled.
d94d10532   Frederic Weisbecker   sched/isolation: ...
103
  	ISOL	CPU Isolation is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
104
  	JOY	Appropriate joystick support is enabled.
84c08fd61   Jason Wessel   kgdb,docs: Update...
105
  	KGDB	Kernel debugger support is enabled.
fef07aae9   Andre Przywara   KVM: add module p...
106
  	KVM	Kernel Virtual Machine support is enabled.
11ef697b3   Kristen Carlson Accardi   [PATCH] libata: A...
107
  	LIBATA  Libata driver is enabled
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
108
109
110
111
  	LP	Printer support is enabled.
  	LOOP	Loopback device support is enabled.
  	M68k	M68k architecture is enabled.
  			These options have more detailed description inside of
23e024228   Mauro Carvalho Chehab   docs: m68k: conve...
112
  			Documentation/m68k/kernel-options.rst.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
113
  	MDA	MDA console support is enabled.
162902466   Randy Dunlap   Documentation: ke...
114
  	MIPS	MIPS architecture is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
115
  	MOUSE	Appropriate mouse support is enabled.
309e57df7   Matthew Wilcox   [PATCH] PCI: Prov...
116
  	MSI	Message Signaled Interrupts (PCI).
c8facbb62   Randy Dunlap   various doc/kerne...
117
  	MTD	MTD (Memory Technology Device) support is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
118
119
120
  	NET	Appropriate network support is enabled.
  	NUMA	NUMA support is enabled.
  	NFS	Appropriate NFS support is enabled.
6c0a7d6c5   Saravana Kannan   FROMGIT: of: prop...
121
  	OF	Devicetree is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
122
  	OSS	OSS sound support is enabled.
c8facbb62   Randy Dunlap   various doc/kerne...
123
124
  	PV_OPS	A paravirtualized kernel is enabled.
  	PARIDE	The ParIDE (parallel port IDE) subsystem is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
125
126
  	PARISC	The PA-RISC architecture is enabled.
  	PCI	PCI bus support is enabled.
7f7857636   Randy Dunlap   pci: implement "p...
127
  	PCIE	PCI Express support is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
128
129
130
131
132
133
  	PCMCIA	The PCMCIA subsystem is enabled.
  	PNP	Plug & Play support is enabled.
  	PPC	PowerPC architecture is enabled.
  	PPT	Parallel port support is enabled.
  	PS2	Appropriate PS/2 support is enabled.
  	RAM	RAM disk support is enabled.
1d9807fc6   Tony Luck   x86/intel_rdt: Ad...
134
  	RDT	Intel Resource Director Technology.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
135
136
  	S390	S390 architecture is enabled.
  	SCSI	Appropriate SCSI support is enabled.
163475fb1   Randy Dunlap   Documentation: mo...
137
138
  			A lot of drivers have their options described inside
  			the Documentation/scsi/ sub-directory.
20510f2f4   James Morris   security: Convert...
139
  	SECURITY Different security models are enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
140
  	SELINUX SELinux support is enabled.
c1c124e91   John Johansen   AppArmor: update ...
141
  	APPARMOR AppArmor support is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
142
  	SERIAL	Serial support is enabled.
e523d93c8   Paul Mundt   doc: Add SH to vd...
143
  	SH	SuperH architecture is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
144
145
  	SMP	The kernel is an SMP kernel.
  	SPARC	Sparc architecture is enabled.
77437fd4e   David Brownell   pm: boot time sus...
146
147
  	SWSUSP	Software suspend (hibernation) is enabled.
  	SUSPEND	System suspend states are enabled.
225a9be24   Rajiv Andrade   TPM: workaround t...
148
  	TPM	TPM drivers are enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
149
  	TS	Appropriate touchscreen support is enabled.
d4f373e57   Alan Stern   USB: usb-storage:...
150
  	UMS	USB Mass Storage support is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
151
152
153
  	USB	USB support is enabled.
  	USBHID	USB Human Interface Device support is enabled.
  	V4L	Video For Linux support is enabled.
81a054ce0   Pawel Moll   virtio-mmio: Devi...
154
  	VMMIO   Driver for memory mapped virtio devices is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
155
156
157
158
  	VGA	The VGA console has been enabled.
  	VT	Virtual terminal support is enabled.
  	WDT	Watchdog support is enabled.
  	XT	IBM PC/XT MFM hard disk support is enabled.
cd4f0ef7c   Alan Cox   doc/kernel-parame...
159
  	X86-32	X86-32, aka i386 architecture is enabled.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
160
161
  	X86-64	X86-64 architecture is enabled.
  			More X86-64 boot options can be found in
cb1aaebea   Mauro Carvalho Chehab   docs: fix broken ...
162
  			Documentation/x86/x86_64/boot-options.rst.
162902466   Randy Dunlap   Documentation: ke...
163
  	X86	Either 32-bit or 64-bit x86 (same as X86-32+X86-64)
1c532e00a   Alex Thorlton   x86/platform/uv: ...
164
  	X86_UV	SGI UV support is enabled.
c1c5413ad   Stefano Stabellini   x86: Unplug emula...
165
  	XEN	Xen support is enabled
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
166

684adc0aa   Mauro Carvalho Chehab   Documentation/ker...
167
  In addition, the following text indicates that the option::
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
168
169
170
171
172
173
174
175
  
  	BUGS=	Relates to possible processor bugs on the said processor.
  	KNL	Is a kernel start-up parameter.
  	BOOT	Is a boot loader parameter.
  
  Parameters denoted with BOOT are actually interpreted by the boot
  loader, and have no meaning to the kernel directly.
  Do not modify the syntax of boot loader parameters without extreme
cb1aaebea   Mauro Carvalho Chehab   docs: fix broken ...
176
  need or coordination with <Documentation/x86/boot.rst>.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
177

5558870bf   Karsten Weiss   [PATCH] x86-64: i...
178
  There are also arch-specific kernel-parameters not documented here.
cb1aaebea   Mauro Carvalho Chehab   docs: fix broken ...
179
  See for example <Documentation/x86/x86_64/boot-options.rst>.
5558870bf   Karsten Weiss   [PATCH] x86-64: i...
180

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
181
182
183
184
185
  Note that ALL kernel parameters listed below are CASE SENSITIVE, and that
  a trailing = on the name of any parameter states that that parameter will
  be entered as an environment variable, whereas its absence indicates that
  it will appear as a kernel argument readable via /proc/cmdline by programs
  running once the system is up.
9c4751fd0   jens m. noedler   [PATCH] update Do...
186
187
188
189
190
  The number of kernel parameters is not limited, but the length of the
  complete command line (parameters including spaces etc.) is limited to
  a fixed number of characters. This limit depends on the architecture
  and is between 256 and 4096 characters. It is defined in the file
  ./include/asm/setup.h as COMMAND_LINE_SIZE.
7a19a237d   Ahmed S. Darwish   Documentation: ex...
191
192
  Finally, the [KMG] suffix is commonly described after a number of kernel
  parameter values. These 'K', 'M', and 'G' letters represent the _binary_
9f02a486d   Tamara Diaconita   Documentation: ad...
193
  multipliers 'Kilo', 'Mega', and 'Giga', equaling 2^10, 2^20, and 2^30
e52347bd6   Jani Nikula   Documentation/adm...
194
  bytes respectively. Such letter suffixes can also be entirely omitted:
7a19a237d   Ahmed S. Darwish   Documentation: ex...
195

e52347bd6   Jani Nikula   Documentation/adm...
196
197
  .. include:: kernel-parameters.txt
     :literal:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
198

684adc0aa   Mauro Carvalho Chehab   Documentation/ker...
199
200
  Todo
  ----
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
201

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
202
  	Add more DRM drivers.