]> git.ipfire.org Git - thirdparty/dracut.git/blobdiff - dracut.modules.7.asc
Revert "github workflow"
[thirdparty/dracut.git] / dracut.modules.7.asc
index 17acdb4d13f89703f577e9e11354af8d6fec642d..67a56bd41f97fbeaf467693560f4670ff9396b0d 100644 (file)
@@ -3,6 +3,7 @@ DRACUT.MODULES(7)
 :doctype: manpage
 :man source:   dracut
 :man manual:   dracut
+:man version:  {version}
 
 NAME
 ----
@@ -19,7 +20,7 @@ you can replace init with your own version of _99base_, this is not encouraged.
 Instead you should use, if possible, the hooks of dracut. All hooks, and the
 point of time in which they are executed, are described in <<stages>>.
 
-The main script, which creates the initramfs is dracut itsself. It parses all
+The main script, which creates the initramfs is dracut itself. It parses all
 arguments and sets up the directory, in which everything is installed. It then
 executes all check, install, installkernel scripts found in the modules, which
 are to be processed. After everything is installed, the install directory is
@@ -96,14 +97,14 @@ This hooks (initqueue/settled) gets executed every time udev has settled.
 
 ==== Initqueue timeout
 
-This hooks (initqueue/timeout) gets executed, when the main loop counter becomes half of the
-rd.retry counter.
+This hooks (initqueue/timeout) gets executed, when the main loop counter becomes
+half of the rd.retry counter.
 
 ==== Initqueue finished
 
 This hook (initqueue/finished) is called after udev has settled and
 if all scripts herein return 0 the main loop will be ended.
-Abritary scripts can be added here, to loop in the
+Arbitrary scripts can be added here, to loop in the
 initqueue until something happens, which a dracut module wants to wait for.
 
 === Hook: pre-mount
@@ -133,7 +134,8 @@ needed anymore.
 Init (or systemd) kills all udev processes, cleans up the environment,
 sets up the arguments for the real init process and finally calls switch_root.
 switch_root removes the whole filesystem hierarchy of the initramfs,
-chroot()s to the real root device and calls /sbin/init with the specified arguments.
+chroot()s to the real root device and calls /sbin/init with the specified
+arguments.
 
 To ensure all files in the initramfs hierarchy can be removed, all processes
 still running from the initramfs should not have any open file descriptors left.
@@ -167,7 +169,7 @@ inst_hook cmdline 20 "$moddir/parse-insmodpost.sh"
 inst_simple "$moddir/insmodpost.sh" /sbin/insmodpost.sh
 ----
 
-The _pase-instmodpost.sh_ parses the kernel command line for a argument
+The _parse-instmodpost.sh_ parses the kernel command line for a argument
 rd.driver.post, blacklists the module from being autoloaded and installs the
 hook _insmodpost.sh_ in the _initqueue/settled_.
 
@@ -211,7 +213,7 @@ check() should return with:
 
 0:: Include the dracut module in the initramfs.
 
-1:: Do not include the dracut module. The requirements are not fullfilled
+1:: Do not include the dracut module. The requirements are not fulfilled
 (missing tools, etc.)
 
 255:: Only include the dracut module, if another module requires it or if
@@ -225,50 +227,58 @@ depends on.
 
 === module-setup.sh: cmdline()
 
-This function should print the kernel command line options needed to boot the current
-machine setup. It should start with a space and should not print a newline.
+This function should print the kernel command line options needed to boot the
+current machine setup. It should start with a space and should not print a
+newline.
 
 === module-setup.sh: install()
 
-The install() function is called to install everything non-kernel related. To install
-binaries, scripts, and other files, you can use the functions mentioned in <<creation>>.
+The install() function is called to install everything non-kernel related.
+To install binaries, scripts, and other files, you can use the functions
+mentioned in <<creation>>.
 
 To address a file in the current module directory, use the variable "$moddir".
 
 === module-setup.sh: installkernel()
 
-In installkernel() all kernel related files should be installed. You can use all of the functions
-mentioned in <<creation>> to install files.
+In installkernel() all kernel related files should be installed. You can use all
+of the functions mentioned in <<creation>> to install files.
 
 === [[creation]]Creation Functions
 
 ==== inst_multiple [-o] <file> [ <file> ...]
 
-installs multiple binaries and files. If executables are specified without a path, dracut
-will search the path PATH=/usr/sbin:/sbin:/usr/bin:/bin for the binary. If the option "-o"
-is given as the first parameter, a missing file does not lead to an error.
+installs multiple binaries and files. If executables are specified without a
+path, dracut will search the path PATH=/usr/sbin:/sbin:/usr/bin:/bin for the
+binary. If the option "-o" is given as the first parameter, a missing file does
+not lead to an error.
 
 ==== inst <src> [<dst>]
 
-installs _one_ file <src> either to the same place in the initramfs or to an optional <dst>.
+installs _one_ file <src> either to the same place in the initramfs or to an
+optional <dst>. inst with more than two arguments is treated the same as
+inst_multiple, all arguments are treated as files to install and none as
+install destinations.
 
 ==== inst_hook <hookdir> <prio> <src>
 
-installs an executable/script <src> in the dracut hook <hookdir> with priority <prio>.
+installs an executable/script <src> in the dracut hook <hookdir> with priority
+<prio>.
 
 ==== inst_rules <udevrule> [ <udevrule> ...]
 
-installs one ore more udev rules. Non-existant udev rules are reported, but do not let dracut fail.
+installs one or more udev rules. Non-existant udev rules are reported, but do
+not let dracut fail.
 
 ==== instmods <kernelmodule> [ <kernelmodule> ... ]
 
 instmods should be used only in the installkernel() function.
 
-instmods installs one or more kernel modules in the initramfs. <kernelmodule> can also be a whole
-subsystem, if prefixed with a "=", like "=drivers/net/team".
+instmods installs one or more kernel modules in the initramfs. <kernelmodule>
+can also be a whole subsystem, if prefixed with a "=", like "=drivers/net/team".
 
-instmods will not install the kernel module, if $hostonly is set and the kernel module is not currently
-needed by any /sys/*...*/uevent MODALIAS.
+instmods will not install the kernel module, if $hostonly is set and the kernel
+module is not currently needed by any /sys/*...*/uevent MODALIAS.
 To install a kernel module regardless of the hostonly mode use the form:
 ----
 hostonly='' instmods <kernelmodule>