1MKFS.EROFS(1) General Commands Manual MKFS.EROFS(1)
2
3
4
6 mkfs.erofs - tool to create an EROFS filesystem
7
9 mkfs.erofs [OPTIONS] DESTINATION SOURCE
10
12 EROFS is a new enhanced lightweight linux read-only filesystem with
13 modern designs (eg. no buffer head, reduced metadata, inline xat‐
14 trs/data, etc.) for scenarios which need high-performance read-only
15 requirements, e.g. Android OS for smartphones and LIVECDs.
16
17 It also provides fixed-sized output compression support, which improves
18 storage density, keeps relatively higher compression ratios, which is
19 more useful to achieve high performance for embedded devices with lim‐
20 ited memory since it has unnoticable memory overhead and page cache
21 thrashing.
22
23 mkfs.erofs is used to create such EROFS filesystem DESTINATION image
24 file from SOURCE directory.
25
27 -z compression-algorithm [,#]
28 Set an algorithm for file compression, which can be set with an
29 optional compression level separated by a comma.
30
31 -d # Specify the level of debugging messages. The default is 0.
32
33 -x # Specify the upper limit of an xattr which is still inlined. The
34 default is 2. Disable storing xattrs if < 0.
35
36 -E extended-option [,...]
37 Set extended options for the filesystem. Extended options are
38 comma separated, and may take an argument using the equals ('=')
39 sign. The following extended options are supported:
40
41 legacy-compress
42 Disable "decompression in-place" and "compacted
43 indexes" support, which is used when generating
44 EROFS images for kernel version < 5.3.
45
46 force-inode-compact
47 Forcely generate compact inodes (32-byte inodes) to
48 output.
49
50 force-inode-extended
51 Forcely generate extended inodes (64-byte inodes) to
52 output.
53
54 -T # Set all files to the given UNIX timestamp. Reproducible builds
55 requires setting all to a specific one.
56
57 --exclude-path=path
58 Ignore file that matches the exact literal path. You may give
59 multiple `--exclude-path' options.
60
61 --exclude-regex=regex
62 Ignore files that match the given regular expression. You may
63 give multiple `--exclude-regex` options.
64
65 --help Display this help and exit.
66
68 This version of mkfs.erofs is written by Li Guifu <blucer‐
69 lee@gmail.com>, Miao Xie <miaoxie@huawei.com> and Gao Xiang <xiang@ker‐
70 nel.org> with continuously improvements from others.
71
72 This manual page was written by Gao Xiang <xiang@kernel.org>.
73
75 mkfs.erofs is part of erofs-utils package and is available from
76 git://git.kernel.org/pub/scm/linux/kernel/git/xiang/erofs-utils.git.
77
79 mkfs(8).
80
81
82
83
84 MKFS.EROFS(1)