RAMROOT.CONF(5)

NAME
ramroot.conf - ramroot initcpio hook configuration file file

SYNOPSIS
/etc/ramroot.conf

DESCRIPTION
This file is an ash shell script. Many common bash builtins are not available here and the syntax tends to be a bit stricter. The fallback config file can be viewed at /usr/lib/ramroot/ramroot.conf.

After any changes are made to /etc/ramroot.conf, a user must execute ramroot -E or mkinitcpio -P in order for those changes to be built into a new initramfs image.

All UUID (or PARTUUID) values must include the proper UUID= prefix. A mountpath is an absolute mount path (as given in /etc/fstab). Every size is a whole number of mebibytes with no suffix.

VARIABLES

mounts_zram
    Defines additional mounts to load to zram during initramfs. A mount consists of the UUID separated from the mountpath by a colon. Multiple mounts are separated by spaces or newlines.

mounts_null
    Defines mounts to specifically ignore by ramroot. The UUID is optional for these mounts. These will not be loaded to zram or mounted normally. If / is specified in mounts_null, ramroot will skip loading altogether.

ps_default
    Default zram y/n prompt value. Valid values are yes or no.

ps_timeout
    Boot prompt timeout, positive integer between 1 and 33. After this many seconds, the zram y/n prompt will assume the ps_default value.

ram_min
    Minimum amount of free ram required.

zram_min
    Minimum amount of free zram required. If both this and ram_min cannot be satisfied, the boot prompt automatically selects no.

ram_pref
    Preferred amount of free ram. If both ram_min and zram_min are satisfied, additional memory is allocated to ram up to this preferred ram value.

zram_max
    Maximum amount of free zram to create. Once ram_pref is satisfied, the amount of free zram is further extended to zram_max.

All remaining memory is allocated towards ram.

SEE ALSO
ramroot(8), <https://github.com/arcmags/ramroot/>

AUTHOR
Written by Chris Magyar.

COPYRIGHT
Copyright © 2017 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.