From f844e7dc8fad137294b928a406eb8e0010244f73 Mon Sep 17 00:00:00 2001 From: Harald Hoyer Date: Mon, 23 Aug 2010 12:22:52 +0200 Subject: [PATCH] manpage corrections --- dracut.8.xml | 12 ++-- dracut.conf.5.xml | 25 +++---- dracut.kernel.7.xml | 163 +++++++++++++++----------------------------- 3 files changed, 73 insertions(+), 127 deletions(-) diff --git a/dracut.8.xml b/dracut.8.xml index 8efced2cc..3be42a872 100644 --- a/dracut.8.xml +++ b/dracut.8.xml @@ -216,7 +216,7 @@ assumed that everything needed is built into kernel - include local /etc/mdadm.conf + include local /etc/mdadm.conf @@ -224,7 +224,7 @@ assumed that everything needed is built into kernel - do not include local /etc/mdadm.conf + do not include local /etc/mdadm.conf @@ -304,7 +304,7 @@ Default: - activates the local mode. Dracut will use modules from the current working + activates the local mode. dracut will use modules from the current working directory instead of the system-wide installed modules in /usr/share/dracut/modules.d. Thsi is useful when running dracut from a git checkout. @@ -320,9 +320,7 @@ Thsi is 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. - - If chrooted to another root other than the real root device, use "--fstab" and provide a valid /etc/fstab. - + If chrooted to another root other than the real root device, use "--fstab" and provide a valid /etc/fstab. @@ -455,7 +453,7 @@ target directory in the final initramfs. /conf/conf.d/ - Any files found in /conf/conf.d/ will be sourced in the initramfs to + 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. diff --git a/dracut.conf.5.xml b/dracut.conf.5.xml index 175a2fe88..df8923371 100644 --- a/dracut.conf.5.xml +++ b/dracut.conf.5.xml @@ -32,11 +32,11 @@ Description - dracut.conf + 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. +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. @@ -45,7 +45,7 @@ overwrite parameters set in /etc/dracut.conf. Each line specifies an attribute a Specify a space-separated list of dracut modules to call when building the initramfs. Modules are located -in /usr/share/dracut/modules.d. +in /usr/share/dracut/modules.d. @@ -107,7 +107,7 @@ initramfs. fw_dir+=" :<dir>[:<dir> ...] " - Specify additional directories, where to look for firmwares, separated by : + Specify additional directories, where to look for firmwares, separated by : @@ -124,9 +124,10 @@ initramfs. Host-Only mode: Install only what is needed for booting - the local host instead of a generic host. - If chrooted to another root other than the real root device, use "--fstab" and provide a valid /etc/fstab. - + the local host instead of a generic host. + If chrooted to another root other than the real root device, use and provide a valid /etc/fstab. + + @@ -134,7 +135,7 @@ initramfs. use_fstab="{yes|no}" - Use /etc/fstab instead of /proc/self/mountinfo. + Use /etc/fstab instead of /proc/self/mountinfo. @@ -142,7 +143,7 @@ initramfs. mdadmconf="{yes|no}" - Include local /etc/mdadm.conf (default=yes) + Include local /etc/mdadm.conf (default=yes) @@ -150,7 +151,7 @@ initramfs. lvmconf="{yes|no}" - Include local /etc/lvm/lvm.conf (default=yes) + Include local /etc/lvm/lvm.conf (default=yes) @@ -179,7 +180,7 @@ initramfs. /etc/dracut/conf.d/ - Any /etc/dracut/conf.d/*.conf file can overwrite the values in /etc/dracut.conf. + Any /etc/dracut/conf.d/*.conf file can overwrite the values in /etc/dracut.conf. The configuration files are read in alphanumerical order. diff --git a/dracut.kernel.7.xml b/dracut.kernel.7.xml index 5cc73d468..07fdce2cd 100644 --- a/dracut.kernel.7.xml +++ b/dracut.kernel.7.xml @@ -48,11 +48,8 @@ root filesystem. 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 - + e.g.: root=/dev/sda1 +root=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1 @@ -60,7 +57,7 @@ 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 + "auto" if not specified, e.g.: rootfstype=ext3 @@ -68,7 +65,7 @@ root=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1 rootflags=<mount options> - specify additional mount options for the root filesystem. If not set, /etc/fstab + 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. @@ -79,7 +76,7 @@ accordingly. do not honor special mount options for the root filesystem found in -/etc/fstab of the real root. +/etc/fstab of the real root. @@ -131,7 +128,7 @@ This parameter can be specified multiple times. rdinitdebug - set -x for the dracut shell and logs to dmesg, console and /init.log + set -x for the dracut shell and logs to dmesg, console and /init.log @@ -143,7 +140,10 @@ This parameter can be specified multiple times. - rdbreak={cmdline|pre-udev|pre-trigger|initqueue|pre-mount|mount|pre-pivot} + + rdbreak= + {cmdline|pre-udev|pre-trigger|initqueue|pre-mount|mount|pre-pivot} + drop to a shell on defined breakpoint @@ -175,7 +175,7 @@ This parameter can be specified multiple times. <keymap base file name> - keyboard translation table loaded by loadkeys; taken from keymaps directory; will be written to /etc/sysconfig/keyboard in the initramfs, e.g.: KEYMAP=de-latin1-nodeadkeys + keyboard translation table loaded by loadkeys; taken from keymaps directory; will be written to /etc/sysconfig/keyboard in the initramfs, e.g.: KEYMAP=de-latin1-nodeadkeys @@ -184,7 +184,7 @@ This parameter can be specified multiple times. <list of keymap base file names> - list of extra keymaps to bo loaded (sep. by space); will be written to /etc/sysconfig/keyboard in the initramfs + list of extra keymaps to bo loaded (sep. by space); will be written to /etc/sysconfig/keyboard in the initramfs @@ -193,7 +193,7 @@ This parameter can be specified multiple times. <1|0> - boolean, indicating UTF-8 mode; will be written to /etc/sysconfig/i18n in the initramfs + boolean, indicating UTF-8 mode; will be written to /etc/sysconfig/i18n in the initramfs @@ -202,7 +202,7 @@ This parameter can be specified multiple times. <font base file name> - console font; taken from consolefonts directory; will be written to /etc/sysconfig/i18n in the initramfs; e.g.: SYSFONT=LatArCyrHeb-16 + console font; taken from consolefonts directory; will be written to /etc/sysconfig/i18n in the initramfs; e.g.: SYSFONT=LatArCyrHeb-16 @@ -211,7 +211,7 @@ This parameter can be specified multiple times. <console map base file name> - see description of '-m' parameter in setfont manual; taken from consoletrans directory; will be written to /etc/sysconfig/i18n in the initramfs + see description of '-m' parameter in setfont manual; taken from consoletrans directory; will be written to /etc/sysconfig/i18n in the initramfs @@ -220,7 +220,7 @@ This parameter can be specified multiple times. <unicode table base file name> - see description of '-u' parameter in setfont manual; taken from unimaps directory; will be written to /etc/sysconfig/i18n in the initramfs + see description of '-u' parameter in setfont manual; taken from unimaps directory; will be written to /etc/sysconfig/i18n in the initramfs @@ -229,7 +229,7 @@ This parameter can be specified multiple times. <locale> - taken from the environment; if no UNICODE is defined we set its value in basis of LANG value (whether it ends with ".utf8" (or similar) or not); will be written to /etc/sysconfig/i18n in the initramfs; e.g.: LANG=pl_PL.utf8 + taken from the environment; if no UNICODE is defined we set its value in basis of LANG value (whether it ends with ".utf8" (or similar) or not); will be written to /etc/sysconfig/i18n in the initramfs; e.g.: LANG=pl_PL.utf8 @@ -238,7 +238,7 @@ This parameter can be specified multiple times. <locale> - taken from the environment; will be written to /etc/sysconfig/i18n in the initramfs + taken from the environment; will be written to /etc/sysconfig/i18n in the initramfs @@ -260,7 +260,7 @@ This parameter can be specified multiple times. only activate the volume groups with the given name -rd_LVM_VG can be specified multiple times on the kernel command line. +rd_LVM_VG can be specified multiple times on the kernel command line. @@ -269,7 +269,7 @@ rd_LVM_VG can be specified multiple times on the kernel command line. only activate the logical volumes with the given name -rd_LVM_LV can be specified multiple times on the kernel command line. +rd_LVM_LV can be specified multiple times on the kernel command line. @@ -277,7 +277,7 @@ 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 + remove any /etc/lvm/lvm.conf, which may exist in the initramfs @@ -299,8 +299,8 @@ rd_LVM_LV can be specified multiple times on the kernel command line. 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 +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. @@ -310,7 +310,7 @@ This parameter can be specified multiple times. rd_NO_CRYPTTAB - do not check, if LUKS partition is in /etc/crypttab + do not check, if LUKS partition is in /etc/crypttab @@ -334,7 +334,7 @@ This parameter can be specified multiple times. <rem. device uuid> - UUID of removalbe device storing keyfile; UUID doesn't have to be exact just like for rd_LUKS_UUID + UUID of removalbe device storing keyfile; UUID doesn't have to be exact just like for rd_LUKS_UUID @@ -411,7 +411,8 @@ This parameter can be specified multiple times. 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 + auto6: IPv6 autoconfiguration + dhcp6: IPv6 DHCP @@ -436,8 +437,7 @@ This parameter can be specified multiple times. 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 +Note: 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. @@ -480,7 +480,7 @@ NFS options can be appended with the prefix ":" or "," and a - root=nfs:<server-ip>:<root-dir>:<nfs-options> + root=nfs:<server-ip>:<root-dir>:<nfs-options> root=nfs4:<server-ip>:<root-dir>:<nfs-options> root= @@ -504,9 +504,9 @@ options can be specified. :<nfs-options> - Deprecated! kernel Documentation/filesystems/nfsroot.txt defines + Deprecated! kernel Documentation/filesystems/nfsroot.txt defines this method. -This is supported by dracut but not recommended. +This is supported by dracut, but not recommended. @@ -515,7 +515,7 @@ This is supported by dracut but not recommended. <NFSv4 domain name> - Set the NFSv4 domain name. Will overwrite the settings in /etc/idmap.conf. + Set the NFSv4 domain name. Will overwrite the settings in /etc/idmap.conf. @@ -524,7 +524,7 @@ This is supported by dracut but not recommended. iSCSI - root=iscsi:<username>:<password>:<reverse>:<password>@ + root=iscsi:<username>:<password>:<reverse>:<password>@ <servername> : <protocol> @@ -542,19 +542,13 @@ the boot server in the Boot stage (Section 7). However, if the then used in the Discovery Service stage in conjunction with other associated fields. http://tools.ietf.org/html/rfc4173 - 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 - + 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>@ + root=??? netroot=iscsi:<username>:<password>:<reverse>:<password>@ <servername> : <protocol> @@ -564,14 +558,12 @@ root=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0 <LUN> :<targetname> ... - multiple netroot options allow setting up multiple iscsi disks. e.g. - -root=UUID=12424547 + 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 - +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. + e.g.: netroot=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0 @@ -604,11 +596,10 @@ netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1 FCoE - netroot=fcoe:<interface|MAC>:{dcb|nodcb} + 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! + 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! @@ -667,8 +658,7 @@ This parameter can be specified multiple times. 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_ZFCP can be specified multiple times on the kernel command line. e.g.: rd_ZFCP=0.0.4000,0x5005076300C213e9,0x5022000000000000 @@ -687,9 +677,9 @@ This parameter can be specified multiple times. 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 + rd_ZNET can be specified multiple times on the kernel command line. e.g.: + 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 @@ -709,70 +699,27 @@ This parameter can be specified multiple times. - Files + Configuration in the Initramfs - /var/log/dracut.log + /conf/conf.d/ - 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 - + 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/dracut.conf.d/*.conf + /etc/cmdline - see - dracut.conf - 5 - + Can contain additional command line options. - - 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 -- 2.47.3