Blame SOURCES/0025-Doc-cleanup-extend-and-split-and-reuse.patch

a56a5e
From 84fe197facb96947638c518639c0913ecad1599b Mon Sep 17 00:00:00 2001
90b079
From: Harald Hoyer <harald@redhat.com>
90b079
Date: Tue, 8 Oct 2013 14:59:47 +0200
90b079
Subject: [PATCH] Doc: cleanup, extend and split and reuse
90b079
90b079
---
90b079
 Makefile             |   8 +-
90b079
 dracut.8.asc         |  61 +---
90b079
 dracut.asc           | 888 +--------------------------------------------------
90b079
 dracut.cmdline.7.asc | 414 ++++++++++++++----------
90b079
 dracut.css           | 434 +------------------------
90b079
 dracut.modules.7.asc | 293 +++++++++++++++++
90b079
 dracut.spec          |   1 +
90b079
 dracut.usage.asc     | 526 ++++++++++++++++++++++++++++++
90b079
 8 files changed, 1084 insertions(+), 1541 deletions(-)
90b079
 create mode 100644 dracut.modules.7.asc
90b079
 create mode 100644 dracut.usage.asc
90b079
90b079
diff --git a/Makefile b/Makefile
90b079
index 124a41b..e7da948 100644
90b079
--- a/Makefile
90b079
+++ b/Makefile
90b079
@@ -21,7 +21,8 @@ man1pages = lsinitrd.1
90b079
 man5pages = dracut.conf.5
90b079
 
90b079
 man7pages = dracut.cmdline.7 \
90b079
-            dracut.bootup.7
90b079
+            dracut.bootup.7 \
90b079
+            dracut.modules.7
90b079
 
90b079
 man8pages = dracut.8 \
90b079
             dracut-catimages.8 \
90b079
@@ -37,7 +38,6 @@ man8pages = dracut.8 \
90b079
 
90b079
 manpages = $(man1pages) $(man5pages) $(man7pages) $(man8pages)
90b079
 
90b079
-
90b079
 .PHONY: install clean archive rpm testimage test all check AUTHORS doc dracut-version.sh
90b079
 
90b079
 all: dracut-version.sh dracut-install
90b079
@@ -76,7 +76,9 @@ endif
90b079
 %.xml: %.asc
90b079
 	asciidoc -d manpage -b docbook -o $@ $<
90b079
 
90b079
-dracut.html: dracut.asc $(manpages) dracut.css
90b079
+dracut.8: dracut.usage.asc dracut.8.asc
90b079
+
90b079
+dracut.html: dracut.asc $(manpages) dracut.css dracut.usage.asc
90b079
 	asciidoc -a numbered -d book -b docbook -o dracut.xml dracut.asc
90b079
 	xsltproc -o dracut.html --xinclude -nonet \
90b079
 		--stringparam custom.css.source dracut.css \
90b079
diff --git a/dracut.8.asc b/dracut.8.asc
90b079
index 76fc75c..584514c 100644
90b079
--- a/dracut.8.asc
90b079
+++ b/dracut.8.asc
90b079
@@ -10,7 +10,7 @@ dracut - low-level tool for generating an initramfs image
90b079
 
90b079
 SYNOPSIS
90b079
 --------
90b079
-*dracut* ['OPTION...'] [<image> [_<kernel version>_]]
90b079
+*dracut* [__OPTION...__] [__<image>__ [__<kernel version>__]]
90b079
 
90b079
 DESCRIPTION
90b079
 -----------
90b079
@@ -37,53 +37,10 @@ Additional debugging info can be produced by adding **rd.debug** to the kernel c
90b079
 _/run/initramfs/rdsosreport.txt_ contains all logs and the output of some tools.
90b079
 It should be attached to any report about dracut problems.
90b079
 
90b079
-EXAMPLE
90b079
--------
90b079
-
90b079
-To create a initramfs image, the most simple command is:
90b079
-----
90b079
-# dracut
90b079
-----
90b079
-
90b079
-This will generate a general purpose initramfs image, with all possible
90b079
-functionality resulting of the combination of the installed dracut modules and
90b079
-system tools. The image is /boot/initramfs-_++<kernel version>++_.img and
90b079
-contains the kernel modules of the currently active kernel with version
90b079
-_++<kernel version>++_.
90b079
-
90b079
-If the initramfs image already exists, dracut will display an error message, and
90b079
-to overwrite the existing image, you have to use the --force option.
90b079
-----
90b079
-# dracut --force
90b079
-----
90b079
-
90b079
-If you want to specify another filename for the resulting image you would issue
90b079
-a command like:
90b079
-----
90b079
-# dracut foobar.img
90b079
-----
90b079
-
90b079
-To generate an image for a specific kernel version, the command would be:
90b079
-----
90b079
-# dracut foobar.img 2.6.40-1.rc5.f20
90b079
-----
90b079
-
90b079
-A shortcut to generate the image at the default location for a specific kernel
90b079
-version is:
90b079
-----
90b079
-# dracut --kver 2.6.40-1.rc5.f20
90b079
-----
90b079
-
90b079
-If you want to create lighter, smaller initramfs images, you may want to specify
90b079
-the --hostonly or -H option. Using this option, the resulting image will
90b079
-contain only those dracut modules, kernel modules and filesystems, which are
90b079
-needed to boot this specific machine. This has the drawback, that you can't put
90b079
-the disk on another controller or machine, and that you can't switch to another
90b079
-root filesystem, without recreating the initramfs image. The usage of the
90b079
---hostonly option is only for experts and you will have to keep the broken
90b079
-pieces. At least keep a copy of a general purpose image (and corresponding
90b079
-kernel) as a fallback to rescue your system.
90b079
+USAGE
90b079
+-----
90b079
 
90b079
+include::dracut.usage.asc[]
90b079
 
90b079
 OPTIONS
90b079
 -------
90b079
@@ -337,7 +294,7 @@ provide a valid _/etc/fstab_.
90b079
 **-N, --no-hostonly**::
90b079
     Disable Host-Only mode
90b079
 
90b079
-**--persistent-policy** _<policy>_::
90b079
+**--persistent-policy** _<policy>_::
90b079
     Use _<policy>_ to address disks and partitions.
90b079
     _<policy>_ can be any directory name found in /dev/disk.
90b079
     E.g. "by-uuid", "by-label"
90b079
@@ -345,7 +302,7 @@ provide a valid _/etc/fstab_.
90b079
 **--fstab**::
90b079
     Use _/etc/fstab_ instead of _/proc/self/mountinfo_.
90b079
 
90b079
-**--add-fstab** _<filename>_ ::
90b079
+**--add-fstab** _<filename>_::
90b079
     Add entries of _<filename>_ to the initramfs /etc/fstab.
90b079
 
90b079
 **--mount** "_<device>_ _<mountpoint>_ _<filesystem type>_ _<filesystem options>_"::
90b079
@@ -358,13 +315,13 @@ provide a valid _/etc/fstab_.
90b079
     LVM or an encrypted partition.
90b079
     [NB --device can be used for compatibility with earlier releases]
90b079
 
90b079
-**-i, --include** _<SOURCE>_ _<TARGET>_::
90b079
+**-i, --include** _<SOURCE>_ _<TARGET>_::
90b079
     include the files in the SOURCE directory into the
90b079
     TARGET directory in the final initramfs. If SOURCE is a file, it will be
90b079
     installed to TARGET in the final initramfs. This parameter can be specified
90b079
     multiple times.
90b079
 
90b079
-**-I, --install** _<file list>_::
90b079
+**-I, --install** _<file list>_::
90b079
     install the space separated list of files into the initramfs.
90b079
 +
90b079
 [NOTE]
90b079
@@ -481,7 +438,7 @@ _/etc/conf.d/_::
90b079
 _/etc/cmdline_::
