From 3d2cdb8b89e4b9eaae0a8532b6beb90dade605fb Mon Sep 17 00:00:00 2001 From: TLINDEN Date: Sun, 2 Mar 2014 22:01:03 +0100 Subject: [PATCH] updated manpage and usage --- include/pcp.h | 1 - man/options.pod | 36 ++++++++++++++++++++---------------- man/pcp1.pod | 39 ++++++++++++++++++++++----------------- src/usage.h | 3 ++- src/usage.txt | 3 ++- 5 files changed, 46 insertions(+), 36 deletions(-) diff --git a/include/pcp.h b/include/pcp.h index fb0d6c6..8b16eae 100644 --- a/include/pcp.h +++ b/include/pcp.h @@ -8,7 +8,6 @@ extern "C" { #include "pcp/config.h" #include "pcp/base85.h" #include "pcp/buffer.h" -#include "pcp/config.h" #include "pcp/crypto.h" #include "pcp/defines.h" #include "pcp/digital_crc32.h" diff --git a/man/options.pod b/man/options.pod index 10688ce..5dd5331 100644 --- a/man/options.pod +++ b/man/options.pod @@ -14,29 +14,33 @@ key export and encryption. -t --text Print textual representation of some item. Specify -V to get info about a - vault, -i to get info about a key id - installed in the vault or -I in which - case it determines itself what kind of - file it is. + vault, -i to get info about a key id + installed in the vault or -I in which + case it determines itself what kind of + file it is. -h --help Print this help message. - -v --version Print program version. + --version Print program version. -D --debug Enable debug output. - + -v --verbose Enable verbose output. + Keymanagement Options: -k --keygen Generate a CURVE25519 secret key. If the generated key is the first one in your vault, it will become the primary secret key. If an output file (-O) has - been specified, don't store the generated - key to the vault but export it to the - file instead. You will be asked for - an owner, mail and a passphrase. If you - leave the passphrase empty, the key will - be stored unencrypted. + been specified, don't store the generated + key to the vault but export it to the + file instead. You will be asked for + an owner, mail and a passphrase. If you + leave the passphrase empty, the key will + be stored unencrypted. -l --listkeys List all keys currently stored in your vault. Only the key id's and some info about the keys will be printed, not the actual keys. + -L --listkeys-verbose Display a more verbose key listing + -l -v including signature fingerprint, key + fingerprint, checksum and the like. -R --remove-key Remove a key from the vault. Requires option -i . -s --export-secret Export a secret key. If your vault only @@ -48,13 +52,13 @@ given, export the primary secret key. Use -O to export to a file. -p --export-public Export a public key. If no key id have - been specified, the public part of your + --export been specified, the public part of your primary secret key will be exported. Use -O to export to a file. -S --import-secret Import a secret key. Use -I to import from a file. -P --import-public Import a public key. Use -I to import - from a file. + --import from a file. -y --export-yaml Export all keys stored in your vault as YAML formatted text. Use -O to put the export into a file. @@ -110,8 +114,8 @@ Encoding Options: -z --z85-encode Encode (armor) something to Z85 encoding. - If used with encryption or singing operation - encode its output. Otherwise encode a plain + -a --armor If used with encryption or singing operation + --textmode encode its output. Otherwise encode a plain file. Use -I and -O respectively, otherwise it uses stdin/stdout. -Z --z85-decode Decode (dearmor) something from Z85 encoding. diff --git a/man/pcp1.pod b/man/pcp1.pod index 9461110..de19e8d 100644 --- a/man/pcp1.pod +++ b/man/pcp1.pod @@ -15,8 +15,9 @@ Pretty Curved Privacy - File encryption using eliptic curve cryptography. General Options: -h --help Print this help message. - -v --version Print program version. + --version Print program version. -D --debug Enable debug output. + -v --verbose Enable verbose output. -V --vault Specify an alternate vault file. -O --outfile Output file. STDOUT if unspecified. -I --infile Input file. STDIN if unspecified. @@ -69,29 +70,33 @@ Pretty Curved Privacy - File encryption using eliptic curve cryptography. key export and encryption. -t --text Print textual representation of some item. Specify -V to get info about a - vault, -i to get info about a key id - installed in the vault or -I in which - case it determines itself what kind of - file it is. + vault, -i to get info about a key id + installed in the vault or -I in which + case it determines itself what kind of + file it is. -h --help Print this help message. - -v --version Print program version. + --version Print program version. -D --debug Enable debug output. - + -v --verbose Enable verbose output. + Keymanagement Options: -k --keygen Generate a CURVE25519 secret key. If the generated key is the first one in your vault, it will become the primary secret key. If an output file (-O) has - been specified, don't store the generated - key to the vault but export it to the - file instead. You will be asked for - an owner, mail and a passphrase. If you - leave the passphrase empty, the key will - be stored unencrypted. + been specified, don't store the generated + key to the vault but export it to the + file instead. You will be asked for + an owner, mail and a passphrase. If you + leave the passphrase empty, the key will + be stored unencrypted. -l --listkeys List all keys currently stored in your vault. Only the key id's and some info about the keys will be printed, not the actual keys. + -L --listkeys-verbose Display a more verbose key listing + -l -v including signature fingerprint, key + fingerprint, checksum and the like. -R --remove-key Remove a key from the vault. Requires option -i . -s --export-secret Export a secret key. If your vault only @@ -103,13 +108,13 @@ Pretty Curved Privacy - File encryption using eliptic curve cryptography. given, export the primary secret key. Use -O to export to a file. -p --export-public Export a public key. If no key id have - been specified, the public part of your + --export been specified, the public part of your primary secret key will be exported. Use -O to export to a file. -S --import-secret Import a secret key. Use -I to import from a file. -P --import-public Import a public key. Use -I to import - from a file. + --import from a file. -y --export-yaml Export all keys stored in your vault as YAML formatted text. Use -O to put the export into a file. @@ -165,8 +170,8 @@ Pretty Curved Privacy - File encryption using eliptic curve cryptography. Encoding Options: -z --z85-encode Encode (armor) something to Z85 encoding. - If used with encryption or singing operation - encode its output. Otherwise encode a plain + -a --armor If used with encryption or singing operation + --textmode encode its output. Otherwise encode a plain file. Use -I and -O respectively, otherwise it uses stdin/stdout. -Z --z85-decode Decode (dearmor) something from Z85 encoding. diff --git a/src/usage.h b/src/usage.h index 95e1c91..e34622d 100644 --- a/src/usage.h +++ b/src/usage.h @@ -10,8 +10,9 @@ "\n" \ "General Options:\n" \ "-h --help Print this help message.\n" \ -"-v --version Print program version.\n" \ +" --version Print program version.\n" \ "-D --debug Enable debug output.\n" \ +"-v --verbose Enable verbose output.\n" \ "-V --vault Specify an alternate vault file.\n" \ "-O --outfile Output file. STDOUT if unspecified.\n" \ "-I --infile Input file. STDIN if unspecified.\n" \ diff --git a/src/usage.txt b/src/usage.txt index e1d1ff9..9115304 100644 --- a/src/usage.txt +++ b/src/usage.txt @@ -8,8 +8,9 @@ Usage: pcp1 [ --help | --version ] General Options: -h --help Print this help message. --v --version Print program version. + --version Print program version. -D --debug Enable debug output. +-v --verbose Enable verbose output. -V --vault Specify an alternate vault file. -O --outfile Output file. STDOUT if unspecified. -I --infile Input file. STDIN if unspecified.