summaryrefslogtreecommitdiff
path: root/Documentation/MANPAGE.md
diff options
context:
space:
mode:
authorJakob Unterwurzacher2018-04-03 21:19:44 +0200
committerJakob Unterwurzacher2018-04-03 21:24:48 +0200
commit4e5783591f9874e2c7336598c96ebd2c5840bd5b (patch)
tree589e9381ad3868eb1eb7dc384fdca4c18cda901b /Documentation/MANPAGE.md
parent8b443c8484f5fdcedbec2a689a7d66d2a277b26e (diff)
fsck: report skipped corrupt files
OpenDir and ListXAttr skip over corrupt entries, readFileID treats files the are too small as empty. This improves usability in the face of corruption, but hides the problem in a log message instead of putting it in the return code. Create a channel to report these corruptions to fsck so it can report them to the user. Also update the manpage and the changelog with the -fsck option. Closes https://github.com/rfjakob/gocryptfs/issues/191
Diffstat (limited to 'Documentation/MANPAGE.md')
-rw-r--r--Documentation/MANPAGE.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/MANPAGE.md b/Documentation/MANPAGE.md
index e20b786..1c7e7b9 100644
--- a/Documentation/MANPAGE.md
+++ b/Documentation/MANPAGE.md
@@ -19,6 +19,9 @@ SYNOPSIS
#### Change password
`gocryptfs -passwd [OPTIONS] CIPHERDIR`
+#### Check consistency
+`gocryptfs -fsck [OPTIONS] CIPHERDIR`
+
DESCRIPTION
===========
@@ -96,6 +99,10 @@ that uses built-in Go crypto.
Setting this option forces the filesystem to read-only and noexec.
+#### -fsck
+Check CIPHERDIR for consistency. If corruption is found, the
+exit code is 26.
+
#### -fsname string
Override the filesystem name (first column in df -T). Can also be
passed as "-o fsname=" and is equivalent to libfuse's option of the
@@ -351,6 +358,7 @@ EXIT CODES
22: password is empty (on "-init")
23: could not read gocryptfs.conf
24: could not write gocryptfs.conf (on "-init" or "-password")
+26: fsck found errors
other: please check the error message
SEE ALSO