summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Unterwurzacher2020-11-14 15:08:57 +0100
committerJakob Unterwurzacher2020-11-14 15:08:57 +0100
commit8470cc38df53f2d171e8c2f34c570d10b0955e61 (patch)
treef14b45064567647f8ecb4b809d8dd9c62932995c
parent6bb42f79fd07c480ccfe08fe8c3ca83d467ac9f5 (diff)
MANPAGE: add -info example output
-rw-r--r--Documentation/MANPAGE.md12
-rw-r--r--README.md3
2 files changed, 13 insertions, 2 deletions
diff --git a/Documentation/MANPAGE.md b/Documentation/MANPAGE.md
index ee9470f..310f27a 100644
--- a/Documentation/MANPAGE.md
+++ b/Documentation/MANPAGE.md
@@ -55,8 +55,16 @@ Print a short help text that shows the more-often used options.
Long help text, shows all available options.
#### -info
-Pretty-print the contents of the config file for human consumption,
-stripping out sensitive data.
+Pretty-print the contents of the config file in CIPHERDIR for
+human consumption, stripping out sensitive data.
+
+Example:
+
+ $ gocryptfs -info my_cipherdir
+ Creator: gocryptfs v2.0-beta2
+ FeatureFlags: GCMIV128 HKDF DirIV EMENames LongNames Raw64
+ EncryptedKey: 64B
+ ScryptObject: Salt=32B N=65536 R=8 P=1 KeyLen=32
#### -init
Initialize encrypted directory.
diff --git a/README.md b/README.md
index a583478..6b59cf0 100644
--- a/README.md
+++ b/README.md
@@ -190,6 +190,9 @@ RM: 3.379
Changelog
---------
+vNEXT, in progress
+* MANPAGE: Split options into sections acc. to where they apply ([#517](https://github.com/rfjakob/gocryptfs/issues/517))
+
v2.0-beta2, 2020-11-14
* Improve [performance](Documentation/performance.txt#L69)
* Fix [GETATTR panic](https://github.com/rfjakob/gocryptfs/issues/519#issuecomment-718790790) in reverse mode