Fix typo in the Gentoo initscript.
[fbsplash.git] / core / docs / kernel_parameters
blobed3840a1562d1ca5514453628d3bd39254d7c4aa
1 To make sure that the silent mode works correctly with this version of
2 splashutils, it is required that you add either
3 'quiet CONSOLE=/dev/tty1' or 'console=tty1' to your kernel command line.
5 'quiet' will prevent most of the initial kernel messages from being displayed.
6 'CONSOLE=/dev/tty1' will redirect all initscript messages to tty1.
7 'console=tty1' will redirect both kernel and initscript messages to tty1.
9 It is also possible to override some splash parameters defined in the
10 system configuration files with options passed on the kernel command
11 line. All splash options are separated by commas and they should form
12 a continuous configuration string. The following options are recognized:
14  - off        - Disable silent and verbose splash (default).
15  - verbose    - Start the system with a verbose splash screen.
16  - silent     - Start the system in the 'silent' mode. (all messages from
17                 the kernel and from the initscripts are covered by a picture
18                 and thus hidden from the user).
19  - silentonly - The same as 'silent', but does not activate the verbose mode.
20  - fadein     - Use a 'fade from black' effect to display the silent image.
21  - fadeout    - Use a 'fade to black' effect after the bootup is finished.
22  - theme:foo  - Use theme 'foo'.
23  - tty:n      - Sse the n-th tty as the silent tty. Default silent tty is
24                 tty8.
25  - kdgraphics - Run in KDGRAPHICS mode. Use of this option is discouraged
26                 but might be necessary when some kernel drivers try to
27                 display messages on the foreground tty despite the 'quiet'
28                 option.
30 Additionally, the following options may be recognized, if the system
31 scripts provide support for them:
33  - profile    - Save splash profiling information. The data saved in a
34                 splash profile file can be used to replay the boot sequence
35                 using the splash_manager script.
36  - insane     - Skip sanity checks.
38 A sample splash kernel command line setting:
39   splash=silent,fadein,theme:linuxrocks,tty:12
41 A sample full kernel command line:
42   root=/dev/hda5 video=vesafb:1024x768-32@85
43   splash=silent,fadein,theme:linuxrocks,tty:12 console=tty1
45 Please note that the default splash mode is 'off'. You have to explicitly
46 specify 'silent' or 'verbose' on the kernel command line in order to get
47 the splash working.
49 The splash helper recognizes the following additional environment
50 variables:
52  BOOT_MSG="message" - use 'message' for the initial greeting (instead of
53                       'Initializing the kernel...') for the silent splash.
55  PROGRESS="xx" - set the initial progress variable to 'xx' instead of '0'.
57 The BOOT_MSG option can also be given on the kernel command line.
58 Note that these additional parameters are never specified as a part of the
59 splash= config string. The correct way of using them is:
61 .. splash=silent,theme:linuxrocks console=tty1 BOOT_MSG="Welcome to Linux!" ..
63 -- 
64  Michal Januszewski <spock@gentoo.org>