{
    "content": [
        {
            "type": "text",
            "text": "# INITRAMFS.CONF (man)\n\n## NAME\n\ninitramfs.conf - configuration file for mkinitramfs\n\n## DESCRIPTION\n\nThe behaviour of mkinitramfs can be modified by its configuration file.\n\n## Sections\n\n- **NAME**\n- **DESCRIPTION**\n- **GENERAL VARIABLES**\n- **VARIABLES FOR LOCAL BOOT**\n- **VARIABLES FOR NFS BOOT**\n- **FILES**\n- **AUTHOR**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "INITRAMFS.CONF",
        "section": "",
        "mode": "man",
        "summary": "initramfs.conf - configuration file for mkinitramfs",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [
            {
                "name": "initramfs-tools",
                "section": "7",
                "url": "https://www.chedong.com/phpMan.php/man/initramfs-tools/7/json"
            },
            {
                "name": "mkinitramfs",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/mkinitramfs/8/json"
            },
            {
                "name": "update-initramfs",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/update-initramfs/8/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 11,
                "subsections": []
            },
            {
                "name": "GENERAL VARIABLES",
                "lines": 49,
                "subsections": []
            },
            {
                "name": "VARIABLES FOR LOCAL BOOT",
                "lines": 13,
                "subsections": []
            },
            {
                "name": "VARIABLES FOR NFS BOOT",
                "lines": 18,
                "subsections": []
            },
            {
                "name": "FILES",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "initramfs.conf - configuration file for mkinitramfs\n\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "The behaviour of mkinitramfs can be modified by its configuration file.\n\nEach  line in the file can be a configuration variable, a blank line, or a comment. The value\nof an variable is assigned by an statement of the form: name=[value]\n\nConfiguration options can be broken out into configuration snippets and placed in  individual\nfiles  in the /etc/initramfs-tools/conf.d directory.  Files in this directory are always read\nafter the main configuration file, so you can override the settings in the main  config  file\nwithout editing it directly.\n\n",
                "subsections": []
            },
            "GENERAL VARIABLES": {
                "content": "MODULES\nSpecifies the modules for the initramfs image.\n\nModules  listed  in  /etc/initramfs-tools/modules  and /usr/share/initramfs-tools/mod‐\nules.d/* are always included in the initramfs,  and  are  loaded  early  in  the  boot\nprocess.\n\n\nlist  doesn't load any additional modules at boot time, other than those listed in the\nabove files.\n\nmost adds most file system, all ata, sata, scsi and usb drivers.\n\ndep tries to guess which modules are necessary for the running box and only adds those\nmodules.\n\nnetboot adds the base and network modules, but skips block devices.\n\n\nThe default setting is most.\n\n\nBUSYBOX\nInclude  busybox utilities for the boot scripts.  If set to 'n' mkinitramfs will build\nan initramfs without busybox.  Beware that many boot scripts need busybox utilities.\n\n\nCOMPRESS\nSpecifies the compression method used for the initramfs image.  mkinitramfs  will  de‐\nfault  to  gzip if the kernel lacks support (CONFIGRD) or the corresponding userspace\nutility is not present.\n\n\nUMASK Set the umask value of the generated initramfs file.  Useful to not disclose  eventual\nkeys.\n\n\nBOOT  Allows  one to use an nfs drive as the root of the drive.  The default is to boot from\nlocal media (hard drive, USB stick).  Set to nfs for an NFS root share.\n\n\nRUNSIZE\nThe size of the /run tmpfs mount point in bytes (suffixes are supported)  or  as  per‐\ncentage  of  your  physical RAM. This parameter is used as the value of the size mount\noption to  tmpfs.  See  https://www.kernel.org/doc/Documentation/filesystems/tmpfs.txt\nfor details. Can be overridden by an optional initramfs.runsize= bootarg.  The default\nis 10%.\n\n",
                "subsections": []
            },
            "VARIABLES FOR LOCAL BOOT": {
                "content": "RESUME\nSpecifies the device used for suspend-to-disk (hibernation), which the initramfs  code\nshould  attempt to resume from.  If this is not defined or is set to auto, mkinitramfs\nwill automatically select the largest available swap partition.  Set  it  to  none  to\ndisable resume from disk.\n\n\nFSTYPE\nSpecifies  the filesystem type(s) to support, separated by commas.  If this is not de‐\nfined or is set to auto, mkinitramfs will automatically detect the  current  root  and\n/usr filesystem types.\n\n",
                "subsections": []
            },
            "VARIABLES FOR NFS BOOT": {
                "content": "DEVICE\nSpecifies  the default network interface to use, like eth0.  The ip or BOOTIF bootargs\nmay override this.\n\n\nVLAN  Specifies the VLAN tag id to setup, e.g. VLAN=eth0.1:eth0.  The vlan bootarg may over‐\nride this.\n\n\nROOT  Allows  optional  root bootarg hardcoding, when no root bootarg can be passed.  A root\nbootarg overrides that special setting.\n\n\nNFSROOT\nDefaults to auto in order to pick up value from DHCP server.  Otherwise  you  need  to\nspecify HOST:MOUNT.\n\n",
                "subsections": []
            },
            "FILES": {
                "content": "/etc/initramfs-tools/initramfs.conf\n\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "The  initramfs-tools  are  written by Maximilian Attems <maks@debian.org>, Jeff Bailey <jbai‐\nley@raspberryginger.com> and numerous others.  Loosely based on mkinitrd.conf by Herbert Xu.\n\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "initramfs-tools(7), mkinitramfs(8), update-initramfs(8).\n\n\n\ninitramfs-tools                              2018/07/18                            INITRAMFS.CONF(5)",
                "subsections": []
            }
        }
    }
}