From: Harald Hoyer Date: Thu, 5 Aug 2010 16:12:38 +0000 (+0200) Subject: manpage corrections X-Git-Tag: 007~24 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3eccdb52898a0dfe1e6ef209a33804982962592d;p=thirdparty%2Fdracut.git manpage corrections --- diff --git a/dracut.8.xml b/dracut.8.xml index ffdddcea9..924ff4cbc 100644 --- a/dracut.8.xml +++ b/dracut.8.xml @@ -1,45 +1,45 @@ - + dracut dracut - Project Leader, Developer - Harald - Hoyer - harald@redhat.com + Project Leader, Developer + Harald + Hoyer + harald@redhat.com - Developer - Victor - Lowther - victor.lowther@gmail.com + Developer + Victor + Lowther + victor.lowther@gmail.com - Developer - Warren - Togami - wtogami@redhat.com + Developer + Warren + Togami + wtogami@redhat.com - Developer - Jeremy - Katz - katzj@redhat.com + Developer + Jeremy + Katz + katzj@redhat.com - Developer - Philippe - Seewer - philippe.seewer@bfh.ch + Developer + Philippe + Seewer + philippe.seewer@bfh.ch - Developer - David - Dillow - dave@thedillows.org + Developer + David + Dillow + dave@thedillows.org @@ -73,7 +73,7 @@ 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 @@ -99,13 +99,13 @@ For a complete list of kernel command line options see - + specify a space-separated list of dracut modules to call when building the initramfs. Modules are located in -/usr/share/dracut/modules.d. +/usr/share/dracut/modules.d. This parameter can be specified multiple times. @@ -113,10 +113,10 @@ Modules are located in - + - omit a space-separated list of dracut modules. + omit a space-separated list of dracut modules. This parameter can be specified multiple times. @@ -124,10 +124,10 @@ Modules are located in - + - add a space-separated list of dracut modules. + add a space-separated list of dracut modules to the default set of modules. This parameter can be specified multiple times. @@ -135,30 +135,30 @@ Modules are located in - + 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. +The kernel modules have to be specified without the ".ko" suffix. This parameter can be specified multiple times. - + specify a space-separated list of kernel modules to add to the initramfs. -The kernel modules have to be specified without the ".ko" suffix. +The kernel modules have to be specified without the ".ko" suffix. This parameter can be specified multiple times. - + specify a space-separated list of kernel filesystem modules to exclusively -include in the generic initramfs. +include in the generic initramfs. This parameter can be specified multiple times. @@ -166,7 +166,7 @@ include in the generic initramfs. - + specify the directory, where to look for kernel modules @@ -174,10 +174,10 @@ include in the generic initramfs. - + - specify additional directory, where to look for firmwares + specify additional directories, where to look for firmwares. This parameter can be specified multiple times. @@ -272,7 +272,7 @@ assumed that everything needed is built into kernel - + specify configuration file to use. @@ -282,7 +282,7 @@ Default: - + specify configuration directory to use. @@ -298,10 +298,10 @@ Default: - local mode. Use modules from the current working -directory instead of the system-wide installed in + 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. -Useful when running dracut from a git checkout. +Thsi is useful when running dracut from a git checkout. @@ -321,7 +321,7 @@ booting the local host instead of a generic host. - + include the files in the SOURCE directory into the @@ -333,7 +333,7 @@ target directory in the final initramfs. - + install the space separated list of files into the initramfs. diff --git a/dracut.conf.5.xml b/dracut.conf.5.xml index 401e0e18e..10fb09df3 100644 --- a/dracut.conf.5.xml +++ b/dracut.conf.5.xml @@ -39,7 +39,9 @@ Command line parameter will overwrite any values set here. 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] " + + dracutmodules+=" <dracut modules> " + Specify a space-separated list of dracut modules to call when building the initramfs. Modules are located @@ -47,19 +49,25 @@ in /usr/share/dracut/modules.d. - omit_dracutmodules+=" [LIST] " + + omit_dracutmodules+=" <dracut modules> " + Omit a space-separated list of dracut modules. - add_dracutmodules+=" [LIST] " + + add_dracutmodules+=" <dracut modules> " + Add a space-separated list of dracut modules. - drivers+=" [LIST] " + + drivers+=" <kernel modules> " + Specify a space-separated list of kernel modules to exclusively include in the initramfs. @@ -67,7 +75,9 @@ The kernel modules have to be specified without the ".ko" suffix. - add_drivers+=" [LIST] " + + add_drivers+=" <kernel modules> " + Specify a space-separated list of kernel modules to add to the initramfs. @@ -75,7 +85,9 @@ The kernel modules have to be specified without the ".ko" suffix. - filesystems+=" [LIST] " + + filesystems+=" <filesystem names> " + Specify a space-separated list of kernel filesystem modules to exclusively include in the generic @@ -83,50 +95,66 @@ initramfs. - drivers_dir=­"<dir> + + drivers_dir="<kernel modules directory>" + Specify the directory, where to look for kernel modules - fw_dir+=­":<dir>[:<dir> ...] + + fw_dir+=" :<dir>[:<dir> ...] " + Specify additional directories, where to look for firmwares, separated by : - do_strip=­"yes|no + + do_strip="{yes|no}" + Strip binaries in the initramfs (default=yes) - hostonly=­"yes|no + + hostonly="{yes|no}" + Host-Only mode: Install only what is needed for booting the local host instead of a generic host. - mdadmconf=­"yes|no + + mdadmconf="{yes|no}" + Include local /etc/mdadm.conf (default=yes) - lvmconf=­"yes|no + + lvmconf="{yes|no}" + Include local /etc/lvm/lvm.conf (default=yes) - kernel_only=yes|no + + kernel_only="{yes|no}" + Only install kernel drivers and firmware files. (default=no) - no_kernel="yes|no + + no_kernel="{yes|no}" + Do not install kernel drivers and firmware files (default=no) diff --git a/dracut.kernel.7.xml b/dracut.kernel.7.xml index 4fd51de80..6ab91b2fa 100644 --- a/dracut.kernel.7.xml +++ b/dracut.kernel.7.xml @@ -1,15 +1,15 @@ - + dracut.kernel dracut - Developer - Harald - Hoyer - harald@redhat.com + Developer + Harald + Hoyer + harald@redhat.com @@ -36,8 +36,7 @@ root filesystem. - init= - <path to real init> + init=<path to real init> @@ -49,9 +48,11 @@ 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 + @@ -142,9 +143,7 @@ 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 @@ -170,13 +169,17 @@ This parameter can be specified multiple times. I18N e.g. - LANG=en_US.UTF-8 - SYSFONT=latarcyrheb-sun16 - KEYTABLE=de-latin1-nodeadkeys + +LANG=en_US.UTF-8 +SYSFONT=latarcyrheb-sun16 +KEYTABLE=de-latin1-nodeadkeys + + - KEYBOARDTYPE={sun|pc} + KEYBOARDTYPE= + {sun|pc} will be written to /etc/sysconfig/keyboard in the initramfs @@ -191,20 +194,25 @@ This parameter can be specified multiple times. - SYSFONT=<Console font> + + SYSFONT=<Console font> + will be written to /etc/sysconfig/i18n in the initramfs - SYSFONTACM=Console map + + SYSFONTACM= + <Console map> + will be written to /etc/sysconfig/i18n in the initramfs - UNIMAP=<Unicode font map> + UNIMAP=<Unicode font map> will be written to /etc/sysconfig/i18n in the initramfs @@ -356,7 +364,10 @@ This parameter can be specified multiple times. Network - ip={dhcp|on|any|dhcp6|auto6} + + 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 @@ -365,7 +376,7 @@ with a valid DHCP root-path. - ip=<interface>:{dhcp|on|any|dhcp6|auto6} + ip=<interface>:{dhcp|on|any|dhcp6|auto6} dhcp|on|any|dhcp6: get ip from dhcp server on a specific interface auto6: do IPv6 autoconfiguration @@ -375,14 +386,14 @@ This parameter can be specified multiple times. ip=<client-IP>: <server-id> - :<gateway-IP>::<netmask>::<client_hostname>::<interface>::{none|off} + :<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> + 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! @@ -392,14 +403,21 @@ This parameter can be specified multiple times. - bootdev=<interface> + + bootdev= + <interface> + specify network interface to use routing and netroot information from. Required if multiple ip= lines are used. - nameserver=<IP> [nameserver=<IP> ...] + + nameserver= + <IP> + nameserver=<IP> ... + specify nameserver(s) to use @@ -410,7 +428,12 @@ Required if multiple ip= lines are used. NFS - root=[<server-ip>:]<root-dir>[:<nfs-options>] + + 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]. @@ -418,9 +441,12 @@ NFS options can be appended with the prefix ":" or "," and a - root=nfs:[<server-ip>:]<root-dir>[:<nfs-options>] - root=nfs4:[<server-ip>:]<root-dir>[:<nfs-options>] - root=dhcp|dhcp6 + 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. @@ -430,7 +456,14 @@ options can be specified. - root=/dev/nfs nfsroot=[<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. @@ -438,7 +471,10 @@ This is supported by dracut but not recommended. - rd_NFS_DOMAIN=<NFSv4 domain name> + + rd_NFS_DOMAIN= + <NFSv4 domain name> + Set the NFSv4 domain name. Will overwrite the settings in /etc/idmap.conf. @@ -449,7 +485,15 @@ This is supported by dracut but not recommended. iSCSI - root=iscsi:[username:password[:reverse:password]@][<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname> + 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 @@ -459,32 +503,52 @@ 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 - - - - 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 + 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 + 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> + + root=??? + iscsi_initiator=<initiator> + iscsi_target_name=<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) @@ -501,7 +565,7 @@ associated fields. 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 @@ -514,13 +578,15 @@ the MAC-address must be lowercase! NBD - root=nbd:<server>:<port>[:<fstype>][:<mountopts>] + root=nbd:<server>:<port>:<fstype>:<mountopts> mount nbd share from <server> - root=dhcp + + 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 @@ -541,7 +607,13 @@ as the rootfs. - rd_DASD=<dasd_adaptor device bus ID>[,readonly=X][,use_diag=X][,erplog=X][,failfast=X] + + rd_DASD= + <dasd_adaptor device bus ID> + ,readonly=X + ,use_diag=X + ,erplog=X + activate DASD device with the given adaptor device bus ID and setting the sysfs attributes to the specified values @@ -554,7 +626,7 @@ This parameter can be specified multiple times. ZFCP - rd_ZFCP=<zfcp adaptor device bus ID>,<WWPN>,<FCPLUN> + 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 @@ -574,7 +646,7 @@ This parameter can be specified multiple times. ZNET - rd_ZNET=<nettype>,<subchannels>,<options> + 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