This patch adds dump.erofs manpage. Signed-off-by: Guo Xuenan <[email protected]> --- man/Makefile.am | 2 +- man/dump.erofs.1 | 58 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 man/dump.erofs.1
diff --git a/man/Makefile.am b/man/Makefile.am index d62d6e2..769b557 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,6 +1,6 @@ # SPDX-License-Identifier: GPL-2.0+ -dist_man_MANS = mkfs.erofs.1 +dist_man_MANS = mkfs.erofs.1 dump.erofs.1 EXTRA_DIST = erofsfuse.1 if ENABLE_FUSE diff --git a/man/dump.erofs.1 b/man/dump.erofs.1 new file mode 100644 index 0000000..98be560 --- /dev/null +++ b/man/dump.erofs.1 @@ -0,0 +1,58 @@ +.\" Copyright (c) 2021 Guo Xuenan <[email protected]> +.\" +.TH DUMP.EROFS 1 +.SH NAME +dump.erofs \- retrieve directory and file entries, show specific file +or overall disk statistics information from an EROFS-formatted image. +.SH SYNOPSIS +.B dump.erofs +[ +.B \--nid +.I inode number +] +[ +.B \-e +] +[ +.B \-s +] +[ +.B \-S +] +[ +.B \-V +] +.I IMAGE +.SH DESCRIPTION +.B dump.erofs +is used to retrieve erofs metadata from \fIIMAGE\fP and demonstrate +1) overall disk statistics, +2) erofs superblock information, +3) file information of given inode number, +4) file extent information. +.SH OPTIONS +.TP +.BI \--nid " inode number" +Specify an inode number to print its file information. +.TP +.BI \-e +Show the file extent information, the option depends on option --nid to specify nid. +.TP +.BI \-V +Print the version number and exit. +.TP +.BI \-s +Show superblock information of the an EROFS-formated image. +.TP +.BI \-S +Show EROFS disk statistics, including file type/size distribution, number of (un)compressed files, compression ratio of the whole image, etc. +.SH AUTHOR +Initial code was written by Wang Qi <[email protected]>, Guo Xuenan <[email protected]>. +.PP +This manual page was written by Guo Xuenan <[email protected]> +.SH AVAILABILITY +.B dump.erofs +is part of erofs-utils package and is available from git://git.kernel.org/pub/scm/linux/kernel/git/xiang/erofs-utils.git. +.SH SEE ALSO +.BR mkfs.erofs(1), +.BR fsck.erofs(1) -- 2.31.1
