[PATCH v2 5/5] erofs-utils: manpage: add dump.erofs manpage.

[Gao Xiang]

On Thu, Oct 28, 2021 at 06:57:48PM +0800, Guo Xuenan wrote:
> This patch adds dump.erofs manpage.
> 
> Signed-off-by: Guo Xuenan <guoxuenan at huawei.com>
> ---
>  man/Makefile.am  |  2 +-
>  man/dump.erofs.1 | 60 ++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 61 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..d44c7b6
> --- /dev/null
> +++ b/man/dump.erofs.1
> @@ -0,0 +1,60 @@
> +.\" Copyright (c) 2021 Guo Xuenan <guoxuenan at huawei.com>
> +.\"
> +.TH DUMP.EROFS 1
> +.SH NAME
> +dump.erofs \- retrieve directory and file entries, show specific file
> +or overall disk statistics information from an EROFS-formated image.

                                                  ^ EROFS-formatted

> +.SH SYNOPSIS
> +.B dump.erofs
> +[
> +.B \--nid
> +.I inode number
> +]
> +[
> +.B \-e
> +]
> +[
> +.B \-s
> +]
> +[
> +.B \-S
> +]
> +[
> +.B \-V
> +]
> +.I DEVICE

But from the usage, it should be 'IMAGE' here?

> +.SH DESCRIPTION
> +.B dump.erofs
> +is used to retrieve erofs metadata (usually in a disk partition).
> +\fIdevice\fP is the special file corresponding to the device (e.g.
> +\fI/dev/sdXX\fP).

is used to retrieve erofs metadata from \fIimage\fP and demonstrate....

> +
> +Currently, it can demonstrate 1) a file information of given inode number, 2)
> +overall disk statistics, 3) file extent information,
> +4) erofs superblock 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.

	.It depends on "--nid" for a given inode.

> +.TP
> +.BI \-V
> +Print the version number and exit.
> +.TP
> +.BI \-s
> +Show superblock information of the an EROFS-formated image.

formatted

> +.TP
> +.BI \-S
> +Show statistics of the overall disk, including file type(by file extension)/size statistics and distribut$ion, number of compressed and uncompressed files, whole compression ratio of image etc.

Show EROFS disk statistics, including file type/size distribution, number of (un)compressed files, compression ratio of the whole image, etc. 

Thanks,
Gao Xiang

> +.SH AUTHOR
> +Initial code was written by Wang Qi <mpiglet at outlook.com>, Guo Xuenan <guoxuenan at huawei.com>.
> +.PP
> +This manual page was written by Guo Xuenan <guoxuenan at huawei.com>
> +.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