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