tinyramfs/doc/tinyramfs.8
2022-05-11 18:26:38 +00:00

85 lines
1.5 KiB
Groff

.\" Generated by scdoc 1.11.2
.\" 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" "8" "2022-05-11" "tinyramfs" "2022-05-09"
.P
.SH NAME
.P
tinyramfs - create an initramfs
.P
.SH SYNOPSIS
.P
\fBtinyramfs\fR [\fB-dfhl\fR] [\fB-c\fR file] [\fB-k\fR kern] [\fB-m\fR path] <output>
.P
.SH DESCRIPTION
.P
The tinyramfs utility generates an initramfs image for loading kernel modules,
unlocking encrypted drives, mounting needed filesystems, etc.\&
.P
.SH OPTIONS
.P
\fB-c\fR <file>
.P
.RS 4
Use <file> as configuration, instead of /etc/tinyramfs/config.\&
.P
.RE
\fB-d\fR
.P
.RS 4
Enable debug mode; print every command tinyramfs executes to standard
error.\&
.P
.RE
\fB-f\fR
.P
.RS 4
Overwrite the output file if it already exists.\&
.P
.RE
\fB-h\fR
.P
.RS 4
Show a summary of options accepted by tinyramfs.\&
.P
.RE
\fB-k\fR <kern>
.P
.RS 4
Set the kernel version to <kern>.\& This way tinyramfs knows which kernel
modules to use.\&
.P
.RE
\fB-l\fR
.P
.RS 4
Use helper scripts in $PWD/lib/, instead of /lib/tinyramfs/.\&
.P
.RE
\fB-m\fR <path>
.P
.RS 4
Look for kernel modules in <path>, instead of /lib/modules/.\&
.P
.RE
.SH FILES
.P
/lib/tinyramfs/hook.\&d/
.RS 4
tinyramfs hooks
.P
.RE
.SH SEE ALSO
.P
\fBtinyramfs\fR(5)
.P
.SH AUTHORS
.P
tinyramfs by illiliti \fBhttps://github.\&com/illiliti\fR
.br
man page by fluorescent_haze \fBhttps://github.\&com/fluorescent-haze\fR