190 lines
6.0 KiB
HTML
190 lines
6.0 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of INITRAMFS.CONF</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>INITRAMFS.CONF</H1>
|
|
Section: File Formats Manual (5)<BR>Updated: 2018/07/18<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<P>
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
initramfs.conf - configuration file for mkinitramfs
|
|
<P>
|
|
<A NAME="lbAC"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The behaviour of
|
|
<B>mkinitramfs</B>
|
|
|
|
can be modified by its configuration file.
|
|
<P>
|
|
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: <I>name</I>=[<I>value</I>]
|
|
<P>
|
|
Configuration options can be broken out into configuration snippets and
|
|
placed in individual files in the /etc/initramfs-tools/conf.d directory. Files
|
|
in this directory are always read <B>after</B> the main configuration file,
|
|
so you can override the settings in the main config file without editing it
|
|
directly.
|
|
<P>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>GENERAL VARIABLES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B> MODULES<DD>
|
|
Specifies the modules for the initramfs image.
|
|
<P>
|
|
Modules listed in </B><I>/etc/initramfs-tools/modules</I> and
|
|
<I>/usr/share/initramfs-tools/modules.d/*</I> are always included in the
|
|
initramfs, and are loaded early in the boot process.
|
|
<P>
|
|
<P>
|
|
<I>list</I> doesn't load any additional modules at boot time, other than those
|
|
listed in the above files.
|
|
<P>
|
|
<I>most</I> adds most file system, all ata, sata, scsi and usb drivers.
|
|
<P>
|
|
<I>dep</I> tries to guess which modules are necessary for the running box and
|
|
only adds those modules.
|
|
<P>
|
|
<I>netboot</I> adds the base and network modules, but skips block devices.
|
|
<P>
|
|
<P>
|
|
The default setting is <I>most</I>.
|
|
<P>
|
|
<DT id="2"><B> BUSYBOX<DD>
|
|
Include busybox utilities for the boot scripts.
|
|
If set to 'n'
|
|
mkinitramfs</B>
|
|
|
|
will build an initramfs without busybox.
|
|
Beware that many boot scripts need busybox utilities.
|
|
<P>
|
|
<DT id="3"><B> COMPCACHE_SIZE<DD>
|
|
Amount of RAM to use for RAM-based compressed swap space.
|
|
The default is not to use compcache.
|
|
<P>
|
|
An empty value - compcache isn't used, or added to the initramfs at all.
|
|
<P>
|
|
An integer and K (e.g. </B><I>65536 K</I>) - use a number of kilobytes.
|
|
<P>
|
|
An integer and M (e.g. <I>256 M</I>) - use a number of megabytes.
|
|
<P>
|
|
An integer and G (e.g. <I>1 G</I>) - use a number of gigabytes.
|
|
<P>
|
|
An integer and % (e.g. <I>50 %</I>) - use a percentage of the amount of RAM.
|
|
<P>
|
|
You can optionally install the <I>compcache</I> package to configure this
|
|
setting via debconf and have userspace scripts to load and unload compcache.
|
|
<P>
|
|
<DT id="4"><B> COMPRESS<DD>
|
|
Specifies the compression method used for the initramfs image.
|
|
mkinitramfs</B>
|
|
|
|
will default to gzip if the kernel lacks support (CONFIG_RD) or the
|
|
corresponding userspace utility is not present.
|
|
<P>
|
|
<DT id="5"><B> UMASK<DD>
|
|
Set the umask value of the generated initramfs file.
|
|
Useful to not disclose eventual keys.
|
|
<P>
|
|
<DT id="6"> BOOT<DD>
|
|
Allows one to use an nfs drive as the root of the drive.
|
|
The default is to boot from </B><I>local</I> media (hard drive, USB stick).
|
|
Set to <I>nfs</I> for an NFS root share.
|
|
<P>
|
|
<DT id="7"><B> RUNSIZE<DD>
|
|
The size of the </B><I>/run</I> 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
|
|
<B><A HREF="https://www.kernel.org/doc/Documentation/filesystems/tmpfs.txt">https://www.kernel.org/doc/Documentation/filesystems/tmpfs.txt</A></B> for
|
|
details. Can be overridden by an optional <B>initramfs.runsize=</B> bootarg.
|
|
The default is 10%.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>VARIABLES FOR LOCAL BOOT</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="8"><B> RESUME<DD>
|
|
Specifies the device used for suspend-to-disk (hibernation), which the
|
|
initramfs code should attempt to resume from. If this is not defined
|
|
or is set to </B><I>auto</I>,
|
|
<B>mkinitramfs</B>
|
|
|
|
will automatically select the largest available swap partition.
|
|
Set it to <I>none</I> to disable resume from disk.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>VARIABLES FOR NFS BOOT</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="9"><B> DEVICE<DD>
|
|
Specifies the default network interface to use, like eth0. The </B><I>ip</I> or
|
|
<I>BOOTIF</I> bootargs may override this.
|
|
<P>
|
|
<DT id="10"><B> VLAN<DD>
|
|
Specifies the VLAN tag id to setup, e.g. VLAN=eth0.1:eth0. The </B><I>vlan</I>
|
|
bootarg may override this.
|
|
<P>
|
|
<DT id="11"><B> ROOT<DD>
|
|
Allows optional root bootarg hardcoding, when no root bootarg can be passed.
|
|
A root bootarg overrides that special setting.
|
|
<P>
|
|
<DT id="12"> NFSROOT<DD>
|
|
Defaults to </B><I>auto</I> in order to pick up value from DHCP server.
|
|
Otherwise you need to specify <I>HOST:MOUNT</I>.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="13"><I>/etc/initramfs-tools/initramfs.conf</I>
|
|
|
|
<DD>
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
The initramfs-tools are written by Maximilian Attems <<A HREF="mailto:maks@debian.org">maks@debian.org</A>>,
|
|
Jeff Bailey <<A HREF="mailto:jbailey@raspberryginger.com">jbailey@raspberryginger.com</A>> and numerous others.
|
|
Loosely based on mkinitrd.conf by Herbert Xu.
|
|
<P>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?7+initramfs-tools">initramfs-tools</A></I>(7),
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?8+mkinitramfs">mkinitramfs</A></I>(8),
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?8+update-initramfs">update-initramfs</A></I>(8).
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="14"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="15"><A HREF="#lbAC">DESCRIPTION</A><DD>
|
|
<DT id="16"><A HREF="#lbAD">GENERAL VARIABLES</A><DD>
|
|
<DT id="17"><A HREF="#lbAE">VARIABLES FOR LOCAL BOOT</A><DD>
|
|
<DT id="18"><A HREF="#lbAF">VARIABLES FOR NFS BOOT</A><DD>
|
|
<DT id="19"><A HREF="#lbAG">FILES</A><DD>
|
|
<DT id="20"><A HREF="#lbAH">AUTHOR</A><DD>
|
|
<DT id="21"><A HREF="#lbAI">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:03 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|