| 1 |
.\" Copyright 2016, Michael Kerrisk <[email protected]> |
| 2 |
.\" Copyright, the authors of the Linux man-pages project |
| 3 |
.\" |
| 4 |
.\" SPDX-License-Identifier: Linux-man-pages-copyleft |
| 5 |
.\" |
| 6 |
.TH erofs 5 2026-02-08 "Linux man-pages 6.18" |
| 7 |
.SH NAME |
| 8 |
erofs \- the Enhanced Read-Only File System |
| 9 |
.SH DESCRIPTION |
| 10 |
.B erofs |
| 11 |
is a create-once read-only filesystem, |
| 12 |
with support for compression and a multi-device backing store. |
| 13 |
.P |
| 14 |
There are two inode formats: |
| 15 |
.IP \[bu] 3 |
| 16 |
32-byte compact with 16-bit UID/GID, |
| 17 |
32-bit file size, |
| 18 |
and no file times |
| 19 |
.PD 0 |
| 20 |
.IP \[bu] |
| 21 |
64-byte extended with 32-bit UID/GID, |
| 22 |
64-bit file size, |
| 23 |
and a modification time |
| 24 |
.RI ( st_mtim ). |
| 25 |
.PD |
| 26 |
.\" See fs/erofs/super.c:shmem_parse_options for options it supports. |
| 27 |
.SS Mount options |
| 28 |
.TP |
| 29 |
.B user_xattr |
| 30 |
.TQ |
| 31 |
.B nouser_xattr |
| 32 |
Controls whether |
| 33 |
.I user |
| 34 |
extended attributes are exposed. |
| 35 |
Defaults to yes. |
| 36 |
.TP |
| 37 |
.B acl |
| 38 |
.TQ |
| 39 |
.B noacl |
| 40 |
Controls whether POSIX |
| 41 |
.BR acl (5)s |
| 42 |
are exposed. |
| 43 |
Defaults to yes. |
| 44 |
.TP |
| 45 |
.BR cache_strategy = disabled | readahead | readaround |
| 46 |
Cache allocation for compressed files: |
| 47 |
never, if reading from start of file, regardless of position. |
| 48 |
Defaults to |
| 49 |
.BR readaround . |
| 50 |
.TP |
| 51 |
.B dax |
| 52 |
.TQ |
| 53 |
.BR dax = always | never |
| 54 |
Direct Access control. |
| 55 |
If |
| 56 |
.B always |
| 57 |
and the source device supports DAX, uncompressed non-inlined files |
| 58 |
will be read directly, without going through the page cache. |
| 59 |
.B dax |
| 60 |
is a synonym for |
| 61 |
.BR always . |
| 62 |
Defaults to unset, which is equivalent to |
| 63 |
.BR never . |
| 64 |
.TP |
| 65 |
.BR device = \f[I]blobdev\f[] |
| 66 |
Add extra device holding some of the data. |
| 67 |
Must be given as many times and in the same order as |
| 68 |
.B \-\-blobdev |
| 69 |
was to |
| 70 |
.BR mkfs.erofs (1). |
| 71 |
.\" Nominally there's a device_table feature and it somehow scans(?) for them, |
| 72 |
.\" cf., super.c:erofs_scan_devices(), but I haven't gotten it to work |
| 73 |
.TP |
| 74 |
.BR domain_id = \f[I]did\f[] |
| 75 |
.TQ |
| 76 |
.BR fsid = \f[I]id\f[] |
| 77 |
Control CacheFiles on-demand read support. |
| 78 |
To be documented. |
| 79 |
.SH VERSIONS |
| 80 |
.B erofs |
| 81 |
images are versioned through the use of feature flags; |
| 82 |
these are listed in the |
| 83 |
.B \-E |
| 84 |
section of |
| 85 |
.BR mkfs.erofs (1), |
| 86 |
.SH CONFIGURATION |
| 87 |
Linux must be configured with the |
| 88 |
.B CONFIG_EROFS_FS |
| 89 |
option to mount EROFS filesystems. |
| 90 |
There are sub-configuration items that restrict the availability |
| 91 |
of some of the parameters above. |
| 92 |
.SH SEE ALSO |
| 93 |
.BR mkfs.erofs (1), |
| 94 |
.BR fsck.erofs (1), |
| 95 |
.BR dump.erofs (1) |
| 96 |
.P |
| 97 |
.I Documentation/filesystems/erofs.rst |
| 98 |
in the Linux source. |