Linux-EROFS Archive on lore.kernel.org
 help / color / Atom feed
From: Gao Xiang via Linux-erofs <linux-erofs@lists.ozlabs.org>
To: Li Guifu <bluce.liguifu@huawei.com>, linux-erofs@lists.ozlabs.org
Cc: Miao Xie <miaoxie@huawei.com>
Subject: [PATCH v2] erofs-utils: add manual for mkfs.erofs
Date: Mon,  4 Nov 2019 15:28:17 +0800
Message-ID: <20191104072817.7936-1-hsiangkao@aol.com> (raw)
In-Reply-To: <20191103153055.11471-1-hsiangkao@aol.com>

This patch adds mkfs.erofs manpage, which is a requirement of
a debian binary package (See Debian Policy Manual section 12.1 [1].)

[1] https://www.debian.org/doc/debian-policy/ch-docs.html#manual-pages
Signed-off-by: Gao Xiang <hsiangkao@aol.com>
---
changes since v1:
 - remove redundant whitespace in the previous version;
 - adjust long lines.

 Makefile.am      |  2 +-
 configure.ac     |  1 +
 man/Makefile.am  |  5 ++++
 man/mkfs.erofs.1 | 68 ++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 75 insertions(+), 1 deletion(-)
 create mode 100644 man/Makefile.am
 create mode 100644 man/mkfs.erofs.1

diff --git a/Makefile.am b/Makefile.am
index d94ab73..1d20577 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -3,4 +3,4 @@
 
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS=lib mkfs
+SUBDIRS = man lib mkfs
diff --git a/configure.ac b/configure.ac
index 4f88678..a93767f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -173,6 +173,7 @@ AM_CONDITIONAL([ENABLE_LZ4], [test "x${have_lz4}" = "xyes"])
 AM_CONDITIONAL([ENABLE_LZ4HC], [test "x${have_lz4hc}" = "xyes"])
 
 AC_CONFIG_FILES([Makefile
+		 man/Makefile
 		 lib/Makefile
 		 mkfs/Makefile])
 AC_OUTPUT
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..dcdbb35
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: GPL-2.0+
+# Makefile.am
+
+dist_man_MANS = mkfs.erofs.1
+
diff --git a/man/mkfs.erofs.1 b/man/mkfs.erofs.1
new file mode 100644
index 0000000..d6bf828
--- /dev/null
+++ b/man/mkfs.erofs.1
@@ -0,0 +1,68 @@
+.\" Copyright (c) 2019 Gao Xiang <xiang@kernel.org>
+.\"
+.TH MKFS.EROFS 1
+.SH NAME
+mkfs.erofs \- tool to create an EROFS filesystem
+.SH SYNOPSIS
+\fBmkfs.erofs\fR [\fIOPTIONS\fR] \fIDESTINATION\fR \fISOURCE\fR
+.SH DESCRIPTION
+EROFS is a new enhanced lightweight linux read-only filesystem with modern
+designs (eg. no buffer head, reduced metadata, inline xattrs/data, etc.) for
+scenarios which need high-performance read-only requirements, e.g. Android OS
+for smartphones and LIVECDs.
+.PP
+It also provides fixed-sized output compression support, which improves storage
+density, keeps relatively higher compression ratios, which is more useful to
+achieve high performance for embedded devices with limited memory since it has
+unnoticable memory overhead and page cache thrashing.
+.PP
+mkfs.erofs is used to create such EROFS filesystem \fIDESTINATION\fR image file
+from \fISOURCE\fR directory.
+.SH OPTIONS
+.TP
+.BI "\-z " compression-algorithm " [" ",#" "]"
+Set an algorithm for file compression, which can be set with an optional
+compression level separated by a comma.
+.TP
+.BI "\-d " #
+Specify the level of debugging messages. The default is 0.
+.TP
+.BI "\-x " #
+Specify the upper limit of an xattr which is still inlined. The default is 2.
+Disable storing xattrs if < 0.
+.TP
+.BI "\-E " extended-option " [,...]"
+Set extended options for the filesystem. Extended options are comma separated,
+and may take an argument using the equals ('=') sign.
+The following extended options are supported:
+.RS 1.2i
+.TP
+.BI legacy-compress
+Disable "decompression in-place" and "compacted indexes" support, which is used
+when generating EROFS images for kernel version < 5.3.
+.TP
+.BI force-inode-compact
+Forcely generate compact inodes (32-byte inodes) to output.
+.TP
+.BI force-inode-extended
+Forcely generate extended inodes (64-byte inodes) to output.
+.RE
+.TP
+.BI "\-T " #
+Set all files to the given UNIX timestamp. Reproducible builds requires setting
+all to a specific one.
+.TP
+.B \-\-help
+Display this help and exit.
+.SH AUTHOR
+This version of \fBmkfs.erofs\fR is written by Li Guifu <blucerlee@gmail.com>,
+Miao Xie <miaoxie@huawei.com> and Gao Xiang <xiang@kernel.org> with
+continuously improvements from others.
+.PP
+This manual page was written by Gao Xiang <xiang@kernel.org>.
+.SH AVAILABILITY
+\fBmkfs.erofs\fR 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 (8).
+
-- 
2.17.1


  reply index

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20191103153055.11471-1-hsiangkao.ref@aol.com>
2019-11-03 15:30 ` [PATCH] " Gao Xiang via Linux-erofs
2019-11-04  7:28   ` Gao Xiang via Linux-erofs [this message]
2019-11-04 16:40     ` [PATCH v2] " Li Guifu

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191104072817.7936-1-hsiangkao@aol.com \
    --to=linux-erofs@lists.ozlabs.org \
    --cc=bluce.liguifu@huawei.com \
    --cc=hsiangkao@aol.com \
    --cc=miaoxie@huawei.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Linux-EROFS Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-erofs/0 linux-erofs/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-erofs linux-erofs/ https://lore.kernel.org/linux-erofs \
		linux-erofs@lists.ozlabs.org linux-erofs@ozlabs.org
	public-inbox-index linux-erofs

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.ozlabs.lists.linux-erofs


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git