From cdc8d9c403aa6e84d99b75d891957d210c994bac Mon Sep 17 00:00:00 2001 From: Harald Hoyer Date: Thu, 5 Aug 2010 16:38:49 +0200 Subject: [PATCH] documentation: moved to docbook man pages --- .gitignore | 5 + Makefile | 10 +- dracut-catimages.8 | 52 --- dracut-catimages.8.xml | 117 +++++++ dracut-gencmdline.8 | 20 -- dracut-gencmdline.8.xml | 47 +++ dracut.8 | 455 --------------------------- dracut.8.xml | 429 +++++++++++++++++++++++++ dracut.conf.5 | 76 ----- dracut.conf.5.xml | 162 ++++++++++ dracut.kernel.7.xml | 679 ++++++++++++++++++++++++++++++++++++++++ 11 files changed, 1447 insertions(+), 605 deletions(-) delete mode 100644 dracut-catimages.8 create mode 100644 dracut-catimages.8.xml delete mode 100644 dracut-gencmdline.8 create mode 100644 dracut-gencmdline.8.xml delete mode 100644 dracut.8 create mode 100644 dracut.8.xml delete mode 100644 dracut.conf.5 create mode 100644 dracut.conf.5.xml create mode 100644 dracut.kernel.7.xml diff --git a/.gitignore b/.gitignore index 227948a58..a689a3efb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,8 @@ test*.img modules.d/99base/switch_root *~ +dracut.kernel.7 +dracut.conf.5 +dracut.8 +dracut-catimages.8 +dracut-gencmdline.8 diff --git a/Makefile b/Makefile index d76e6f494..c177275ee 100644 --- a/Makefile +++ b/Makefile @@ -8,6 +8,7 @@ sysconfdir ?= ${prefix}/etc sbindir ?= ${prefix}/sbin mandir ?= ${prefix}/share/man +manpages = dracut.8 dracut.kernel.7 dracut.conf.5 dracut-catimages.8 dracut-gencmdline.8 .PHONY: install clean archive rpm testimage test all check AUTHORS @@ -17,7 +18,10 @@ else targets = endif -all: $(targets) +all: $(targets) $(manpages) + +%: %.xml + xsltproc -o $@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< modules.d/99base/switch_root: switch_root.c gcc -D _GNU_SOURCE -D 'PACKAGE_STRING="dracut"' -std=gnu99 -fsigned-char -g -O2 -o modules.d/99base/switch_root switch_root.c @@ -27,7 +31,7 @@ install: mkdir -p $(DESTDIR)$(sbindir) mkdir -p $(DESTDIR)$(sysconfdir) mkdir -p $(DESTDIR)$(pkglibdir)/modules.d - mkdir -p $(DESTDIR)$(mandir)/man{5,8} + mkdir -p $(DESTDIR)$(mandir)/man{5,7,8} install -m 0755 dracut $(DESTDIR)$(sbindir)/dracut install -m 0755 dracut-gencmdline $(DESTDIR)$(sbindir)/dracut-gencmdline install -m 0755 dracut-catimages $(DESTDIR)$(sbindir)/dracut-catimages @@ -44,6 +48,7 @@ endif install -m 0644 dracut-catimages.8 $(DESTDIR)$(mandir)/man8 install -m 0644 dracut-gencmdline.8 $(DESTDIR)$(mandir)/man8 install -m 0644 dracut.conf.5 $(DESTDIR)$(mandir)/man5 + install -m 0644 dracut.kernel.5 $(DESTDIR)$(mandir)/man7 ifeq (1,${WITH_SWITCH_ROOT}) rm $(DESTDIR)$(pkglibdir)/modules.d/99base/switch_root endif @@ -55,6 +60,7 @@ clean: rm -f modules.d/99base/switch_root rm -f test-*.img rm -f dracut-*.rpm dracut-*.tar.bz2 + rm -f $(manpages) make -C test clean archive: dracut-$(VERSION)-$(GITVERSION).tar.bz2 diff --git a/dracut-catimages.8 b/dracut-catimages.8 deleted file mode 100644 index b7d703eac..000000000 --- a/dracut-catimages.8 +++ /dev/null @@ -1,52 +0,0 @@ -.TH DRACUT-CATIMAGES 8 "June 2009" "Linux" -.SH NAME -dracut-catimages \- creates initial ramdisk image by concatenating images -.SH SYNOPSIS -\fBdracut-catimages\fR [\fIOPTION\fR]... \fI\fR \fI[...]\fR - -.SH DESCRIPTION -.B dracut-catimages -creates an initial ramdisk image by concatenating several images from the command -line and /boot/dracut/*.img - -.SH OPTIONS -.TP -.BR \-f ", " \-\-force -overwrite existing initramfs file. -.TP -.BR \-i ", " \-\-imagedir -Directory with additional images to add (default: /boot/dracut/) -.TP -.BR \-o ", " \-\-overlaydir -Overlay directory, which contains additional files that will be used to create an additional image -.TP -.BR \-\-nooverlay -Do not use the overlay directory -.TP -.BR \-\-noimagedir -Do not use the additional image directory -.TP -.BR \-h ", " \-\-help -display help text and exit. -.TP -.B \-\-debug -output debug information of the build process -.TP -.BR \-v ", " \-\-verbose -verbose output during the build process - -.SH FILES -.TP -.B /boot/dracut/*.img -.TP -.B -.SH AUTHORS -.nf -Harald Hoyer -.fi -.SH AVAILABILITY -The dracut-catimages command is part of the dracut package and is available from -http://sourceforge.net/apps/trac/dracut/wiki - -.SH SEE ALSO -.BR dracut (8) diff --git a/dracut-catimages.8.xml b/dracut-catimages.8.xml new file mode 100644 index 000000000..67a6ae404 --- /dev/null +++ b/dracut-catimages.8.xml @@ -0,0 +1,117 @@ + + + + + +DRACUT-CATIMAGES +8 +June 2009 +Linux + + +dracut-catimages +creates initial ramdisk image by concatenating images + + + + + dracut-catimages OPTION + <initramfs + base + image> + <image> + + + + + +DESCRIPTION +dracut-catimages +creates an initial ramdisk image by concatenating several images from the command +line and /boot/dracut/*.img + + + +OPTIONS + + + , + +overwrite existing initramfs file. + + + + , + +Directory with additional images to add (default: /boot/dracut/) + + + + , + +Overlay directory, which contains additional files that will be used to create an additional image + + + + + +Do not use the overlay directory + + + + + +Do not use the additional image directory + + + + , + +display help text and exit. + + + + + +output debug information of the build process + + + + , + +verbose output during the build process + + + + + + +FILES + + + /boot/dracut/*.img + + + + + + + +AUTHORS + +Harald Hoyer <harald@redhat.com> + + + +AVAILABILITY +The dracut-catimages command is part of the dracut package and is available from +http://sourceforge.net/apps/trac/dracut/wiki + + + +SEE ALSO +dracut8 + + + diff --git a/dracut-gencmdline.8 b/dracut-gencmdline.8 deleted file mode 100644 index 2f2ece71d..000000000 --- a/dracut-gencmdline.8 +++ /dev/null @@ -1,20 +0,0 @@ -.TH DRACUT-GENCMDLINE 8 "June 2009" "Linux" -.SH NAME -dracut-gencmdline \- generates kernel command line parameters for the dracut generated initramfs -.SH SYNOPSIS -.BR dracut-gencmdline - -.SH DESCRIPTION -.B dracut-gencmdline -generates kernel command line parameters for the dracut generated initramfs, which are very specific to the host system. - -.SH AUTHORS -.nf -Harald Hoyer -.fi -.SH AVAILABILITY -The dracut-gencmdline command is part of the dracut package and is available from -http://sourceforge.net/apps/trac/dracut/wiki - -.SH SEE ALSO -.BR dracut (8) diff --git a/dracut-gencmdline.8.xml b/dracut-gencmdline.8.xml new file mode 100644 index 000000000..6b0358284 --- /dev/null +++ b/dracut-gencmdline.8.xml @@ -0,0 +1,47 @@ + + + + + +DRACUT-GENCMDLINE +8 +June 2009 +Linux + + +dracut-gencmdline +generates kernel command line parameters for the dracut generated initramfs + + + + + dracut-gencmdline + + + + + +DESCRIPTION +dracut-gencmdline +generates kernel command line parameters for the dracut generated initramfs, which are very specific to the host system. + + + +AUTHORS + +Harald Hoyer <harald@redhat.com> + + + +AVAILABILITY +The dracut-gencmdline command is part of the dracut package and is available from +http://sourceforge.net/apps/trac/dracut/wiki + + + +SEE ALSO +dracut8 + + + diff --git a/dracut.8 b/dracut.8 deleted file mode 100644 index 2c668f88d..000000000 --- a/dracut.8 +++ /dev/null @@ -1,455 +0,0 @@ -.TH DRACUT 8 "June 2009" "Linux" -.SH NAME -dracut \- create initial ramdisk images for preloading modules -.SH SYNOPSIS -\fBdracut\fR [\fIOPTION\fR]... \fI\fR \fI\fR - -.SH DESCRIPTION -.B dracut -creates an initial image used by the kernel for -preloading the block device modules (such as IDE, SCSI or RAID) -which are needed to access the root filesystem. - -.SS Options -.TP -.BR \-f ", " \-\-force -overwrite existing initramfs file. -.TP -.BR \-m ", " \-\-modules " \fILIST\fR" -specify a space-separated list of dracut modules to call -when building the initramfs. -Modules are located in -.IR /usr/share/dracut/modules.d . -.TP -.BR \-o ", " \-\-omit " \fILIST\fR" -omit a space-separated list of dracut modules. -.TP -.BR \-a ", " \-\-add " \fILIST\fR" -add a space-separated list of dracut modules. -.TP -.BR \-d ", " \-\-drivers " \fILIST\fR" -specify a space-separated list of kernel modules to exclusively include -in the initramfs. -The kernel modules have to be specified without the ".ko" suffix. -.TP -.BR \-\-add-drivers " \fILIST\fR" -specify a space-separated list of kernel modules to add to the initramfs. -The kernel modules have to be specified without the ".ko" suffix. -.TP -.BR \-\-filesystems " \fILIST\fR" -specify a space-separated list of kernel filesystem modules to exclusively -include in the generic initramfs. -.TP -.BR \-k ", " \-\-kmoddir " \fI{DIR}\fR -specify the directory, where to look for kernel modules -.TP -.BR " \-\-fwdir " \fI{DIR}\fR -specify additional directory, where to look for firmwares -.TP -.BR \-\-kernel-only -only install kernel drivers and firmware files -.TP -.BR \-\-no-kernel -do not install kernel drivers and firmware files -.TP -.BR \-\-ignore-kernel-modules -don't try to load modules; it automatically implies \fB--no-kernel\fR; it's -assumed that everything needed is built into kernel -.TP -.BR \-\-mdadmconf -include local /etc/mdadm.conf -.TP -.BR \-\-nomdadmconf -do not include local /etc/mdadm.conf -.TP -.BR \-\-strip -strip binaries in the initramfs (default) -.TP -.BR \-\-nostrip -do not strip binaries in the initramfs -.TP -.BR \-h ", " \-\-help -display help text and exit. -.TP -.B \-\-debug -output debug information of the build process -.TP -.BR \-v ", " \-\-verbose -verbose output during the build process -.TP -.BR \-c ", " \-\-conf " \fIFILE\fR" -specify configuration file to use. -Default: -.IR /etc/dracut.conf -.TP -.BR \-\-confdir " \fIDIR\fR" -specify configuration directory to use. -Default: -.IR /etc/dracut.conf.d -.TP -.BR \-l ", " \-\-local -local mode. Use modules from the current working -directory instead of the system-wide installed in -.IR /usr/share/dracut/modules.d . -Useful when running dracut from a git checkout. -.TP -.BR \-H ", " \-\-hostonly -Host-Only mode: Install only what is needed for -booting the local host instead of a generic host. -.TP -.BR \-i ", " \-\-include " \fISOURCE\fR" "" " \fITARGET\fR" -include the files in the SOURCE directory into the -target directory in the final initramfs. -.TP -.BR \-I ", " \-\-install " \fILIST\fR" -install the space separated list of files into the initramfs. - -.SH "KERNEL COMMAND LINE" -The root filesystem used by the kernel is specified in the boot configuration -file, as always. The traditional \fBroot=/dev/hda1\fR style device -specification is allowed. If a label is used, as in \fBroot=LABEL=rootPart\fR -the initrd will search all available devices for an ext2 or ext3 filesystem -with the appropriate label, and mount that device as the root filesystem. -\fBroot=UUID=uuidnumber\fR will mount the partition with that UUID as the -root filesystem. - -.SS Standard -.TP -.BR init= "" -.TP -.BR root= "" -specify blockdevice to use as root filesystem. - e.g. - root=/dev/sda1 - root=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1 -.TP -.BR rootfstype= "" -"auto" if not specified, e.g. rootfstype=ext3 -.TP -.BR rootflags "=" -specify additional mount options for the root filesystem. If not set, /etc/fstab -of the real root will be parsed for special mount options and mounted -accordingly. -.TP -.B rd_NO_FSTAB -do not honor special mount options for the root filesystem found in -/etc/fstab of the real root. - -.SS Misc -.TP -.BR rdblacklist= -do not load kernel module -This parameter can be specified multiple times. -.TP -.BR rdloaddriver= -force loading kernel module -This parameter can be specified multiple times. - -.SS Debug -.TP -.B rdinfo -print informational output though "quiet" is set -.TP -.B rdshell -allow dropping to a shell, if root mounting fails -.TP -.B rdinitdebug -set -x for the dracut shell and logs to dmesg, console and /init.log -.TP -.B rdbreak -drop to a shell at the end -.TP -.ad l -.BR rdbreak= \%{cmdline\:|pre-udev\:|pre-trigger\:|initqueue\:|pre-mount\:|mount\:|pre-pivot} -.ad -drop to a shell on defined breakpoint -.TP -.B rdudevinfo -set udev to loglevel info -.TP -.B rdudevdebug -set udev to loglevel debug - -.SS I18N - e.g. - LANG=en_US.UTF-8 - SYSFONT=latarcyrheb-sun16 - KEYTABLE=de-latin1-nodeadkeys -.TP -.BR KEYBOARDTYPE= sun|pc -will be written to /etc/sysconfig/keyboard in the initramfs -.TP -.BR KEYTABLE= "" -will be written to /etc/sysconfig/keyboard in the initramfs -.TP -.BR SYSFONT= "Console font" -will be written to /etc/sysconfig/i18n in the initramfs -.TP -.BR SYSFONTACM= "Unicode font map" -will be written to /etc/sysconfig/i18n in the initramfs -.TP -.BR UNIMAP= "Unicode font map" -will be written to /etc/sysconfig/i18n in the initramfs -.TP -.BR LANG= -will be written to /etc/sysconfig/i18n in the initramfs - -.SS LVM -.TP -.BR rd_NO_LVM -disable LVM detection -.TP -.BR rd_LVM_VG= "" -only activate the volume groups with the given name -rd_LVM_VG can be specified multiple times on the kernel command line. -.TP -.BR rd_LVM_LV= "" -only activate the logical volumes with the given name -rd_LVM_LV can be specified multiple times on the kernel command line. -.TP -.BR rd_NO_LVMCONF -remove any /etc/lvm/lvm.conf, which may exist in the initramfs - -.SS "crypto LUKS" -.TP -.BR rd_NO_LUKS -disable crypto LUKS detection -.TP -.BR rd_LUKS_UUID= "" -only activate the LUKS partitions with the given UUID -Any "luks-" of the LUKS UUID is removed before comparing to . -The comparisons also matches, if is only the beginning of the -LUKS UUID, so you don't have to specify the full UUID. -This parameter can be specified multiple times. -.TP -.BR rd_NO_CRYPTTAB -do not check, if LUKS partition is in /etc/crypttab - -.SS MD -.TP -.BR rd_NO_MD -disable MD RAID detection -.TP -.BR rd_NO_MDIMSM -no MD RAID for imsm/isw raids, use dmraid instead -.TP -.BR rd_NO_MDADMCONF -ignore mdadm.conf included in initramfs -.TP -.BR rd_MD_UUID= "" -only activate the raid sets with the given UUID. -This parameter can be specified multiple times. - -.SS DMRAID -.TP -.BR rd_NO_DM -disable DM RAID detection -.TP -.BR rd_DM_UUID= "" -only activate the raid sets with the given UUID. -This parameter can be specified multiple times. - -.SS Network -.TP -.BR ip= {dhcp|on|any|dhcp6|auto6} -dhcp|on|any: get ip from dhcp server from all interfaces. If root=dhcp, -loop sequentially through all interfaces (eth0, eth1, ...) and use the first -with a valid DHCP root-path. - -auto6: do IPv6 autoconfiguration -.TP -.BR ip= :{dhcp|on|any|dhcp6|auto6} -dhcp|on|any|dhcp6: get ip from dhcp server on a specific interface -auto6: do IPv6 autoconfiguration -This parameter can be specified multiple times. - -.TP -.ad l -.BR ip= "\%\::[]\::\::\::\::\::{none|off}" -.ad -explicit network configuration. If you want do define a IPv6 address, put it in brackets (e.g. [2001:DB8::1]). -This parameter can be specified multiple times. -.TP -.BR ifname= : -Assign network device name (ie eth0) to the NIC with MAC . -Note letters in the MAC-address must be lowercase! -Note that if you use this option you \fBmust\fR specify an ifname= argument -for all interfaces used in ip= or fcoe= arguments -This parameter can be specified multiple times. -.TP -.BR bootdev= -specify network interface to use routing and netroot information from. -Required if multiple ip= lines are used. -.TP -.BR nameserver= " [nameserver= ...]" -specify nameserver(s) to use - -.SS NFS -.TP -.BR root= "[:][:]" -mount nfs share from :/, if no server-ip is given, -use dhcp next_server. if server-ip is an IPv6 address it has to be put in brackets, e.g. [2001:DB8::1]. -NFS options can be appended with the prefix ":" or "," and are seperated by ",". -.TP -.BR root= "nfs:[:][:]" -.TP -.BR root= "nfs4:[:][:]" -.TP -.BR root= dhcp|dhcp6 -root=dhcp alone directs initrd to look at the DHCP root-path where NFS -options can be specified. - root-path=:[,] - root-path=nfs::[,] - root-path=nfs4::[,] -.TP -.BR root= /dev/nfs " nfsroot=" "[:][,]" -\fBDeprecated!\fR kernel Documentation/filesystems/nfsroot.txt defines -this method. -This is supported by dracut but not recommended. -.TP -.BR rd_NFS_DOMAIN= "" -Set the NFSv4 domain name. Will overwrite the settings in /etc/idmap.conf. - -.SS iSCSI -.TP -.ad l -.BR root= "\%iscsi:[username:password\:[:reverse:password]@]\:[]\::[]\::[]\::[]\::" -.ad -protocol defaults to "6", LUN defaults to "0". - -If the "servername" field is provided by BOOTP or DHCP, then that -field is used in conjunction with other associated fields to contact -the boot server in the Boot stage (Section 7). However, if the -"servername" field is not provided, then the "targetname" field is -then used in the Discovery Service stage in conjunction with other -associated fields. - -http://tools.ietf.org/html/rfc4173 - -.TP -.ad l -.BR root= "\%iscsi:[username:password\:[:reverse:password]@]\:[]\::[]\::[]\::[]\::" -.ad -e.g. root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0 - -.ad l -If servername is an IPv6 address, it has to be put in brackets. - e.g. - root=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0 -.TP -.ad l -.BR root= ??? " netroot=" "\%iscsi:[username:password[:reverse:password]@]\:[]\::[]\::[]\::[]\:: ..." -.ad -multiple netroot options allow setting up multiple iscsi disks - e.g. - root=UUID=12424547 - netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0 - netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1 - -.ad l -If servername is an IPv6 address, it has to be put in brackets. - e.g. - netroot=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0 -.TP -.ad l -.BR \%root= \%??? " \%iscsi_initiator=" \% " \%iscsi_target_name=" "" " \%iscsi_target_ip=" "" " \%iscsi_target_port=" "" " \%iscsi_target_group=" "" " \%iscsi_username=" "" " \%iscsi_password=" " \%iscsi_in_username=" "" " \%iscsi_in_password=" "" -.ad -manually specify all iscsistart parameter (see \fIiscsistart\ --help\fR) - -.TP -.BR root= ??? " iscsi_firmware" -will read the iscsi parameter from the BIOS firmware - -.SS FCoE -.TP -.BR netroot= fcoe:: -Try to connect to a FCoE SAN through the NIC specified by or , -for the second argument, currently only nodcb is supported. Note letters in -the MAC-address must be lowercase! - -.SS NBD -.TP -.BR root= nbd::[:][:] -mount nbd share from -.TP -.BR root= dhcp -with dhcp root-path=nbd::[:][:] -root=dhcp alone directs initrd to look at the DHCP root-path where NBD -options can be specified. -This syntax is only usable in cases where you are directly mounting the volume -as the rootfs. - - -.SS DASD -.TP -.BR rd_DASD_MOD= .... -same syntax as the kernel module parameter (s390 only) - -.TP -.ad l -.BR rd_DASD= "\%\:[,readonly=X]\:[,use_diag=X]\:[,erplog=X]\:[,failfast=X]" -.ad -activate DASD device with the given adaptor device bus ID and setting the sysfs attributes -to the specified values -This parameter can be specified multiple times. - -.SS ZFCP -.TP -.BR rd_ZFCP= ",\:,\:" -rd_ZFCP can be specified multiple times on the kernel command line. - -example: rd_ZFCP=0.0.4000,0x5005076300C213e9,0x5022000000000000 -.TP -.BR rd_NO_ZFCPCONF -ignore zfcp.conf included in the initramfs - -.SS ZNET -.TP -.BR rd_ZNET= ",," -rd_ZNET can be specified multiple times on the kernel command line. Examples: - rd_ZNET=qeth,0.0.0600,0.0.0601,0.0.0602,layer2=1,portname=foo - rd_ZNET=ctc,0.0.0600,0.0.0601,0.0.0602,protocol=bar - -.SS "Plymouth Boot Splash" -.TP -.BR rd_NO_PLYMOUTH -do not start plymouth. This will not work with encrypted partitions. - -.SH FILES -.TP -.B /var/log/dracut.log -logfile of initramfs image creation -.TP -.B /tmp/dracut.log -logfile of initramfs image creation, if /var/log/dracut.log is not writable -.TP -.B /etc/dracut.conf -see \fBdracut.conf\fR(5) -.TP -.B /etc/dracut.conf.d/*.conf -see \fBdracut.conf\fR(5) -.SS "Configuration in the Initramfs" -.TP -.B /conf/conf.d/ -Any files found in /conf/conf.d/ will be sourced in the initramfs to -set initial values. Command line options will override these values -set in the configuration files. -.TP -.B /etc/cmdline -Can contain additional command line options. - -.SH AUTHORS -.nf -Harald Hoyer -Victor Lowther -Warren Togami -Jeremy Katz -Philippe Seewer -David Dillow -.fi -.SH AVAILABILITY -The dracut command is part of the dracut package and is available from -http://sourceforge.net/apps/trac/dracut/wiki - -.SH SEE ALSO -.BR dracut.conf (5) diff --git a/dracut.8.xml b/dracut.8.xml new file mode 100644 index 000000000..ffdddcea9 --- /dev/null +++ b/dracut.8.xml @@ -0,0 +1,429 @@ + + + + + dracut + dracut + + + Project Leader, Developer + Harald + Hoyer + harald@redhat.com + + + Developer + Victor + Lowther + victor.lowther@gmail.com + + + Developer + Warren + Togami + wtogami@redhat.com + + + Developer + Jeremy + Katz + katzj@redhat.com + + + Developer + Philippe + Seewer + philippe.seewer@bfh.ch + + + Developer + David + Dillow + dave@thedillows.org + + + + + dracut + 8 + + + + dracut + create initial ramdisk images for preloading modules + + + + dracut + + OPTION + + + <image> + + <kernel-version> + + + + + + + Descrition + dracut +creates an initial image used by the kernel for +preloading the block device modules (such as IDE, SCSI or RAID) +which are needed to access the root filesystem. + +For a complete list of kernel command line options see + + dracut.kernel + 7 + + + + Options + + + + + + + + + + overwrite existing initramfs file. + + + + + + + + + + + specify a space-separated list of dracut modules to call +when building the initramfs. +Modules are located in +/usr/share/dracut/modules.d. + + + + + + + + + + + omit a space-separated list of dracut modules. + + + + + + + + + + + add a space-separated list of dracut modules. + + + + + + + + + + + specify a space-separated list of kernel modules to exclusively include +in the initramfs. +The kernel modules have to be specified without the ".ko" suffix. + + + + + + + + specify a space-separated list of kernel modules to add to the initramfs. +The kernel modules have to be specified without the ".ko" suffix. + + + + + + + + specify a space-separated list of kernel filesystem modules to exclusively +include in the generic initramfs. + + + + + + + + + + + specify the directory, where to look for kernel modules + + + + + + + + specify additional directory, where to look for firmwares + + + + + + + + only install kernel drivers and firmware files + + + + + + + + do not install kernel drivers and firmware files + + + + + + + + don't try to load modules; it automatically implies ; it's +assumed that everything needed is built into kernel + + + + + + + + include local /etc/mdadm.conf + + + + + + + + do not include local /etc/mdadm.conf + + + + + + + + strip binaries in the initramfs (default) + + + + + + + + do not strip binaries in the initramfs + + + + + + + + + + + display help text and exit. + + + + + + + + output debug information of the build process + + + + + + + + + + + verbose output during the build process + + + + + + + + + + + specify configuration file to use. +Default: +/etc/dracut.conf + + + + + + + + specify configuration directory to use. +Default: +/etc/dracut.conf.d + + + + + + + + + + + local mode. Use modules from the current working +directory instead of the system-wide installed in +/usr/share/dracut/modules.d. +Useful when running dracut from a git checkout. + + + + + + + + + + + Host-Only mode: Install only what is needed for +booting the local host instead of a generic host. + + + + + + + + + + + include the files in the SOURCE directory into the +target directory in the final initramfs. + + + + + + + + + + + install the space separated list of files into the initramfs. + + + + + + + FILES + + + + /var/log/dracut.log + + + logfile of initramfs image creation + + + + + /tmp/dracut.log + + + logfile of initramfs image creation, if /var/log/dracut.log is not writable + + + + + /etc/dracut.conf + + + see + dracut.conf + 5 + + + + + + /etc/dracut.conf.d/*.conf + + + see + dracut.conf + 5 + + + + + + Configuration in the Initramfs + + + + /conf/conf.d/ + + + Any files found in /conf/conf.d/ will be sourced in the initramfs to +set initial values. Command line options will override these values +set in the configuration files. + + + + + /etc/cmdline + + + Can contain additional command line options. + + + + + + + AVAILABILITY + The dracut command is part of the dracut package and is available from +http://sourceforge.net/apps/trac/dracut/wiki + + + SEE ALSO + + + dracut.kernel + 7 + + + dracut.conf + 5 + + + + diff --git a/dracut.conf.5 b/dracut.conf.5 deleted file mode 100644 index 4a9a02f17..000000000 --- a/dracut.conf.5 +++ /dev/null @@ -1,76 +0,0 @@ -.TH DRACUT.CONF 5 "NOV 2009" "Linux" -.SH NAME -dracut.conf \- configuration file(s) for dracut - -.SH SYNOPSIS -\fB/etc/dracut.conf\fR \fB/etc/dracut.conf.d/*.conf\fR - -.SH DESCRIPTION -.B dracut.conf -is loaded during the initialisation phase of dracut. -Command line parameter will overwrite any values set here. -.B dracut.conf.d/*.conf files are read in alphanumerical order and will -overwrite parameters set in /etc/dracut.conf. - -.SH OPTIONS -.TP -.BR dracutmodules+= \%"[LIST]" -Specify a space-separated list of dracut modules to -call when building the initramfs. Modules are located -in /usr/share/dracut/modules.d. -.TP -.BR omit_dracutmodules+= \%"[LIST]" -Omit a space-separated list of dracut modules. -.TP -.BR add_dracutmodules+= \%"[LIST]" -Add a space-separated list of dracut modules. -.TP -.BR drivers+= \%"[LIST]" -Specify a space-separated list of kernel modules to -exclusively include in the initramfs. -The kernel modules have to be specified without the ".ko" suffix. -.TP -.BR add_drivers+= \%"[LIST]" -Specify a space-separated list of kernel -modules to add to the initramfs. -The kernel modules have to be specified without the ".ko" suffix. -.TP -.BR filesystems+= \%"[LIST]" -Specify a space-separated list of kernel filesystem -modules to exclusively include in the generic -initramfs. -.TP -.BR drivers_dir= \%"" -Specify the directory, where to look for kernel modules -.TP -.BR fw_dir+= \%":[:\ ...]" -Specify additional directories, where to look for firmwares, separated by : -.TP -.BR do_strip= \%"yes|no" -Strip binaries in the initramfs (default=yes) -.TP -.BR hostonly= \%"yes|no" -Host-Only mode: Install only what is needed for booting -the local host instead of a generic host. -.TP -.BR mdadmconf= \%"yes|no" -Include local /etc/mdadm.conf (default=yes) -.TP -.BR lvmconf= \%"yes|no" -Include local /etc/lvm/lvm.conf (default=yes) -.TP -.BR kernel_only= "yes|no" -Only install kernel drivers and firmware files. (default=no) -.TP -.BR no_kernel= \%"yes|no" -Do not install kernel drivers and firmware files (default=no) - -.SH FILES -.TP -.B /etc/dracut/conf.d/ -Any /etc/dracut/conf.d/*.conf file can overwrite the values in /etc/dracut.conf. -The configuration files are read in alphanumerical order. - -.SH SEE ALSO -.BR dracut (8) - diff --git a/dracut.conf.5.xml b/dracut.conf.5.xml new file mode 100644 index 000000000..401e0e18e --- /dev/null +++ b/dracut.conf.5.xml @@ -0,0 +1,162 @@ + + + + + dracut.conf + dracut + + + Developer + Harald + Hoyer + harald@redhat.com + + + + + dracut.conf + 5 + + + dracut.conf + configuration file(s) for dracut + + + + /etc/dracut.conf + + /etc/dracut.conf.d/*.conf + + + + + + Description + dracut.conf +is loaded during the initialisation phase of dracut. +Command line parameter will overwrite any values set here. +dracut.conf.d/*.conf files are read in alphanumerical order and will +overwrite parameters set in /etc/dracut.conf. Each line specifies an attribute and a value. A '#' indicates the beginning of a comment; following characters, up to the end of the line are not interpreted. + + + dracutmodules+=" [LIST] " + + Specify a space-separated list of dracut modules to +call when building the initramfs. Modules are located +in /usr/share/dracut/modules.d. + + + + omit_dracutmodules+=" [LIST] " + + Omit a space-separated list of dracut modules. + + + + add_dracutmodules+=" [LIST] " + + Add a space-separated list of dracut modules. + + + + drivers+=" [LIST] " + + Specify a space-separated list of kernel modules to +exclusively include in the initramfs. +The kernel modules have to be specified without the ".ko" suffix. + + + + add_drivers+=" [LIST] " + + Specify a space-separated list of kernel +modules to add to the initramfs. +The kernel modules have to be specified without the ".ko" suffix. + + + + filesystems+=" [LIST] " + + Specify a space-separated list of kernel filesystem +modules to exclusively include in the generic +initramfs. + + + + drivers_dir=­"<dir> + + Specify the directory, where to look for kernel modules + + + + fw_dir+=­":<dir>[:<dir> ...] + + Specify additional directories, where to look for firmwares, separated by : + + + + do_strip=­"yes|no + + Strip binaries in the initramfs (default=yes) + + + + hostonly=­"yes|no + + Host-Only mode: Install only what is needed for booting +the local host instead of a generic host. + + + + mdadmconf=­"yes|no + + Include local /etc/mdadm.conf (default=yes) + + + + lvmconf=­"yes|no + + Include local /etc/lvm/lvm.conf (default=yes) + + + + kernel_only=yes|no + + Only install kernel drivers and firmware files. (default=no) + + + + no_kernel="yes|no + + Do not install kernel drivers and firmware files (default=no) + + + + + + Files + + + + /etc/dracut/conf.d/ + + + Any /etc/dracut/conf.d/*.conf file can overwrite the values in /etc/dracut.conf. +The configuration files are read in alphanumerical order. + + + + + + See Also + + dracut + 8 + + + dracut.kernel + 7 + + + + diff --git a/dracut.kernel.7.xml b/dracut.kernel.7.xml new file mode 100644 index 000000000..4fd51de80 --- /dev/null +++ b/dracut.kernel.7.xml @@ -0,0 +1,679 @@ + + + + + dracut.kernel + dracut + + + Developer + Harald + Hoyer + harald@redhat.com + + + + + dracut.kernel + 7 + + + + dracut.kernel + dracut kernel command line options + + + Description + The root filesystem used by the kernel is specified in the boot configuration +file, as always. The traditional root=/dev/hda1 style device +specification is allowed. If a label is used, as in root=LABEL=rootPart +the initramfs will search all available devices for an ext2 or ext3 filesystem +with the appropriate label, and mount that device as the root filesystem. +root=UUID=uuidnumber will mount the partition with that UUID as the +root filesystem. + + Standard + + + + init= + <path to real init> + + + + + + + + root=<path to blockdevice> + + + specify blockdevice to use as root filesystem. + e.g. + root=/dev/sda1 + root=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1 + + + + + rootfstype=<filesystem type> + + + "auto" if not specified, e.g. rootfstype=ext3 + + + + + rootflags=<mount options> + + + specify additional mount options for the root filesystem. If not set, /etc/fstab +of the real root will be parsed for special mount options and mounted +accordingly. + + + + + rd_NO_FSTAB + + + do not honor special mount options for the root filesystem found in +/etc/fstab of the real root. + + + + + + Misc + + + + rdblacklist=<drivername> + + + do not load kernel module <drivername> +This parameter can be specified multiple times. + + + + + rdloaddriver=<drivername> + + + force loading kernel module <drivername> +This parameter can be specified multiple times. + + + + + + Debug + + + + rdinfo + + + print informational output though "quiet" is set + + + + + rdshell + + + allow dropping to a shell, if root mounting fails + + + + + rdinitdebug + + + set -x for the dracut shell and logs to dmesg, console and /init.log + + + + + rdbreak + + + drop to a shell at the end + + + + + rdbreak={cmdline|pre-udev|pre-trigger|initqueue|pre-mount|mount|pre-pivot} + + + drop to a shell on defined breakpoint + + + + + rdudevinfo + + + set udev to loglevel info + + + + + rdudevdebug + + + set udev to loglevel debug + + + + + + I18N + e.g. + LANG=en_US.UTF-8 + SYSFONT=latarcyrheb-sun16 + KEYTABLE=de-latin1-nodeadkeys + + + + KEYBOARDTYPE={sun|pc} + + + will be written to /etc/sysconfig/keyboard in the initramfs + + + + + KEYTABLE=<keytable filename> + + + will be written to /etc/sysconfig/keyboard in the initramfs + + + + SYSFONT=<Console font> + + will be written to /etc/sysconfig/i18n in the initramfs + + + + SYSFONTACM=Console map + + will be written to /etc/sysconfig/i18n in the initramfs + + + + + UNIMAP=<Unicode font map> + + + will be written to /etc/sysconfig/i18n in the initramfs + + + + + LANG=<locale> + + + will be written to /etc/sysconfig/i18n in the initramfs + + + + + + LVM + + + + rd_NO_LVM + + + disable LVM detection + + + + + rd_LVM_VG=<volume group name> + + + only activate the volume groups with the given name +rd_LVM_VG can be specified multiple times on the kernel command line. + + + + + rd_LVM_LV=<logical volume name> + + + only activate the logical volumes with the given name +rd_LVM_LV can be specified multiple times on the kernel command line. + + + + + rd_NO_LVMCONF + + + remove any /etc/lvm/lvm.conf, which may exist in the initramfs + + + + + + crypto LUKS + + + + rd_NO_LUKS + + + disable crypto LUKS detection + + + + + rd_LUKS_UUID=<luks uuid> + + + only activate the LUKS partitions with the given UUID +Any "luks-" of the LUKS UUID is removed before comparing to <luks uuid>. +The comparisons also matches, if <luks uuid> is only the beginning of the +LUKS UUID, so you don't have to specify the full UUID. +This parameter can be specified multiple times. + + + + + rd_NO_CRYPTTAB + + + do not check, if LUKS partition is in /etc/crypttab + + + + + + MD + + + + rd_NO_MD + + + disable MD RAID detection + + + + + rd_NO_MDIMSM + + + no MD RAID for imsm/isw raids, use dmraid instead + + + + + rd_NO_MDADMCONF + + + ignore mdadm.conf included in initramfs + + + + + rd_MD_UUID=<md uuid> + + + only activate the raid sets with the given UUID. +This parameter can be specified multiple times. + + + + + + DMRAID + + + + rd_NO_DM + + + disable DM RAID detection + + + + + rd_DM_UUID=<dmraid uuid> + + + only activate the raid sets with the given UUID. +This parameter can be specified multiple times. + + + + + + Network + + + ip={dhcp|on|any|dhcp6|auto6} + + dhcp|on|any: get ip from dhcp server from all interfaces. If root=dhcp, +loop sequentially through all interfaces (eth0, eth1, ...) and use the first +with a valid DHCP root-path. + auto6: do IPv6 autoconfiguration + + + + ip=<interface>:{dhcp|on|any|dhcp6|auto6} + + dhcp|on|any|dhcp6: get ip from dhcp server on a specific interface +auto6: do IPv6 autoconfiguration +This parameter can be specified multiple times. + + + + ip=<client-IP>: + <server-id> + :<gateway-IP>::<netmask>::<client_hostname>::<interface>::{none|off} + + explicit network configuration. If you want do define a IPv6 address, put it in brackets (e.g. [2001:DB8::1]). +This parameter can be specified multiple times. + + + + ifname=<interface>:<MAC> + + Assign network device name <interface> (ie eth0) to the NIC with MAC <MAC>. +Note letters in the MAC-address must be lowercase! +Note that if you use this option you must specify an ifname= argument +for all interfaces used in ip= or fcoe= arguments +This parameter can be specified multiple times. + + + + bootdev=<interface> + + specify network interface to use routing and netroot information from. +Required if multiple ip= lines are used. + + + + nameserver=<IP> [nameserver=<IP> ...] + + specify nameserver(s) to use + + + + + + NFS + + + root=[<server-ip>:]<root-dir>[:<nfs-options>] + + mount nfs share from <server-ip>:/<root-dir>, if no server-ip is given, +use dhcp next_server. if server-ip is an IPv6 address it has to be put in brackets, e.g. [2001:DB8::1]. +NFS options can be appended with the prefix ":" or "," and are seperated by ",". + + + + root=nfs:[<server-ip>:]<root-dir>[:<nfs-options>] + root=nfs4:[<server-ip>:]<root-dir>[:<nfs-options>] + root=dhcp|dhcp6 + + root=dhcp alone directs initrd to look at the DHCP root-path where NFS +options can be specified. + root-path=<server-ip>:<root-dir>[,<nfs-options>] + root-path=nfs:<server-ip>:<root-dir>[,<nfs-options>] + root-path=nfs4:<server-ip>:<root-dir>[,<nfs-options>] + + + + root=/dev/nfs nfsroot=[<server-ip>:]<root-dir>[,<nfs-options>] + + Deprecated! kernel Documentation/filesystems/nfsroot.txt defines +this method. +This is supported by dracut but not recommended. + + + + rd_NFS_DOMAIN=<NFSv4 domain name> + + Set the NFSv4 domain name. Will overwrite the settings in /etc/idmap.conf. + + + + + + iSCSI + + + root=iscsi:[username:password[:reverse:password]@][<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname> + + protocol defaults to "6", LUN defaults to "0". + If the "servername" field is provided by BOOTP or DHCP, then that +field is used in conjunction with other associated fields to contact +the boot server in the Boot stage (Section 7). However, if the +"servername" field is not provided, then the "targetname" field is +then used in the Discovery Service stage in conjunction with other +associated fields. + http://tools.ietf.org/html/rfc4173 + + + + root=iscsi:[username:password[:reverse:password]@][<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname> + + e.g. root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0 + If servername is an IPv6 address, it has to be put in brackets. + e.g. + root=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0 + + + + root=??? netroot=iscsi:[username:password[:reverse:password]@][<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname> ... + + multiple netroot options allow setting up multiple iscsi disks + e.g. + root=UUID=12424547 + netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0 + netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1 + If servername is an IPv6 address, it has to be put in brackets. + e.g. + netroot=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0 + + + + root=??? iscsi_initiator=<initiator><target name> iscsi_target_ip=<target ip> iscsi_target_port=<target port> iscsi_target_group=<target group> iscsi_username=<username> iscsi_password=<password> iscsi_in_username=<in username> iscsi_in_password=<in password> + + manually specify all iscsistart parameter (see iscsistart --help) + + + + root=??? iscsi_firmware + + will read the iscsi parameter from the BIOS firmware + + + + + + FCoE + + + netroot=fcoe:<interface|MAC>:<dcb|nodcb> + + Try to connect to a FCoE SAN through the NIC specified by <interface> or <MAC>, +for the second argument, currently only nodcb is supported. Note letters in +the MAC-address must be lowercase! + + + + + + NBD + + + root=nbd:<server>:<port>[:<fstype>][:<mountopts>] + + mount nbd share from <server> + + + + root=dhcp + + with dhcp root-path=nbd:<server>:<port>[:<fstype>][:<mountopts>] +root=dhcp alone directs initrd to look at the DHCP root-path where NBD +options can be specified. +This syntax is only usable in cases where you are directly mounting the volume +as the rootfs. + + + + + + DASD + + + rd_DASD_MOD=.... + + same syntax as the kernel module parameter (s390 only) + + + + rd_DASD=<dasd_adaptor device bus ID>[,readonly=X][,use_diag=X][,erplog=X][,failfast=X] + + activate DASD device with the given adaptor device bus ID and setting the sysfs attributes +to the specified values +This parameter can be specified multiple times. + + + + + + ZFCP + + + rd_ZFCP=<zfcp adaptor device bus ID>,<WWPN>,<FCPLUN> + + rd_ZFCP can be specified multiple times on the kernel command line. + example: rd_ZFCP=0.0.4000,0x5005076300C213e9,0x5022000000000000 + + + + + rd_NO_ZFCPCONF + + + ignore zfcp.conf included in the initramfs + + + + + + ZNET + + + rd_ZNET=<nettype>,<subchannels>,<options> + + rd_ZNET can be specified multiple times on the kernel command line. Examples: + rd_ZNET=qeth,0.0.0600,0.0.0601,0.0.0602,layer2=1,portname=foo + rd_ZNET=ctc,0.0.0600,0.0.0601,0.0.0602,protocol=bar + + + + + + Plymouth Boot Splash + + + + rd_NO_PLYMOUTH + + + do not start plymouth. This will not work with encrypted partitions. + + + + + + + FILES + + + + /var/log/dracut.log + + + logfile of initramfs image creation + + + + + /tmp/dracut.log + + + logfile of initramfs image creation, if /var/log/dracut.log is not writable + + + + + /etc/dracut.conf + + + see + dracut.conf + 5 + + + + + + /etc/dracut.conf.d/*.conf + + + see + dracut.conf + 5 + + + + + + Configuration in the Initramfs + + + + /conf/conf.d/ + + + Any files found in /conf/conf.d/ will be sourced in the initramfs to +set initial values. Command line options will override these values +set in the configuration files. + + + + + /etc/cmdline + + + Can contain additional command line options. + + + + + + + See Also + + + dracut + 8 + + + dracut.conf + 5 + + + + -- 2.47.3