network-manager: remove useless use of basename

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

diff --git a/dracut.8.asc b/dracut.8.asc
index 2ea6744712512699228073e336e6ed143bdc7a61..2e974fb0b632680494146d56f962def6515a9745 100644 (file)
--- a/dracut.8.asc
+++ b/dracut.8.asc
@@ -6,7 +6,7 @@ DRACUT(8)
 
 NAME
 ----
 
 NAME
 ----

-dracut - low-level tool for generating an initramfs image
+dracut - low-level tool for generating an initramfs/initrd image

 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------


@@ -28,14 +28,16 @@ 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.
 
 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,
 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,

-the file _/run/initramfs/rdsosreport.txt_ is created, which can be safed to a
+the file _/run/initramfs/rdsosreport.txt_ is created, which can be saved to a

 (to be mounted by hand) partition (usually /boot) or a USB stick.
 (to be mounted by hand) partition (usually /boot) or a USB stick.

-Additional debugging info can be produced by adding **rd.debug** to the kernel command line.
-_/run/initramfs/rdsosreport.txt_ contains all logs and the output of some tools.
-It should be attached to any report about dracut problems.
+Additional debugging info can be produced by adding **rd.debug** to the kernel
+command line. _/run/initramfs/rdsosreport.txt_ contains all logs and the output
+of some tools. It should be attached to any report about dracut problems.

 
 USAGE
 -----
 
 USAGE
 -----


