Add MANPAGE.md and MANPAGE-render.bash

MANPAGE-render.bash renders the markdown to a proper man(1) manpage
This commit is contained in:
Jakob Unterwurzacher 2015-11-11 09:15:14 +01:00
parent e43733ca0d
commit 0084087d35
4 changed files with 82 additions and 25 deletions

5
.gitignore vendored
View File

@ -1,4 +1,4 @@
# binary
# the gocryptfs executable
/gocryptfs
# temporary files created by the tests
@ -6,3 +6,6 @@
# binary releases
/*.tar.gz
# manpage generated by MANPAGE-render.bash
/gocryptfs.1

7
MANPAGE-render.bash Executable file
View File

@ -0,0 +1,7 @@
#!/bin/bash
set -eux
# Render MANPAGE.md to a proper man(1) manpage
pandoc MANPAGE.md -s -t man -o gocryptfs.1 && man ./gocryptfs.1

71
MANPAGE.md Normal file
View File

@ -0,0 +1,71 @@
% GOCRYPTFS(1)
% github.com/rfjakob
% Nov 2015
NAME
====
gocryptfs - mount and encrypted directory
SYNOPSIS
========
Initialize encrypted filesystem
-------------------------------
gocryptfs -init [OPTIONS] CIPHERDIR
Mount
-----
gocryptfs [OPTIONS] CIPHERDIR MOUNTPOINT
Change password
---------------
gocryptfs -passwd CIPHERDIR
DESCRIPTION
===========
Options:
**-cpuprofile string**
: Write cpu profile to specified file
**-debug**
: Enable debug output
**-f**
: Stay in the foreground
**-fusedebug**
: Enable fuse library debug output
**-init**
: Initialize encrypted directory
**-masterkey string**
: Mount with explicit master key
**-notifypid int**
: Send USR1 to the specified process after successful mount - used internally for daemonization
**-openssl bool**
: Use OpenSSL instead of built-in Go crypto (default true)
**-passwd**
: Change password
**-plaintextnames**
: Do not encrypt file names - can only be used together with -init
**-q**
: Quiet - silence informational messages
**-version**
: Print version and exit
**-zerokey**
: Use all-zero dummy master key

View File

@ -1,24 +0,0 @@
Usage: gocryptfs [OPTIONS] CIPHERDIR MOUNTPOINT
Options:
-cpuprofile string
Write cpu profile to specified file
-debug
Enable debug output
-f Stay in the foreground
-fusedebug
Enable fuse library debug output
-init
Initialize encrypted directory
-masterkey string
Mount with explicit master key
-openssl
Use OpenSSL instead of built-in Go crypto (default true)
-passwd
Change password
-plaintextnames
Do not encrypt file names - can only be used together with -init
-version
Print version and exit
-zerokey
Use all-zero dummy master key