Debian Codegraph @

upstream/fedora-44/man7/bootparam.7

raw
1 .\" Copyright (c) 1995,1997 Paul Gortmaker and Andries Brouwer
2 .\"
3 .\" SPDX-License-Identifier: GPL-2.0-or-later
4 .\"
5 .\" This man page written 950814 by aeb, based on Paul Gortmaker's HOWTO
6 .\" (dated v1.0.1, 15/08/95).
7 .\" Major update, aeb, 970114.
8 .\"
9 .TH bootparam 7 2024-06-28 "Linux man-pages 6.13"
10 .SH NAME
11 bootparam \- introduction to boot time parameters of the Linux kernel
12 .SH DESCRIPTION
13 The Linux kernel accepts certain 'command-line options' or 'boot time
14 parameters' at the moment it is started.
15 In general, this is used to
16 supply the kernel with information about hardware parameters that
17 the kernel would not be able to determine on its own, or to avoid/override
18 the values that the kernel would otherwise detect.
19 .P
20 When the kernel is booted directly by the BIOS,
21 you have no opportunity to specify any parameters.
22 So, in order to take advantage of this possibility you have to
23 use a boot loader that is able to pass parameters, such as GRUB.
24 .SS The argument list
25 The kernel command line is parsed into a list of strings
26 (boot arguments) separated by spaces.
27 Most of the boot arguments have the form:
28 .P
29 .in +4n
30 .EX
31 name[=value_1][,value_2]...[,value_10]
32 .EE
33 .in
34 .P
35 where 'name' is a unique keyword that is used to identify what part of
36 the kernel the associated values (if any) are to be given to.
37 Note the limit of 10 is real, as the present code handles only 10 comma
38 separated parameters per keyword.
39 (However, you can reuse the same
40 keyword with up to an additional 10 parameters in unusually
41 complicated situations, assuming the setup function supports it.)
42 .P
43 Most of the sorting is coded in the kernel source file
44 .IR init/main.c .
45 First, the kernel
46 checks to see if the argument is any of the special arguments 'root=',
47 \&'nfsroot=', 'nfsaddrs=', 'ro', 'rw', 'debug', or 'init'.
48 The meaning of these special arguments is described below.
49 .P
50 Then it walks a list of setup functions
51 to see if the specified argument string (such as 'foo') has
52 been associated with a setup function ('foo_setup()') for a particular
53 device or part of the kernel.
54 If you passed the kernel the line
55 foo=3,4,5,6 then the kernel would search the bootsetups array to see
56 if 'foo' was registered.
57 If it was, then it would call the setup
58 function associated with 'foo' (foo_setup()) and hand it the arguments
59 3, 4, 5, and 6 as given on the kernel command line.
60 .P
61 Anything of the form 'foo=bar' that is not accepted as a setup function
62 as described above is then interpreted as an environment variable to
63 be set.
64 A (useless?) example would be to use 'TERM=vt100' as a boot
65 argument.
66 .P
67 Any remaining arguments that were not picked up by the kernel and were
68 not interpreted as environment variables are then passed onto PID 1,
69 which is usually the
70 .BR init (1)
71 program.
72 The most common argument that
73 is passed to the
74 .I init
75 process is the word 'single' which instructs it
76 to boot the computer in single user mode, and not launch all the usual
77 daemons.
78 Check the manual page for the version of
79 .BR init (1)
80 installed on
81 your system to see what arguments it accepts.
82 .SS General non-device-specific boot arguments
83 .TP
84 .B "'init=...'"
85 This sets the initial command to be executed by the kernel.
86 If this is not set, or cannot be found, the kernel will try
87 .IR /sbin/init ,
88 then
89 .IR /etc/init ,
90 then
91 .IR /bin/init ,
92 then
93 .I /bin/sh
94 and panic if all of this fails.
95 .TP
96 .B "'nfsaddrs=...'"
97 This sets the NFS boot address to the given string.
98 This boot address is used in case of a net boot.
99 .TP
100 .B "'nfsroot=...'"
101 This sets the NFS root name to the given string.
102 If this string
103 does not begin with '/' or ',' or a digit, then it is prefixed by
104 \&'/tftpboot/'.
105 This root name is used in case of a net boot.
106 .TP
107 .B "'root=...'"
108 This argument tells the kernel what device is to be used as the root
109 filesystem while booting.
110 The default of this setting is determined
111 at compile time, and usually is the value of the root device of the
112 system that the kernel was built on.
113 To override this value, and
114 select the second floppy drive as the root device, one would
115 use 'root=/dev/fd1'.
116 .IP
117 The root device can be specified symbolically or numerically.
118 A symbolic specification has the form
119 .IR /dev/XXYN ,
120 where XX designates
121 the device type (e.g., 'hd' for ST-506 compatible hard disk, with Y in
122 \&'a'\[en]'d'; 'sd' for SCSI compatible disk, with Y in 'a'\[en]'e'),
123 Y the driver letter or
124 number, and N the number (in decimal) of the partition on this device.
125 .IP
126 Note that this has nothing to do with the designation of these
127 devices on your filesystem.
128 The '/dev/' part is purely conventional.
129 .IP
130 The more awkward and less portable numeric specification of the above
131 possible root devices in major/minor format is also accepted.
132 (For example,
133 .I /dev/sda3
134 is major 8, minor 3, so you could use 'root=0x803' as an
135 alternative.)
136 .TP
137 .B 'rootdelay='
138 This parameter sets the delay (in seconds) to pause before attempting
139 to mount the root filesystem.
140 .TP
141 .B 'rootflags=...'
142 This parameter sets the mount option string for the root filesystem
143 (see also
144 .BR fstab (5)).
145 .TP
146 .B 'rootfstype=...'
147 The 'rootfstype' option tells the kernel to mount the root filesystem as
148 if it where of the type specified.
149 This can be useful (for example) to
150 mount an ext3 filesystem as ext2 and then remove the journal in the root
151 filesystem, in fact reverting its format from ext3 to ext2 without the
152 need to boot the box from alternate media.
153 .TP
154 .B 'ro'
155 .TQ
156 .B 'rw'
157 The 'ro' option tells the kernel to mount the root filesystem
158 as 'read-only' so that filesystem consistency check programs (fsck)
159 can do their work on a quiescent filesystem.
160 No processes can
161 write to files on the filesystem in question until it is 'remounted'
162 as read/write capable, for example, by 'mount \-w \-n \-o remount /'.
163 (See also
164 .BR mount (8).)
165 .IP
166 The 'rw' option tells the kernel to mount the root filesystem read/write.
167 This is the default.
168 .TP
169 .B "'resume=...'"
170 This tells the kernel the location of
171 the suspend-to-disk data that you want the machine to resume from
172 after hibernation.
173 Usually, it is the same as your swap partition or file.
174 Example:
175 .IP
176 .in +4n
177 .EX
178 resume=/dev/hda2
179 .EE
180 .in
181 .TP
182 .B "'reserve=...'"
183 This is used to protect I/O port regions from probes.
184 The form of the command is:
185 .IP
186 .in +4n
187 .EX
188 .BI reserve= iobase,extent[,iobase,extent]...
189 .EE
190 .in
191 .IP
192 In some machines it may be necessary to prevent device drivers from
193 checking for devices (auto-probing) in a specific region.
194 This may be
195 because of hardware that reacts badly to the probing, or hardware
196 that would be mistakenly identified, or merely
197 hardware you don't want the kernel to initialize.
198 .IP
199 The reserve boot-time argument specifies an I/O port region that
200 shouldn't be probed.
201 A device driver will not probe a reserved region,
202 unless another boot argument explicitly specifies that it do so.
203 .IP
204 For example, the boot line
205 .IP
206 .in +4n
207 .EX
208 reserve=0x300,32 blah=0x300
209 .EE
210 .in
211 .IP
212 keeps all device drivers except the driver for 'blah' from probing
213 0x300\-0x31f.
214 .TP
215 .B "'panic=N'"
216 By default, the kernel will not reboot after a panic, but this option
217 will cause a kernel reboot after N seconds (if N is greater than zero).
218 This panic timeout can also be set by
219 .IP
220 .in +4n
221 .EX
222 echo N > /proc/sys/kernel/panic
223 .EE
224 .in
225 .TP
226 .B "'reboot=[warm|cold][,[bios|hard]]'"
227 Since Linux 2.0.22, a reboot is by default a cold reboot.
228 One asks for the old default with 'reboot=warm'.
229 (A cold reboot may be required to reset certain hardware,
230 but might destroy not yet written data in a disk cache.
231 A warm reboot may be faster.)
232 By default, a reboot is hard, by asking the keyboard controller
233 to pulse the reset line low, but there is at least one type
234 of motherboard where that doesn't work.
235 The option 'reboot=bios' will
236 instead jump through the BIOS.
237 .TP
238 .B 'nosmp'
239 .TQ
240 .B 'maxcpus=N'
241 (Only when __SMP__ is defined.)
242 A command-line option of 'nosmp' or 'maxcpus=0' will disable SMP
243 activation entirely; an option 'maxcpus=N' limits the maximum number
244 of CPUs activated in SMP mode to N.
245 .SS Boot arguments for use by kernel developers
246 .TP
247 .B "'debug'"
248 Kernel messages are handed off to a daemon (e.g.,
249 .BR klogd (8)
250 or similar) so that they may be logged to disk.
251 Messages with a priority above
252 .I console_loglevel
253 are also printed on the console.
254 (For a discussion of log levels, see
255 .BR syslog (2).)
256 By default,
257 .I console_loglevel
258 is set to log messages at levels higher than
259 .BR KERN_DEBUG .
260 This boot argument will cause the kernel to also
261 print messages logged at level
262 .BR KERN_DEBUG .
263 The console loglevel can also be set on a booted system via the
264 .I /proc/sys/kernel/printk
265 file (described in
266 .BR syslog (2)),
267 the
268 .BR syslog (2)
269 .B SYSLOG_ACTION_CONSOLE_LEVEL
270 operation, or
271 .BR dmesg (8).
272 .TP
273 .B "'profile=N'"
274 It is possible to enable a kernel profiling function,
275 if one wishes to find out where the kernel is spending its CPU cycles.
276 Profiling is enabled by setting the variable
277 .I prof_shift
278 to a nonzero value.
279 This is done either by specifying
280 .B CONFIG_PROFILE
281 at compile time, or by giving the 'profile=' option.
282 Now the value that
283 .I prof_shift
284 gets will be N, when given, or
285 .BR CONFIG_PROFILE_SHIFT ,
286 when that is given, or 2, the default.
287 The significance of this variable is that it
288 gives the granularity of the profiling: each clock tick, if the
289 system was executing kernel code, a counter is incremented:
290 .IP
291 .in +4n
292 .EX
293 profile[address >> prof_shift]++;
294 .EE
295 .in
296 .IP
297 The raw profiling information can be read from
298 .IR /proc/profile .
299 Probably you'll want to use a tool such as readprofile.c to digest it.
300 Writing to
301 .I /proc/profile
302 will clear the counters.
303 .SS Boot arguments for ramdisk use
304 (Only if the kernel was compiled with
305 .BR CONFIG_BLK_DEV_RAM .)
306 In general it is a bad idea to use a ramdisk under Linux\[em]the
307 system will use available memory more efficiently itself.
308 But while booting,
309 it is often useful to load the floppy contents into a
310 ramdisk.
311 One might also have a system in which first
312 some modules (for filesystem or hardware) must be loaded
313 before the main disk can be accessed.
314 .IP
315 In Linux 1.3.48, ramdisk handling was changed drastically.
316 Earlier, the memory was allocated statically, and there was
317 a 'ramdisk=N' parameter to tell its size.
318 (This could also be set in the kernel image at compile time.)
319 These days ram disks use the buffer cache, and grow dynamically.
320 For a lot of information on the current ramdisk
321 setup, see the kernel source file
322 .I Documentation/blockdev/ramdisk.txt
323 .RI ( Documentation/ramdisk.txt
324 in older kernels).
325 .IP
326 There are four parameters, two boolean and two integral.
327 .TP
328 .B "'load_ramdisk=N'"
329 If N=1, do load a ramdisk.
330 If N=0, do not load a ramdisk.
331 (This is the default.)
332 .TP
333 .B "'prompt_ramdisk=N'"
334 If N=1, do prompt for insertion of the floppy.
335 (This is the default.)
336 If N=0, do not prompt.
337 (Thus, this parameter is never needed.)
338 .TP
339 .BR 'ramdisk_size=N' " or (obsolete) " 'ramdisk=N'
340 Set the maximal size of the ramdisk(s) to N kB.
341 The default is 4096 (4\ MB).
342 .TP
343 .B "'ramdisk_start=N'"
344 Sets the starting block number (the offset on the floppy where
345 the ramdisk starts) to N.
346 This is needed in case the ramdisk follows a kernel image.
347 .TP
348 .B "'noinitrd'"
349 (Only if the kernel was compiled with
350 .B CONFIG_BLK_DEV_RAM
351 and
352 .BR CONFIG_BLK_DEV_INITRD .)
353 These days it is possible to compile the kernel to use initrd.
354 When this feature is enabled, the boot process will load the kernel
355 and an initial ramdisk; then the kernel converts initrd into
356 a "normal" ramdisk, which is mounted read-write as root device;
357 then
358 .I /linuxrc
359 is executed; afterward the "real" root filesystem is mounted,
360 and the initrd filesystem is moved over to
361 .IR /initrd ;
362 finally
363 the usual boot sequence (e.g., invocation of
364 .IR /sbin/init )
365 is performed.
366 .IP
367 For a detailed description of the initrd feature, see the kernel source file
368 .I Documentation/admin\-guide/initrd.rst
369 .\" commit 9d85025b0418163fae079c9ba8f8445212de8568
370 (or
371 .I Documentation/initrd.txt
372 before Linux 4.10).
373 .IP
374 The 'noinitrd' option tells the kernel that although it was compiled for
375 operation with initrd, it should not go through the above steps, but
376 leave the initrd data under
377 .IR /dev/initrd .
378 (This device can be used only once: the data is freed as soon as
379 the last process that used it has closed
380 .IR /dev/initrd .)
381 .SS Boot arguments for SCSI devices
382 General notation for this section:
383 .P
384 .I iobase
385 -- the first I/O port that the SCSI host occupies.
386 These are specified in hexadecimal notation,
387 and usually lie in the range from 0x200 to 0x3ff.
388 .P
389 .I irq
390 -- the hardware interrupt that the card is configured to use.
391 Valid values will be dependent on the card in question, but will
392 usually be 5, 7, 9, 10, 11, 12, and 15.
393 The other values are usually
394 used for common peripherals like IDE hard disks, floppies, serial
395 ports, and so on.
396 .P
397 .I scsi\-id
398 -- the ID that the host adapter uses to identify itself on the
399 SCSI bus.
400 Only some host adapters allow you to change this value, as
401 most have it permanently specified internally.
402 The usual default value
403 is 7, but the Seagate and Future Domain TMC-950 boards use 6.
404 .P
405 .I parity
406 -- whether the SCSI host adapter expects the attached devices
407 to supply a parity value with all information exchanges.
408 Specifying a one indicates parity checking is enabled,
409 and a zero disables parity checking.
410 Again, not all adapters will support selection of parity
411 behavior as a boot argument.
412 .TP
413 .B "'max_scsi_luns=...'"
414 A SCSI device can have a number of 'subdevices' contained within
415 itself.
416 The most common example is one of the new SCSI CD-ROMs that
417 handle more than one disk at a time.
418 Each CD is addressed as a
419 \&'Logical Unit Number' (LUN) of that particular device.
420 But most
421 devices, such as hard disks, tape drives, and such are only one device,
422 and will be assigned to LUN zero.
423 .IP
424 Some poorly designed SCSI devices cannot handle being probed for
425 LUNs not equal to zero.
426 Therefore, if the compile-time flag
427 .B CONFIG_SCSI_MULTI_LUN
428 is not set, newer kernels will by default probe only LUN zero.
429 .IP
430 To specify the number of probed LUNs at boot, one enters
431 \&'max_scsi_luns=n' as a boot arg, where n is a number between one and
432 eight.
433 To avoid problems as described above, one would use n=1 to
434 avoid upsetting such broken devices.
435 .TP
436 .B "SCSI tape configuration"
437 Some boot time configuration of the SCSI tape driver can be achieved
438 by using the following:
439 .IP
440 .in +4n
441 .EX
442 .BI st= buf_size[,write_threshold[,max_bufs]]
443 .EE
444 .in
445 .IP
446 The first two numbers are specified in units of kB.
447 The default
448 .I buf_size
449 is 32k\ B, and the maximum size that can be specified is a
450 ridiculous 16384\ kB.
451 The
452 .I write_threshold
453 is the value at which the buffer is committed to tape, with a
454 default value of 30\ kB.
455 The maximum number of buffers varies
456 with the number of drives detected, and has a default of two.
457 An example usage would be:
458 .IP
459 .in +4n
460 .EX
461 st=32,30,2
462 .EE
463 .in
464 .IP
465 Full details can be found in the file
466 .I Documentation/scsi/st.txt
467 (or
468 .I drivers/scsi/README.st
469 for older kernels) in the Linux kernel source.
470 .SS Hard disks
471 .TP
472 .B "IDE Disk/CD-ROM Driver Parameters"
473 The IDE driver accepts a number of parameters, which range from disk
474 geometry specifications, to support for broken controller chips.
475 Drive-specific options are specified by using 'hdX=' with X in 'a'\[en]'h'.
476 .IP
477 Non-drive-specific options are specified with the prefix 'hd='.
478 Note that using a drive-specific prefix for a non-drive-specific option
479 will still work, and the option will just be applied as expected.
480 .IP
481 Also note that 'hd=' can be used to refer to the next unspecified
482 drive in the (a, ..., h) sequence.
483 For the following discussions,
484 the 'hd=' option will be cited for brevity.
485 See the file
486 .I Documentation/ide/ide.txt
487 (or
488 .I Documentation/ide.txt
489 .\" Linux 2.0, 2.2, 2.4
490 in older kernels, or
491 .I drivers/block/README.ide
492 in ancient kernels) in the Linux kernel source for more details.
493 .TP
494 .B "The 'hd=cyls,heads,sects[,wpcom[,irq]]' options"
495 These options are used to specify the physical geometry of the disk.
496 Only the first three values are required.
497 The cylinder/head/sectors
498 values will be those used by fdisk.
499 The write precompensation value
500 is ignored for IDE disks.
501 The IRQ value specified will be the IRQ
502 used for the interface that the drive resides on, and is not really a
503 drive-specific parameter.
504 .TP
505 .B "The 'hd=serialize' option"
506 The dual IDE interface CMD-640 chip is broken as designed such that
507 when drives on the secondary interface are used at the same time as
508 drives on the primary interface, it will corrupt your data.
509 Using this
510 option tells the driver to make sure that both interfaces are never
511 used at the same time.
512 .TP
513 .B "The 'hd=noprobe' option"
514 Do not probe for this drive.
515 For example,
516 .IP
517 .in +4n
518 .EX
519 hdb=noprobe hdb=1166,7,17
520 .EE
521 .in
522 .IP
523 would disable the probe, but still specify the drive geometry so
524 that it would be registered as a valid block device, and hence
525 usable.
526 .TP
527 .B "The 'hd=nowerr' option"
528 Some drives apparently have the
529 .B WRERR_STAT
530 bit stuck on permanently.
531 This enables a work-around for these broken devices.
532 .TP
533 .B "The 'hd=cdrom' option"
534 This tells the IDE driver that there is an ATAPI compatible CD-ROM
535 attached in place of a normal IDE hard disk.
536 In most cases the CD-ROM
537 is identified automatically, but if it isn't then this may help.
538 .TP
539 .B "Standard ST-506 Disk Driver Options ('hd=')"
540 The standard disk driver can accept geometry arguments for the disks
541 similar to the IDE driver.
542 Note however that it expects only three
543 values (C/H/S); any more or any less and it will silently ignore you.
544 Also, it accepts only 'hd=' as an argument, that is, 'hda='
545 and so on are not valid here.
546 The format is as follows:
547 .IP
548 .in +4n
549 .EX
550 hd=cyls,heads,sects
551 .EE
552 .in
553 .IP
554 If there are two disks installed, the above is repeated with the
555 geometry parameters of the second disk.
556 .SS Ethernet devices
557 Different drivers make use of different parameters, but they all at
558 least share having an IRQ, an I/O port base value, and a name.
559 In its most generic form, it looks something like this:
560 .P
561 .in +4n
562 .EX
563 ether=irq,iobase[,param_1[,...param_8]],name
564 .EE
565 .in
566 .P
567 The first nonnumeric argument is taken as the name.
568 The param_n values (if applicable) usually have different meanings for each
569 different card/driver.
570 Typical param_n values are used to specify
571 things like shared memory address, interface selection, DMA channel
572 and the like.
573 .P
574 The most common use of this parameter is to force probing for a second
575 ethercard, as the default is to probe only for one.
576 This can be accomplished with a simple:
577 .P
578 .in +4n
579 .EX
580 ether=0,0,eth1
581 .EE
582 .in
583 .P
584 Note that the values of zero for the IRQ and I/O base in the above
585 example tell the driver(s) to autoprobe.
586 .P
587 The Ethernet-HowTo has extensive documentation on using multiple
588 cards and on the card/driver-specific implementation
589 of the param_n values where used.
590 Interested readers should refer to
591 the section in that document on their particular card.
592 .SS The floppy disk driver
593 There are many floppy driver options, and they are all listed in
594 .I Documentation/blockdev/floppy.txt
595 (or
596 .I Documentation/floppy.txt
597 in older kernels, or
598 .I drivers/block/README.fd
599 for ancient kernels) in the Linux kernel source.
600 See that file for the details.
601 .SS The sound driver
602 The sound driver can also accept boot arguments to override the compiled-in
603 values.
604 This is not recommended, as it is rather complex.
605 It is described in the Linux kernel source file
606 .I Documentation/sound/oss/README.OSS
607 .RI ( drivers/sound/Readme.linux
608 in older kernel versions).
609 It accepts
610 a boot argument of the form:
611 .P
612 .in +4n
613 .EX
614 sound=device1[,device2[,device3...[,device10]]]
615 .EE
616 .in
617 .P
618 where each deviceN value is of the following format 0xTaaaId and the
619 bytes are used as follows:
620 .P
621 T \- device type: 1=FM, 2=SB, 3=PAS, 4=GUS, 5=MPU401, 6=SB16,
622 7=SB16-MPU401
623 .P
624 aaa \- I/O address in hex.
625 .P
626 I \- interrupt line in hex (i.e., 10=a, 11=b, ...)
627 .P
628 d \- DMA channel.
629 .P
630 As you can see, it gets pretty messy, and you are better off to compile
631 in your own personal values as recommended.
632 Using a boot argument of
633 \&'sound=0' will disable the sound driver entirely.
634 .SS The line printer driver
635 .TP
636 .B "'lp='"
637 .br
638 Syntax:
639 .IP
640 .in +4n
641 .EX
642 lp=0
643 lp=auto
644 lp=reset
645 lp=port[,port...]
646 .EE
647 .in
648 .IP
649 You can tell the printer driver what ports to use and what ports not
650 to use.
651 The latter comes in handy if you don't want the printer driver
652 to claim all available parallel ports, so that other drivers
653 (e.g., PLIP, PPA) can use them instead.
654 .IP
655 The format of the argument is multiple port names.
656 For example,
657 lp=none,parport0 would use the first parallel port for lp1, and
658 disable lp0.
659 To disable the printer driver entirely, one can use
660 lp=0.
661 .\" .SH AUTHORS
662 .\" Linus Torvalds (and many others)
663 .SH SEE ALSO
664 .BR klogd (8),
665 .BR mount (8)
666 .P
667 For up-to-date information, see the kernel source file
668 .IR Documentation/admin\-guide/kernel\-parameters.txt .