hardcoresushi/libgocryptfs
1
0
Fork 0
Code Issues Pull Requests Releases Activity

MANPAGE: update exit codes

Browse Source 
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.
This commit is contained in:
Jakob Unterwurzacher 2017-08-21 20:53:25 +02:00
parent a605e8fed0
commit 26a6e61a46
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/MANPAGE.md
View File

@ -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