11 Commits

Author SHA1 Message Date
Ben Hutchings
00809d736a Make manual pages and usage messages more consistent
* Don't use angle brackets around parameters
* Show all options in manual page synopses if possible
* Make the usage summary line match the manual page synopsis,
  excluding the -h option
* List all options in usage messages
* Refer to manual pages from usage messages
* Include one blank line at start and end of usage messages

Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
2019-02-06 03:37:11 +00:00
Ben Hutchings
9bd960e4d7 docs: Set man page header source and manual parameters correctly
Set the .TH source parameter for all pages to "initramfs-tools".
Set the .TH manual parameter to a commonly used name for the man page
section.

Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
2018-07-18 23:38:23 +01:00
Ben Hutchings
562d86ef33 docs: Update man page header dates
Set each page's date to the date of the last substantive
change, i.e. excluding cross-reference updates and spelling fixes.

Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
2018-07-18 23:38:14 +01:00
Ben Hutchings
63cec7bb02 docs: Move initramfs-tools man page to section 7
Manual pages that describe a general topic belong in section 7, not 8.

Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
2018-07-18 23:36:57 +01:00
Kevin Locke
f1f18a44fd Create unmkinitramfs command
This command supports extracting files from an initramfs image.  It is
designed to be a drop-in for cpio wherever an initramfs may be present.

It is implemented using the code from lsinitramfs, which now delegates
to uninitramfs instead of cpio.

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
[bwh: Rename it from uninitramfs to unmkinitramfs; add to .install list]
Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
2016-12-15 21:49:33 +00:00
Ben Hutchings
4b4e578bb9 lsinitramfs.8: Update the BUGS section to note fix for #717805
lsinitramfs does now support the common case of a multi-segment
initramfs, but not arbitrary concatenations.

Closes: #790095
Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
2015-12-09 03:22:18 +00:00
Henrique de Moraes Holschuh
b8295f08fe lsinitramfs(8): document failure to deal with early initramfs
lsinitramfs cannot deal with a multi-segmented initramfs archive, such
as one with an uncompressed early initramfs prepended to the main
compressed initramfs.  Document this in the manpage.

The kernel will parse all cpio archives it can find in the initramfs in
sequence, and it doesn't care if some of them are compressed and others
are not.

Signed-off-by: Henrique de Moraes Holschuh <hmh@debian.org>
2013-06-17 10:24:33 +02:00
Michael Prokop
adce374416 docs: fix wording ("allows *one* to") to make lintian happy.
Signed-off-by: Michael Prokop <mika@debian.org>
2011-05-11 23:56:44 +02:00
Michael Prokop
d25f610599 slightly improve manpage lsinitramfs.8
Signed-off-by: Michael Prokop <mika@debian.org>
2010-06-18 12:22:16 +02:00
maximilian attems
2f3eb88faf lsinitramfs: use getopt for -l option
only pass verbose to cpio if invoked with -l or --long.

add minimal hints to manpage.

Signed-off-by: maximilian attems <maks@debian.org>
2010-06-18 11:50:38 +02:00
maximilian attems
a39db63500 Add lsinitramfs to initramfs-tools
useful script to quickly look into initramfs for debugger
or bug reporter, inspired by similar dracut tool.

Signed-off-by: maximilian attems <maks@debian.org>
2010-06-17 13:59:38 +02:00