initramfs.conf.5 3.75 KB
Newer Older
1
.TH INITRAMFS.CONF 5  "2018/07/18" "initramfs\-tools" "File Formats Manual"
2 3 4 5 6 7

.SH NAME
initramfs.conf \- configuration file for mkinitramfs

.SH DESCRIPTION
The behaviour of
8
.B mkinitramfs
9 10 11 12 13 14
can be modified by its configuration file.

Each line in the file can be a configuration variable, a blank line,
or a comment. The value of an variable is assigned by an statement
of the form: \fIname\fP=[\fIvalue\fP]

15
Configuration options can be broken out into configuration snippets and
16
placed in individual files in the /etc/initramfs-tools/conf.d directory.  Files
17 18 19 20
in this directory are always read \fBafter\fP the main configuration file,
so you can override the settings in the main config file without editing it
directly.

21 22 23 24 25
.SH GENERAL VARIABLES
.TP
\fB MODULES
Specifies the modules for the initramfs image.

26 27 28 29 30 31 32
Modules listed in \fI/etc/initramfs-tools/modules\fP and
\fI/usr/share/initramfs-tools/modules.d/*\fP are always included in the
initramfs, and are loaded early in the boot process.


\fIlist\fP doesn't load any additional modules at boot time, other than those
listed in the above files.
33

34
\fImost\fP adds most file system, all ata, sata, scsi and usb drivers.
35

36 37
\fIdep\fP tries to guess which modules are necessary for the running box and
only adds those modules.
38

39 40 41 42
\fInetboot\fP adds the base and network modules, but skips block devices.


The default setting is \fImost\fP.
43

44 45 46
.TP
\fB BUSYBOX
Include busybox utilities for the boot scripts.
47
If set to 'n'
48
.B mkinitramfs
49
will build an initramfs without busybox.
50 51
Beware that many boot scripts need busybox utilities.

52 53
.TP
\fB KEYMAP
David Härdeman's avatar
David Härdeman committed
54 55 56
If set to 'y', the console keymap will be loaded during the initramfs stage.
The keymap will anyway be loaded by the initscripts later, and the packages
that might need input will normally set this variable automatically, so there
57 58
should normally be no need to set this.

59 60 61 62 63 64
.TP
\fB COMPRESS
Specifies the compression method used for the initramfs image.
.B mkinitramfs
will default to gzip if the kernel lacks support (CONFIG_RD) or the
corresponding userspace utility is not present.
65

66 67 68 69 70
.TP
\fB UMASK
Set the umask value of the generated initramfs file.
Useful to not disclose eventual keys.

71 72
.TP
\fB BOOT
73
Allows one to use an nfs drive as the root of the drive.
maximilian attems's avatar
maximilian attems committed
74
The default is to boot from \fIlocal\fP media (hard drive, USB stick).
75 76
Set to \fInfs\fP for an NFS root share.

77 78 79 80 81 82 83 84 85
.TP
\fB RUNSIZE
The size of the \fI/run\fP tmpfs mount point in bytes (suffixes are supported)
or as percentage of your physical RAM. This parameter is used as the value of
the size mount option to tmpfs. See
\fBhttps://www.kernel.org/doc/Documentation/filesystems/tmpfs.txt\fR for
details. Can be overridden by an optional \fBinitramfs.runsize=\fR bootarg.
The default is 10%.

86 87 88 89
.SH VARIABLES FOR LOCAL BOOT
.TP
\fB RESUME
Specifies the device used for suspend-to-disk (hibernation), which the
90 91
initramfs code should attempt to resume from.  If this is not defined
or is set to \fIauto\fP,
92 93
.B mkinitramfs
will automatically select the largest available swap partition.
94
Set it to \fInone\fP to disable resume from disk.
95

96
.SH VARIABLES FOR NFS BOOT
97 98
.TP
\fB DEVICE
99 100
Specifies the default network interface to use, like eth0.  The \fIip\fP or
\fIBOOTIF\fP bootargs may override this.
101

102 103 104 105 106
.TP
\fB ROOT
Allows optional root bootarg hardcoding, when no root bootarg can be passed.
A root bootarg overrides that special setting.

107 108 109 110 111
.TP
\fB NFSROOT
Defaults to \fIauto\fP in order to pick up value from DHCP server.
Otherwise you need to specify \fIHOST:MOUNT\fP.

112 113 114
.SH FILES
.TP
.I /etc/initramfs-tools/initramfs.conf
115 116

.SH AUTHOR
117
The initramfs-tools are written by Maximilian Attems <maks@debian.org>,
118
Jeff Bailey <jbailey@raspberryginger.com> and numerous others.
119 120
Loosely based on mkinitrd.conf by Herbert Xu.

121 122
.SH SEE ALSO
.BR
123
.IR initramfs-tools (7),
124 125
.IR mkinitramfs (8),
.IR update-initramfs (8).