From 259321dd25c548d75f26c00c2b7df7ff72fcaa4e Mon Sep 17 00:00:00 2001 From: Christopher Wellons Date: Thu, 13 Jul 2017 09:01:00 -0400 Subject: [PATCH] Add man page. --- index.html | 327 +++++++++++++++++++++++++++++++++++++++++++++++++++++ man.css | 22 ++++ 2 files changed, 349 insertions(+) create mode 100644 index.html create mode 100644 man.css diff --git a/index.html b/index.html new file mode 100644 index 0000000..f77a1fb --- /dev/null +++ b/index.html @@ -0,0 +1,327 @@ + + + + + + + + + + +ENCHIVE + + + + +

ENCHIVE

+ +NAME
+SYNOPSIS
+DESCRIPTION
+OPTIONS
+COMMANDS
+ENVIRONMENT
+FILES
+EXAMPLES
+SEE ALSO
+ +
+ + +

NAME + +

+ + +

enchive - +personal archive encryption

+ +

SYNOPSIS + +

+ + + + + + + + +
+ + +

enchive

 + + +

[--no-agent] +[-a|--agent[=SECONDS]] +[--random-device DEV] +[-p|--pubkey FILE] +[-s|--seckey FILE] [--version] +[--help]

+ +

command [args...]

+ +

DESCRIPTION + +

+ + +

enchive +is a program to encrypt files to yourself for long-term +archival. It’s a focused, simple alternative to more +complex tools such as GnuPG or encrypted filesystems. Like +GnuPG, you can safely encrypt files on systems that you +don’t trust with your secret key.

+ +

Files are +secured with ChaCha20, Curve25519, and HMAC-SHA256.

+ +

OPTIONS + +

+ + + +

--agent[=SECONDS]

+ +

Runs the key agent for awhile +after successfully reading the passphrase. The agent will +remain resident in memory until a period of inactivity +passes. Default is 900 seconds (15 minutes).

+ +

--no-agent

+ +

Do not start the key agent +(default).

+ +

-p, --pubkey +FILE

+ +

Specifies the public key file +to use for encryption.

+ +

--random-device +DEV

+ +

Use DEV as an entropy +source instead of /dev/urandom.

+ +

-s, --seckey +FILE

+ +

Specifies the secret key file +to use for decryption.

+ +

--version

+ +

Print version information.

+ + + + + + + + +
+ + +

--help

 + + +

Print a synopsis of the command line interface.

 +
+ +

COMMANDS + +

+ + +

Any unique +prefix for a command is accepted. For example, the command +a would mean archive.
+keygen [OPTION]...

+ +

Generates a new keypair either +from the random device or a passphrase.

+ +

--derive[=N], +-d[N]

+ +

Derives the secret key from a +passphrase. The key will be derived from the passphrase +using difficulty exponent N. Default is 29.

+ + + + + + + +
+ + +

--edit

 + + +

Edits the protection passphrase on an existing key. This +also regenerates the public key file from the secret +key.

+ +

--fingerprint

+ +

Prints the public key +fingerprint after generation or editing.

+ +

--force, -f

+ +

Overwrites any existing keypair +without prompting.

+ +

--iterations +N

+ +

Sets the difficulty exponent +for deriving the protection key from the protection key +passphrase. Default is 25.

+ +

--plain, -u

+ +

Do not use a protection key, +and instead store the secret key unencrypted on the disk. +Consider using the key agent instead of this option.

+ +

archive +[-d|--delete] [INPUT +[OUTPUT]]

+ +

Encrypts a single file for +archival using only the public key. If no output filename is +given, the output filename will be the input filename with a +.enchive suffix. Except for --delete, the +original file is untouched. If no filenames are given, +encrypts standard input to standard output.

+ +

--delete, -d

+ +

Delete the original input file +after success.

+ +

extract +[-d|--delete] [INPUT +[OUTPUT]]

+ +

Decrypt a single file from +archival using the secret key. If no output filename is +given, the output filename will be the input filename with +the .enchive suffix removed. Without an output +filename, it is an error for the input to lack this suffix. +If no filenames are given, dencrypt standard input to +standard output.

+ +

--delete, -d

+ +

Delete the original input file +after success.

+ +

fingerprint

+ +

Print the public key +fingerprint to standard output.

+ +

ENVIRONMENT + +

+ + + + + + + + +
+ + +

TMPDIR

 + + +

If $XDG_RUNTIME_DIR is unset, +the directory in which to create the agent socket. Default +is /tmp.

+ +

XDG_CONFIG_HOME

+ +

The directory under which keys +will be created and read. Default is $HOME/.config.

+ +

XDG_RUNTIME_DIR

+ +

The directory in which to +create the agent socket.

+ +

FILES + +

+ + + +

$XDG_CONFIG_HOME/enchive/enchive.pub

+ +

The file holding the public key +used for encrypting files.

+ + +

$XDG_CONFIG_HOME/enchive/enchive.sec

+ +

The file holding the secret key +used for decrypting files.

+ +

EXAMPLES + +

+ + +

enchive +keygen --derive

+ +

Generate a new +keypair from a passphrase prompt.

+ +

enchive +archive -d mydata.tar.gz

+ +

Encrypt +mydata.tar.gz to mydata.tar.gz.enchive and +delete the unencrypted file.

+ +

enchive +extract mydata.tar.gz.enchive

+ +

Decrypt +mydata.tar.gz.enchive to mydata.tar.gz, +preserving the original file.

+ +

SEE ALSO + +

+ + +

gpg(1) +
+https://github.com/skeeto/enchive
+ http://nullprogram.com/blog/2017/03/12/

+
+ + diff --git a/man.css b/man.css new file mode 100644 index 0000000..7570169 --- /dev/null +++ b/man.css @@ -0,0 +1,22 @@ +html { + background: lightgray; +} + +body { + background: white; + padding: 15px; + font: 14px monospace; + max-width: 700px; + margin: auto; + text-align: justify; +} + +body > a, body > br, body > hr { + display: none; +} + +p, br { + display: block; + margin-bottom: 0.5em; + content: " "; +}