initramfs.conf(5) - configuration file for mkinitramfs

[amurleopard]

INITRAMFS.CONF(5)	     initramfs.conf manual	     INITRAMFS.CONF(5)

NAME
       initramfs.conf - configuration file for mkinitramfs

DESCRIPTION
       The behaviour of mkinitramfs 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: name=[value]

       Configuration options can be broken out into configuration snippets and
       placed in individual files in  the  /etc/initramfs-tools/conf.d	direc‐
       tory.   Files in this directory are always read after the main configu‐
       ration file, so you can override the settings in the main  config  file
       without editing it directly.

GENERAL VARIABLES
	MODULES
	      Specifies the modules for the initramfs image.

	      Modules	  listed     in    /etc/initramfs-tools/modules    and
	      /usr/share/initramfs-tools/modules.d/* are  always  included  in
	      the initramfs, and are loaded early in the boot process.

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

	      most adds most file system, all ata, sata, scsi and usb drivers.

	      dep tries to guess which modules are necessary for  the  running
	      box and only adds those modules.

	      netboot  adds  the  base	and  network  modules, but skips block
	      devices.

	      The default setting is most.

	BUSYBOX
	      Include busybox utilities for the boot scripts.  If set  to  'n'
	      mkinitramfs  will  build	an  initramfs without busybox.	Beware
	      that many boot scripts need busybox utilities.

	COMPRESS
	      Specifies the compression method used for the  initramfs	image.
	      mkinitramfs  will  default  to  gzip if the kernel lacks support
	      (CONFIG_RD)  or  the  corresponding  userspace  utility  is  not
	      present.

	UMASK Set  the umask value of the generated initramfs file.  Useful to
	      not disclose eventual keys.

	COMPCACHE_SIZE
	      Amount of RAM to use for RAM-based compressed swap  space.   The
	      default is not to use compcache.

	      An empty value - compcache isn't used, or added to the initramfs
	      at all.

	      An integer and K (e.g. 65536 K) - use a number of kilobytes.

	      An integer and M (e.g. 256 M) - use a number of megabytes.

	      An integer and G (e.g. 1 G) - use a number of gigabytes.

	      An integer and % (e.g. 50 %) - use a percentage of the amount of
	      RAM.

	      You  can	optionally  install the compcache package to configure
	      this setting via debconf and have userspace scripts to load  and
	      unload compcache.

NFS VARIABLES
	BOOT  Allows  one  to  use an nfs drive as the root of the drive.  The
	      default is to boot from local media  (hard  drive,  USB  stick).
	      Set to nfs for an NFS root share.

	DEVICE
	      Specifies the network interface, like eth0.

	ROOT  Allows  optional	root  bootarg hardcoding, when no root bootarg
	      can be passed.  A root bootarg overrides that special setting.

	NFSROOT
	      Defaults to auto in order to pick up  value  from  DHCP  server.
	      Otherwise you need to specify HOST:MOUNT.

FILES
       /etc/initramfs-tools/initramfs.conf

AUTHOR
       The initramfs-tools are written by Maximilian Attems <[email protected]>,
       Jeff Bailey <[email protected]> and numerous others.  Loosely
       based on mkinitrd.conf by Herbert Xu.

SEE ALSO
	initramfs-tools(8), mkinitramfs(8), update-initramfs(8).

Linux				  2010/11/22		     INITRAMFS.CONF(5)