[PATCH] erofs-utils: man: fsck: document extraction options

Vansh Choudhary ch at vnsh.in
Sun Mar 22 01:18:30 AEDT 2026


Document the existing fsck.erofs extraction-related options in the
manpage, including --offset and the extraction-only force,
overwrite, and preserve flags.

Also normalize the option markup for --no-sbcrc and --[no-]xattrs to
match the surrounding manpage style.

This keeps the manpage in sync with the current CLI help output.

Signed-off-by: Vansh Choudhary <ch at vnsh.in>
---
 man/fsck.erofs.1 | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/man/fsck.erofs.1 b/man/fsck.erofs.1
index 0f698da..1659dea 100644
--- a/man/fsck.erofs.1
+++ b/man/fsck.erofs.1
@@ -34,7 +34,10 @@ take a long time depending on the image size.
 
 Optionally extract contents of the \fIIMAGE\fR to \fIdirectory\fR.
 .TP
-.B "--no-sbcrc"
+.BI "\-\-offset=" #
+Skip # bytes at the beginning of IMAGE.
+.TP
+.B "\-\-no\-sbcrc"
 Bypass the on-disk superblock checksum verification.
 .TP
 .BI "\-\-nid=" #
@@ -45,11 +48,31 @@ The default is the root inode.
 Specify the target inode by its path for checking or extraction. If both
 \fB\-\-nid\fR and \fB\-\-path\fR are specified, \fB\-\-path\fR takes precedence.
 .TP
-.BI "--[no-]xattrs"
+.BI "\-\-[no\-]xattrs"
 Whether to dump extended attributes during extraction (default off).
 .TP
 \fB\-h\fR, \fB\-\-help\fR
 Display help string and exit.
+.PP
+The following options are only meaningful when used with \fB\-\-extract\fR=\fIX\fR:
+.TP
+.B \-\-force
+Allow extracting to the root directory.
+.TP
+.B \-\-overwrite
+Overwrite files that already exist.
+.TP
+.B "\-\-[no\-]preserve"
+Same as \fB\-\-[no\-]preserve\-owner\fR \fB\-\-[no\-]preserve\-perms\fR.
+.TP
+.B "\-\-[no\-]preserve\-owner"
+Whether to preserve the ownership from the filesystem (default for
+superuser), or to extract as yourself (default for ordinary users).
+.TP
+.B "\-\-[no\-]preserve\-perms"
+Whether to preserve the exact permissions from the filesystem without
+applying umask (default for superuser), or to modify the permissions
+by applying umask (default for ordinary users).
 .TP
 \fB\-a\fR, \fB\-A\fR, \fB-y\fR
 These options do nothing at all; they are provided only for compatibility with
-- 
2.51.0



More information about the Linux-erofs mailing list