From 26a6e61a46b9d14dbfaa0b1ba6b99caa86155037 Mon Sep 17 00:00:00 2001 From: Jakob Unterwurzacher Date: Mon, 21 Aug 2017 20:53:25 +0200 Subject: [PATCH] MANPAGE: update exit codes The exit codes have been documented in CLI_ABI.md for a while, but they should also be listed in the man page. Also fix the rendering of "[-o COMMA-SEPARATED-OPTIONS]", where the square brackets where interpreted as something. Escape all square brackets to be safe. --- Documentation/MANPAGE.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/Documentation/MANPAGE.md b/Documentation/MANPAGE.md index e4ec8d9..26652cc 100644 --- a/Documentation/MANPAGE.md +++ b/Documentation/MANPAGE.md @@ -1,6 +1,6 @@ % GOCRYPTFS(1) % github.com/rfjakob -% Oct 2016 +% Aug 2017 NAME ==== @@ -11,13 +11,13 @@ SYNOPSIS ======== #### Initialize encrypted filesystem -gocryptfs -init [OPTIONS] CIPHERDIR +gocryptfs -init \[OPTIONS\] CIPHERDIR #### Mount -gocryptfs [OPTIONS] CIPHERDIR MOUNTPOINT [-o COMMA-SEPARATED-OPTIONS] +gocryptfs \[OPTIONS\] CIPHERDIR MOUNTPOINT \[-o COMMA-SEPARATED-OPTIONS\] #### Change password -gocryptfs -passwd [OPTIONS] CIPHERDIR +gocryptfs -passwd \[OPTIONS\] CIPHERDIR DESCRIPTION =========== @@ -289,7 +289,12 @@ EXIT CODES ========== 0: success +6: CIPHERDIR is not an empty directory (on "-init") +10: MOUNTPOINT is not an empty directory 12: password incorrect +22: password is empty (on "-init") +23: could not read gocryptfs.conf +24: could not write gocryptfs.conf (on "-init" or "-password") other: please check the error message SEE ALSO