From fbb6a8c4537d2a374a7335758ce46c379c35b694 Mon Sep 17 00:00:00 2001 From: illiliti Date: Fri, 4 Sep 2020 11:34:59 +0300 Subject: [PATCH] update man pages --- Makefile | 7 +- docs/tinyramfs.8 | 85 +++++++++++++++++++ docs/tinyramfs.8.scd | 62 ++++++++++++++ docs/{tinyramfs.5 => tinyramfs.config.5} | 3 +- ...tinyramfs.5.scd => tinyramfs.config.5.scd} | 3 +- 5 files changed, 156 insertions(+), 4 deletions(-) create mode 100644 docs/tinyramfs.8 create mode 100644 docs/tinyramfs.8.scd rename docs/{tinyramfs.5 => tinyramfs.config.5} (98%) rename docs/{tinyramfs.5.scd => tinyramfs.config.5.scd} (98%) diff --git a/Makefile b/Makefile index 6e452f8..17438a0 100644 --- a/Makefile +++ b/Makefile @@ -8,14 +8,17 @@ MANDIR = ${PREFIX}/share/man install: mkdir -p ${DESTDIR}${DATADIR}/tinyramfs \ ${DESTDIR}${MANDIR}/man5 \ + ${DESTDIR}${MANDIR}/man8 \ ${DESTDIR}${BINDIR} cp -R hooks ${DESTDIR}${DATADIR}/tinyramfs cp device-helper ${DESTDIR}${DATADIR}/tinyramfs cp init ${DESTDIR}${DATADIR}/tinyramfs cp tinyramfs ${DESTDIR}${BINDIR}/tinyramfs - cp docs/tinyramfs.5 ${DESTDIR}${MANDIR}/man5 + cp docs/tinyramfs.8 ${DESTDIR}${MANDIR}/man8 + cp docs/tinyramfs.config.5 ${DESTDIR}${MANDIR}/man5 uninstall: rm -f ${DESTDIR}${BINDIR}/tinyramfs rm -rf ${DESTDIR}${DATADIR}/tinyramfs - rm -f ${DESTDIR}${MANDIR}/man5/tinyramfs.5 + rm -f ${DESTDIR}${MANDIR}/man8/tinyramfs.8 + rm -f ${DESTDIR}${MANDIR}/man5/tinyramfs.config.5 diff --git a/docs/tinyramfs.8 b/docs/tinyramfs.8 new file mode 100644 index 0000000..4a3f4ed --- /dev/null +++ b/docs/tinyramfs.8 @@ -0,0 +1,85 @@ +.\" 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 +.P +.RS 4 +Specify directory where modules stored.\& Default is \fB/lib/modules\fR.\& +.P +.RE +\fB-s\fR, \fB--sources\fR +.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 +.P +.RS 4 +Specify output location where initramfs image will be stored.\& +.P +.RE +\fB-c\fR, \fB--config\fR +.P +.RS 4 +Specify config location.\& Default is \fB/etc/tinyramfs/config\fR.\& +.P +.RE +\fB-k\fR, \fB--kernel\fR +.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 +.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) diff --git a/docs/tinyramfs.8.scd b/docs/tinyramfs.8.scd new file mode 100644 index 0000000..0782e8b --- /dev/null +++ b/docs/tinyramfs.8.scd @@ -0,0 +1,62 @@ +tinyramfs(8) + +# NAME + +Tinyramfs - tiny initramfs written in POSIX shell + +# SYNOPSIS + +*tinyramfs* [-df] [-o output] [-c config] [-m dir] [-s dir] [-k ver] [-H dir] + +# DESCRIPTION + +Tinyramfs is a simple, extensible and modular initramfs generator tool written +with focus on portability. + +# OPTIONS + +*-m*, *--modules* + + Specify directory where modules stored. Default is */lib/modules*. + +*-s*, *--sources* + + Specify directory where tinyramfs stored files such as *device-helper* + and *init*. Default is */usr/share/tinyramfs*. + +*-o*, *--output* + + Specify output location where initramfs image will be stored. + +*-c*, *--config* + + Specify config location. Default is */etc/tinyramfs/config*. + +*-k*, *--kernel* + + Specify kernel version. Useful for bootstraping future system with modular + kernel. Default is current kernel version. + +*-H*, *--hooks* + + Specify additional hooks location. Default is */usr/share/tinyramfs/hooks* + and */etc/tinyramfs/hooks*. + +*-d*, *--debug* + + Enable debug mode. Useful for reporting bugs in build stage. + +*-f*, *--force* + + Forcefully overwrite initramfs image. + +# NOTES + +If you have modular kernel and you use *busybox modrobe* to handle modules, you +must note that *busybox modprobe* doesn't have ability to install soft +dependencies of modules (i.e modules.softdep). You must install them yourself +using hooks. See *tinyramfs.hooks*(7) how to do it. + +# SEE ALSO + +*tinyramfs.config*(5) *tinyramfs.cmdline*(7) *tinyramfs.hooks*(7) diff --git a/docs/tinyramfs.5 b/docs/tinyramfs.config.5 similarity index 98% rename from docs/tinyramfs.5 rename to docs/tinyramfs.config.5 index 9106b61..415bb40 100644 --- a/docs/tinyramfs.5 +++ b/docs/tinyramfs.config.5 @@ -12,6 +12,7 @@ Tinyramfs - configuration file .P .SH SYNOPSIS +.P \fB/etc/tinyramfs/config\fR .P .SH DESCRIPTION @@ -526,4 +527,4 @@ root=/dev/disk/by-uuid/aa82d7bb-ab2b-4739-935f-fd8a5c9a6cb0 .P .SH SEE ALSO .P -\fBtinyramfs\fR(8) \fBtinyramfs.\&cmdline\fR(7) +\fBtinyramfs\fR(8) \fBtinyramfs.\&cmdline\fR(7) \fBtinyramfs.\&hooks\fR(7) diff --git a/docs/tinyramfs.5.scd b/docs/tinyramfs.config.5.scd similarity index 98% rename from docs/tinyramfs.5.scd rename to docs/tinyramfs.config.5.scd index c917ee9..26097b9 100644 --- a/docs/tinyramfs.5.scd +++ b/docs/tinyramfs.config.5.scd @@ -5,6 +5,7 @@ tinyramfs(5) Tinyramfs - configuration file # SYNOPSIS + */etc/tinyramfs/config* # DESCRIPTION @@ -223,4 +224,4 @@ root=/dev/disk/by-uuid/aa82d7bb-ab2b-4739-935f-fd8a5c9a6cb0 # SEE ALSO -*tinyramfs*(8) *tinyramfs.cmdline*(7) +*tinyramfs*(8) *tinyramfs.cmdline*(7) *tinyramfs.hooks*(7)