emo/tinyramfs
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity

write up man pages

Browse Source
This commit is contained in:
illiliti
2020-03-08 03:28:00 +03:00
parent 2f725a9ff7
commit 537b89819f
5 changed files with 293 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
usr/share/man/man5/tinyramfs.config.5 Normal file
View File

@@ -0,0 +1,172 @@
.TH tinyramfs 5 "March 2020" tinyramfs
.SH NAME
tinyramfs \- configuration options
.SH GENERAL
.TP
.BR \fBdebug=\fR"\&\fI {0|1} \fR\&"
Enable shell debugging
This option also drop you to shell after root partition being mounted in initramfs
.TP
.TP
.BR \fBforce=\fR"\&\fI {0|1} \fR\&"
Disable warning about exists initramfs image
.TP
.TP
.BR \fBinit=\fR"\&\fI /path/to/file \fR\&"
Specify init program
.TP
.TP
.BR \fBinitramfs=\fR"\&\fI /path/to/file \fR\&"
Specify initramfs output name
.TP
.TP
.BR \fBmoddir=\fR"\&\fI /path/to/dir \fR\&"
Specify directory of drivers
.TP
.TP
.BR \fBkernel=\fR"\&\fI ... \fR\&"
Specify kernel version
.TP
.TP
.BR \fBcompress=\fR"\&\fI ... \fR\&"
Specify compression program
.TP
.TP
.BR \fBroot=\fR"\&\fI ... \fR\&"
Specify root partition [PARTUUID, UUID, LABEL, DEVICE]
This option is required
.TP
.TP
.BR \fBroot_type=\fR"\&\fI ... \fR\&"
Specify root partition type
.TP
.TP
.BR \fBroot_opts=\fR"\&\fI ... \fR\&"
Specify root partition mount options (comma separated)
.TP
.TP
.BR \fButil_linux=\fR"\&\fI {0|1} \fR\&"
Include util-linux binaries
This option required if you need PARTUUID support
.TP
.TP
.BR \fBdevmgr=\fR"\&\fI ... \fR\&"
Specify device manager [udev, mdev, mdevd]
This option is required
.TP
.TP
.BR \fBhostonly=\fR"\&\fI {0|1} \fR\&"
Enable hostonly mode
.TP
.TP
.BR \fBdrivers=\fR"\&\fI ... \fR\&"
Include additional drivers (space separated)
If host only mode enabled you need to specify your root partition driver
.TP
.TP
.BR \fBdrivers_exclude=\fR"\&\fI ... \fR\&"
Exclude specified drivers (space separated)
.TP
.TP
.BR \fBbinaries=\fR"\&\fI ... \fR\&"
Include additional binaries (space separated)
.TP
.SH LVM
.TP
.BR \fBlvm=\fR"\&\fI {0|1} \fR\&"
Enable LVM support
This option required if you need LVM support
.TP
.TP
.BR \fBlvm_name=\fR"\&\fI ... \fR\&"
Specify logical volume name
.TP
.TP
.BR \fBlvm_group=\fR"\&\fI ... \fR\&"
Specify volume group name
.TP
.TP
.BR \fBlvm_config=\fR"\&\fI {0|1} \fR\&"
Include config from /etc/lvm
This option overwrite lvm_discard option
.TP
.TP
.BR \fBlvm_discard=\fR"\&\fI {0|1} \fR\&"
Enable TRIM requests
.TP
.TP
.BR \fBlvm_args=\fR"\&\fI ... \fR\&"
Pass additional options to lvm
.TP
.SH LUKS
.TP
.BR \fBluks=\fR"\&\fI {0|1} \fR\&"
Enable LUKS support
This option required if you need LUKS support
.TP
.TP
.BR \fBluks_root=\fR"\&\fI ... \fR\&"
Specify encrypted root partition [PARTUUID, UUID, LABEL, DEVICE]
This option required if you need LUKS support
.TP
.TP
.BR \fBluks_name=\fR"\&\fI ... \fR\&"
Specify device mapper name
.TP
.TP
.BR \fBluks_header=\fR"\&\fI /path/to/file \fR\&"
Embed header into initramfs
.TP
.TP
.BR \fBluks_keyfile=\fR"\&\fI /path/to/file \fR\&"
Embed key into initramfs
.TP
.TP
.BR \fBluks_discard=\fR"\&\fI {0|1} \fR\&"
Enable TRIM requests
.TP
.TP
.BR \fBluks_args=\fR"\&\fI ... \fR\&"
Pass additional options to cryptsetup
.TP