90b079
     Can contain additional command line options. Deprecated, better use /etc/cmdline.d/*.conf.
90b079
 
90b079
-_/etc/cmdline.d/*.conf::
90b079
+_/etc/cmdline.d/*.conf_::
90b079
     Can contain additional command line options.
90b079
 
90b079
 AVAILABILITY
90b079
diff --git a/dracut.asc b/dracut.asc
90b079
index c011658..031b201 100644
90b079
--- a/dracut.asc
90b079
+++ b/dracut.asc
90b079
@@ -1,7 +1,7 @@
90b079
 dracut
90b079
 ======
90b079
 Harald Hoyer <harald@redhat.com>
90b079
-v2.0, March 2011
90b079
+v3.0, October 2013
90b079
 
90b079
 :language: bash
90b079
 
90b079
@@ -145,885 +145,10 @@ This ensures, that all devices are disassembled and unmounted cleanly.
90b079
 
90b079
 = User Manual
90b079
 
90b079
-== Creating an initramfs Image
90b079
-To create a initramfs image, the most simple command is:
90b079
-----
90b079
-# dracut
90b079
-----
90b079
-
90b079
-This will generate a general purpose initramfs image, with all possible
90b079
-functionality resulting of the combination of the installed dracut modules and
90b079
-system tools. The image is /boot/initramfs-_++<kernel version>++_.img and
90b079
-contains the kernel modules of the currently active kernel with version
90b079
-_++<kernel version>++_.
90b079
-
90b079
-If the initramfs image already exists, dracut will display an error message, and
90b079
-to overwrite the existing image, you have to use the --force option.
90b079
-----
90b079
-# dracut --force
90b079
-----
90b079
-
90b079
-If you want to specify another filename for the resulting image you would issue
90b079
-a command like:
90b079
-----
90b079
-# dracut foobar.img
90b079
-----
90b079
-
90b079
-To generate an image for a specific kernel version, the command would be:
90b079
-----
90b079
-# dracut foobar.img 2.6.40-1.rc5.f20
90b079
-----
90b079
-
90b079
-A shortcut to generate the image at the default location for a specific kernel
90b079
-version is:
90b079
-----
90b079
-# dracut --kver 2.6.40-1.rc5.f20
90b079
-----
90b079
-
90b079
-If you want to create lighter, smaller initramfs images, you may want to specify
90b079
-the --host-only or -H option. Using this option, the resulting image will
90b079
-contain only those dracut modules, kernel modules and filesystems, which are
90b079
-needed to boot this specific machine. This has the drawback, that you can't put
90b079
-the disk on another controller or machine, and that you can't switch to another
90b079
-root filesystem, without recreating the initramfs image. The usage of the
90b079
---host-only option is only for experts and you will have to keep the broken
90b079
-pieces. At least keep a copy of a general purpose image (and corresponding
90b079
-kernel) as a fallback to rescue your system.
90b079
-
90b079
-=== Inspecting the Contents
90b079
-To see the contents of the image created by dracut, you can use the lsinitrd tool.
90b079
-----
90b079
-# lsinitrd /boot/initramfs-$(uname -r).img | less
90b079
-----
90b079
-
90b079
-To display the contents of a file in the initramfs also use the lsinitrd tool:
90b079
-----
90b079
-# lsinitrd /boot/initramfs-$(uname -r).img  /etc/ld.so.conf
90b079
-include ld.so.conf.d/*.conf
90b079
-----
90b079
-
90b079
-=== Adding dracut Modules
90b079
-Some dracut modules are turned off by default and have to be activated manually.
90b079
-You can do this by adding the dracut modules to the configuration file
90b079
-_/etc/dracut.conf_ or _/etc/dracut.conf.d/myconf.conf_. See <<dracutconf5>>.
90b079
-You can also add dracut modules on the command line
90b079
-by using the -a or --add option:
90b079
-----
90b079
-# dracut --add bootchart initramfs-bootchart.img
90b079
-----
90b079
-
90b079
-To see a list of available dracut modules, use the --list-modules option:
90b079
-----
90b079
-# dracut --list-modules
90b079
-----
90b079
-
90b079
-or, if you have a dracut version earlier than +008+, issue the command:
90b079
-----
90b079
-# for mod in /usr/lib/dracut/modules.d/*; do echo ${mod##*/??}; done
90b079
-----
90b079
-
90b079
-=== Omitting dracut Modules
90b079
-Sometimes you don't want a dracut module to be included for reasons of speed,
90b079
-size or functionality. To do this, either specify the omit_dracutmodules
90b079
-variable in the _dracut.conf_ or _/etc/dracut.conf.d/myconf.conf_ configuration
90b079
-file (see <<dracutconf5>>), or use the -o or --omit option
90b079
-on the command line:
90b079
-----
90b079
-# dracut -o "multipath lvm" no-multipath-lvm.img
90b079
-----
90b079
-
90b079
-=== Adding Kernel Modules
90b079
-If you need a special kernel module in the initramfs, which is not
90b079
-automatically picked up by dracut, you have the use the --add-drivers option
90b079
-on the command line or  the drivers vaiable in  the _/etc/dracut.conf_
90b079
-or _/etc/dracut.conf.d/myconf.conf_ configuration file (see <<dracutconf5>>):
90b079
-----
90b079
-# dracut --add-drivers mymod initramfs-with-mymod.img
90b079
-----
90b079
-
90b079
-== Boot parameters
90b079
-The generated initramfs.img file normally does not contain any system
90b079
-configuration files (except for some special exceptions), so the configuration
90b079
-has to be done on the kernel command line. With this flexibility, you can easily
90b079
-boot from a changed root partition, without the need to recompile the initramfs
90b079
-image. So, you could completly change your root partition (move it inside a md
90b079
-raid with encryption and LVM on top), as long as you specify the correct
90b079
-filesystem LABEL or UUID on the kernel command line for your root device, dracut
90b079
-will find it and boot from it.
90b079
-
90b079
-The kernel command line usually can be configured in _/boot/grub/grub.conf_, if
90b079
-grub is your bootloader and it also can be edited in the real boot process in
90b079
-the grub menu.
90b079
-
90b079
-The kernel command line can also be provided by the dhcp server with the
90b079
-root-path option. See <<NetworkBoot>>.
90b079
-
90b079
-For a full reference of all kernel command line parameters, see <<dracut8>>.
90b079
-
90b079
-=== Specifying the root Device
90b079
-This is the only option dracut really needs to boot from your root partition.
90b079
-Because your root partition can live in various environments, there are a lot of
90b079
-formats for the root= option. The most basic one is root=_++
90b079
-node>++_:
90b079
-----
90b079
-root=/dev/sda2
90b079
-----
90b079
-
90b079
-Because device node names can change, dependent on the drive ordering, you are
90b079
-encouraged to use the filesystem identifier (UUID) or filesystem label (LABEL)
90b079
-to specify your root partition:
90b079
-----
90b079
-root=UUID=19e9dda3-5a38-484d-a9b0-fa6b067d0331
90b079
-----
90b079
-
90b079
-or
90b079
-
90b079
-----
90b079
-root=LABEL=myrootpartitionlabel
90b079
-----
90b079
-
90b079
-To see all UUIDs or LABELs on your system, do:
90b079
-----
90b079
-# ls -l /dev/disk/by-uuid
90b079
-----
90b079
-
90b079
-or
90b079
-
90b079
-----
90b079
-# ls -l /dev/disk/by-label
90b079
-----
90b079
-
90b079
-If your root partition is on the network see <<NetworkBoot>>.
90b079
-
90b079
-=== Keyboard Settings
90b079
-If you have to input passwords for encrypted disk volumes, you might want to set
90b079
-the keyboard layout and specify a display font.
90b079
-
90b079
-A typical german kernel command would contain:
90b079
-----
90b079
-vconsole.font=latarcyrheb-sun16 vconsole.keymap=de-latin1-nodeadkeys locale.LANG=de_DE.UTF-8
90b079
-----
90b079
-
90b079
-Setting these options can override the setting stored on your system, if you use
90b079
-a modern init system, like systemd.
90b079
-
90b079
-For dracut versions prior to version +008+ the line would look like:
90b079
-----
90b079
-LANG=de_DE.UTF-8 SYSFONT=latarcyrheb-sun16 KEYBOARDTYPE=pc KEYTABLE=de-latin1-nodeadkeys
90b079
-----
90b079
-
90b079
-=== Blacklisting Kernel Modules
90b079
-Sometimes it is required to prevent the automatic kernel module loading of a
90b079
-specific kernel module. To do this, just add rd.blacklist=_++
90b079
-name>++_, with _++<kernel module name>++_ not containing the _.ko_
90b079
-suffix, to the kernel command line. For example:
90b079
-----
90b079
-rd.driver.blacklist=mptsas rd.driver.blacklist=nouveau
90b079
-----
90b079
-
90b079
-The option can be specified multiple times on the kernel command line.
90b079
-
90b079
-=== Speeding up the Boot Process
90b079
-If you want to speed up the boot process, you can specify as much information
90b079
-for dracut on the kernel command as possible. For example, you can tell dracut,
90b079
-that you root partition is not on a LVM volume or not on a raid partition, or
90b079
-that it lives inside a specific crypto LUKS encrypted volume. By default, dracut
90b079
-searches everywhere. A typical dracut kernel command line for a plain primary or
90b079
-logical partition would contain:
90b079
-----
90b079
-rd.luks=0 rd.lvm=0 rd.md=0 rd.dm=0
90b079
-----
90b079
-
90b079
-On systems with dracut version prior to +008+ the line would look like:
90b079
-----
90b079
-rd_NO_LUKS rd_NO_LVM rd_NO_MD rd_NO_DM
90b079
-----
90b079
-
90b079
-This turns off every automatic assembly of LVM, MD raids, DM raids and crypto LUKS.
90b079
-
90b079
-Of course, you could also omit the dracut modules in the initramfs creation
90b079
-process, but then you would lose the posibility to turn it on on demand.
90b079
-
90b079
-
90b079
-[[Injecting]]
90b079
-=== Injecting custom Files
90b079
-To add your own files to the initramfs image, you have several possibilities.
90b079
-
90b079
-The --include option let you specify a source path and a target path. For example
90b079
-----
90b079
-# dracut --include cmdline-preset /etc/cmdline.d/mycmdline.conf initramfs-cmdline-pre.img
90b079
-----
90b079
-will create an initramfs image, where the file cmdline-preset will be copied
90b079
-inside the initramfs to _/etc/cmdline.d/mycmdline.conf_. --include can only be specified once.
90b079
-
90b079
-
90b079
-----
90b079
-# mkdir rd.live.overlay
90b079
-# mkdir rd.live.overlay/etc
90b079
-# mkdir rd.live.overlay/etc/conf.d
90b079
-# mkdir rd.live.overlay/etc/cmdline.d
90b079
-# echo "ip=auto" >> rd.live.overlay/etc/cmdline.d/mycmdline.conf
90b079
-# echo export FOO=testtest >> rd.live.overlay/etc/conf.d/testvar.conf
90b079
-# echo export BAR=testtest >> rd.live.overlay/etc/conf.d/testvar.conf
90b079
-# tree rd.live.overlay/
90b079
-rd.live.overlay/
90b079
-└── etc
90b079
-    ├── cmdline.d
90b079
-        │   └── mycmdline.conf
90b079
-	    └── conf.d
90b079
-	            └── testvar.conf
90b079
-
90b079
-# dracut --include rd.live.overlay / initramfs-rd.live.overlay.img
90b079
-----
90b079
-
90b079
-This will put the contents of the rd.live.overlay directory into the root of the
90b079
-initramfs image.
90b079
-
90b079
-The --install option let you specify several files, which will get installed in
90b079
-the initramfs image at the same location, as they are present on initramfs
90b079
-creation time.
90b079
-
90b079
-
90b079
-----
90b079
-# dracut --install 'strace fsck.ext3 ssh' initramfs-dbg.img
90b079
-----
90b079
-
90b079
-This will create an initramfs with the strace, fsck.ext3 and ssh executables,
90b079
-together with the libraries needed to start those. The --install option can be
90b079
-specified multiple times.
90b079
-
90b079
-
90b079
-[[NetworkBoot]]
90b079
-== Network Boot
90b079
-
90b079
-If your root partition is on a network drive, you have to have the network
90b079
-dracut modules installed to create a network aware initramfs image.
90b079
-
90b079
-On a Red Hat Enterprise Linux or Fedora system, this means, you have to install
90b079
-the _dracut-network_ rpm package:
90b079
-
90b079
-
90b079
-----
90b079
-# yum install dracut-network
90b079
-----
90b079
-
90b079
-The resulting initramfs image can be served by a boot manager residing on your
90b079
-local hard drive or it can be served by a PXE/TFTP server.
90b079
-
90b079
-How to setup your PXE/TFTP server can be found in the
90b079
-http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/[Red
90b079
-Hat Enterprise Linux Storage Administration Guide].
90b079
-
90b079
-If you specify ip=auto on the kernel command line, then dracut asks a dhcp
90b079
-server about the ip adress for the machine. The dhcp server can also serve an
90b079
-additional root-path, which will set the root device for dracut. With this
90b079
-mechanism, you have static configuration on your client machine and a
90b079
-centralized boot configuration on your TFTP/DHCP server. If you can't pass a
90b079
-kernel command line, then you can inject _/etc/cmdline.d/mycmdline.conf_, with a method described
90b079
-in <<Injecting>>.
90b079
-
90b079
-
90b079
-
90b079
-
90b079
-=== Reducing the Image Size
90b079
-
90b079
-To reduce the size of the initramfs, you should create it with by ommitting all
90b079
-dracut modules, which you know, you don't need to boot the machine.
90b079
-
90b079
-You can also specify the exact dracut and kernel modules to produce a very tiny
90b079
-initramfs image.
90b079
-
90b079
-For example for a NFS image, you would do:
90b079
-
90b079
-
90b079
-----
90b079
-# dracut -m "nfs network  base" initramfs-nfs-only.img
90b079
-----
90b079
-
90b079
-Then you would boot from this image with your target machine and reduce the size
90b079
-once more by creating it on the target machine with the --host-only option:
90b079
-
90b079
-
90b079
-----
90b079
-# dracut -m "nfs network base" --host-only initramfs-nfs-host-only.img
90b079
-----
90b079
-
90b079
-This will reduce the size of the initramfs image significantly.
90b079
-
90b079
-
90b079
-
90b079
-=== NFS Root Device
90b079
-
90b079
-FIXME
90b079
-
90b079
-=== iSCSI Root Device
90b079
-
90b079
-FIXME 
90b079
-
90b079
-=== FCoE Root Device
90b079
-
90b079
-FIXME
90b079
-
90b079
-== Troubleshooting
90b079
-
90b079
-If the boot process does not succeed, you have several options to debug the
90b079
-situation. Some of the basic operations are covered here. For more information
90b079
-you should also visit:
90b079
-http://fedoraproject.org/wiki/How_to_debug_Dracut_problems
90b079
-
90b079
-
90b079
-[[identifying-your-problem-area]]
90b079
-=== Identifying your problem area
90b079
-. Remove ''rhgb'' and ''quiet'' from the kernel command line
90b079
-. Add ''rd.shell'' to the kernel command line. This will present a shell should
90b079
-dracut be unable to locate your root device
90b079
-. Add ''rd.shell rd.debug log_buf_len=1M'' to the kernel command line so that
90b079
-dracut shell commands are printed as they are executed
90b079
-. With dracut >= 002-11, you can inspect the rd.debug output with:
90b079
-+
90b079
-----
90b079
-# less /run/initramfs/init.log
90b079
-# dmesg | less
90b079
-----
90b079
-. With dracut >= 022 and systemd, you can inspect the rd.debug output with:
90b079
-----
90b079
-# journalctl -ab
90b079
-----
90b079
-. With dracut >= 025 the file /run/initramfs/rdsosreport.txt is generated, which contains all the logs and the output of all significant tools, which are mentioned later.
90b079
-
90b079
-If you want to save that output, simply mount /boot by hand or insert an USB stick and mount that.
90b079
-Then you can store the output for later inspection.
90b079
-
90b079
-[[information-to-include-in-your-report]]
90b079
-=== Information to include in your report
90b079
-
90b079
-[[all-bug-reports]]
90b079
-==== All bug reports
90b079
-In all cases, the following should be mentioned and attached to your bug report:
90b079
-
90b079
-* The exact kernel command-line used. Typically from the bootloader
90b079
-configuration file (e.g. _/etc/grub.conf_) or from _/proc/cmdline_.
90b079
-* A copy of your disk partition information from _/etc/fstab_, which might be
90b079
-obtained booting an old working initramfs or a rescue medium.
90b079
-* A device listing from device-mapper. This can be obtained by running the
90b079
-command
90b079
-+
90b079
-----
90b079
-# dmsetup ls --tree
90b079
-----
90b079
-+
90b079
-* A list of block device attributes. This can be obtained by running the commands: 
90b079
-+
90b079
-----
90b079
-# blkid -p
90b079
-# blkid -p -o udev
90b079
-----
90b079
-* Turn on dracut debugging (see _the 'debugging dracut' section_), and attach
90b079
-all relevant information from the boot log. This can be obtained by running the
90b079
-command 
90b079
-+
90b079
-----
90b079
-# dmesg|grep dracut
90b079
-----
90b079
-+
90b079
-* If you use a dracut configuration file, please include _/etc/dracut.conf_ and
90b079
-all files in _/etc/dracut.conf.d/*.conf_
90b079
-
90b079
-[[logical-volume-management-related-problems]]
90b079
-==== Logical Volume Management related problems
90b079
-As well as the information from <<all-bug-reports>> include the following
90b079
-information:
90b079
-
90b079
-* Include physical volume information by running the command:
90b079
-+
90b079
-----
90b079
-# lvm pvdisplay
90b079
-----
90b079
-+
90b079
-* Include volume group information by running the command:
90b079
-+
90b079
-----
90b079
-# lvm vgdisplay
90b079
-----
90b079
-+
90b079
-* Include logical volume information by running the command:
90b079
-+
90b079
-----
90b079
-# lvm lvdisplay
90b079
-----
90b079
-
90b079
-[[software-raid-related-problems]]
90b079
-==== Software RAID related problems
90b079
-As well as the information from <<all-bug-reports>>, include the following
90b079
-information:
90b079
-
90b079
-* If using software RAID disk partitions, please include the output of
90b079
-+
90b079
-----
90b079
-# cat /proc/mdstat
90b079
-----
90b079
-
90b079
-[[network-root-device-related-problems]]
90b079
-==== Network root device related problems
90b079
-This section details information to include when experiencing problems on a
90b079
-system whose root device is located on a network attached volume (e.g. iSCSI,
90b079
-NFS or NBD). As well as the information from <<all-bug-reports>>, include the
90b079
-following information:
90b079
-
90b079
-
90b079
-* Please include the output of
90b079
-+
90b079
-----
90b079
-# /sbin/ifup <interfacename>
90b079
-# ip addr show
90b079
-----
90b079
-
90b079
-[[debugging-dracut]]
90b079
-=== Debugging dracut
90b079
-
90b079
-
90b079
-[[configure-a-serial-console]]
90b079
-==== Configure a serial console
90b079
-
90b079
-Successfully debugging dracut will require some form of console
90b079
-logging during the system boot.  This section documents configuring a
90b079
-serial console connection to record boot messages.
90b079
-
90b079
-. First, enable serial console output for both the kernel and the bootloader.
90b079
-. Open the file _/etc/grub.conf_ for editing. Below the line ''timeout=5'', add
90b079
-the following:
90b079
-+
90b079
-----
90b079
-serial --unit=0 --speed=9600
90b079
-terminal --timeout=5 serial console
90b079
-----
90b079
-+
90b079
-. Also in _/etc/grub.conf_, add the following boot arguemnts to the ''kernel''
90b079
-line:
90b079
-+
90b079
-----
90b079
-console=tty0 console=ttyS0,9600
90b079
-----
90b079
-+
90b079
-. When finished, the _/etc/grub.conf_ file should look similar to the example
90b079
-below.
90b079
-+
90b079
-----
90b079
-default=0
90b079
-timeout=5
90b079
-serial --unit=0 --speed=9600
90b079
-terminal --timeout=5 serial console
90b079
-title Fedora (2.6.29.5-191.fc11.x86_64)
90b079
-  root (hd0,0)
90b079
-  kernel /vmlinuz-2.6.29.5-191.fc11.x86_64 ro root=/dev/mapper/vg_uc1-lv_root console=tty0 console=ttyS0,9600
90b079
-  initrd /dracut-2.6.29.5-191.fc11.x86_64.img
90b079
-----
90b079
-+
90b079
-. More detailed information on how to configure the kernel for console output
90b079
-can be found at
90b079
-http://www.faqs.org/docs/Linux-HOWTO/Remote-Serial-Console-HOWTO.html#CONFIGURE-KERNEL.
90b079
-. Redirecting non-interactive output
90b079
-+
90b079
---
90b079
-NOTE: You can redirect all non-interactive output to _/dev/kmsg_ and the kernel
90b079
-will put it out on the console when it reaches the kernel buffer by doing
90b079
-
90b079
-----
90b079
-# exec >/dev/kmsg 2>&1 
90b079
-----
90b079
---
90b079
-
90b079
-[[using-the-dracut-shell]]
90b079
-==== Using the dracut shell
90b079
-
90b079
-dracut offers a shell for interactive debugging in the event dracut fails to
90b079
-locate your root filesystem. To enable the shell:
90b079
-
90b079
-. Add the boot parameter ''rd.shell'' to your bootloader configuration file
90b079
-(e.g. _/etc/grub.conf_)
90b079
-. Remove the boot arguments ''rhgb'' and ''quiet''
90b079
-+
90b079
-A sample _/etc/grub.conf_ bootloader configuration file is listed below.
90b079
-+
90b079
-----
90b079
-default=0
90b079
-timeout=5
90b079
-serial --unit=0 --speed=9600
90b079
-terminal --timeout=5 serial console
90b079
-title Fedora (2.6.29.5-191.fc11.x86_64)
90b079
-  root (hd0,0)
90b079
-  kernel /vmlinuz-2.6.29.5-191.fc11.x86_64 ro root=/dev/mapper/vg_uc1-lv_root console=tty0 rd.shell
90b079
-  initrd /dracut-2.6.29.5-191.fc11.x86_64.img
90b079
-----
90b079
-+
90b079
-. If system boot fails, you will be dropped into a shell as seen in the example below.
90b079
-+
90b079
-----
90b079
-No root device found
90b079
-Dropping to debug shell.
90b079
-
90b079
-#
90b079
-----
90b079
-+
90b079
-. Use this shell prompt to gather the information requested above (see <<all-bug-reports>>).
90b079
-
90b079
-[[accessing-the-root-volume-from-the-dracut-shell]]
90b079
-==== Accessing the root volume from the dracut shell
90b079
-From the dracut debug shell, you can manually perform the task of locating and
90b079
-preparing your root volume for boot. The required steps will depend on how your
90b079
-root volume is configured. Common scenarios include:
90b079
-
90b079
-* A block device (e.g. _/dev/sda7_)
90b079
-* A LVM logical volume (e.g. _/dev/VolGroup00/LogVol00_)
90b079
-* An encrypted device (e.g. _/dev/mapper/luks-4d5972ea-901c-4584-bd75-1da802417d83_)
90b079
-* A network attached device (e.g. netroot=iscsi:@192.168.0.4::3260::iqn.2009-02.org.fedoraproject:for.all)
90b079
-
90b079
-The exact method for locating and preparing will vary. However, to continue with
90b079
-a successful boot, the objective is to locate your root volume and create a
90b079
-symlink _/dev/root_ which points to the file system. For example, the following
90b079
-example demonstrates accessing and booting a root volume that is an encrypted
90b079
-LVM Logical volume.
90b079
-
90b079
-. Inspect your partitions using parted
90b079
-+
90b079
-----
90b079
-# parted /dev/sda -s p
90b079
-Model: ATA HTS541060G9AT00 (scsi)
90b079
-Disk /dev/sda: 60.0GB
90b079
-Sector size (logical/physical): 512B/512B
90b079
-Partition Table: msdos
90b079
-Number  Start   End     Size    Type      File system  Flags
90b079
-1      32.3kB  10.8GB  107MB   primary   ext4         boot
90b079
-2      10.8GB  55.6GB  44.7GB  logical                lvm
90b079
-----
90b079
-+
90b079
-. You recall that your root volume was a LVM logical volume. Scan and activate
90b079
-any logical volumes.
90b079
-+
90b079
-----
90b079
-# lvm vgscan
90b079
-# lvm vgchange -ay
90b079
-----
90b079
-+
90b079
-. You should see any logical volumes now using the command blkid:
90b079
-+
90b079
-----
90b079
-# blkid
90b079
-/dev/sda1: UUID="3de247f3-5de4-4a44-afc5-1fe179750cf7" TYPE="ext4"
90b079
-/dev/sda2: UUID="Ek4dQw-cOtq-5MJu-OGRF-xz5k-O2l8-wdDj0I" TYPE="LVM2_member"
90b079
-/dev/mapper/linux-root: UUID="def0269e-424b-4752-acf3-1077bf96ad2c" TYPE="crypto_LUKS"
90b079
-/dev/mapper/linux-home: UUID="c69127c1-f153-4ea2-b58e-4cbfa9257c5e" TYPE="ext3"
90b079
-/dev/mapper/linux-swap: UUID="47b4d329-975c-4c08-b218-f9c9bf3635f1" TYPE="swap"
90b079
-----
90b079
-+
90b079
-. From the output above, you recall that your root volume exists on an encrypted
90b079
-block device. Following the guidance disk encryption guidance from the
90b079
-Installation Guide, you unlock your encrypted root volume.
90b079
-+
90b079
-----
90b079
-# UUID=$(cryptsetup luksUUID /dev/mapper/linux-root)
90b079
-# cryptsetup luksOpen /dev/mapper/linux-root luks-$UUID
90b079
-Enter passphrase for /dev/mapper/linux-root:
90b079
-Key slot 0 unlocked.
90b079
-----
90b079
-+
90b079
-. Next, make a symbolic link to the unlocked root volume
90b079
-+
90b079
-----
90b079
-# ln -s /dev/mapper/luks-$UUID /dev/root
90b079
-----
90b079
-+
90b079
-. With the root volume available, you may continue booting the system by exiting
90b079
-the dracut shell
90b079
-+
90b079
-----
90b079
-# exit
90b079
-----
90b079
-
90b079
-[[additional-dracut-boot-parameters]]
90b079
-==== Additional dracut boot parameters
90b079
-For more debugging options, see <<dracutkerneldebug>> in <<dracutcmdline7>>.
90b079
-
90b079
-
90b079
-[[debugging-dracut-on-shutdown]]
90b079
-==== Debugging dracut on shutdown
90b079
-
90b079
-To debug the shutdown sequence on systemd systems, you can _rd.break_
90b079
-on _pre-shutdown_ or _shutdown_.
90b079
-
90b079
-To do this from an already booted system:
90b079
-----
90b079
-# mkdir -p /run/initramfs/etc/cmdline.d
90b079
-# echo "rd.break=pre-shutdown" > /run/initramfs/etc/cmdline.d/debug.conf
90b079
-# touch /run/initramfs/.need_shutdown
90b079
-----
90b079
-
90b079
-This will give you a dracut shell after the system pivot'ed back in the initramfs.
90b079
-
90b079
-
90b079
-= Developer Manual
90b079
-
90b079
-== dracut Components
90b079
-
90b079
-dracut uses a modular system to build and extend the initramfs image. All
90b079
-modules are located in _/usr/lib/dracut/modules.d_ or in _<git-src>/modules.d_.
90b079
-The most basic dracut module is _99base_. In _99base_ the initial shell script
90b079
-init is defined, which gets run by the kernel after initramfs loading. Although
90b079
-you can replace init with your own version of _99base_, this is not encouraged.
90b079
-Instead you should use, if possible, the hooks of dracut. All hooks, and the
90b079
-point of time in which they are executed, are described in <<stages>>.
90b079
-
90b079
-The main script, which creates the initramfs is dracut itsself. It parses all
90b079
-arguments and sets up the directory, in which everything is installed. It then
90b079
-executes all check, install, installkernel scripts found in the modules, which
90b079
-are to be processed. After everything is installed, the install directory is
90b079
-archived and compressed to the final initramfs image. All helper functions used
90b079
-by check, install and installkernel are found in in the file _dracut-functions_.
90b079
-These shell functions are available to all module installer (install,
90b079
-installkernel) scripts, without the need to source _dracut-functions_.
90b079
-
90b079
-A module can check the preconditions for install and installkernel with the
90b079
-check script. Also dependencies can be expressed with check. If a module passed
90b079
-check, install and installkernel will be called to install all of the necessary
90b079
-files for the module. To split between kernel and non-kernel parts of the
90b079
-installation, all kernel module related parts have to be in installkernel. All
90b079
-other files found in a module directory are module specific and mostly are hook
90b079
-scripts and udev rules.
90b079
-
90b079
-
90b079
-[[stages]]
90b079
-== Boot Process Stages
90b079
-
90b079
-dracut modules can insert custom script at various points, to control the boot
90b079
-process.
90b079
-These hooks are plain directories containing shell scripts ending with ".sh",
90b079
-which are sourced by init.
90b079
-Common used functions are in _dracut-lib.sh_, which can be sourced by any script.
90b079
-
90b079
-=== Hook: cmdline
90b079
-
90b079
-The _cmdline_ hook is a place to insert scripts to parse the kernel command line
90b079
-and prepare the later actions, like setting up udev rules and configuration
90b079
-files.
90b079
-
90b079
-In this hook the most important environment variable is defined: root. The
90b079
-second one is rootok, which indicates, that a module claimed to be able to parse
90b079
-the root defined. So for example, **root=**__iscsi:....__ will be claimed by the
90b079
-iscsi dracut module, which then sets rootok.
90b079
-
90b079
-=== Hook: pre-udev
90b079
-
90b079
-This hook is executed right after the cmdline hook and a check if root and
90b079
-rootok were set. Here modules can take action with the final root, and before
90b079
-udev has been run.
90b079
-
90b079
-=== Start Udev
90b079
-
90b079
-Now udev is started and the logging for udev is setup.
90b079
-
90b079
-=== Hook: pre-trigger
90b079
-
90b079
-In this hook, you can set udev environment variables with **udevadm control
90b079
---property=KEY=_value_** or control the further execution of udev with
90b079
-udevadm.
90b079
-
90b079
-=== Trigger Udev
90b079
-
90b079
-udev is triggered by calling udevadm trigger, which sends add events for all
90b079
-devices and subsystems.
90b079
-
90b079
-=== Main Loop
90b079
-
90b079
-In the main loop of dracut loops until udev has settled and
90b079
-all scripts in _initqueue/finished_ returned true.
90b079
-In this loop there are three hooks, where scripts can be inserted
90b079
-by calling /sbin/initqueue.
90b079
-
90b079
-==== Initqueue
90b079
-
90b079
-This hook gets executed every time a script is inserted here, regardless of the
90b079
-udev state.
90b079
-
90b079
-==== Initqueue settled
90b079
-
90b079
-This hooks (initqueue/settled) gets executed every time udev has settled.
90b079
-
90b079
-
90b079
-==== Initqueue timeout
90b079
-
90b079
-This hooks (initqueue/timeout) gets executed, when the main loop counter becomes half of the
90b079
-rd.retry counter.
90b079
-
90b079
-==== Initqueue finished
90b079
-
90b079
-This hook (initqueue/finished) is called after udev has settled and
90b079
-if all scripts herein return 0 the main loop will be ended.
90b079
-Abritary scripts can be added here, to loop in the
90b079
-initqueue until something happens, which a dracut module wants to wait for.
90b079
-
90b079
-=== Hook: pre-mount
90b079
-
90b079
-Before the root device is mounted all scripts in the hook pre-mount are
90b079
-executed. In some cases (e.g. NFS) the real root device is already mounted,
90b079
-though.
90b079
-
90b079
-=== Hook: mount
90b079
-
90b079
-This hook is mainly to mount the real root device.
90b079
-
90b079
-=== Hook: pre-pivot
90b079
-
90b079
-This hook is called before cleanup hook, This is a good place for
90b079
-actions other than cleanups which need to be called before pivot.
90b079
-
90b079
-=== Hook: cleanup
90b079
-
90b079
-This hook is the last hook and is called before init finally switches root to
90b079
-the real root device. This is a good place to clean up and kill processes not
90b079
-needed anymore.
90b079
-
90b079
-
90b079
-=== Cleanup and switch_root
90b079
-
90b079
-Init (or systemd) kills all udev processes, cleans up the environment,
90b079
-sets up the arguments for the real init process and finally calls switch_root.
90b079
-switch_root removes the whole filesystem hierarchy of the initramfs,
90b079
-chroot()s to the real root device and calls /sbin/init with the specified arguments.
90b079
-
90b079
-To ensure all files in the initramfs hierarchy can be removed, all processes
90b079
-still running from the initramfs should not have any open file descriptors left.
90b079
-
90b079
-== Network Infrastructure
90b079
-
90b079
-FIXME
90b079
-
90b079
-== Writing a Module
90b079
-
90b079
-A simple example module is _96insmodpost_, which modprobes a kernel module after
90b079
-udev has settled and the basic device drivers have been loaded.
90b079
-
90b079
-All module installation information is in the file module-setup.sh.
90b079
-
90b079
-First we create a check() function, which just exits with 0 indicating that this
90b079
-module should be included by default.
90b079
-
90b079
-check():
90b079
-----
90b079
-return 0
90b079
-----
90b079
-
90b079
-The we create the install() function, which installs a cmdline hook with
90b079
-priority number 20 called _parse-insmodpost.sh_. It also installs the
90b079
-_insmodpost.sh_ script in _/sbin_.
90b079
-
90b079
-install():
90b079
-----
90b079
-inst_hook cmdline 20 "$moddir/parse-insmodpost.sh"
90b079
-inst_simple "$moddir/insmodpost.sh" /sbin/insmodpost.sh
90b079
-----
90b079
-
90b079
-The _pase-instmodpost.sh_ parses the kernel command line for a argument
90b079
-rd.driver.post, blacklists the module from being autoloaded and installs the
90b079
-hook _insmodpost.sh_ in the _initqueue/settled_.
90b079
-
90b079
-_parse-insmodpost.sh_:
90b079
-----
90b079
-for p in $(getargs rd.driver.post=); do
90b079
-    echo "blacklist $p" >> /etc/modprobe.d/initramfsblacklist.conf
90b079
-    _do_insmodpost=1
90b079
-done
90b079
-
90b079
-[ -n "$_do_insmodpost" ] && /sbin/initqueue --settled --unique --onetime /sbin/insmodpost.sh
90b079
-unset _do_insmodpost
90b079
-
90b079
-----
90b079
-
90b079
-_insmodpost.sh_, which is called in the _initqueue/settled_ hook will just
90b079
-modprobe the kernel modules specified in all rd.driver.post kernel command line
90b079
-parameters. It runs after udev has settled and is only called once (--onetime).
90b079
-
90b079
-_insmodpost.sh_:
90b079
-----
90b079
-. /lib/dracut-lib.sh
90b079
-
90b079
-for p in $(getargs rd.driver.post=); do
90b079
-    modprobe $p
90b079
-done
90b079
-
90b079
-----
90b079
-
90b079
-
90b079
-
90b079
-=== check()
90b079
-
90b079
-_check()_ is called by dracut to evaluate the inclusion of a dracut module in
90b079
-the initramfs.
90b079
-
90b079
-$hostonly:: If the $hostonly variable is set, then the module check() function
90b079
-should be in "hostonly" mode, which means, that the check() should only return
90b079
-0, if the module is really needed to boot this specific host.
90b079
-
90b079
-check() should return with:
90b079
-
90b079
-0:: Include the dracut module in the initramfs.
90b079
-
90b079
-1:: Do not include the dracut module. The requirements are not fullfilled
90b079
-(missing tools, etc.)
90b079
-
90b079
-255:: Only include the dracut module, if another module requires it or if
90b079
-explicitly specified in the config file or on the argument list.
90b079
-
90b079
-
90b079
-
90b079
-=== depends()
90b079
-
90b079
-The function depends() should echo all other dracut module names the module
90b079
-depends on.
90b079
-
90b079
-
90b079
-
90b079
-=== install()
90b079
-
90b079
-inst_multiple
90b079
-
90b079
-inst
90b079
-
90b079
-inst_hook
90b079
-
90b079
-inst_rules
90b079
-
90b079
-
90b079
-
90b079
-
90b079
-
90b079
-=== installkernel()
90b079
-
90b079
-instmods
90b079
-
90b079
-
90b079
-
90b079
-=== Creation Functions
90b079
-
90b079
-FIXME
90b079
-
90b079
-
90b079
-=== Initramfs Functions
90b079
-
90b079
-FIXME
90b079
-
90b079
-
90b079
-=== Network Modules
90b079
-
90b079
-FIXME
90b079
-
90b079
 :leveloffset: 1
90b079
-[[dracutbootup7]]
90b079
-include::dracut.bootup.7.asc[]
90b079
-
90b079
-:leveloffset: 1
90b079
-[[dracut8]]
90b079
 include::dracut.8.asc[]
90b079
 
90b079
+:leveloffset: 1
90b079
 [[dracutconf5]]
90b079
 include::dracut.conf.5.asc[]
90b079
 
90b079
@@ -1036,6 +161,15 @@ include::lsinitrd.1.asc[]
90b079
 [[mkinitrd8]]
90b079
 include::mkinitrd.8.asc[]
90b079
 
90b079
+= Developer Manual
90b079
+
90b079
+:leveloffset: 1
90b079
+[[dracutmodules7]]
90b079
+include::dracut.modules.7.asc[]
90b079
+
90b079
+[[dracutbootup7]]
90b079
+include::dracut.bootup.7.asc[]
90b079
+
90b079
 :leveloffset: 0
90b079
 [appendix]
90b079
 License
90b079
diff --git a/dracut.cmdline.7.asc b/dracut.cmdline.7.asc
90b079
index 4b2ab03..19bfb93 100644
90b079
--- a/dracut.cmdline.7.asc
90b079
+++ b/dracut.cmdline.7.asc
90b079
@@ -31,16 +31,16 @@ line is the value, which is honored.
90b079
 
90b079
 Standard
90b079
 ~~~~~~~~
90b079
-**init=**_<path to real init>_::
90b079
+**init=**__<path to real init>__::
90b079
     specify the path to the init programm to be started after the initramfs has
90b079
     finished
90b079
 
90b079
-**root=**_<path to blockdevice>_::
90b079
+**root=**__<path to blockdevice>__::
90b079
     specify the block device to use as the root filesystem.
90b079
 +
90b079
-E.g.:
90b079
-+
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 root=/dev/sda1
90b079
 root=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
90b079
 root=/dev/disk/by-label/Root
90b079
@@ -48,15 +48,17 @@ root=LABEL=Root
90b079
 root=/dev/disk/by-uuid/3f5ad593-4546-4a94-a374-bcfb68aa11f7
90b079
 root=UUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
90b079
 root=PARTUUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
90b079
-----
90b079
+--
90b079
 
90b079
-**rootfstype=**_<filesystem type>_:: "auto" if not specified, e.g.:
90b079
+**rootfstype=**__<filesystem type>__:: "auto" if not specified.
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 rootfstype=ext3
90b079
-----
90b079
+--
90b079
 
90b079
-**rootflags=**_<mount options>_::
90b079
+**rootflags=**__<mount options>__::
90b079
     specify additional mount options for the root filesystem. If not set,
90b079
     _/etc/fstab_ of the real root will be parsed for special mount options and
90b079
     mounted accordingly.
90b079
@@ -69,7 +71,7 @@ rootfstype=ext3
90b079
     force mounting _/_ and _/usr_ (if it is a separate device) read-write.
90b079
     See also ro option.
90b079
 
90b079
-**rootfallback=**_<path to blockdevice>_::
90b079
+**rootfallback=**__<path to blockdevice>__::
90b079
     specify the block device to use as the root filesystem, if the normal root cannot be found.
90b079
     This can only be a simple block device with a simple file system, for which the filesystem
90b079
     driver is either compiled in, or added manually to the initramfs.
90b079
@@ -83,16 +85,16 @@ rootfstype=ext3
90b079
     do not honor special mount options for the root filesystem found in
90b079
     _/etc/fstab_ of the real root.
90b079
 
90b079
-**resume=**_<path to resume partition>_::
90b079
+**resume=**__<path to resume partition>__::
90b079
     resume from a swap partition
90b079
 +
90b079
-E.g.:
90b079
-+
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 resume=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
90b079
 resume=/dev/disk/by-uuid/3f5ad593-4546-4a94-a374-bcfb68aa11f7
90b079
 resume=UUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
90b079
-----
90b079
+--
90b079
 
90b079
 **rd.skipfsck**::
90b079
     skip fsck for rootfs and _/usr_.  If you're mounting _/usr_ read-only and
90b079
@@ -102,19 +104,19 @@ resume=UUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
90b079
 
90b079
 Misc
90b079
 ~~~~
90b079
-**rd.driver.blacklist=**_<drivername>[,<drivername>,...]_::
90b079
+**rd.driver.blacklist=**__<drivername>__[,__<drivername>__,...]::
90b079
     do not load kernel module <drivername>. This parameter can be specified
90b079
     multiple times.
90b079
 
90b079
-**rd.driver.pre=**_<drivername>[,<drivername>,...]_::
90b079
+**rd.driver.pre=**__<drivername>__[,__<drivername>__,...]::
90b079
     force loading kernel module <drivername>. This parameter can be specified
90b079
     multiple times.
90b079
 
90b079
-**rd.driver.post=**_<drivername>[,<drivername>,...]_::
90b079
+**rd.driver.post=**__<drivername>__[,__<drivername>__,...]::
90b079
     force loading kernel module <drivername> after all automatic loading modules
90b079
     have been loaded. This parameter can be specified multiple times.
90b079
 
90b079
-**rd.retry=**_<seconds>_::
90b079
+**rd.retry=**__<seconds>__::
90b079
     specify how long dracut should wait for devices to appear.
90b079
     The default is 30 seconds. After 2/3 of the time, degraded raids are force
90b079
     started. If you have hardware, which takes a very long time to announce its
90b079
@@ -123,7 +125,7 @@ Misc
90b079
 **rd.noverifyssl**::
90b079
     accept self-signed certificates for ssl downloads.
90b079
 
90b079
-**rd.ctty=**_<terminal device>_**::
90b079
+**rd.ctty=**__<terminal device>__::
90b079
    specify the controlling terminal for the console.
90b079
    This is useful, if you have multiple "console=" arguments.
90b079
 
90b079
@@ -150,17 +152,20 @@ It should be attached to any report about dracut problems.
90b079
     If "quiet" is set, it also logs to the console.
90b079
 
90b079
 **rd.memdebug=[0-3]**::
90b079
-    Print memory usage info at various points, set the verbose level from 0 to 3
90b079
+    Print memory usage info at various points, set the verbose level from 0 to 3. +
90b079
     Higher level means more debugging output:
90b079
++
90b079
+----
90b079
     0 - no output
90b079
     1 - partial /proc/meminfo
90b079
     2 - /proc/meminfo
90b079
     3 - /proc/meminfo + /proc/slabinfo
90b079
+----
90b079
 
90b079
 **rd.break**::
90b079
     drop to a shell at the end
90b079
 
90b079
-**rd.break=**_{cmdline|pre-udev|pre-trigger|initqueue|pre-mount|mount|pre-pivot|cleanup}_::
90b079
+**rd.break=**__{cmdline|pre-udev|pre-trigger|initqueue|pre-mount|mount|pre-pivot|cleanup}__::
90b079
     drop to a shell on defined breakpoint
90b079
 
90b079
 **rd.udev.info**::
90b079
@@ -171,50 +176,56 @@ It should be attached to any report about dracut problems.
90b079
 
90b079
 I18N
90b079
 ~~~~
90b079
-**vconsole.keymap=**_<keymap base file name>_::
90b079
+**rd.vconsole.keymap=**__<keymap base file name>__::
90b079
     keyboard translation table loaded by loadkeys; taken from keymaps directory;
90b079
-    will be written as KEYMAP to _/etc/vconsole.conf_ in the initramfs, e.g.:
90b079
+    will be written as KEYMAP to _/etc/vconsole.conf_ in the initramfs.
90b079
 +
90b079
-----
90b079
-vconsole.keymap=de-latin1-nodeadkeys
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
+rd.vconsole.keymap=de-latin1-nodeadkeys
90b079
+--
90b079
 
90b079
-**vconsole.keymap.ext=**_<list of keymap base file names>_::
90b079
+**rd.vconsole.keymap.ext=**__<list of keymap base file names>__::
90b079
     list of extra keymaps to bo loaded (sep. by space); will be written as
90b079
     EXT_KEYMAP to _/etc/vconsole.conf_ in the initramfs
90b079
 
90b079
-**vconsole.unicode**[=_{0|1}_]::
90b079
+**rd.vconsole.unicode**::
90b079
     boolean, indicating UTF-8 mode; will be written as UNICODE to
90b079
     _/etc/vconsole.conf_ in the initramfs
90b079
 
90b079
-**vconsole.font=**_<font base file name>_::
90b079
+**rd.vconsole.font=**__<font base file name>__::
90b079
     console font; taken from consolefonts directory; will be written as FONT to
90b079
-    _/etc/vconsole.conf_ in the initramfs; e.g.:
90b079
+    _/etc/vconsole.conf_ in the initramfs.
90b079
 +
90b079
-----
90b079
-vconsole.font=LatArCyrHeb-16
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
+rd.vconsole.font=LatArCyrHeb-16
90b079
+--
90b079
 
90b079
-**vconsole.font.map=**_<console map base file name>_::
90b079
+**rd.vconsole.font.map=**__<console map base file name>__::
90b079
     see description of '-m' parameter in setfont manual; taken from consoletrans
90b079
     directory; will be written as FONT_MAP to _/etc/vconsole.conf_ in the
90b079
     initramfs
90b079
 
90b079
-**vconsole.font.unimap=**_<unicode table base file name>_::
90b079
+**rd.vconsole.font.unimap=**__<unicode table base file name>__::
90b079
     see description of '-u' parameter in setfont manual; taken from unimaps
90b079
     directory; will be written as FONT_UNIMAP to _/etc/vconsole.conf_ in the
90b079
     initramfs
90b079
 
90b079
-**locale.LANG=**_<locale>_::
90b079
+**rd.locale.LANG=**__<locale>__::
90b079
     taken from the environment; if no UNICODE is defined we set its value in
90b079
     basis of LANG value (whether it ends with ".utf8" (or similar) or not); will
90b079
-    be written as LANG to _/etc/locale.conf_ in the initramfs; e.g.:
90b079
+    be written as LANG to _/etc/locale.conf_ in the initramfs.
90b079
 +
90b079
-----
90b079
-locale.LANG=pl_PL.utf8
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
+rd.locale.LANG=pl_PL.utf8
90b079
+--
90b079
 
90b079
-**locale.LC_ALL=**_<locale>_::
90b079
+**rd.locale.LC_ALL=**__<locale>__::
90b079
     taken from the environment; will be written as LC_ALL to _/etc/locale.conf_
90b079
     in the initramfs
90b079
 
90b079
@@ -223,11 +234,11 @@ LVM
90b079
 **rd.lvm=0**::
90b079
     disable LVM detection
90b079
 
90b079
-**rd.lvm.vg=**_<volume group name>_::
90b079
+**rd.lvm.vg=**__<volume group name>__::
90b079
     only activate the volume groups with the given name. rd.lvm.vg can be
90b079
     specified multiple times on the kernel command line.
90b079
 
90b079
-**rd.lvm.lv=**_<logical volume name>_::
90b079
+**rd.lvm.lv=**__<logical volume name>__::
90b079
     only activate the logical volumes with the given name. rd.lvm.lv can be
90b079
     specified multiple times on the kernel command line.
90b079
 
90b079
@@ -239,14 +250,14 @@ crypto LUKS
90b079
 **rd.luks=0**::
90b079
     disable crypto LUKS detection
90b079
 
90b079
-**rd.luks.uuid=**_<luks uuid>_::
90b079
+**rd.luks.uuid=**__<luks uuid>__::
90b079
     only activate the LUKS partitions with the given UUID. Any "luks-" of the
90b079
     LUKS UUID is removed before comparing to _<luks uuid>_.
90b079
     The comparisons also matches, if _<luks uuid>_ is only the beginning of the
90b079
     LUKS UUID, so you don't have to specify the full UUID.
90b079
     This parameter can be specified multiple times.
90b079
 
90b079
-**rd.luks.allow-discards=**_<luks uuid>_::
90b079
+**rd.luks.allow-discards=**__<luks uuid>__::
90b079
     Allow  using  of discards (TRIM) requests for LUKS partitions with the given UUID.
90b079
     Any "luks-" of the LUKS UUID is removed before comparing to _<luks uuid>_.
90b079
     The comparisons also matches, if _<luks uuid>_ is only the beginning of the
90b079
@@ -261,16 +272,18 @@ crypto LUKS
90b079
 
90b079
 crypto LUKS - key on removable device support
90b079
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90b079
-**rd.luks.key=**_<keypath>:<keydev>:<luksdev>_::
90b079
+**rd.luks.key=**__<keypath>__:__<keydev>__:__<luksdev>__::
90b079
     _keypath_ is a path to key file to look for. It's REQUIRED. When _keypath_ ends with '.gpg' it's considered to be key encrypted symmetrically with GPG. You will be prompted for password on boot. GPG support comes with 'crypt-gpg' module which needs to be added explicitly.
90b079
 +
90b079
 _keydev_ is a device on which key file resides. It might be kernel name of devices (should start with "/dev/"), UUID (prefixed with "UUID=") or label (prefix with "LABEL="). You don't have to specify full UUID. Just its beginning will suffice, even if its ambiguous. All matching devices will be probed. This parameter is recommended, but not required. If not present, all block devices will be probed, which may significantly increase boot time.
90b079
 +
90b079
 If _luksdev_ is given, the specified key will only be applied for that LUKS device. Possible values are the same as for _keydev_. Unless you have several LUKS devices, you don't have to specify this parameter. The simplest usage is:
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 rd.luks.key=/foo/bar.key
90b079
-----
90b079
+--
90b079
 +
90b079
 As you see, you can skip colons in such a case.
90b079
 +
90b079
@@ -281,20 +294,20 @@ to crypsetup luksFormat with _-d -_, too!
90b079
 
90b079
 Here follows example for key encrypted with GPG:
90b079
 
90b079
-----
90b079
-gpg --quiet --decrypt rootkey.gpg \
90b079
-| cryptsetup -d - -v \
90b079
---cipher serpent-cbc-essiv:sha256 \
90b079
+[listing]
90b079
+--
90b079
+gpg --quiet --decrypt rootkey.gpg | \
90b079
+cryptsetup -d - -v --cipher serpent-cbc-essiv:sha256 \
90b079
 --key-size 256 luksFormat /dev/sda3
90b079
-----
90b079
+--
90b079
 
90b079
 If you use plain keys, just add path to _-d_ option:
90b079
 
90b079
-----
90b079
-cryptsetup -d rootkey.key -v \
90b079
---cipher serpent-cbc-essiv:sha256 \
90b079
---key-size 256 luksFormat /dev/sda3
90b079
-----
90b079
+[listing]
90b079
+--
90b079
+cryptsetup -d rootkey.key -v --cipher serpent-cbc-essiv:sha256 \
90b079
+ --key-size 256 luksFormat /dev/sda3
90b079
+--
90b079
 ===============================
90b079
 
90b079
 MD RAID
90b079
@@ -314,7 +327,7 @@ MD RAID
90b079
 **rd.md.waitclean=1**::
90b079
     wait for any resync, recovery, or reshape activity to finish before continuing
90b079
 
90b079
-**rd.md.uuid=**_<md raid uuid>_::
90b079
+**rd.md.uuid=**__<md raid uuid>__::
90b079
     only activate the raid sets with the given UUID. This parameter can be
90b079
     specified multiple times.
90b079
 
90b079
@@ -323,7 +336,7 @@ DM RAID
90b079
 **rd.dm=0**::
90b079
     disable DM RAID detection
90b079
 
90b079
-**rd.dm.uuid=**_<dm raid uuid>_::
90b079
+**rd.dm.uuid=**__<dm raid uuid>__::
90b079
    only activate the raid sets with the given UUID. This parameter can be
90b079
    specified multiple times.
90b079
 
90b079
@@ -332,15 +345,17 @@ FIPS
90b079
 **rd.fips**::
90b079
     enable FIPS
90b079
 
90b079
-**boot=**_<boot device>_::
90b079
-    specify the device, where /boot is located. e.g.
90b079
+**boot=**__<boot device>__::
90b079
+    specify the device, where /boot is located.
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 boot=/dev/sda1
90b079
 boot=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
90b079
 boot=UUID=<uuid>
90b079
 boot=LABEL=<label>
90b079
-----
90b079
+--
90b079
 
90b079
 **rd.fips.skipkernel**::
90b079
     skip checksum check of the kernel image. Useful, if the kernel image is not
90b079
@@ -348,7 +363,66 @@ boot=LABEL=<label>
90b079
 
90b079
 Network
90b079
 ~~~~~~~
90b079
-**ip=**_{dhcp|on|any|dhcp6|auto6|ibft}_::
90b079
+
90b079
+[IMPORTANT]
90b079
+=====================
90b079
+It is recommended to either bind an interface to a MAC with the **ifname** argument,
90b079
+or to use the systemd-udevd predictable network interface names.
90b079
+
90b079
+Predictable network interface device names based on:
90b079
+
90b079
+- firmware/bios-provided index numbers for on-board devices
90b079
+- firmware-provided pci-express hotplug slot index number
90b079
+- physical/geographical location of the hardware
90b079
+- the interface's MAC address
90b079
+
90b079
+See: http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames
90b079
+
90b079
+Two character prefixes based on the type of interface:
90b079
+
90b079
+en:: ethernet
90b079
+wl:: wlan
90b079
+ww:: wwan
90b079
+
90b079
+Type of names:
90b079
+
90b079
+o<index>:: on-board device index number
90b079
+s<slot>[f<function>][d<dev_id>]:: hotplug slot index number
90b079
+x<MAC>:: MAC address
90b079
+[P<domain>]p<bus>s<slot>[f<function>][d<dev_id>]:: PCI geographical location
90b079
+[P<domain>]p<bus>s<slot>[f<function>][u<port>][..][c<config>][i<interface>]:: USB port number chain
90b079
+
90b079
+All multi-function PCI devices will carry the [f<function>] number in the
90b079
+device name, including the function 0 device.
90b079
+
90b079
+When using PCI geography, The PCI domain is only prepended when it is not 0.
90b079
+
90b079
+For USB devices the full chain of port numbers of hubs is composed. If the
90b079
+name gets longer than the maximum number of 15 characters, the name is not
90b079
+exported.
90b079
+The usual USB configuration == 1 and interface == 0 values are suppressed.
90b079
+
90b079
+PCI ethernet card with firmware index "1"::
90b079
+* eno1
90b079
+
90b079
+PCI ethernet card in hotplug slot with firmware index number::
90b079
+* ens1
90b079
+
90b079
+PCI ethernet multi-function card with 2 ports::
90b079
+* enp2s0f0
90b079
+* enp2s0f1
90b079
+
90b079
+PCI wlan card::
90b079
+* wlp3s0
90b079
+
90b079
+USB built-in 3G modem::
90b079
+* wwp0s29u1u4i6
90b079
+
90b079
+USB Android phone::
90b079
+* enp0s29u1u2
90b079
+=====================
90b079
+
90b079
+**ip=**__{dhcp|on|any|dhcp6|auto6|ibft}__::
90b079
     dhcp|on|any::: get ip from dhcp server from all interfaces. If root=dhcp, loop
90b079
     sequentially through all interfaces (eth0, eth1, ...) and use the first with
90b079
     a valid DHCP root-path.
90b079
@@ -359,7 +433,7 @@ Network
90b079
 
90b079
     ibft::: iBFT autoconfiguration
90b079
 
90b079
-**ip=**_<interface>_:_{dhcp|on|any|dhcp6|auto6}_[:[_<mtu>_][:_<macaddr>_]]::
90b079
+**ip=**__<interface>__:__{dhcp|on|any|dhcp6|auto6}__[:[__<mtu>__][:__<macaddr>__]]::
90b079
     This parameter can be specified multiple times.
90b079
 +
90b079
 =====================
90b079
@@ -370,16 +444,7 @@ cannot be used in conjunction with the **ifname** argument for the
90b079
 same <interface>.
90b079
 =====================
90b079
 
90b079
-[IMPORTANT]
90b079
-=====================
90b079
-It is recommended to either bind <interface> to a MAC with the **ifname**
90b079
-argument. Or use biosdevname to name your interfaces, which will then have names according to their hardware location.
90b079
-
90b079
-em<port>::: for embedded NICs
90b079
-p<slot>#<port>_<virtual instance>::: for cards in PCI slots
90b079
-=====================
90b079
-
90b079
-**ip=**_<client-IP>_:_<server-IP>_:_<gateway-IP>_:_<netmask>_:_<client_hostname>_:_<interface>_:_{none|off|dhcp|on|any|dhcp6|auto6|ibft}_[:[_<mtu>_][:_<macaddr>_]]::
90b079
+**ip=**__<client-IP>__:__<server-IP>__:__<gateway-IP>__:__<netmask>__:__<client_hostname>__:__<interface>__:__{none|off|dhcp|on|any|dhcp6|auto6|ibft}__:[:[__<mtu>__][:__<macaddr>__]]::
90b079
     explicit network configuration. If you want do define a IPv6 address, put it
90b079
     in brackets (e.g. [2001:DB8::1]). This parameter can be specified multiple
90b079
     times.
90b079
@@ -390,25 +455,14 @@ cannot be used in conjunction with the **ifname** argument for the
90b079
 same <interface>.
90b079
 =====================
90b079
 
90b079
-[IMPORTANT]
90b079
-=====================
90b079
-It is recommended to either bind <interface> to a MAC with the **ifname**
90b079
-argument. Or use biosdevname to name your interfaces, which will then have names according to their hardware location.
90b079
-
90b079
-em<port>::: for embedded NICs
90b079
-p<slot>#<port>_<virtual instance>::: for cards in PCI slots
90b079
-=====================
90b079
-
90b079
-**ifname=**_<interface>_:_<MAC>_::
90b079
+**ifname=**__<interface>__:__<MAC>__::
90b079
     Assign network device name <interface> (ie "bootnet") to the NIC with MAC <MAC>.
90b079
 +
90b079
-[IMPORTANT]
90b079
-
90b079
-Do **not** use the default kernel naming scheme for the interface name,
90b079
+WARNING: Do **not** use the default kernel naming scheme for the interface name,
90b079
 as it can conflict with the kernel names. So, don't use "eth[0-9]+" for the
90b079
 interface name. Better name it "bootnet" or "bluesocket".
90b079
 
90b079
-**bootdev=**_<interface>_::
90b079
+**bootdev=**__<interface>__::
90b079
     specify network interface to use routing and netroot information from.
90b079
     Required if multiple ip= lines are used.
90b079
 
90b079
@@ -421,12 +475,12 @@ interface name. Better name it "bootnet" or "bluesocket".
90b079
 **rd.neednet=1**::
90b079
     boolean, bring up network even without netroot set
90b079
 
90b079
-**vlan=_<vlanname>_:_<phydevice>_**::
90b079
+**vlan=**__<vlanname>__:__<phydevice>__::
90b079
     Setup vlan device named <vlanname> on <phydeivce>.
90b079
     We support the four styles of vlan names: VLAN_PLUS_VID (vlan0005), VLAN_PLUS_VID_NO_PAD (vlan5),
90b079
     DEV_PLUS_VID (eth0.0005), DEV_PLUS_VID_NO_PAD (eth0.5)
90b079
 
90b079
-**bond=_<bondname>_[:_<bondslaves>_:[:_<options>_]]**::
90b079
+**bond=**__<bondname>__[:__<bondslaves>__:[:__<options>__]]::
90b079
     Setup bonding device <bondname> on top of <bondslaves>.
90b079
     <bondslaves> is a comma-separated list of physical (ethernet) interfaces.
90b079
     <options> is a comma-separated list on bonding options (modinfo bonding for details)
90b079
@@ -434,68 +488,63 @@ interface name. Better name it "bootnet" or "bluesocket".
90b079
     then its values should be separated by semicolon.
90b079
     Bond without parameters assumes bond=bond0:eth0,eth1:mode=balance-rr
90b079
 
90b079
-**team =_<teammaster>_:_<teamslaves>_**::
90b079
+**team=**__<teammaster>__:__<teamslaves>__::
90b079
     Setup team device <teammaster> on top of <teamslaves>.
90b079
     <teamslaves> is a comma-separated list of physical (ethernet) interfaces.
90b079
 
90b079
-**bridge=_<bridgename>_:_<ethnames>_**::
90b079
+**bridge=**__<bridgename>__:__<ethnames>__::
90b079
     Setup bridge <bridgename> with <ethnames>. <ethnames> is a comma-separated
90b079
     list of physical (ethernet) interfaces. Bridge without parameters assumes bridge=br0:eth0
90b079
 
90b079
-
90b079
 NFS
90b079
 ~~~
90b079
-**root=**[_<server-ip>_:]_<root-dir>_[:_<nfs-options>_]::
90b079
+**root=**\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__]::
90b079
     mount nfs share from <server-ip>:/<root-dir>, if no server-ip is given, use
90b079
     dhcp next_server. if server-ip is an IPv6 address it has to be put in
90b079
     brackets, e.g. [2001:DB8::1]. NFS options can be appended with the prefix
90b079
     ":" or "," and are seperated by ",".
90b079
 
90b079
-**root=**nfs:[_<server-ip>_:]_<root-dir>_[:_<nfs-options>_], **root=**nfs4:[_<server-ip>_:]_<root-dir>_[:_<nfs-options>_], **root=**_{dhcp|dhcp6}_::
90b079
+**root=**nfs:\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__], **root=**nfs4:\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__], **root=**__{dhcp|dhcp6}__::
90b079
     root=dhcp alone directs initrd to look at the DHCP root-path where NFS
90b079
     options can be specified.
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
     root-path=<server-ip>:<root-dir>[,<nfs-options>]
90b079
     root-path=nfs:<server-ip>:<root-dir>[,<nfs-options>]
90b079
     root-path=nfs4:<server-ip>:<root-dir>[,<nfs-options>]
90b079
-----
90b079
+--
90b079
 
90b079
-**root=**_/dev/nfs_ nfsroot=[_<server-ip>_:]_<root-dir>_[:_<nfs-options>_]::
90b079
+**root=**_/dev/nfs_ nfsroot=\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__]::
90b079
     _Deprecated!_ kernel Documentation_/filesystems/nfsroot.txt_ defines this
90b079
     method. This is supported by dracut, but not recommended.
90b079
 
90b079
-**rd.nfs.domain=**_<NFSv4 domain name>_::
90b079
+**rd.nfs.domain=**__<NFSv4 domain name>__::
90b079
     Set the NFSv4 domain name. Will overwrite the settings in _/etc/idmap.conf_.
90b079
 
90b079
 CIFS
90b079
 ~~~
90b079
-**root=**cifs://[_<username>_[:_<password>_]@]_<server-ip>_:_<root-dir>_::
90b079
+**root=**cifs://[__<username>__[:__<password>__]@]__<server-ip>__:__<root-dir>__::
90b079
     mount cifs share from <server-ip>:/<root-dir>, if no server-ip is given, use
90b079
     dhcp next_server. if server-ip is an IPv6 address it has to be put in
90b079
     brackets, e.g. [2001:DB8::1]. If a username or password are not specified
90b079
 as part of the root, then they must be passed on the command line through
90b079
 cifsuser/cifspass.
90b079
 +
90b079
-[WARNING]
90b079
-====
90b079
-Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path.
90b079
-====
90b079
+WARNING: Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path.
90b079
 
90b079
-**cifsuser=_<username>_::
90b079
+**cifsuser**=__<username>__::
90b079
     Set the cifs username, if not specified as part of the root.
90b079
 
90b079
-**cifspass=_<password>_::
90b079
+**cifspass**=__<password>__::
90b079
     Set the cifs password, if not specified as part of the root.
90b079
 +
90b079
-[WARNING]
90b079
-====
90b079
-Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path.
90b079
-====
90b079
+WARNING: Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path.
90b079
 
90b079
 iSCSI
90b079
 ~~~~~
90b079
-**root=**iscsi:[_<username>_:_<password>_[:_<reverse>_:_<password>_]@][_<servername>_]:[_<protocol>_]:[_<port>_][:[_<iscsi_iface_name>_]:[_<netdev_name>_]]:[_<LUN>_]:_<targetname>_::
90b079
+**root=**iscsi:[__<username>__:__<password>__[:__<reverse>__:__<password>__]@][__<servername>__]:[__<protocol>__]:[__<port>__][:[__<iscsi_iface_name>__]:[__<netdev_name>__]]:[__<LUN>__]:__<targetname>__::
90b079
     protocol defaults to "6", LUN defaults to "0". If the "servername" field is
90b079
     provided by BOOTP or DHCP, then that field is used in conjunction with other
90b079
     associated fields to contact the boot server in the Boot stage. However, if
90b079
@@ -503,85 +552,84 @@ iSCSI
90b079
     used in the Discovery Service stage in conjunction with other associated
90b079
     fields. See
90b079
     link:$$http://tools.ietf.org/html/rfc4173#section-5$$[rfc4173].
90b079
-    e.g.:
90b079
 +
90b079
-----
90b079
+WARNING: Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path.
90b079
++
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
90b079
-----
90b079
+--
90b079
 +
90b079
-If servername is an IPv6 address, it has to be put in brackets. e.g.:
90b079
+If servername is an IPv6 address, it has to be put in brackets:
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 root=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0
90b079
-----
90b079
-+
90b079
-[WARNING]
90b079
-====
90b079
-Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path.
90b079
-====
90b079
+--
90b079
 
90b079
-**root=**_???_ **netroot=**iscsi:[_<username>_:_<password>_[:_<reverse>_:_<password>_]@][_<servername>_]:[_<protocol>_]:[_<port>_][:[_<iscsi_iface_name>_]:[_<netdev_name>_]]:[_<LUN>_]:_<targetname>_ ...::
90b079
-    multiple netroot options allow setting up multiple iscsi disks. e.g.:
90b079
+**root=**__???__ **netroot=**iscsi:[__<username>__:__<password>__[:__<reverse>__:__<password>__]@][__<servername>__]:[__<protocol>__]:[__<port>__][:[__<iscsi_iface_name>__]:[__<netdev_name>__]]:[__<LUN>__]:__<targetname>__ ...::
90b079
+    multiple netroot options allow setting up multiple iscsi disks:
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 root=UUID=12424547
90b079
 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
90b079
 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1
90b079
-----
90b079
+--
90b079
 +
90b079
-If servername is an IPv6 address, it has to be put in brackets. e.g.:
90b079
+If servername is an IPv6 address, it has to be put in brackets:
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 netroot=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0
90b079
-----
90b079
+--
90b079
 +
90b079
-[WARNING]
90b079
-====
90b079
-Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path. You may want to use rd.iscsi.firmware.
90b079
-====
90b079
+WARNING: Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path. You may want to use rd.iscsi.firmware.
90b079
 
90b079
-**root=**_???_ **rd.iscsi.initiator=**_<initiator>_ **rd.iscsi.target.name=**_<target name>_  **rd.iscsi.target.ip=**_<target ip>_ **rd.iscsi.target.port=**_<target port>_ **rd.iscsi.target.group=**_<target group>_ **rd.iscsi.username=**_<username>_ **rd.iscsi.password=**_<password>_ **rd.iscsi.in.username=**_<in username>_ **rd.iscsi.in.password=**_<in password>_::
90b079
+**root=**__???__ **rd.iscsi.initiator=**__<initiator>__ **rd.iscsi.target.name=**__<target name>__  **rd.iscsi.target.ip=**__<target ip>__ **rd.iscsi.target.port=**__<target port>__ **rd.iscsi.target.group=**__<target group>__ **rd.iscsi.username=**__<username>__ **rd.iscsi.password=**__<password>__ **rd.iscsi.in.username=**__<in username>__ **rd.iscsi.in.password=**__<in password>__::
90b079
     manually specify all iscsistart parameter (see **+iscsistart --help+**)
90b079
 +
90b079
-[WARNING]
90b079
-====
90b079
-Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path. You may want to use rd.iscsi.firmware.
90b079
-====
90b079
+WARNING: Passwords specified on the kernel command line are visible for all users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the network, when using DHCP with DHCP root-path. You may want to use rd.iscsi.firmware.
90b079
 
90b079
 **root=**_???_ **netroot=**iscsi **rd.iscsi.firmware=1**::
90b079
  will read the iscsi parameter from the BIOS firmware
90b079
 
90b079
-**rd.iscsi.param=**_<param>_::
90b079
+**rd.iscsi.param=**__<param>__::
90b079
     <param> will be passed as "--param <param>" to iscsistart.
90b079
     This parameter can be specified multiple times.
90b079
-    e.g.:
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 "netroot=iscsi rd.iscsi.firmware=1 rd.iscsi.param=node.session.timeo.replacement_timeout=30"
90b079
-----
90b079
+--
90b079
 +
90b079
 will result in
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+--
90b079
 iscsistart -b --param node.session.timeo.replacement_timeout=30
90b079
-----
90b079
+--
90b079
 
90b079
 FCoE
90b079
 ~~~~
90b079
-**fcoe=**_<edd|interface|MAC>_:_{dcb|nodcb}_::
90b079
+**fcoe=**__<edd|interface|MAC>__:__{dcb|nodcb}__::
90b079
     Try to connect to a FCoE SAN through the NIC specified by _<interface>_ or
90b079
     _<MAC>_ or EDD settings. For the second argument, currently only nodcb is
90b079
     supported. This parameter can be specified multiple times.
90b079
 +
90b079
-[NOTE]
90b079
-letters in the MAC-address must be lowercase!
90b079
+NOTE: letters in the MAC-address must be lowercase!
90b079
 
90b079
 NBD
90b079
 ~~~
90b079
-**root=**??? **netroot=**nbd:_<server>_:_<port>_[:_<fstype>_[:_<mountopts>_[:_<nbdopts>_]]]::
90b079
+**root=**??? **netroot=**nbd:__<server>__:__<port>__[:__<fstype>__[:__<mountopts>__[:__<nbdopts>__]]]::
90b079
     mount nbd share from <server>
90b079
 
90b079
-**root=dhcp** with **dhcp** **root-path=**nbd:_<server>_:_<port>_[:_<fstype>_[:_<mountopts>_[:_<nbdopts>_]]]::
90b079
+**root=dhcp** with **dhcp** **root-path=**nbd:__<server>__:__<port>__[:__<fstype>__[:__<mountopts>__[:__<nbdopts>__]]]::
90b079
     root=dhcp alone directs initrd to look at the DHCP root-path where NBD
90b079
     options can be specified. This syntax is only usable in cases where you are
90b079
     directly mounting the volume as the rootfs.
90b079
@@ -593,25 +641,29 @@ DASD
90b079
 
90b079
 ZFCP
90b079
 ~~~~
90b079
-**rd.zfcp=**_<zfcp adaptor device bus ID>_,_<WWPN>_,_<FCPLUN>_::
90b079
-    rd.zfcp can be specified multiple times on the kernel command line. e.g.: 
90b079
+**rd.zfcp=**__<zfcp adaptor device bus ID>__,__<WWPN>__,__<FCPLUN>__::
90b079
+    rd.zfcp can be specified multiple times on the kernel command line.
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 rd.zfcp=0.0.4000,0x5005076300C213e9,0x5022000000000000
90b079
-----
90b079
+--
90b079
 
90b079
 **rd.zfcp.conf=0**::
90b079
     ignore zfcp.conf included in the initramfs
90b079
 
90b079
 ZNET
90b079
 ~~~~
90b079
-**rd.znet=**_<nettype>_,_<subchannels>_,_<options>_::
90b079
-    rd.znet can be specified multiple times on the kernel command line. e.g.: 
90b079
+**rd.znet=**__<nettype>__,__<subchannels>__,__<options>__::
90b079
+    rd.znet can be specified multiple times on the kernel command line.
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 rd.znet=qeth,0.0.0600,0.0.0601,0.0.0602,layer2=1,portname=foo
90b079
 rd.znet=ctc,0.0.0600,0.0.0601,protocol=bar
90b079
-----
90b079
+--
90b079
 
90b079
 Plymouth Boot Splash
90b079
 ~~~~~~~~~~~~~~~~~~~~
90b079
@@ -623,33 +675,41 @@ Plymouth Boot Splash
90b079
 
90b079
 Kernel keys
90b079
 ~~~~~~~~~~~
90b079
-**masterkey=**_<kernel master key path name>_::
90b079
-    Set the path name of the kernel master key. e.g.: 
90b079
+**masterkey=**__<kernel master key path name>__::
90b079
+    Set the path name of the kernel master key.
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 masterkey=/etc/keys/kmk-trusted.blob
90b079
-----
90b079
+--
90b079
 
90b079
-**masterkeytype=**_<kernel master key type>_::
90b079
-    Set the type of the kernel master key. e.g.: 
90b079
+**masterkeytype=**__<kernel master key type>__::
90b079
+    Set the type of the kernel master key.
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 masterkeytype=trusted
90b079
-----
90b079
+--
90b079
 
90b079
-**evmkey=**_<EVM key path name>_::
90b079
-    Set the path name of the EVM key. e.g.: 
90b079
+**evmkey=**__<EVM key path name>__::
90b079
+    Set the path name of the EVM key.
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 evmkey=/etc/keys/evm-trusted.blob
90b079
-----
90b079
+--
90b079
 
90b079
-**ecryptfskey=**_<eCryptfs key path name>_::
90b079
-    Set the path name of the eCryptfs key. e.g.: 
90b079
+**ecryptfskey=**__<eCryptfs key path name>__::
90b079
+    Set the path name of the eCryptfs key.
90b079
 +
90b079
-----
90b079
+[listing]
90b079
+.Example
90b079
+--
90b079
 ecryptfskey=/etc/keys/ecryptfs-trusted.blob
90b079
-----
90b079
+--
90b079
 
90b079
 Deprecated, renamed Options
90b079
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
90b079
diff --git a/dracut.css b/dracut.css
90b079
index e419a06..357ede1 100644
90b079
--- a/dracut.css
90b079
+++ b/dracut.css
90b079
@@ -14,45 +14,6 @@ body {
90b079
 	color:black;
90b079
 }
90b079
 
90b079
-body.toc_embeded {
90b079
-	/*for web hosting system only*/
90b079
-	margin-left: 300px;
90b079
-}
90b079
-
90b079
-object.toc, iframe.toc {
90b079
-	/*for web hosting system only*/
90b079
-	border-style:none;
90b079
-	position:fixed;
90b079
-	width:290px;
90b079
-	height:99.99%;
90b079
-	top:0;
90b079
-	left:0;
90b079
-	z-index: 100;
90b079
-	border-style:none;
90b079
-	border-right:1px solid #999;
90b079
-}
90b079
-
90b079
-/* Hide web menu */
90b079
-
90b079
-body.notoc {
90b079
-	margin-left: 3em;
90b079
-}
90b079
-
90b079
-iframe.notoc {
90b079
-	border-style:none;
90b079
-	border: none;
90b079
-	padding: 0em;
90b079
-	position:fixed;
90b079
-	width: 21px;
90b079
-	height: 29px;
90b079
-	top: 0px;
90b079
-	left:0;
90b079
-	overflow: hidden;
90b079
-	margin: 0em;
90b079
-	margin-left: -3px;
90b079
-}
90b079
-/* End hide web menu */
90b079
-
90b079
 /* desktop styles */
