diff options
| author | Harald Hoyer <harald@redhat.com> | 2012-03-14 13:58:26 +0100 |
|---|---|---|
| committer | Harald Hoyer <harald@redhat.com> | 2012-03-14 15:48:33 +0100 |
| commit | 888d53f270a1a163460d764c886c23f2f276c035 (patch) | |
| tree | 7a475c68f62e9ca8456badbf60afbfe81266e038 /dracut.8.xml | |
| parent | dc824f19943d31bfba33f017be63e0c8ed74bb47 (diff) | |
| download | dracut-888d53f270a1a163460d764c886c23f2f276c035.tar.gz dracut-888d53f270a1a163460d764c886c23f2f276c035.tar.bz2 dracut-888d53f270a1a163460d764c886c23f2f276c035.zip | |
replace xml documentation with asciidoc
Diffstat (limited to 'dracut.8.xml')
| -rw-r--r-- | dracut.8.xml | 684 |
1 files changed, 0 insertions, 684 deletions
diff --git a/dracut.8.xml b/dracut.8.xml deleted file mode 100644 index de1a0bfd..00000000 --- a/dracut.8.xml +++ /dev/null @@ -1,684 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!-- This document was created with Syntext Serna Free. --><!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []> -<!-- vim: set ts=8 sts=2 sw=2 et: --> -<refentry id="dracut8"> - <refentryinfo> - <title>dracut</title> - <productname>dracut</productname> - <authorgroup> - <author> - <contrib>Project Leader, Developer</contrib> - <firstname>Harald</firstname> - <surname>Hoyer</surname> - <email>harald@redhat.com</email> - </author> - <author> - <contrib>Developer</contrib> - <firstname>Victor</firstname> - <surname>Lowther</surname> - <email>victor.lowther@gmail.com</email> - </author> - <author> - <contrib>Developer</contrib> - <firstname>Philippe</firstname> - <surname>Seewer</surname> - <email>philippe.seewer@bfh.ch</email> - </author> - <author> - <contrib>Developer</contrib> - <firstname>Warren</firstname> - <surname>Togami</surname> - </author> - <author> - <contrib>Developer</contrib> - <firstname>Amadeusz</firstname> - <surname>Żołnowski</surname> - <email>aidecoe@aidecoe.name</email> - </author> - <author> - <contrib>Developer</contrib> - <firstname>Jeremy</firstname> - <surname>Katz</surname> - </author> - <author> - <contrib>Developer</contrib> - <firstname>David</firstname> - <surname>Dillow</surname> - <email>dave@thedillows.org</email> - </author> - </authorgroup> - </refentryinfo> - <refmeta> - <refentrytitle>dracut</refentrytitle> - <manvolnum>8</manvolnum> - <refmiscinfo class="version"/> - </refmeta> - <refnamediv> - <refname>dracut</refname> - <refpurpose>create initial ramdisk images for preloading modules</refpurpose> - </refnamediv> - <refsynopsisdiv> - <cmdsynopsis> - <command>dracut</command> - <arg choice="opt" rep="repeat"> - <replaceable>OPTION</replaceable> - </arg> - <arg choice="opt"> - <replaceable><image></replaceable> - <arg choice="opt"> - <replaceable><kernel-version></replaceable> - </arg> - </arg> - <sbr/> - </cmdsynopsis> - </refsynopsisdiv> - <refsect1> - <title>Description</title> - <para><command>dracut</command> -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.</para> - <para> -For a complete list of kernel command line options see - <citerefentry> - <refentrytitle>dracut.cmdline</refentrytitle> - <manvolnum>7</manvolnum> - </citerefentry> -</para> - <refsect2> - <title>Options</title> - <variablelist> - <varlistentry> - <term> - <option>-f</option> - </term> - <term> - <option>--force</option> - </term> - <listitem> - <para>overwrite existing initramfs file.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-m</option> - </term> - <term> - <option>--modules <replaceable><list of dracut modules></replaceable></option> - </term> - <listitem> - <para>specify a space-separated list of dracut modules to call -when building the initramfs. -Modules are located in -<filename>/usr/lib/dracut/modules.d</filename>. This parameter can be specified multiple times.</para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --modules "module1 module2" ...</screen> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-o</option> - </term> - <term> - <option>--omit <replaceable><list of dracut modules></replaceable></option> - </term> - <listitem> - <para>omit a space-separated list of dracut modules. This parameter can be specified multiple times.</para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --omit "module1 module2" ...</screen> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-a</option> - </term> - <term> - <option>--add <replaceable><list of dracut modules></replaceable></option> - </term> - <listitem> - <para>add a space-separated list of dracut modules to the default set of modules. This parameter can be specified multiple times.</para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --add "module1 module2" ...</screen> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--force-add <replaceable><list of dracut modules></replaceable></option> - </term> - <listitem> - <para>force to add a space-separated list of dracut modules to the default set of modules, when -H is specified. This parameter can be specified multiple times.</para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --force-add "module1 module2" ...</screen> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <option>-d</option> - </term> - <term> - <option>--drivers <replaceable><list of kernel modules></replaceable></option> - </term> - <listitem> - <para>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. This parameter can be specified multiple times.</para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --drivers "kmodule1 kmodule2" ...</screen> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--add-drivers <replaceable><list of kernel modules></replaceable></option> - </term> - <listitem> - <para>specify a space-separated list of kernel modules to add to the initramfs. -The kernel modules have to be specified without the ".ko" suffix. This parameter can be specified multiple times.</para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --add-drivers "kmodule1 kmodule2" ...</screen> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--omit-drivers <replaceable><list of kernel modules></replaceable></option> - </term> - <listitem> - <para>specify a space-separated list of kernel modules not to add to the initramfs. -The kernel modules have to be specified without the ".ko" suffix. This parameter can be specified multiple times.</para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --omit-drivers "kmodule1 kmodule2" ...</screen> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--filesystems <replaceable><list of filesystems></replaceable></option> - </term> - <listitem> - <para>specify a space-separated list of kernel filesystem modules to exclusively -include in the generic initramfs. This parameter can be specified multiple times.</para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --filesystems "filesystem1 filesystem2" ...</screen> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-k</option> - </term> - <term> - <option>--kmoddir <replaceable><kernel directory></replaceable></option> - </term> - <listitem> - <para>specify the directory, where to look for kernel modules</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option> --fwdir <replaceable><dir>[:<dir>...]</replaceable></option> - </term> - <listitem> - <para>specify additional directories, where to look for firmwares. This parameter can be specified multiple times.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--kernel-only</option> - </term> - <listitem> - <para>only install kernel drivers and firmware files</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--no-kernel</option> - </term> - <listitem> - <para>do not install kernel drivers and firmware files</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--mdadmconf</option> - </term> - <listitem> - <para>include local <filename>/etc/mdadm.conf</filename></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--nomdadmconf</option> - </term> - <listitem> - <para>do not include local <filename>/etc/mdadm.conf</filename></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--lvmconf</option> - </term> - <listitem> - <para>include local <filename>/etc/lvm/lvm.conf</filename></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--nolvmconf</option> - </term> - <listitem> - <para>do not include local <filename>/etc/lvm/lvm.conf</filename></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--fscks [LIST]</option> - </term> - <listitem> - <para>add a space-separated list of fsck tools, in addition to - <filename>dracut.conf</filename>'s specification; the - installation is opportunistic (non-existing tools are ignored) - </para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --fscks "fsck.foo barfsck" ...</screen> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--nofscks</option> - </term> - <listitem> - <para>inhibit installation of any fsck tools</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--strip</option> - </term> - <listitem> - <para>strip binaries in the initramfs (default)</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--nostrip</option> - </term> - <listitem> - <para>do not strip binaries in the initramfs</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--prefix <replaceable><dir></replaceable></option> - </term> - <listitem> - <para>prefix initramfs files with the specified directory</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--noprefix</option> - </term> - <listitem> - <para>do not prefix initramfs files (default)</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--ctty</option> - </term> - <listitem> - <para>if possible, try to spawn an emergency shell on a terminal - with job control</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-h</option> - </term> - <term> - <option>--help</option> - </term> - <listitem> - <para>display help text and exit.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--debug</option> - </term> - <listitem> - <para>output debug information of the build process</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-v</option> - </term> - <term> - <option>--verbose</option> - </term> - <listitem> - <para>increase verbosity level (default is info(4))</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-q</option> - </term> - <term> - <option>--quiet</option> - </term> - <listitem> - <para>decrease verbosity level (default is info(4))</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-c</option> - </term> - <term> - <option>--conf <replaceable><dracut configuration file></replaceable></option> - </term> - <listitem> - <para>specify configuration file to use. -Default: -<filename>/etc/dracut.conf</filename></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--confdir <replaceable><configuration directory></replaceable></option> - </term> - <listitem> - <para>specify configuration directory to use. -Default: -<filename>/etc/dracut.conf.d</filename></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--sshkey <replaceable><sshkey file></replaceable></option> - </term> - <listitem> - <para>ssh key file used with ssh-client module.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-l</option> - </term> - <term> - <option>--local</option> - </term> - <listitem> - <para>activates the local mode. dracut will use modules from the current working -directory instead of the system-wide installed modules in -<filename>/usr/lib/dracut/modules.d</filename>. -This is useful when running dracut from a git checkout.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-H</option> - </term> - <term> - <option>--hostonly</option> - </term> - <listitem> - <para>Host-Only mode: Install only what is needed for booting -the local host instead of a generic host. - <warning> - <para>If chrooted to another root other than the real root device, use "--fstab" and provide a valid <filename>/etc/fstab</filename>.</para> - </warning></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--fstab</option> - </term> - <listitem> - <para>Use <filename>/etc/fstab</filename> instead of <filename>/proc/self/mountinfo</filename>.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--add_fstab <replaceable><filename></replaceable> </option> - </term> - <listitem> - <para>Add entries of <replaceable><filename></replaceable> to the initramfs /etc/fstab.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--mount "<replaceable><device></replaceable> <replaceable><mountpoint></replaceable> <replaceable><filesystem type></replaceable> <replaceable><filesystem options></replaceable>"</option> - </term> - <listitem> - <para>Add entries of <replaceable><filename></replaceable> to the initramfs /etc/fstab.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-i</option> - </term> - <term> - <option>--include <replaceable><SOURCE></replaceable> <replaceable><TARGET></replaceable></option> - </term> - <listitem> - <para>include the files in the SOURCE directory into the -TARGET directory in the final initramfs. If SOURCE is a file, it will be installed to TARGET in the final initramfs. This parameter can be specified multiple times.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-I</option> - </term> - <term> - <option>--install <replaceable><file list></replaceable></option> - </term> - <listitem> - <para>install the space separated list of files into the initramfs.</para> - <para> - If [LIST] has multiple arguments, then you have to put these in quotes. - For example: - <screen># dracut --install "/bin/foo /sbin/bar" ...</screen> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--gzip</option> - </term> - <listitem> - <para>Compress the generated initramfs using gzip. - This will be done by default, unless another compression option or --no-compress is passed. Equivalent to "--compress=gzip -9"</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--bzip2</option> - </term> - <listitem> - <para>Compress the generated initramfs using bzip2. - <warning> - <para>Make sure your kernel has bzip2 decompression support compiled in, otherwise you will not be able to boot. Equivalent to "--compress=bzip2"</para> - </warning></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--lzma</option> - </term> - <listitem> - <para>Compress the generated initramfs using lzma. - <warning> - <para>Make sure your kernel has lzma decompression support compiled in, otherwise you will not be able to boot. Equivalent to "--compress=lzma -9"</para> - </warning></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--xz</option> - </term> - <listitem> - <para>Compress the generated initramfs using xz. - <warning> - <para>Make sure your kernel has xz decompression support compiled in, otherwise you will not be able to boot. Equivalent to "--compress=xz --check=crc32 --lzma2=dict=1MiB"</para> - </warning></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--compress <replaceable><compressor></replaceable></option> - </term> - <listitem> - <para>Compress the generated initramfs using the passed compression program. If you pass it just the name of a compression program, it will call that program with known-working arguments. If you pass a quoted string with arguments, it will be called with exactly those arguments. Depending on what you pass, this may result in an initramfs that the kernel cannot decompress.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--no-compress</option> - </term> - <listitem> - <para>Do not compress the generated initramfs. This will override any other compression options.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--list-modules</option> - </term> - <listitem> - <para>List all available dracut modules.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>-M</option> - </term> - <term> - <option>--show-modules</option> - </term> - <listitem> - <para>Print included module's name to standard output during build.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--keep</option> - </term> - <listitem> - <para>Keep the initramfs temporary directory for debugging purposes.</para> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - </refsect1> - <refsect1> - <title>Files</title> - <variablelist> - <varlistentry> - <term> - <filename>/var/log/dracut.log</filename> - </term> - <listitem> - <para>logfile of initramfs image creation</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <filename>/tmp/dracut.log</filename> - </term> - <listitem> - <para>logfile of initramfs image creation, if <filename>/var/log/dracut.log</filename> is not writable</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <filename>/etc/dracut.conf</filename> - </term> - <listitem> - <para>see <citerefentry> - <refentrytitle>dracut.conf</refentrytitle> - <manvolnum>5</manvolnum> - </citerefentry></para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <filename>/etc/dracut.conf.d/*.conf</filename> - </term> - <listitem> - <para>see <citerefentry> - <refentrytitle>dracut.conf</refentrytitle> - <manvolnum>5</manvolnum> - </citerefentry></para> - </listitem> - </varlistentry> - </variablelist> - <refsect2> - <title>Configuration in the Initramfs</title> - <variablelist> - <varlistentry> - <term> - <filename>/etc/conf.d/</filename> - </term> - <listitem> - <para>Any files found in <filename>/etc/conf.d/</filename> will be sourced in the initramfs to -set initial values. Command line options will override these values -set in the configuration files.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <filename>/etc/cmdline</filename> - </term> - <listitem> - <para>Can contain additional command line options.</para> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - </refsect1> - <refsect1> - <title>Availability</title> - <para>The dracut command is part of the dracut package and is available from -<ulink url='https://dracut.wiki.kernel.org'>https://dracut.wiki.kernel.org</ulink></para> - </refsect1> - <refsect1> - <title>See Also</title> - <para> - <citerefentry> - <refentrytitle>dracut.cmdline</refentrytitle> - <manvolnum>7</manvolnum> - </citerefentry> - <citerefentry> - <refentrytitle>dracut.conf</refentrytitle> - <manvolnum>5</manvolnum> - </citerefentry> - </para> - </refsect1> -</refentry> |