102
usr/share/man/man7/tinyramfs.cmdline.7 Normal file
View File

@@ -0,0 +1,102 @@
.TH tinyramfs 7 "March 2020" tinyramfs
.SH NAME
tinyramfs \- kernel command line options
.SH GENERAL
.TP
.BR \fBdebug=\fR"\&\fI {0|1} \fR\&"
Enable shell debugging
This option also drop you to shell after root partition being mounted
.TP
.TP
.BR \fBinit=\fR"\&\fI /path/to/file \fR\&"
Specify init program
.TP
.TP
.BR \fBroot=\fR"\&\fI ... \fR\&"
Specify root partition [PARTUUID, UUID, LABEL, DEVICE]
.TP
.TP
.BR \fBroot.type=\fR"\&\fI ... \fR\&"
Specify root partition type
.TP
.TP
.BR \fBroot.opts=\fR"\&\fI ... \fR\&"
Specify root partition mount options (comma separated)
.TP
.SH LVM
.TP
.BR \fBlvm=\fR"\&\fI {0|1} \fR\&"
Enable LVM support
.TP
.TP
.BR \fBlvm.name=\fR"\&\fI ... \fR\&"
Specify logical volume name
.TP
.TP
.BR \fBlvm.group=\fR"\&\fI ... \fR\&"
Specify volume group name
.TP
.TP
.BR \fBlvm.config=\fR"\&\fI {0|1} \fR\&"
Not implemented
.TP
.TP
.BR \fBlvm.discard=\fR"\&\fI {0|1} \fR\&"
Not implemented
.TP
.TP
.BR \fBlvm.args=\fR"\&\fI ... \fR\&"
Pass additional options to lvm
.TP
.SH LUKS
.TP
.BR \fBluks=\fR"\&\fI {0|1} \fR\&"
Enable LUKS support
.TP
.TP
.BR \fBluks.root=\fR"\&\fI ... \fR\&"
Specify encrypted root partition [PARTUUID, UUID, LABEL, DEVICE]
.TP
.TP
.BR \fBluks.name=\fR"\&\fI ... \fR\&"
Specify device mapper name
.TP
.TP
.BR \fBluks.header=\fR"\&\fI /path/to/file \fR\&"
Not implemented
.TP
.TP
.BR \fBluks.keyfile=\fR"\&\fI /path/to/file \fR\&"
Not implemented
.TP
.TP
.BR \fBluks.discard=\fR"\&\fI {0|1} \fR\&"
Enable TRIM requests
.TP
.TP
.BR \fBluks.args=\fR"\&\fI ... \fR\&"
Pass additional options to cryptsetup
.TP

5
usr/share/tinyramfs/init
View File

@@ -68,9 +68,6 @@ setup_devmgr() {
mdevd &
mdevd-coldplug
;;
*)
panic "devmgr option broken"
;;
esac
}
@@ -82,7 +79,6 @@ findfs_sh() {
UUID) device="/dev/disk/by-uuid/${value}" ;;
PARTUUID) device="/dev/disk/by-partuuid/${value}" ;;
/dev/*) device="$1" ;;
*) panic "findfs option broken" ;;
esac
# avoid race condition
@@ -131,7 +127,6 @@ cleanup() {
mdevd) killall mdevd ;;
esac
# unmount pseudofs's
umount /dev /sys /proc
}