90b079
 body.desktop {
90b079
 	margin-left: 26em;
90b079
@@ -166,7 +127,6 @@ h1 {
90b079
 	margin-bottom: 0em;
90b079
 	font-size: 3.0em;
90b079
 	font-weight: bold;
90b079
-	background: #003d6e url(../images/h1-bg.png) top left repeat-x;
90b079
 	color: white;
90b079
 	text-align: center;
90b079
 	padding: 0.7em;
90b079
@@ -480,106 +440,14 @@ h3.author {
90b079
 	font-weight:bold;
90b079
 }
90b079
 
90b079
-/* inline syntax highlighting */
90b079
-.perl_Alert {
90b079
-	color: #0000ff;
90b079
-}
90b079
-
90b079
-.perl_BaseN {
90b079
-	color: #007f00;
90b079
-}
90b079
-
90b079
-.perl_BString {
90b079
-	color: #5C3566;
90b079
-}
90b079
-
90b079
-.perl_Char {
90b079
-	color: #ff00ff;
90b079
-}
90b079
-
90b079
-.perl_Comment {
90b079
-	color: #FF00FF;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_DataType {
90b079
-	color: #0000ff;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_DecVal {
90b079
-	color: #00007f;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_Error {
90b079
-	color: #ff0000;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_Float {
90b079
-	color: #00007f;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_Function {
90b079
-	color: #007f00;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_IString {
90b079
-	color: #5C3566;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_Keyword {
90b079
-	color: #002F5D;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_Operator {
90b079
-	color: #ffa500;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_Others {
90b079
-	color: #b03060;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_RegionMarker {
90b079
-	color: #96b9ff;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_Reserved {
90b079
-	color: #9b30ff;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_String {
90b079
-	color: #5C3566;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_Variable {
90b079
-	color: #0000ff;
90b079
-}
90b079
-
90b079
-
90b079
-.perl_Warning {
90b079
-	color: #0000ff;
90b079
-}
90b079
 
90b079
 /*Lists*/
90b079
 ul {
90b079
 	padding-left:1.6em;
90b079
-	list-style-image:url(../images/dot.png);
90b079
 	list-style-type: circle;
90b079
 }
90b079
 
90b079
 ul ul {
90b079
-	list-style-image:url(../images/dot2.png);
90b079
 	list-style-type: circle;
90b079
 }
90b079
 
90b079
@@ -769,21 +637,6 @@ code {
90b079
 	word-wrap: break-word; /* Internet Explorer 5.5+ */
90b079
 }
90b079
 
90b079
-/*Notifications*/
90b079
-div.warning:before {
90b079
-	content:url(../images/warning.png);
90b079
-	padding-left: 5px;
90b079
-}
90b079
-
90b079
-div.note:before {
90b079
-	content:url(../images/note.png);
90b079
-	padding-left: 5px;
90b079
-}
90b079
-
90b079
-div.important:before {
90b079
-	content:url(../images/important.png);
90b079
-	padding-left: 5px;
90b079
-}
90b079
 
90b079
 div.warning, div.note, div.important {
90b079
 	color: black;
90b079
@@ -792,7 +645,8 @@ div.warning, div.note, div.important {
90b079
 	background: none;
90b079
 	background-color: white;
90b079
 	margin-bottom: 1em;
90b079
-	border-bottom: 1px solid #aaaaaa;
90b079
+	padding-left: 1em;
90b079
+	border-left: 2px solid #aaaaaa;
90b079
 }
90b079
 
90b079
 div.warning h2, div.note h2,div.important h2 {
90b079
@@ -817,20 +671,6 @@ div.admonition_header {
90b079
 	font-size: 1.0em;
90b079
 }
90b079
 
90b079
-div.warning div.admonition_header {
90b079
-	background: url(../images/red.png) top left repeat-x;
90b079
-	background-color: #590000;
90b079
-}
90b079
-
90b079
-div.note div.admonition_header {
90b079
-	background: url(../images/green.png) top right repeat-x;
90b079
-	background-color: #597800;
90b079
-}
90b079
-
90b079
-div.important div.admonition_header {
90b079
-	background: url(../images/yellow.png) top right repeat-x;
90b079
-	background-color: #a6710f;
90b079
-}
90b079
 
90b079
 div.warning p, div.warning div.para,
90b079
 div.note p, div.note div.para,
90b079
@@ -1131,266 +971,6 @@ ul li p:last-child, ul li div.para:last-child {
90b079
 	padding-bottom:0em;
90b079
 }
90b079
 
90b079
-/*document navigation*/
90b079
-.docnav a, .docnav strong {
90b079
-	border:none;
90b079
-	text-decoration:none;
90b079
-	font-weight:normal;
90b079
-}
90b079
-
90b079
-.docnav {
90b079
-	list-style:none;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-	position:relative;
90b079
-	width:100%;
90b079
-	padding-bottom:2em;
90b079
-	padding-top:1em;
90b079
-	border-top:1px dotted #ccc;
90b079
-}
90b079
-
90b079
-.docnav li {
90b079
-	list-style:none;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-	display:inline;
90b079
-	font-size:.8em;
90b079
-}
90b079
-
90b079
-.docnav li:before {
90b079
-	content:" ";
90b079
-}
90b079
-
90b079
-.docnav li.previous, .docnav li.next {
90b079
-	position:absolute;
90b079
-	top:1em;
90b079
-}
90b079
-
90b079
-.docnav li.up, .docnav li.home {
90b079
-	margin:0em 1.5em;
90b079
-}
90b079
-
90b079
-.docnav li.previous {
90b079
-	left:0px;
90b079
-	text-align:left;
90b079
-}
90b079
-
90b079
-.docnav li.next {
90b079
-	right:0px;
90b079
-	text-align:right;
90b079
-}
90b079
-
90b079
-.docnav li.previous strong, .docnav li.next strong {
90b079
-	height:22px;
90b079
-	display:block;
90b079
-}
90b079
-
90b079
-.docnav {
90b079
-	margin:0 auto;
90b079
-	text-align:center;
90b079
-}
90b079
-
90b079
-.docnav li.next a strong {
90b079
-	background:  url(../images/stock-go-forward.png) top right no-repeat;
90b079
-	padding-top:3px;
90b079
-	padding-bottom:4px;
90b079
-	padding-right:28px;
90b079
-	font-size:1.2em;
90b079
-}
90b079
-
90b079
-.docnav li.previous a strong {
90b079
-	background: url(../images/stock-go-back.png) top left no-repeat;
90b079
-	padding-top:3px;
90b079
-	padding-bottom:4px;
90b079
-	padding-left:28px;
90b079
-	padding-right:0.5em;
90b079
-	font-size:1.2em;
90b079
-}
90b079
-
90b079
-.docnav li.home a strong {
90b079
-	background: url(../images/stock-home.png) top left no-repeat;
90b079
-	padding:5px;
90b079
-	padding-left:28px;
90b079
-	font-size:1.2em;
90b079
-}
90b079
-
90b079
-.docnav li.up a strong {
90b079
-	background: url(../images/stock-go-up.png) top left no-repeat;
90b079
-	padding:5px;
90b079
-	padding-left:28px;
90b079
-	font-size:1.2em;
90b079
-}
90b079
-
90b079
-.docnav a:link, .docnav a:visited {
90b079
-	color:#666;
90b079
-}
90b079
-
90b079
-.docnav a:hover, .docnav a:focus, .docnav a:active {
90b079
-	color:black;
90b079
-}
90b079
-
90b079
-.docnav a {
90b079
-	max-width: 10em;
90b079
-	overflow:hidden;
90b079
-}
90b079
-
90b079
-.docnav a:link strong {
90b079
-	text-decoration:none;
90b079
-}
90b079
-
90b079
-.docnav {
90b079
-	margin:0 auto;
90b079
-	text-align:center;
90b079
-}
90b079
-
90b079
-ul.docnav {
90b079
-	margin-bottom: 1em;
90b079
-}
90b079
-/* Reports */
90b079
-.reports ul {
90b079
-	list-style:none;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-}
90b079
-
90b079
-.reports li{
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-}
90b079
-
90b079
-.reports li.odd {
90b079
-	background-color: #eeeeee;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-}
90b079
-
90b079
-.reports dl {
90b079
-	display:inline;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-	float:right;
90b079
-	margin-right: 17em;
90b079
-	margin-top:-1.3em;
90b079
-}
90b079
-
90b079
-.reports dt {
90b079
-	display:inline;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-}
90b079
-
90b079
-.reports dd {
90b079
-	display:inline;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-	padding-right:.5em;
90b079
-}
90b079
-
90b079
-.reports h2, .reports h3{
90b079
-	display:inline;
90b079
-	padding-right:.5em;
90b079
-	font-size:10pt;
90b079
-	font-weight:normal;
90b079
-}
90b079
-
90b079
-.reports div.progress {
90b079
-	display:inline;
90b079
-	float:right;
90b079
-	width:16em;
90b079
-	background:#c00 url(../images/shine.png) top left repeat-x;
90b079
-	margin:0em;
90b079
-	margin-top:-1.3em;
90b079
-	padding:0em;
90b079
-	border:none;
90b079
-}
90b079
-
90b079
-/*uniform*/
90b079
-body.results, body.reports {
90b079
-	max-width:57em ;
90b079
-	padding:0em;
90b079
-}
90b079
-
90b079
-/*Progress Bar*/
90b079
-div.progress {
90b079
-	display:block;
90b079
-	float:left;
90b079
-	width:16em;
90b079
-	background:#c00 url(../images/shine.png) top left repeat-x;
90b079
-	height:1em;
90b079
-}
90b079
-
90b079
-div.progress span {
90b079
-	height:1em;
90b079
-	float:left;
90b079
-}
90b079
-
90b079
-div.progress span.translated {
90b079
-	background:#6c3 url(../images/shine.png) top left repeat-x;
90b079
-}
90b079
-
90b079
-div.progress span.fuzzy {
90b079
-	background:#ff9f00 url(../images/shine.png) top left repeat-x;
90b079
-}
90b079
-
90b079
-
90b079
-/*Results*/
90b079
-
90b079
-.results ul {
90b079
-	list-style:none;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-}
90b079
-
90b079
-.results li{
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-}
90b079
-
90b079
-.results li.odd {
90b079
-	background-color: #eeeeee;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-}
90b079
-
90b079
-.results dl {
90b079
-	display:inline;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-	float:right;
90b079
-	margin-right: 17em;
90b079
-	margin-top:-1.3em;
90b079
-}
90b079
-
90b079
-.results dt {
90b079
-	display:inline;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-}
90b079
-
90b079
-.results dd {
90b079
-	display:inline;
90b079
-	margin:0em;
90b079
-	padding:0em;
90b079
-	padding-right:.5em;
90b079
-}
90b079
-
90b079
-.results h2, .results h3 {
90b079
-	display:inline;
90b079
-	padding-right:.5em;
90b079
-	font-size:10pt;
90b079
-	font-weight:normal;
90b079
-}
90b079
-
90b079
-.results div.progress {
90b079
-	display:inline;
90b079
-	float:right;
90b079
-	width:16em;
90b079
-	background:#c00 url(../images/shine.png) top left repeat-x;
90b079
-	margin:0em;
90b079
-	margin-top:-1.3em;
90b079
-	padding:0em;
90b079
-	border:none;
90b079
-}
90b079
 
90b079
 /* Dirty EVIL Mozilla hack for round corners */
90b079
 pre {
90b079
@@ -1423,12 +1003,6 @@ span.remark {
90b079
 	background-color: #ff00ff;
90b079
 }
90b079
 
90b079
-.draft {
90b079
-	background-image: url(../images/watermark-draft.png);
90b079
-	background-repeat: repeat-y;
90b079
-        background-position: center;
90b079
-}
90b079
-
90b079
 .foreignphrase {
90b079
 	font-style: inherit;
90b079
 }
90b079
@@ -1513,10 +1087,6 @@ h1 {
90b079
 	color:#3c6eb4
90b079
 }
90b079
 
90b079
-.producttitle {
90b079
-	background: #3c6eb4 url(../images/h1-bg.png) top left repeat;
90b079
-}
90b079
-
90b079
 .section h1.title {
90b079
 	color:#3c6eb4;
90b079
 }
90b079
diff --git a/dracut.modules.7.asc b/dracut.modules.7.asc
90b079
new file mode 100644
90b079
index 0000000..4cb2aa1
90b079
--- /dev/null
90b079
+++ b/dracut.modules.7.asc
90b079
@@ -0,0 +1,293 @@
90b079
+DRACUT.MODULES(7)
90b079
+=================
90b079
+:doctype: manpage
90b079
+:man source:   dracut
90b079
+:man manual:   dracut
90b079
+
90b079
+NAME
90b079
+----
90b079
+dracut.modules - dracut modules
90b079
+
90b079
+DESCRIPTION
90b079
+-----------
90b079
+== dracut Components
90b079
+
90b079
+dracut uses a modular system to build and extend the initramfs image. All
90b079
+modules are located in _/usr/lib/dracut/modules.d_ or in _<git-src>/modules.d_.
90b079
+The most basic dracut module is _99base_. In _99base_ the initial shell script
90b079
+init is defined, which gets run by the kernel after initramfs loading. Although
90b079
+you can replace init with your own version of _99base_, this is not encouraged.
90b079
+Instead you should use, if possible, the hooks of dracut. All hooks, and the
90b079
+point of time in which they are executed, are described in <<stages>>.
90b079
+
90b079
+The main script, which creates the initramfs is dracut itsself. It parses all
90b079
+arguments and sets up the directory, in which everything is installed. It then
90b079
+executes all check, install, installkernel scripts found in the modules, which
90b079
+are to be processed. After everything is installed, the install directory is
90b079
+archived and compressed to the final initramfs image. All helper functions used
90b079
+by check, install and installkernel are found in in the file _dracut-functions_.
90b079
+These shell functions are available to all module installer (install,
90b079
+installkernel) scripts, without the need to source _dracut-functions_.
90b079
+
90b079
+A module can check the preconditions for install and installkernel with the
90b079
+check script. Also dependencies can be expressed with check. If a module passed
90b079
+check, install and installkernel will be called to install all of the necessary
90b079
+files for the module. To split between kernel and non-kernel parts of the
90b079
+installation, all kernel module related parts have to be in installkernel. All
90b079
+other files found in a module directory are module specific and mostly are hook
90b079
+scripts and udev rules.
90b079
+
90b079
+
90b079
+[[stages]]
90b079
+== Boot Process Stages
90b079
+
90b079
+dracut modules can insert custom script at various points, to control the boot
90b079
+process.
90b079
+These hooks are plain directories containing shell scripts ending with ".sh",
90b079
+which are sourced by init.
90b079
+Common used functions are in _dracut-lib.sh_, which can be sourced by any script.
90b079
+
90b079
+=== Hook: cmdline
90b079
+
90b079
+The _cmdline_ hook is a place to insert scripts to parse the kernel command line
90b079
+and prepare the later actions, like setting up udev rules and configuration
90b079
+files.
90b079
+
90b079
+In this hook the most important environment variable is defined: root. The
90b079
+second one is rootok, which indicates, that a module claimed to be able to parse
90b079
+the root defined. So for example, **root=**__iscsi:....__ will be claimed by the
90b079
+iscsi dracut module, which then sets rootok.
90b079
+
90b079
+=== Hook: pre-udev
90b079
+
90b079
+This hook is executed right after the cmdline hook and a check if root and
90b079
+rootok were set. Here modules can take action with the final root, and before
90b079
+udev has been run.
90b079
+
90b079
+=== Start Udev
90b079
+
90b079
+Now udev is started and the logging for udev is setup.
90b079
+
90b079
+=== Hook: pre-trigger
90b079
+
90b079
+In this hook, you can set udev environment variables with **udevadm control
90b079
+--property=KEY=_value_** or control the further execution of udev with
90b079
+udevadm.
90b079
+
90b079
+=== Trigger Udev
90b079
+
90b079
+udev is triggered by calling udevadm trigger, which sends add events for all
90b079
+devices and subsystems.
90b079
+
90b079
+=== Main Loop
90b079
+
90b079
+In the main loop of dracut loops until udev has settled and
90b079
+all scripts in _initqueue/finished_ returned true.
90b079
+In this loop there are three hooks, where scripts can be inserted
90b079
+by calling /sbin/initqueue.
90b079
+
90b079
+==== Initqueue
90b079
+
90b079
+This hook gets executed every time a script is inserted here, regardless of the
90b079
+udev state.
90b079
+
90b079
+==== Initqueue settled
90b079
+
90b079
+This hooks (initqueue/settled) gets executed every time udev has settled.
90b079
+
90b079
+==== Initqueue timeout
90b079
+
90b079
+This hooks (initqueue/timeout) gets executed, when the main loop counter becomes half of the
90b079
+rd.retry counter.
90b079
+
90b079
+==== Initqueue finished
90b079
+
90b079
+This hook (initqueue/finished) is called after udev has settled and
90b079
+if all scripts herein return 0 the main loop will be ended.
90b079
+Abritary scripts can be added here, to loop in the
90b079
+initqueue until something happens, which a dracut module wants to wait for.
90b079
+
90b079
+=== Hook: pre-mount
90b079
+
90b079
+Before the root device is mounted all scripts in the hook pre-mount are
90b079
+executed. In some cases (e.g. NFS) the real root device is already mounted,
90b079
+though.
90b079
+
90b079
+=== Hook: mount
90b079
+
90b079
+This hook is mainly to mount the real root device.
90b079
+
90b079
+=== Hook: pre-pivot
90b079
+
90b079
+This hook is called before cleanup hook, This is a good place for
90b079
+actions other than cleanups which need to be called before pivot.
90b079
+
90b079
+=== Hook: cleanup
90b079
+
90b079
+This hook is the last hook and is called before init finally switches root to
90b079
+the real root device. This is a good place to clean up and kill processes not
90b079
+needed anymore.
90b079
+
90b079
+
90b079
+=== Cleanup and switch_root
90b079
+
90b079
+Init (or systemd) kills all udev processes, cleans up the environment,
90b079
+sets up the arguments for the real init process and finally calls switch_root.
90b079
+switch_root removes the whole filesystem hierarchy of the initramfs,
90b079
+chroot()s to the real root device and calls /sbin/init with the specified arguments.
90b079
+
90b079
+To ensure all files in the initramfs hierarchy can be removed, all processes
90b079
+still running from the initramfs should not have any open file descriptors left.
90b079
+
90b079
+== Network Infrastructure
90b079
+
90b079
+FIXME
90b079
+
90b079
+== Writing a Module
90b079
+
90b079
+A simple example module is _96insmodpost_, which modprobes a kernel module after
90b079
+udev has settled and the basic device drivers have been loaded.
90b079
+
90b079
+All module installation information is in the file module-setup.sh.
90b079
+
90b079
+First we create a check() function, which just exits with 0 indicating that this
90b079
+module should be included by default.
90b079
+
90b079
+check():
90b079
+----
90b079
+return 0
90b079
+----
90b079
+
90b079
+The we create the install() function, which installs a cmdline hook with
90b079
+priority number 20 called _parse-insmodpost.sh_. It also installs the
90b079
+_insmodpost.sh_ script in _/sbin_.
90b079
+
90b079
+install():
90b079
+----
90b079
+inst_hook cmdline 20 "$moddir/parse-insmodpost.sh"
90b079
+inst_simple "$moddir/insmodpost.sh" /sbin/insmodpost.sh
90b079
+----
90b079
+
90b079
+The _pase-instmodpost.sh_ parses the kernel command line for a argument
90b079
+rd.driver.post, blacklists the module from being autoloaded and installs the
90b079
+hook _insmodpost.sh_ in the _initqueue/settled_.
90b079
+
90b079
+_parse-insmodpost.sh_:
90b079
+----
90b079
+for p in $(getargs rd.driver.post=); do
90b079
+    echo "blacklist $p" >> /etc/modprobe.d/initramfsblacklist.conf
90b079
+    _do_insmodpost=1
90b079
+done
90b079
+
90b079
+[ -n "$_do_insmodpost" ] && /sbin/initqueue --settled --unique --onetime /sbin/insmodpost.sh
90b079
+unset _do_insmodpost
90b079
+
90b079
+----
90b079
+
90b079
+_insmodpost.sh_, which is called in the _initqueue/settled_ hook will just
90b079
+modprobe the kernel modules specified in all rd.driver.post kernel command line
90b079
+parameters. It runs after udev has settled and is only called once (--onetime).
90b079
+
90b079
+_insmodpost.sh_:
90b079
+----
90b079
+. /lib/dracut-lib.sh
90b079
+
90b079
+for p in $(getargs rd.driver.post=); do
90b079
+    modprobe $p
90b079
+done
90b079
+
90b079
+----
90b079
+
90b079
+
90b079
+=== module-setup.sh: check()
90b079
+
90b079
+_check()_ is called by dracut to evaluate the inclusion of a dracut module in
90b079
+the initramfs.
90b079
+
90b079
+$hostonly:: If the $hostonly variable is set, then the module check() function
90b079
+should be in "hostonly" mode, which means, that the check() should only return
90b079
+0, if the module is really needed to boot this specific host.
90b079
+
90b079
+check() should return with:
90b079
+
90b079
+0:: Include the dracut module in the initramfs.
90b079
+
90b079
+1:: Do not include the dracut module. The requirements are not fullfilled
90b079
+(missing tools, etc.)
90b079
+
90b079
+255:: Only include the dracut module, if another module requires it or if
90b079
+explicitly specified in the config file or on the argument list.
90b079
+
90b079
+
90b079
+=== module-setup.sh: depends()
90b079
+
90b079
+The function depends() should echo all other dracut module names the module
90b079
+depends on.
90b079
+
90b079
+=== module-setup.sh: cmdline()
90b079
+
90b079
+This function should print the kernel command line options needed to boot the current
90b079
+machine setup. It should start with a space and should not print a newline.
90b079
+
90b079
+=== module-setup.sh: install()
90b079
+
90b079
+The install() function is called to install everything non-kernel related. To install
90b079
+binaries, scripts, and other files, you can use the functions mentioned in <<creation>>.
90b079
+
90b079
+To address a file in the current module directory, use the variable "$moddir".
90b079
+
90b079
+=== module-setup.sh: installkernel()
90b079
+
90b079
+In installkernel() all kernel related files should be installed. You can use all of the functions
90b079
+mentioned in <<creation>> to install files.
90b079
+
90b079
+=== [[creation]]Creation Functions
90b079
+
90b079
+==== inst_multiple [-o] <file> [ <file> ...]
90b079
+
90b079
+installs multiple binaries and files. If executables are specified without a path, dracut
90b079
+will search the path PATH=/usr/sbin:/sbin:/usr/bin:/bin for the binary. If the option "-o"
90b079
+is given as the first parameter, a missing file does not lead to an error.
90b079
+
90b079
+==== inst <src> [<dst>]
90b079
+
90b079
+installs _one_ file <src> either to the same place in the initramfs or to an optional <dst>.
90b079
+
90b079
+==== inst_hook <hookdir> <prio> <src>
90b079
+
90b079
+installs an executable/script <src> in the dracut hook <hookdir> with priority <prio>.
90b079
+
90b079
+==== inst_rules <udevrule> [ <udevrule> ...]
90b079
+
90b079
+installs one ore more udev rules. Non-existant udev rules are reported, but do not let dracut fail.
90b079
+
90b079
+==== instmods <kernelmodule> [ <kernelmodule> ... ]
90b079
+
90b079
+instmods should be used only in the installkernel() function.
90b079
+
90b079
+instmods installs one or more kernel modules in the initramfs. <kernelmodule> can also be a whole
90b079
+subsystem, if prefixed with a "=", like "=drivers/net/team".
90b079
+
90b079
+instmods will not install the kernel module, if $hostonly is set and the kernel module is not currently
90b079
+needed by any /sys/*...*/uevent MODALIAS.
90b079
+To install a kernel module regardless of the hostonly mode use the form:
90b079
+----
90b079
+hostonly='' instmods <kernelmodule>
90b079
+----
90b079
+
90b079
+=== Initramfs Functions
90b079
+
90b079
+FIXME
90b079
+
90b079
+
90b079
+=== Network Modules
90b079
+
90b079
+FIXME
90b079
+
90b079
+AUTHOR
90b079
+------
90b079
+Harald Hoyer
90b079
+
90b079
+SEE ALSO
90b079
+--------
90b079
+*dracut*(8)
90b079
diff --git a/dracut.spec b/dracut.spec
90b079
index b1cf9fe..8dfc753 100644
90b079
--- a/dracut.spec
90b079
+++ b/dracut.spec
90b079
@@ -316,6 +316,7 @@ rm -rf -- $RPM_BUILD_ROOT
90b079
 %endif
90b079
 %{_mandir}/man7/dracut.kernel.7*
90b079
 %{_mandir}/man7/dracut.cmdline.7*
90b079
+%{_mandir}/man7/dracut.modules.7*
90b079
 %{_mandir}/man7/dracut.bootup.7*
90b079
 %{_mandir}/man5/dracut.conf.5*
90b079
 %if %{defined _unitdir}
90b079
diff --git a/dracut.usage.asc b/dracut.usage.asc
90b079
new file mode 100644
90b079
index 0000000..6d37920
90b079
--- /dev/null
90b079
+++ b/dracut.usage.asc
90b079
@@ -0,0 +1,526 @@
90b079
+To create a initramfs image, the most simple command is:
90b079
+----
90b079
+# dracut
90b079
+----
90b079
+
90b079
+This will generate a general purpose initramfs image, with all possible
90b079
+functionality resulting of the combination of the installed dracut modules and
90b079
+system tools. The image is /boot/initramfs-_++<kernel version>++_.img and
90b079
+contains the kernel modules of the currently active kernel with version
90b079
+_++<kernel version>++_.
90b079
+
90b079
+If the initramfs image already exists, dracut will display an error message, and
90b079
+to overwrite the existing image, you have to use the --force option.
90b079
+----
90b079
+# dracut --force
90b079
+----
90b079
+
90b079
+If you want to specify another filename for the resulting image you would issue
90b079
+a command like:
90b079
+----
90b079
+# dracut foobar.img
90b079
+----
90b079
+
90b079
+To generate an image for a specific kernel version, the command would be:
90b079
+----
90b079
+# dracut foobar.img 2.6.40-1.rc5.f20
90b079
+----
90b079
+
90b079
+A shortcut to generate the image at the default location for a specific kernel
90b079
+version is:
90b079
+----
90b079
+# dracut --kver 2.6.40-1.rc5.f20
90b079
+----
90b079
+
90b079
+If you want to create lighter, smaller initramfs images, you may want to specify
90b079
+the --hostonly or -H option. Using this option, the resulting image will
90b079
+contain only those dracut modules, kernel modules and filesystems, which are
90b079
+needed to boot this specific machine. This has the drawback, that you can't put
90b079
+the disk on another controller or machine, and that you can't switch to another
90b079
+root filesystem, without recreating the initramfs image. The usage of the
90b079
+--hostonly option is only for experts and you will have to keep the broken
90b079
+pieces. At least keep a copy of a general purpose image (and corresponding
90b079
+kernel) as a fallback to rescue your system.
90b079
+
90b079
+=== Inspecting the Contents
90b079
+To see the contents of the image created by dracut, you can use the lsinitrd tool.
90b079
+----
90b079
+# lsinitrd | less
90b079
+----
90b079
+
90b079
+To display the contents of a file in the initramfs also use the lsinitrd tool:
90b079
+----
90b079
+# lsinitrd -f /etc/ld.so.conf
90b079
+include ld.so.conf.d/*.conf
90b079
+----
90b079
+
90b079
+=== Adding dracut Modules
90b079
+Some dracut modules are turned off by default and have to be activated manually.
90b079
+You can do this by adding the dracut modules to the configuration file
90b079
+_/etc/dracut.conf_ or _/etc/dracut.conf.d/myconf.conf_. See *dracut.conf*(5).
90b079
+You can also add dracut modules on the command line
90b079
+by using the -a or --add option:
90b079
+----
90b079
+# dracut --add bootchart initramfs-bootchart.img
90b079
+----
90b079
+
90b079
+To see a list of available dracut modules, use the --list-modules option:
90b079
+----
90b079
+# dracut --list-modules
90b079
+----
90b079
+
90b079
+=== Omitting dracut Modules
90b079
+Sometimes you don't want a dracut module to be included for reasons of speed,
90b079
+size or functionality. To do this, either specify the omit_dracutmodules
90b079
+variable in the _dracut.conf_ or _/etc/dracut.conf.d/myconf.conf_ configuration
90b079
+file (see *dracut.conf*(5)), or use the -o or --omit option
90b079
+on the command line:
90b079
+----
90b079
+# dracut -o "multipath lvm" no-multipath-lvm.img
90b079
+----
90b079
+
90b079
+=== Adding Kernel Modules
90b079
+If you need a special kernel module in the initramfs, which is not
90b079
+automatically picked up by dracut, you have the use the --add-drivers option
90b079
+on the command line or  the drivers vaiable in  the _/etc/dracut.conf_
90b079
+or _/etc/dracut.conf.d/myconf.conf_ configuration file (see *dracut.conf*(5)):
90b079
+----
90b079
+# dracut --add-drivers mymod initramfs-with-mymod.img
90b079
+----
90b079
+
90b079
+=== Boot parameters
90b079
+An initramfs generated without the "hostonly" mode, does not contain any system
90b079
+configuration files (except for some special exceptions), so the configuration
90b079
+has to be done on the kernel command line. With this flexibility, you can easily
90b079
+boot from a changed root partition, without the need to recompile the initramfs
90b079
+image. So, you could completly change your root partition (move it inside a md
90b079
+raid with encryption and LVM on top), as long as you specify the correct
90b079
+filesystem LABEL or UUID on the kernel command line for your root device, dracut
90b079
+will find it and boot from it.
90b079
+
90b079
+The kernel command line usually can be configured in _/boot/grub/grub.conf_, if
90b079
+grub is your bootloader and it also can be edited in the real boot process in
90b079
+the grub menu.
90b079
+
90b079
+The kernel command line can also be provided by the dhcp server with the
90b079
+root-path option. See <<NetworkBoot>>.
90b079
+
90b079
+For a full reference of all kernel command line parameters, see *dracut.cmdline*(5).
90b079
+
90b079
+To get a quick start for the suitable kernel command line on your system, use the
90b079
+__--print-cmdline__ option:
90b079
+----
90b079
+# dracut --print-cmdline
90b079
+ root=UUID=8b8b6f91-95c7-4da2-831b-171e12179081 rootflags=rw,relatime,discard,data=ordered rootfstype=ext4
90b079
+----
90b079
+
90b079
+==== Specifying the root Device
90b079
+This is the only option dracut really needs to boot from your root partition.
90b079
+Because your root partition can live in various environments, there are a lot of
90b079
+formats for the root= option. The most basic one is root=_++
90b079
+node>++_:
90b079
+----
90b079
+root=/dev/sda2
90b079
+----
90b079
+
90b079
+Because device node names can change, dependent on the drive ordering, you are
90b079
+encouraged to use the filesystem identifier (UUID) or filesystem label (LABEL)
90b079
+to specify your root partition:
90b079
+----
90b079
+root=UUID=19e9dda3-5a38-484d-a9b0-fa6b067d0331
90b079
+----
90b079
+
90b079
+or
90b079
+
90b079
+----
90b079
+root=LABEL=myrootpartitionlabel
90b079
+----
90b079
+
90b079
+To see all UUIDs or LABELs on your system, do:
90b079
+----
90b079
+# ls -l /dev/disk/by-uuid
90b079
+----
90b079
+
90b079
+or
90b079
+
90b079
+----
90b079
+# ls -l /dev/disk/by-label
90b079
+----
90b079
+
90b079
+If your root partition is on the network see <<NetworkBoot>>.
90b079
+
90b079
+==== Keyboard Settings
90b079
+If you have to input passwords for encrypted disk volumes, you might want to set
90b079
+the keyboard layout and specify a display font.
90b079
+
90b079
+A typical german kernel command would contain:
90b079
+----
90b079
+rd.vconsole.font=latarcyrheb-sun16 rd.vconsole.keymap=de-latin1-nodeadkeys rd.locale.LANG=de_DE.UTF-8
90b079
+----
90b079
+
90b079
+Setting these options can override the setting stored on your system, if you use
90b079
+a modern init system, like systemd.
90b079
+
90b079
+==== Blacklisting Kernel Modules
90b079
+Sometimes it is required to prevent the automatic kernel module loading of a
90b079
+specific kernel module. To do this, just add rd.blacklist=_++
90b079
+name>++_, with _++<kernel module name>++_ not containing the _.ko_
90b079
+suffix, to the kernel command line. For example:
90b079
+----
90b079
+rd.driver.blacklist=mptsas rd.driver.blacklist=nouveau
90b079
+----
90b079
+
90b079
+The option can be specified multiple times on the kernel command line.
90b079
+
90b079
+==== Speeding up the Boot Process
90b079
+If you want to speed up the boot process, you can specify as much information
90b079
+for dracut on the kernel command as possible. For example, you can tell dracut,
90b079
+that you root partition is not on a LVM volume or not on a raid partition, or
90b079
+that it lives inside a specific crypto LUKS encrypted volume. By default, dracut
90b079
+searches everywhere. A typical dracut kernel command line for a plain primary or
90b079
+logical partition would contain:
90b079
+----
90b079
+rd.luks=0 rd.lvm=0 rd.md=0 rd.dm=0
90b079
+----
90b079
+
90b079
+This turns off every automatic assembly of LVM, MD raids, DM raids and crypto LUKS.
90b079
+
90b079
+Of course, you could also omit the dracut modules in the initramfs creation
90b079
+process, but then you would lose the posibility to turn it on on demand.
90b079
+
90b079
+
90b079
+[[Injecting]]
90b079
+=== Injecting custom Files
90b079
+To add your own files to the initramfs image, you have several possibilities.
90b079
+
90b079
+The --include option let you specify a source path and a target path. For example
90b079
+----
90b079
+# dracut --include cmdline-preset /etc/cmdline.d/mycmdline.conf initramfs-cmdline-pre.img
90b079
+----
90b079
+will create an initramfs image, where the file cmdline-preset will be copied
90b079
+inside the initramfs to _/etc/cmdline.d/mycmdline.conf_. --include can only be specified once.
90b079
+
90b079
+
90b079
+----
90b079
+# mkdir -p rd.live.overlay/etc/cmdline.d
90b079
+# mkdir -p rd.live.overlay/etc/conf.d
90b079
+# echo "ip=auto" >> rd.live.overlay/etc/cmdline.d/mycmdline.conf
90b079
+# echo export FOO=testtest >> rd.live.overlay/etc/conf.d/testvar.conf
90b079
+# echo export BAR=testtest >> rd.live.overlay/etc/conf.d/testvar.conf
90b079
+# tree rd.live.overlay/
90b079
+rd.live.overlay/
90b079
+`-- etc
90b079
+    |-- cmdline.d
90b079
+    |   `-- mycmdline.conf
90b079
+    `-- conf.d
90b079
+        `-- testvar.conf
90b079
+
90b079
+# dracut --include rd.live.overlay / initramfs-rd.live.overlay.img
90b079
+----
90b079
+
90b079
+This will put the contents of the rd.live.overlay directory into the root of the
90b079
+initramfs image.
90b079
+
90b079
+The --install option let you specify several files, which will get installed in
90b079
+the initramfs image at the same location, as they are present on initramfs
90b079
+creation time.
90b079
+
90b079
+
90b079
+----
90b079
+# dracut --install 'strace fsck.ext3 ssh' initramfs-dbg.img
90b079
+----
90b079
+
90b079
+This will create an initramfs with the strace, fsck.ext3 and ssh executables,
90b079
+together with the libraries needed to start those. The --install option can be
90b079
+specified multiple times.
90b079
+
90b079
+
90b079
+[[NetworkBoot]]
90b079
+=== Network Boot
90b079
+
90b079
+If your root partition is on a network drive, you have to have the network
90b079
+dracut modules installed to create a network aware initramfs image.
90b079
+
90b079
+On a Red Hat Enterprise Linux or Fedora system, this means, you have to install
90b079
+the _dracut-network_ rpm package:
90b079
+
90b079
+
90b079
+----
90b079
+# yum install dracut-network
90b079
+----
90b079
+
90b079
+The resulting initramfs image can be served by a boot manager residing on your
90b079
+local hard drive or it can be served by a PXE/TFTP server.
90b079
+
90b079
+How to setup your PXE/TFTP server can be found in the
90b079
+http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/[Red
90b079
+Hat Enterprise Linux Storage Administration Guide].
90b079
+
90b079
+If you specify ip=auto on the kernel command line, then dracut asks a dhcp
90b079
+server about the ip adress for the machine. The dhcp server can also serve an
90b079
+additional root-path, which will set the root device for dracut. With this
90b079
+mechanism, you have static configuration on your client machine and a
90b079
+centralized boot configuration on your TFTP/DHCP server. If you can't pass a
90b079
+kernel command line, then you can inject _/etc/cmdline.d/mycmdline.conf_, with a method described
90b079
+in <<Injecting>>.
90b079
+
90b079
+==== Reducing the Image Size
90b079
+
90b079
+To reduce the size of the initramfs, you should create it with by ommitting all
90b079
+dracut modules, which you know, you don't need to boot the machine.
90b079
+
90b079
+You can also specify the exact dracut and kernel modules to produce a very tiny
90b079
+initramfs image.
90b079
+
90b079
+For example for a NFS image, you would do:
90b079
+
90b079
+
90b079
+----
90b079
+# dracut -m "nfs network  base" initramfs-nfs-only.img
90b079
+----
90b079
+
90b079
+Then you would boot from this image with your target machine and reduce the size
90b079
+once more by creating it on the target machine with the --host-only option:
90b079
+
90b079
+
90b079
+----
90b079
+# dracut -m "nfs network base" --host-only initramfs-nfs-host-only.img
90b079
+----
90b079
+
90b079
+This will reduce the size of the initramfs image significantly.
90b079
+
90b079
+
90b079
+== Troubleshooting
90b079
+
90b079
+If the boot process does not succeed, you have several options to debug the
90b079
+situation. Some of the basic operations are covered here. For more information
90b079
+you should also visit:
90b079
+http://fedoraproject.org/wiki/How_to_debug_Dracut_problems
90b079
+
90b079
+
90b079
+[[identifying-your-problem-area]]
90b079
+=== Identifying your problem area
90b079
+. Remove ''rhgb'' and ''quiet'' from the kernel command line
90b079
+. Add ''rd.shell'' to the kernel command line. This will present a shell should
90b079
+dracut be unable to locate your root device
90b079
+. Add ''rd.shell rd.debug log_buf_len=1M'' to the kernel command line so that
90b079
+dracut shell commands are printed as they are executed
90b079
+. The file /run/initramfs/rdsosreport.txt is generated,
90b079
+which contains all the logs and the output of all significant tools, which are mentioned later.
90b079
+
90b079
+If you want to save that output, simply mount /boot by hand or insert an USB stick and mount that.
90b079
+Then you can store the output for later inspection.
90b079
+
90b079
+[[information-to-include-in-your-report]]
90b079
+=== Information to include in your report
90b079
+
90b079
+[[all-bug-reports]]
90b079
+==== All bug reports
90b079
+In all cases, the following should be mentioned and attached to your bug report:
90b079
+
90b079
+* The exact kernel command-line used. Typically from the bootloader
90b079
+configuration file (e.g. _/etc/grub.conf_) or from _/proc/cmdline_.
90b079
+* A copy of your disk partition information from _/etc/fstab_, which might be
90b079
+obtained booting an old working initramfs or a rescue medium.
90b079
+* Turn on dracut debugging (see _the 'debugging dracut' section_), and attach
90b079
+the file /run/initramfs/rdsosreport.txt.
90b079
+* If you use a dracut configuration file, please include _/etc/dracut.conf_ and
90b079
+all files in _/etc/dracut.conf.d/*.conf_
90b079
+
90b079
+[[network-root-device-related-problems]]
90b079
+==== Network root device related problems
90b079
+This section details information to include when experiencing problems on a
90b079
+system whose root device is located on a network attached volume (e.g. iSCSI,
90b079
+NFS or NBD). As well as the information from <<all-bug-reports>>, include the
90b079
+following information:
90b079
+
90b079
+
90b079
+* Please include the output of
90b079
++
90b079
+----
90b079
+# /sbin/ifup <interfacename>
90b079
+# ip addr show
90b079
+----
90b079
+
90b079
+[[debugging-dracut]]
90b079
+=== Debugging dracut
90b079
+
90b079
+
90b079
+[[configure-a-serial-console]]
90b079
+==== Configure a serial console
90b079
+
90b079
+Successfully debugging dracut will require some form of console
90b079
+logging during the system boot.  This section documents configuring a
90b079
+serial console connection to record boot messages.
90b079
+
90b079
+. First, enable serial console output for both the kernel and the bootloader.
90b079
+. Open the file _/etc/grub.conf_ for editing. Below the line ''timeout=5'', add
90b079
+the following:
90b079
++
90b079
+----
90b079
+serial --unit=0 --speed=9600
90b079
+terminal --timeout=5 serial console
90b079
+----
90b079
++
90b079
+. Also in _/etc/grub.conf_, add the following boot arguemnts to the ''kernel''
90b079
+line:
90b079
++
90b079
+----
90b079
+console=tty0 console=ttyS0,9600
90b079
+----
90b079
++
90b079
+. When finished, the _/etc/grub.conf_ file should look similar to the example
90b079
+below.
90b079
++
90b079
+----
90b079
+default=0
90b079
+timeout=5
90b079
+serial --unit=0 --speed=9600
90b079
+terminal --timeout=5 serial console
90b079
+title Fedora (2.6.29.5-191.fc11.x86_64)
90b079
+  root (hd0,0)
90b079
+  kernel /vmlinuz-2.6.29.5-191.fc11.x86_64 ro root=/dev/mapper/vg_uc1-lv_root console=tty0 console=ttyS0,9600
90b079
+  initrd /dracut-2.6.29.5-191.fc11.x86_64.img
90b079
+----
90b079
++
90b079
+. More detailed information on how to configure the kernel for console output
90b079
+can be found at
90b079
+http://www.faqs.org/docs/Linux-HOWTO/Remote-Serial-Console-HOWTO.html#CONFIGURE-KERNEL.
90b079
+. Redirecting non-interactive output
90b079
++
90b079
+--
90b079
+NOTE: You can redirect all non-interactive output to _/dev/kmsg_ and the kernel
90b079
+will put it out on the console when it reaches the kernel buffer by doing
90b079
+
90b079
+----
90b079
+# exec >/dev/kmsg 2>&1 
90b079
+----
90b079
+--
90b079
+
90b079
+[[using-the-dracut-shell]]
90b079
+==== Using the dracut shell
90b079
+
90b079
+dracut offers a shell for interactive debugging in the event dracut fails to
90b079
+locate your root filesystem. To enable the shell:
90b079
+
90b079
+. Add the boot parameter ''rd.shell'' to your bootloader configuration file
90b079
+(e.g. _/etc/grub.conf_)
90b079
+. Remove the boot arguments ''rhgb'' and ''quiet''
90b079
++
90b079
+A sample _/etc/grub.conf_ bootloader configuration file is listed below.
90b079
++
90b079
+----
90b079
+default=0
90b079
+timeout=5
90b079
+serial --unit=0 --speed=9600
90b079
+terminal --timeout=5 serial console
90b079
+title Fedora (2.6.29.5-191.fc11.x86_64)
90b079
+  root (hd0,0)
90b079
+  kernel /vmlinuz-2.6.29.5-191.fc11.x86_64 ro root=/dev/mapper/vg_uc1-lv_root console=tty0 rd.shell
90b079
+  initrd /dracut-2.6.29.5-191.fc11.x86_64.img
90b079
+----
90b079
++
90b079
+. If system boot fails, you will be dropped into a shell as seen in the example below.
90b079
++
90b079
+----
90b079
+No root device found
90b079
+Dropping to debug shell.
90b079
+
90b079
+#
90b079
+----
90b079
++
90b079
+. Use this shell prompt to gather the information requested above (see <<all-bug-reports>>).
90b079
+
90b079
+[[accessing-the-root-volume-from-the-dracut-shell]]
90b079
+==== Accessing the root volume from the dracut shell
90b079
+From the dracut debug shell, you can manually perform the task of locating and
90b079
+preparing your root volume for boot. The required steps will depend on how your
90b079
+root volume is configured. Common scenarios include:
90b079
+
90b079
+* A block device (e.g. _/dev/sda7_)
90b079
+* A LVM logical volume (e.g. _/dev/VolGroup00/LogVol00_)
90b079
+* An encrypted device (e.g. _/dev/mapper/luks-4d5972ea-901c-4584-bd75-1da802417d83_)
90b079
+* A network attached device (e.g. netroot=iscsi:@192.168.0.4::3260::iqn.2009-02.org.fedoraproject:for.all)
90b079
+
90b079
+The exact method for locating and preparing will vary. However, to continue with
90b079
+a successful boot, the objective is to locate your root volume and create a
90b079
+symlink _/dev/root_ which points to the file system. For example, the following
90b079
+example demonstrates accessing and booting a root volume that is an encrypted
90b079
+LVM Logical volume.
90b079
+
90b079
+. Inspect your partitions using parted
90b079
++
90b079
+----
90b079
+# parted /dev/sda -s p
90b079
+Model: ATA HTS541060G9AT00 (scsi)
90b079
+Disk /dev/sda: 60.0GB
90b079
+Sector size (logical/physical): 512B/512B
90b079
+Partition Table: msdos
90b079
+Number  Start   End     Size    Type      File system  Flags
90b079
+1      32.3kB  10.8GB  107MB   primary   ext4         boot
90b079
+2      10.8GB  55.6GB  44.7GB  logical                lvm
90b079
+----
90b079
++
90b079
+. You recall that your root volume was a LVM logical volume. Scan and activate
90b079
+any logical volumes.
90b079
++
90b079
+----
90b079
+# lvm vgscan
90b079
+# lvm vgchange -ay
90b079
+----
90b079
++
90b079
+. You should see any logical volumes now using the command blkid:
90b079
++
90b079
+----
90b079
+# blkid
90b079
+/dev/sda1: UUID="3de247f3-5de4-4a44-afc5-1fe179750cf7" TYPE="ext4"
90b079
+/dev/sda2: UUID="Ek4dQw-cOtq-5MJu-OGRF-xz5k-O2l8-wdDj0I" TYPE="LVM2_member"
90b079
+/dev/mapper/linux-root: UUID="def0269e-424b-4752-acf3-1077bf96ad2c" TYPE="crypto_LUKS"
90b079
+/dev/mapper/linux-home: UUID="c69127c1-f153-4ea2-b58e-4cbfa9257c5e" TYPE="ext3"
90b079
+/dev/mapper/linux-swap: UUID="47b4d329-975c-4c08-b218-f9c9bf3635f1" TYPE="swap"
90b079
+----
90b079
++
90b079
+. From the output above, you recall that your root volume exists on an encrypted
90b079
+block device. Following the guidance disk encryption guidance from the
90b079
+Installation Guide, you unlock your encrypted root volume.
90b079
++
90b079
+----
90b079
+# UUID=$(cryptsetup luksUUID /dev/mapper/linux-root)
90b079
+# cryptsetup luksOpen /dev/mapper/linux-root luks-$UUID
90b079
+Enter passphrase for /dev/mapper/linux-root:
90b079
+Key slot 0 unlocked.
90b079
+----
90b079
++
90b079
+. Next, make a symbolic link to the unlocked root volume
90b079
++
90b079
+----
90b079
+# ln -s /dev/mapper/luks-$UUID /dev/root
90b079
+----
90b079
++
90b079
+. With the root volume available, you may continue booting the system by exiting
90b079
+the dracut shell
90b079
++
90b079
+----
90b079
+# exit
90b079
+----
90b079
+
90b079
+[[additional-dracut-boot-parameters]]
90b079
+==== Additional dracut boot parameters
90b079
+For more debugging options, see *dracut.cmdline*(7).
90b079
+
90b079
+
90b079
+[[debugging-dracut-on-shutdown]]
90b079
+==== Debugging dracut on shutdown
90b079
+
90b079
+To debug the shutdown sequence on systemd systems, you can _rd.break_
90b079
+on _pre-shutdown_ or _shutdown_.
90b079
+
90b079
+To do this from an already booted system:
90b079
+----
90b079
+# mkdir -p /run/initramfs/etc/cmdline.d
90b079
+# echo "rd.break=pre-shutdown" > /run/initramfs/etc/cmdline.d/debug.conf
90b079
+# touch /run/initramfs/.need_shutdown
90b079
+----
90b079
+
90b079
+This will give you a dracut shell after the system pivot'ed back in the initramfs.
90b079
+