man: clarify add_dracutmodules vs dracutmodules

[thirdparty/dracut.git] / dracut.8.asc

diff --git a/dracut.8.asc b/dracut.8.asc
index d22c1cb76ac9d82e6eac60f07227c406669a89fa..aee84c45a1c5fe9f15316901511a2eeddae9a29f 100644 (file)
--- a/dracut.8.asc
+++ b/dracut.8.asc
@@ -6,7 +6,7 @@ DRACUT(8)
 
 NAME
 ----
-dracut - low-level tool for generating an initramfs image
+dracut - low-level tool for generating an initramfs/initrd image
 
 SYNOPSIS
 --------
@@ -28,6 +28,8 @@ At boot time, the kernel unpacks that archive into RAM disk, mounts and uses it
 as initial root file system. All finding of the root device happens in this
 early userspace.
 
+Initramfs images are also called "initrd".
+
 For a complete list of kernel command line options see *dracut.cmdline*(7).
 
 If you are dropped to an emergency shell, while booting your initramfs,
@@ -54,57 +56,59 @@ OPTIONS
 **-f, --force**::
     overwrite existing initramfs file.
 
-**-m, --modules** _<list of dracut modules>_::
-    specify a space-separated list of dracut modules to call when building the
-    initramfs. Modules are located in _/usr/lib/dracut/modules.d_. This
-    parameter can be specified multiple times.
+**-a, --add** _<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.
 +
 [NOTE]
 ===============================
 If [LIST] has multiple arguments, then you have to put these in quotes. For
 example:
 ----
-# dracut --modules "module1 module2"  ...
+# dracut --add "module1 module2"  ...
 ----
 ===============================
 
-**-o, --omit** _<list of dracut modules>_::
-    omit a space-separated list of dracut modules. This parameter can be
-    specified multiple times.
+**--force-add** _<list of dracut modules>_::
+    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.
 +
 [NOTE]
 ===============================
 If [LIST] has multiple arguments, then you have to put these in quotes. For
 example:
 ----
-# dracut --omit "module1 module2"  ...
+# dracut --force-add "module1 module2"  ...
 ----
 ===============================
 
-**-a, --add** _<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.
+**-o, --omit** _<list of dracut modules>_::
+    omit a space-separated list of dracut modules. This parameter can be
+    specified multiple times.
 +
 [NOTE]
 ===============================
 If [LIST] has multiple arguments, then you have to put these in quotes. For
 example:
 ----
-# dracut --add "module1 module2"  ...
+# dracut --omit "module1 module2"  ...
 ----
 ===============================
 
-**--force-add** _<list of dracut modules>_::
-    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.
+**-m, --modules** _<list of dracut modules>_::
+    specify a space-separated list of dracut modules to call when building the
+    initramfs. Modules are located in _/usr/lib/dracut/modules.d_. This
+    parameter can be specified multiple times.
+    This option forces dracut to only include the specified dracut modules.
+    In most cases the "--add" option is what you want to use.
 +
 [NOTE]
 ===============================
 If [LIST] has multiple arguments, then you have to put these in quotes. For
 example:
 ----
-# dracut --force-add "module1 module2"  ...
+# dracut --modules "module1 module2"  ...
 ----
 ===============================