@@ -54,57 +56,59 @@ OPTIONS
 **-f, --force**::
     overwrite existing initramfs file.
 
 **-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:
 ----
 +
 [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:
 ----
 +
 [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:
 ----
 +
 [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:
 ----
 +
 [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"  ...

 ----
 ===============================
 
 ----
 ===============================
 


@@ -136,6 +140,19 @@ example:
 ----
 ===============================
 
 ----
 ===============================
 

+**--force-drivers** _<list of kernel modules>_::
+    See add-drivers above. But in this case it is ensured that the drivers
+    are tried to be loaded early via modprobe.
++
+[NOTE]
+===============================
+If [LIST] has multiple arguments, then you have to put these in quotes. For
+example:
+----
+# dracut --force-drivers "kmodule1 kmodule2"  ...
+----
+===============================
+

 **--omit-drivers** _<list of kernel modules>_::
     specify a space-separated list of kernel modules not to add to the
     initramfs.
 **--omit-drivers** _<list of kernel modules>_::
     specify a space-separated list of kernel modules not to add to the
     initramfs.


@@ -226,12 +243,6 @@ example:
 **--nostrip**::
     do not strip binaries in the initramfs
 
 **--nostrip**::
     do not strip binaries in the initramfs
 

-**--prelink**::
-    prelink binaries in the initramfs (default)
-
-**--noprelink**::
-    do not prelink binaries in the initramfs
-

 **--hardlink**::
     hardlink files in the initramfs (default)
 
 **--hardlink**::
     hardlink files in the initramfs (default)
 


@@ -275,6 +286,12 @@ Default:
 
 **--sshkey** _<sshkey file>_:: ssh key file used with ssh-client module.
 
 
 **--sshkey** _<sshkey file>_:: ssh key file used with ssh-client module.
 

+**--logfile** _<logfile>_:: logfile to use; overrides any setting from
+    the configuration files.
++
+Default:
+    _/var/log/dracut.log_
+

 **-l, --local**::
     activates the local mode. dracut will use modules from the current working
     directory instead of the system-wide installed modules in
 **-l, --local**::
     activates the local mode. dracut will use modules from the current working
     directory instead of the system-wide installed modules in


@@ -294,6 +311,22 @@ provide a valid _/etc/fstab_.
 **-N, --no-hostonly**::
     Disable Host-Only mode
 
 **-N, --no-hostonly**::
     Disable Host-Only mode
 

+**--hostonly-cmdline**:
+    Store kernel command line arguments needed in the initramfs
+
+**--no-hostonly-cmdline**:
+    Do not store kernel command line arguments needed in the initramfs
+
+**--no-hostonly-default-device**:
+    Do not generate implicit host devices like root, swap, fstab, etc.
+    Use "--mount" or "--add-device" to explicitly add devices as needed.
+
+**--hostonly-i18n**:
+    Install only needed keyboard and font files according to the host configuration (default).
+
+**--no-hostonly-i18n**:
+    Install all keyboard and font files available.
+

 **--persistent-policy** _<policy>_::
     Use _<policy>_ to address disks and partitions.
     _<policy>_ can be any directory name found in /dev/disk.
 **--persistent-policy** _<policy>_::
     Use _<policy>_ to address disks and partitions.
     _<policy>_ can be any directory name found in /dev/disk.


@@ -305,9 +338,17 @@ provide a valid _/etc/fstab_.
 **--add-fstab** _<filename>_::
     Add entries of _<filename>_ to the initramfs /etc/fstab.
 
 **--add-fstab** _<filename>_::
     Add entries of _<filename>_ to the initramfs /etc/fstab.
 

-**--mount** "_<device>_ _<mountpoint>_ _<filesystem type>_ _<filesystem options>_"::
-    Mount _<device>_ on _<mountpoint>_ with _<filesystem type>_ and _<filesystem
-    options>_ in the initramfs
+**--mount** "_<device>_ _<mountpoint>_ _<filesystem type>_ [_<filesystem options>_ [_<dump frequency>_ [_<fsck order>_]]]"::
+    Mount _<device>_ on _<mountpoint>_ with _<filesystem type>_ in the
+    initramfs. _<filesystem options>_, _<dump options>_ and _<fsck order>_ can
+    be specified, see fstab manpage for the details.
+    The default _<filesystem options>_ is "defaults".
+    The default _<dump frequency>_ is "0".
+    the default _<fsck order>_ is "2".
+
+**--mount** "_<mountpoint>_"::
+    Like above, but _<device>_, _<filesystem type>_ and _<filesystem options>_
+    are determined by looking at the current mounts.

 
 **--add-device** _<device>_ ::
     Bring up _<device>_ in initramfs, _<device>_ should be the device name.
 
 **--add-device** _<device>_ ::
     Bring up _<device>_ in initramfs, _<device>_ should be the device name.


@@ -333,6 +374,9 @@ example:
 ----
 ===============================
 
 ----
 ===============================
 

+**--install-optional** _<file list>_::
+    install the space separated list of files into the initramfs, if they exist.
+

 **--gzip**::
     Compress the generated initramfs using gzip. This will be done by default,
     unless another compression option or --no-compress is passed. Equivalent to
 **--gzip**::
     Compress the generated initramfs using gzip. This will be done by default,
     unless another compression option or --no-compress is passed. Equivalent to


@@ -362,7 +406,8 @@ will not be able to boot. Equivalent to "lzma --compress=lzma -9"
 [WARNING]
 ====
 Make sure your kernel has xz decompression support compiled in, otherwise you
 [WARNING]
 ====
 Make sure your kernel has xz decompression support compiled in, otherwise you

-will not be able to boot. Equivalent to "lzma --compress=xz --check=crc32 --lzma2=dict=1MiB"
+will not be able to boot. Equivalent to
+"lzma --compress=xz --check=crc32 --lzma2=dict=1MiB"

 ====
 
 **--lzo**::
 ====
 
 **--lzo**::


@@ -381,17 +426,32 @@ Make sure your kernel has lz4 decompression support compiled in, otherwise you
 will not be able to boot.
 ====
 
 will not be able to boot.
 ====
 

+**--zstd**::
+    Compress the generated initramfs using Zstandard.
+[WARNING]
+====
+Make sure your kernel has zstd decompression support compiled in, otherwise you
+will not be able to boot.
+====
+

 **--compress** _<compressor>_::
     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.
 **--compress** _<compressor>_::
     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.

+    The default value can also be set via the _INITRD_COMPRESS_ environment variable.

 
 **--no-compress**::
     Do not compress the generated initramfs. This will override any other
     compression options.
 
 
 **--no-compress**::
     Do not compress the generated initramfs. This will override any other
     compression options.
 

+**--reproducible**::
+    Create reproducible images.
+
+**--no-reproducible**::
+    Do not create reproducible images.
+

 **--list-modules**::
     List all available dracut modules.
 
 **--list-modules**::
     List all available dracut modules.
 


@@ -423,8 +483,39 @@ will not be able to boot.
 ----
 
 **--regenerate-all**::
 ----
 
 **--regenerate-all**::

-    Regenerate all initramfs images at the default location with the kernel versions found on the system.
-    Additional parameters are passed through.
+    Regenerate all initramfs images at the default location with the kernel
+    versions found on the system. Additional parameters are passed through.
+
+**--loginstall _<DIR>_**::
+    Log all files installed from the host to _<DIR>_.
+
+**--uefi**::
+    Instead of creating an initramfs image, dracut will create an UEFI executable,
+    which can be executed by an UEFI BIOS. The default output filename is
+    _<EFI>/EFI/Linux/linux-$kernel$-<MACHINE_ID>-<BUILD_ID>.efi_. <EFI> might be
+    _/efi_, _/boot_ or _/boot/efi_ depending on where the ESP partition is mounted.
+    The <BUILD_ID> is taken from BUILD_ID in _/usr/lib/os-release_ or if it exists
+    _/etc/os-release_ and is left out, if BUILD_ID is non-existant or empty.
+
+**--no-machineid**::
+    affects the default output filename of **--uefi** and will discard the <MACHINE_ID>
+    part.
+
+**--uefi-stub _<FILE>_**::
+    Specifies the UEFI stub loader, which will load the attached kernel, initramfs and
+    kernel command line and boots the kernel. The default is
+    _$prefix/lib/systemd/boot/efi/linux<EFI-MACHINE-TYPE-NAME>.efi.stub_
+    or _$prefix/lib/gummiboot/linux<EFI-MACHINE-TYPE-NAME>.efi.stub_
+
+**--kernel-image _<FILE>_**::
+    Specifies the kernel image, which to include in the UEFI executable. The default is
+    _/lib/modules/<KERNEL-VERSION>/vmlinuz_ or _/boot/vmlinuz-<KERNEL-VERSION>_
+
+ENVIRONMENT
+-----------
+
+_INITRD_COMPRESS_::
+    sets the default compression program. See **--compress**.

 
 FILES
 -----
 
 FILES
 -----


@@ -452,7 +543,8 @@ _/etc/conf.d/_::
     set in the configuration files.
 
 _/etc/cmdline_::
     set in the configuration files.
 
 _/etc/cmdline_::

-    Can contain additional command line options. Deprecated, better use /etc/cmdline.d/*.conf.
+    Can contain additional command line options. Deprecated, better use
+    /etc/cmdline.d/*.conf.

 
 _/etc/cmdline.d/*.conf_::
     Can contain additional command line options.
 
 _/etc/cmdline.d/*.conf_::
     Can contain additional command line options.


@@ -482,4 +574,4 @@ Will Woods
 
 SEE ALSO
 --------
 
 SEE ALSO
 --------

-*dracut.cmdline*(7) *dracut.conf*(5)
+*dracut.cmdline*(7) *dracut.conf*(5) *lsinitrd*(1)