Merge pull request #71 from jsynacek/doc-fix
[dracut.git] / mkinitrd.8.asc
blob146a6d0fb73dc8855dfd1804996909e5c83520bb
1 MKINITRD(8)
2 =========
3 :doctype: manpage
4 :man source:   dracut
5 :man manual:   dracut
7 NAME
8 ----
9 mkinitrd - is a compat wrapper, which calls dracut to generate an initramfs
11 SYNOPSIS
12 --------
13 *mkinitrd* ['OPTION...'] [<initrd-image>]  <kernel-version>
15 DESCRIPTION
16 -----------
17 mkinitrd creates an initramfs image <initrd-image> for the kernel with
18 version <kernel-version> by calling "dracut".
20 [IMPORTANT]
21 If a more fine grained control over the resulting image is needed,
22 "dracut" should be called directly.
24 OPTIONS
25 -------
26 **--version**::
27     print info about the version
29 **-v, --verbose**::
30     increase verbosity level
32 **-f, --force**::
33     overwrite existing initramfs file.
35 **--image-version*::
36     append the kernel version to the target image
37     <initrd-image>-<kernel-version>.
39 **--with=<module>**::
40      add the kernel module <module> to the initramfs.
42 **--preload=<module>**::
43      preload the kernel module <module> in the initramfs before any other kernel
44      modules are loaded. This can be used to ensure a certain device naming,
45      which should in theory be avoided and the use of symbolic links in /dev is
46      encouraged.
48 **--nocompress**::
49      do not compress the resulting image.
51 **--help**::
52     print a help message and exit.
54 AVAILABILITY
55 ------------
56 The mkinitrd command is part of the dracut package and is available from
57 link:$$https://dracut.wiki.kernel.org$$[https://dracut.wiki.kernel.org]
59 AUTHORS
60 -------
61 Harald Hoyer
63 SEE ALSO
64 --------
65 *dracut*(8)