tinyramfs/docs/tinyramfs.8

86 lines
2.0 KiB
Groff
Raw Normal View History

2020-09-04 14:04:59 +05:30
.\" Generated by scdoc 1.11.0
.\" 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" "2020-09-04"
.P
.SH NAME
.P
Tinyramfs - tiny initramfs written in POSIX shell
.P
.SH SYNOPSIS
.P
\fBtinyramfs\fR [-df] [-o output] [-c config] [-m dir] [-s dir] [-k ver] [-H dir]
.P
.SH DESCRIPTION
.P
Tinyramfs is a simple, extensible and modular initramfs generator tool written
with focus on portability.\&
.P
.SH OPTIONS
.P
\fB-m\fR, \fB--modules\fR <directory>
.P
.RS 4
Specify directory where modules stored.\& Default is \fB/lib/modules\fR.\&
.P
.RE
\fB-s\fR, \fB--sources\fR <directory>
.RS 4
.P
Specify directory where tinyramfs stored files such as \fBdevice-helper\fR
and \fBinit\fR.\& Default is \fB/usr/share/tinyramfs\fR.\&
.P
.RE
\fB-o\fR, \fB--output\fR <output>
.P
.RS 4
Specify output location where initramfs image will be stored.\&
.P
.RE
\fB-c\fR, \fB--config\fR <config>
.P
.RS 4
Specify config location.\& Default is \fB/etc/tinyramfs/config\fR.\&
.P
.RE
\fB-k\fR, \fB--kernel\fR <version>
.P
.RS 4
Specify kernel version.\& Useful for bootstraping future system with modular
kernel.\& Default is current kernel version.\&
.P
.RE
\fB-H\fR, \fB--hooks\fR <directory>
.P
.RS 4
Specify additional hooks location.\& Default is \fB/usr/share/tinyramfs/hooks\fR
and \fB/etc/tinyramfs/hooks\fR.\&
.P
.RE
\fB-d\fR, \fB--debug\fR
.P
.RS 4
Enable debug mode.\& Useful for reporting bugs in build stage.\&
.P
.RE
\fB-f\fR, \fB--force\fR
.P
.RS 4
Forcefully overwrite initramfs image.\&
.P
.RE
.SH NOTES
.P
If you have modular kernel and you use \fBbusybox modrobe\fR to handle modules, you
must note that \fBbusybox modprobe\fR doesn't have ability to install soft
dependencies of modules (i.\&e modules.\&softdep).\& You must install them yourself
using hooks.\& See \fBtinyramfs.\&hooks\fR(7) how to do it.\&
.P
.SH SEE ALSO
.P
\fBtinyramfs.\&config\fR(5) \fBtinyramfs.\&cmdline\fR(7) \fBtinyramfs.\&hooks\fR(7)