From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-14.8 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8AD17CA9EB0 for ; Sun, 3 Nov 2019 15:31:44 +0000 (UTC) Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 394312067D for ; Sun, 3 Nov 2019 15:31:44 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.ozlabs.org header.i=@lists.ozlabs.org header.b="O6us94A8"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=aol.com header.i=@aol.com header.b="fao4WoXb" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 394312067D Authentication-Results: mail.kernel.org; dmarc=pass (p=none dis=none) header.from=lists.ozlabs.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=linux-erofs-bounces+linux-erofs=archiver.kernel.org@lists.ozlabs.org Received: from bilbo.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 475fzf15C0zDrK5 for ; Mon, 4 Nov 2019 02:31:42 +1100 (AEDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=lists.ozlabs.org; s=201707; t=1572795102; bh=uuuGd1kgDtEBkx21NE/ytcSoRfcXODJDJnC/aQsgOdk=; h=To:Subject:Date:References:List-Id:List-Unsubscribe:List-Archive: List-Post:List-Help:List-Subscribe:From:Reply-To:Cc:From; b=O6us94A8TsUhHBvvcOzHUg1Jks/Dmmcnq1vGGL/wEoLjTm+3jTmXzQqIhlWUUff0b AA+7w8Nf48Ffd1bOycd5/wpD4pMNi6ls/OsJw3n4QyFgo4BSSArght9uHghSH5XXW1 dceGQmBe+DFMrTUKxexc57VQrHCSZnM1DDNUbT3eka5mcdJWVfcE7+S/wupIF1mW3h dAVhlvGFgL98GrFyqus3r9hvn3iNRxwGgQoVbt5Cz9k4G8BRNRZj3CNq9F2Qskuyv7 hR/PYdDTzuIuVbXEqRxRvecWHSPacdbO0QIR44Lxiz/aFFONwlGKRoNLylMOyMDT1k 9q9tUbP4kjjYA== Authentication-Results: lists.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=aol.com (client-ip=98.137.65.205; helo=sonic311-24.consmr.mail.gq1.yahoo.com; envelope-from=hsiangkao@aol.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=pass (p=reject dis=none) header.from=aol.com Authentication-Results: lists.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=aol.com header.i=@aol.com header.b="fao4WoXb"; dkim-atps=neutral Received: from sonic311-24.consmr.mail.gq1.yahoo.com (sonic311-24.consmr.mail.gq1.yahoo.com [98.137.65.205]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 475fzL39MJzDqZL for ; Mon, 4 Nov 2019 02:31:24 +1100 (AEDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aol.com; s=a2048; t=1572795080; bh=6C2L0nR5xC/VgaZ/aZ7HjNajUT3aE8WNd4EMaz1+6o8=; h=From:To:Cc:Subject:Date:References:From:Subject; b=fao4WoXb07QazAFPj7UK18gLEwmIyQALhr3s5S8iHOt4HaI06iEb48axEXITSDV0aHRkZvirQQCL9UEhH8bHLdVPg/aH9RmuwBHgMCfGTZ3SM2qQ5YG8uSMZ7d6yl6KHwRZklp6qISev8kPKdfyRvTlXgJYR6LflKQIO7WFVFoAtTKL8/Ln6zCa49tY33fsdlifpwtz1FzpCxTRvdVgDYjP7Ewpce9gn+uXN2SjP+kdspdFm4rIuS8t8Sz82RWq3ecTQAX5H6TTV3GsQRoIacEKKFWtSxm0udh08LKr3j8n+TP9YbHXuHeGfsiGXiPtQbJDyWywna/7+HVFcGVesfQ== X-YMail-OSG: 56UsztAVM1l68CzR7looqzm2ELiEpq_MiYpookDxLDSrTaqZYBbLTnU8maE5Uld gUOTuw4YVlQFAtRpdiPhU73CKBdEy4Pd8__dgZde9CTntnZLP19TfBa_CRYykzv.Kku7Jwf9Rrau eOkAS4TptchwT8u99xhRSz5TDEm7Ep.VZjIUH.G2xhrJqDIzb7SjQEdVlIxEapAuU99nBQXuNk.u FZ4Wy3DfgAQWe5CY7PbMDOjC2maz9fMJl8ZwIcESnuj3c00TWe7RHEXcM29efbcJevjbqevOAdjY 0CJzVMmmD3C90pODcEfRcnu7hYxN2kQSFG933FqjAHsEonKi40pngJ33Rs_OPWIRdb_xfoESYsXV ZWAXcaJkr6NpXdi.rR_ihrpN.a_1pWTpluDbHv31STq_nIxmNX54QZXkHSYs.YmZKO.i_E.dcqzO 2wlb0nG6Dlh2XMG0DA1tWVwuHFok74i5OhscdV0.MEN2cPeYikb95wtJ3.aTGsQ32431mOjk8RTk XiPlZs7EeL5kbhi7rPCqcrATpyS7IU779aHsJRfE6vbHYK25K.TGwXImBKyFj5EvPTbS9hlLMeG0 Pme0laJhVE7oDhjuMtRcyc8E8oaE5aH_.rrnYrXcmvftZmgffF.Ruqwc5TFQizUFc7Ku322NYlG. Kc1.FTknYdiElpQnz_DeiYcUupf1xdczFheVAjNU0dYHxjaAiD0bk3zGQmv4yeFEezX1TMfXYGNm o4zFKQ7OxKevuuQfzTXjQK4lwfckp0GTpKZAVBRu9kBj4plYLqd_izyYL6aXp8_53CWK1BTvyPj7 D22ME4iZpjtATKKaV.iX2rErPgdcPhH0GD3XwHu0QjBE8twYhV7fPskVt9HlMTJ6Vtj0rCR3kSEY EZhukBB3UrMBwb0bYPUhw6iuqGME1SjPVcUzUYvkeW0v_pv231aT33vk_RvxMvKu3ignJy7M81j7 CQh2KSfEVdE471MXbKuXRAFHDjY8qG365L1DcoUR_SNiLs46VFEGJRSU_IiKKC8tNUTKouXURgPe y2x6k52NIcU2NOoPZc0icYBXjQl3rqXLeKuJFF75bAqNHp0dl3hulNa.UK3f3roPB4w97Mlcgr_W C0oiboarF5VcCCIhl0okVN7TuXKLHWlUtSIPS3BxdiX0LDX1L.42gaRU1qLf9C4jH86FK65six9k E2pthvvEq39F4F0rDbHifhvy3MyNVsQq_mNF_pi0MrdJYdbC91EBc6oScxCsjO4rfW.IlGmkpCdd WF8OCi71CFHnJaTVzGNmz6igX_Xcw6lV78lxOGQ2ae2j7rRrMkYMjNRkDxUpqYv9k5E0pNqt1iYO lb_8Z9qkc8ejlYmLecgtRkctnL_Ipr7Kls9X4rcht87mn_lh1KtX8GwNnoWK7gg0jqp52XCMhR.6 xbaEX4NmqBxKh Received: from sonic.gate.mail.ne1.yahoo.com by sonic311.consmr.mail.gq1.yahoo.com with HTTP; Sun, 3 Nov 2019 15:31:20 +0000 Received: by smtp404.mail.ir2.yahoo.com (Oath Hermes SMTP Server) with ESMTPA ID f24b5b2ef490fb6c4b107b2d97cf1d16; Sun, 03 Nov 2019 15:31:15 +0000 (UTC) To: Li Guifu , linux-erofs@lists.ozlabs.org Subject: [PATCH] erofs-utils: add manual for mkfs.erofs Date: Sun, 3 Nov 2019 23:30:55 +0800 Message-Id: <20191103153055.11471-1-hsiangkao@aol.com> X-Mailer: git-send-email 2.17.1 References: <20191103153055.11471-1-hsiangkao.ref@aol.com> X-BeenThere: linux-erofs@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development of Linux EROFS file system List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Gao Xiang via Linux-erofs Reply-To: Gao Xiang Cc: Miao Xie Errors-To: linux-erofs-bounces+linux-erofs=archiver.kernel.org@lists.ozlabs.org Sender: "Linux-erofs" 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 --- 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..7fb1464 --- /dev/null +++ b/man/mkfs.erofs.1 @@ -0,0 +1,68 @@ +.\" Copyright (c) 2019 Gao Xiang +.\" +.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 this 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 , +Miao Xie and Gao Xiang with +continuously improvements from others. +.PP +This manual page was written by Gao Xiang . +.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