Commit updated man page.

gh-pages
Christopher Wellons 2017-07-21 19:45:34 -04:00
parent 259321dd25
commit 2bd9413c7f
1 changed files with 38 additions and 44 deletions

View File

@ -1,5 +1,5 @@
<!-- Creator : groff version 1.22.3 -->
<!-- CreationDate: Thu Jul 13 12:53:38 2017 -->
<!-- CreationDate: Fri Jul 21 23:45:04 2017 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
@ -59,15 +59,19 @@ personal archive encryption</p>
<td width="77%">
<p style="margin-top: 1em">[<b>--no-agent</b>]
[-<b>a</b>|<b>--agent</b>[=<i>SECONDS</i>]]
[<b>--random-device</b> <i>DEV</i>]
[<b>-p</b>|<b>--pubkey</b> <i>FILE</i>]
[<b>-s</b>|<b>--seckey</b> <i>FILE</i>] [<b>--version</b>]
[<b>--help</b>]</p> </td></tr>
<p style="margin-top: 1em">[-<b>a</b>[<i>seconds</i>]|<b>-A</b>]
[<b>-r</b> <i>device</i>] [<b>-p</b> <i>pubkey</i>]
[<b>-s</b> <i>seckey</i>]</p></td></tr>
</table>
<p style="margin-left:23%;"><i>command [args</i>...]</p>
<p style="margin-left:23%;">[<b>--version</b>]
[<b>--help</b>] <b><br>
keygen</b> [<b>-d</b>[<i>N</i>]] [<b>-e</b>] [<b>-f</b>]
[<b>-i</b>] [<b>-k</b> <i>N</i>] [<b>-u</b>] <b><br>
archive</b> [<b>-d</b>] <b><br>
extract</b> [<b>-d</b>] <b><br>
fingerprint</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
@ -89,33 +93,33 @@ secured with ChaCha20, Curve25519, and HMAC-SHA256.</p>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>--agent</b>[=<i>SECONDS</i>]</p>
<p style="margin-left:11%; margin-top: 1em"><b>-a</b>
<i>seconds</i>, <b>--agent</b>[=<i>seconds</i>]</p>
<p style="margin-left:22%;">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).</p>
<p style="margin-left:11%;"><b>--no-agent</b></p>
<p style="margin-left:11%;"><b>-A, --no-agent</b></p>
<p style="margin-left:22%;">Do not start the key agent
(default).</p>
<p style="margin-left:11%;"><b>-p, --pubkey</b>
<i>FILE</i></p>
<i>file</i></p>
<p style="margin-left:22%;">Specifies the public key file
to use for encryption.</p>
<p style="margin-left:11%;"><b>--random-device</b>
<i>DEV</i></p>
<p style="margin-left:11%;"><b>-r</b>,
<b>--random-device</b> <i>device</i></p>
<p style="margin-left:22%;">Use <i>DEV</i> as an entropy
<p style="margin-left:22%;">Use <i>device</i> as an entropy
source instead of <b>/dev/urandom</b>.</p>
<p style="margin-left:11%;"><b>-s, --seckey</b>
<i>FILE</i></p>
<i>file</i></p>
<p style="margin-left:22%;">Specifies the secret key file
to use for decryption.</p>
@ -154,48 +158,38 @@ keygen</b> [<i>OPTION</i>]...</p>
<p style="margin-left:22%;">Generates a new keypair either
from the random device or a passphrase.</p>
<p style="margin-left:17%;"><b>--derive</b>[=<i>N</i>],
<b>-d</b>[<i>N</i>]</p>
<p style="margin-left:17%;"><b>-d</b>[<i>N</i>],
<b>--derive</b>[=<i>N</i>]</p>
<p style="margin-left:28%;">Derives the secret key from a
passphrase. The key will be derived from the passphrase
using difficulty exponent <i>N</i>. Default is 29.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="17%"></td>
<td width="9%">
<p style="margin-left:17%;"><b>-e</b>, <b>--edit</b></p>
<p style="margin-left:28%;">Edits the protection passphrase
on an existing key. This also regenerates the public key
file from the secret key.</p>
<p><b>--edit</b></p></td>
<td width="2%"></td>
<td width="72%">
<p>Edits the protection passphrase on an existing key. This
also regenerates the public key file from the secret
key.</p> </td></tr>
</table>
<p style="margin-left:17%;"><b>--fingerprint</b></p>
<p style="margin-left:28%;">Prints the public key
fingerprint after generation or editing.</p>
<p style="margin-left:17%;"><b>--force</b>, <b>-f</b></p>
<p style="margin-left:17%;"><b>-f</b>, <b>--force</b></p>
<p style="margin-left:28%;">Overwrites any existing keypair
without prompting.</p>
<p style="margin-left:17%;"><b>--iterations</b>
<i>N</i></p>
<p style="margin-left:17%;"><b>-i</b>,
<b>--fingerprint</b></p>
<p style="margin-left:28%;">Prints the public key
fingerprint after generation or editing.</p>
<p style="margin-left:17%;"><b>-k</b> <i>N</i>,
<b>--iterations</b> <i>N</i></p>
<p style="margin-left:28%;">Sets the difficulty exponent
for deriving the protection key from the protection key
passphrase. Default is 25.</p>
<p style="margin-left:17%;"><b>--plain</b>, <b>-u</b></p>
<p style="margin-left:17%;"><b>-u</b>, <b>--plain</b></p>
<p style="margin-left:28%;">Do not use a protection key,
and instead store the secret key unencrypted on the disk.
@ -212,7 +206,7 @@ given, the output filename will be the input filename with a
original file is untouched. If no filenames are given,
encrypts standard input to standard output.</p>
<p style="margin-left:17%;"><b>--delete</b>, <b>-d</b></p>
<p style="margin-left:17%;"><b>-d</b>, <b>--delete</b></p>
<p style="margin-left:28%;">Delete the original input file
after success.</p>
@ -229,7 +223,7 @@ filename, it is an error for the input to lack this suffix.
If no filenames are given, dencrypt standard input to
standard output.</p>
<p style="margin-left:17%;"><b>--delete</b>, <b>-d</b></p>
<p style="margin-left:17%;"><b>-d</b>, <b>--delete</b></p>
<p style="margin-left:28%;">Delete the original input file
after success.</p>