tinyramfs.5

.\" Generated by scdoc 1.11.1
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "tinyramfs" "5" "2025-01-03" "tinyramfs" "2024-12-03"
.P
.SH NAME
.P
tinyramfs - configuration file
.P
.SH DESCRIPTION
.P
A tinyramfs configuration file is written in POSIX sh.\& Configuration is done
via variable asignment (eg.\& \fBoption=value\fR).\& Special characters and whitespace
must be quoted or escaped, more info: \fBsh\fR(1).\& By default tinyramfs looks to
\fB/etc/tinyramfs/config\fR for a configuration file.\&
.P
.SH OPTIONS
.P
Option marked with \fB(bool)\fR can hold a value of true or false.\& False if the
variable is unset or empty, true otherwise.\&
.P
Some options only apply to certain hooks and have been categorized accordingly.\&
.P
Options which expect a device as a value can also refer to the device via
\fBUUID\fR, \fBLABEL\fR, and \fBPARTUUID\fR (eg.\& LABEL=<label>).\& This requires a blkid
utility which supports that identifier.\&
.P
hooks
.P
.RS 4
A comma separated list of hooks to include in the initramfs.\& Hooks can
be found in /lib/tinyramfs/hook.\&d/.\&
.P
.RE
.SS MOUNTING
.P
root
.P
.RS 4
The device your root filesystem is located on.\&
.P
(available formats: /dev/sdX, LABEL=label, PARTUUID=partuuid, UUID=uuid)
.P
Note: using /dev/sdX is not recommeded since device path mappings may change
after changing hardware or even updating the kernel.\&
.P
.RE
root_type
.P
.RS 4
The filesystem you're using for your root device (eg.\& ext4).\&
.P
.RE
root_opts
.P
.RS 4
Arguments passed to mount command when mounting root device.\&
.P
.RE
rorw
.P
.RS 4
Define root partition ro/rw mounting, default to use ro to make use of init system.\&
.P
(available options: ro, rw)
.P
.RE
.SS MODULES
.P
modules_copy
.P
.RS 4
Instructs tinyramfs whether or not to include kernel modules in the initramfs.\&
.P
off: prevent modules to be copied
hostonly: (default) copy only modules used in host system
config: copy only modules defined (modules_list) in config files
all: copy all modules (likely to be HUGE!\&!\&!\&)
.P
(available options: off, hostonly, config, all)
.P
.RE
modules_list
.P
.RS 4
Define modules to be copied when modules_copy=config, will be passed to "find" command
.P
.RE
.SS COMPRESSION
.P
compress
.P
.RS 4
The utility to use for compressing the initramfs.\& The option accepts
arbitrary commands (eg.\& 'gzip -9').\& Use 'cat' for an uncompressed
initramfs.\&
.P
.RE
.SS LOADKEYMAP / LOADKEYS
.P
keymap_path
.P
.RS 4
Path to your keymap.\&
.P
.RE
.SS LUKS
.P
luks_discard
.P
.RS 4
(bool) Allow the use of discard (TRIM) requests for your luks device.\&
.P
\fBWARNING\fR: This option may have a negative security impact.\& For more info
read \fBcryptsetup\fR(8).\&
.P
.RE
luks_header
.P
.RS 4
Path to your LUKS header.\&
.P
.RE
luks_root
.P
.RS 4
The device your LUKS volume is located on.\&
.P
.RE
luks_name
.P
.RS 4
The name to map your LUKS device to.\&
.P
.RE
luks_key
.P
.RS 4
Path to your LUKS keyfile.\&
.P
.RE
.SS RESUME
.P
resume
.P
.RS 4
The location of your swap partition.\&
.P
.RE
.SS LIVE
.P
live_disk_type
.P
.RS 4
Define live medium partition locator type
.P
(available format: label, partuuid, uuid)
.P
.RE
live_disk
.P
.RS 4
define live medium partition located in /dev/disk/by-live_disk_type
.P
.RE
live_disk_fs
.P
.RS 4
define live medium partition fs type, iso9660 by default
.P
.RE
live_sfs_opts
.P
.RS 4
define squashfs mount options, "defaults,ro" by default
.P
.RE
live_ram
.P
.RS 4
define if squashfs should be copied into ram
.P
.RE
live_ram_opts
.P
.RS 4
define ramdisk mounting options
.P
.RE
.SS PLYMOUTH
.P
plymouth_nocopymodule
.P
.RS 4
define to prevent copying modules during plymouth hook
.P
.RE
plymouth_earlyquit
.P
.RS 4
define to quit plymouth when late hook executed (instead of using init system)
.P
.RE
.SH FILES
.P
/lib/tinyramfs/hook.\&d/
.RS 4
tinyramfs hooks
.P
.RE
.SH SEE ALSO
.P
\fBtinyramfs\fR(8)
.P
.SH AUTHORS
.P
tinyramfs by illiliti \fBhttps://github.\&com/illiliti\fR
.br
man page by fluorescent_haze \fBhttps://github.\&com/fluorescent-haze\fR