diff options
| author | Guo Xuenan <guoxuenan@huawei.com> | 2021-10-29 17:12:44 +0800 |
|---|---|---|
| committer | Gao Xiang <xiang@kernel.org> | 2021-10-31 22:55:57 +0800 |
| commit | f500db7128ba4d45455f522323477839b73df4a6 (patch) | |
| tree | 46fffcefd3330a82849ff4dc625d92869fbce067 | |
| parent | 769e8b439ee00eed7a6517dc5a6c76daebf8e182 (diff) | |
| download | erofs-utils-f500db7128ba4d45455f522323477839b73df4a6.tar.gz | |
erofs-utils: manpage: add dump.erofs manpage
This patch adds dump.erofs manpage.
Link: https://lore.kernel.org/r/20211029091244.1162119-5-guoxuenan@huawei.com
Signed-off-by: Guo Xuenan <guoxuenan@huawei.com>
Signed-off-by: Gao Xiang <xiang@kernel.org>
| -rw-r--r-- | man/Makefile.am | 2 | ||||
| -rw-r--r-- | man/dump.erofs.1 | 58 |
2 files changed, 59 insertions, 1 deletions
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..8233c89 --- /dev/null +++ b/man/dump.erofs.1 @@ -0,0 +1,58 @@ +.\" Copyright (c) 2021 Guo Xuenan <guoxuenan@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-formatted image. +.SH SYNOPSIS +.B dump.erofs +[ +.B \--nid +.I inode NID +] +[ +.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) superblock information, +3) file information of the given inode NID, +4) file extent information of the given inode NID. +.SH OPTIONS +.TP +.BI \--nid " inode NID" +Specify an inode NID in order 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-formatted 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 <mpiglet@outlook.com>, Guo Xuenan <guoxuenan@huawei.com>. +.PP +This manual page was written by Guo Xuenan <guoxuenan@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) |