scip/pcp
1
0
Fork 0
mirror of https://codeberg.org/scip/pcp.git synced 2025-12-17 12:00:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

updated manpage and usage

Browse Source
This commit is contained in:
TLINDEN
2014-03-02 22:01:03 +01:00
parent b640fe6743
commit 3d2cdb8b89
5 changed files with 46 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
include/pcp.h
View File

@@ -8,7 +8,6 @@ extern "C" {
#include "pcp/config.h" #include "pcp/config.h"
#include "pcp/base85.h" #include "pcp/base85.h"
#include "pcp/buffer.h" #include "pcp/buffer.h"
#include "pcp/config.h"
#include "pcp/crypto.h" #include "pcp/crypto.h"
#include "pcp/defines.h" #include "pcp/defines.h"
#include "pcp/digital_crc32.h" #include "pcp/digital_crc32.h"

36
man/options.pod
View File

@@ -14,29 +14,33 @@
key export and encryption. key export and encryption.
-t --text Print textual representation of some -t --text Print textual representation of some
item. Specify -V to get info about a item. Specify -V to get info about a
vault, -i to get info about a key id vault, -i to get info about a key id
installed in the vault or -I in which installed in the vault or -I in which
case it determines itself what kind of case it determines itself what kind of
file it is. file it is.
-h --help Print this help message. -h --help Print this help message.
-v --version Print program version. --version Print program version.
-D --debug Enable debug output. -D --debug Enable debug output.
-v --verbose Enable verbose output.
Keymanagement Options: Keymanagement Options:
-k --keygen Generate a CURVE25519 secret key. If -k --keygen Generate a CURVE25519 secret key. If
the generated key is the first one in the generated key is the first one in
your vault, it will become the primary your vault, it will become the primary
secret key. If an output file (-O) has secret key. If an output file (-O) has
been specified, don't store the generated been specified, don't store the generated
key to the vault but export it to the key to the vault but export it to the
file instead. You will be asked for file instead. You will be asked for
an owner, mail and a passphrase. If you an owner, mail and a passphrase. If you
leave the passphrase empty, the key will leave the passphrase empty, the key will
be stored unencrypted. be stored unencrypted.
-l --listkeys List all keys currently stored in your -l --listkeys List all keys currently stored in your
vault. Only the key id's and some info vault. Only the key id's and some info
about the keys will be printed, not the about the keys will be printed, not the
actual keys. 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 -R --remove-key Remove a key from the vault. Requires
option -i <keyid>. option -i <keyid>.
-s --export-secret Export a secret key. If your vault only -s --export-secret Export a secret key. If your vault only
@@ -48,13 +52,13 @@
given, export the primary secret key. given, export the primary secret key.
Use -O to export to a file. Use -O to export to a file.
-p --export-public Export a public key. If no key id have -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. primary secret key will be exported.
Use -O to export to a file. Use -O to export to a file.
-S --import-secret Import a secret key. Use -I to import -S --import-secret Import a secret key. Use -I to import
from a file. from a file.
-P --import-public Import a public key. Use -I to import -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 -y --export-yaml Export all keys stored in your vault
as YAML formatted text. Use -O to put as YAML formatted text. Use -O to put
the export into a file. the export into a file.
@@ -110,8 +114,8 @@
Encoding Options: Encoding Options:
-z --z85-encode Encode (armor) something to Z85 encoding. -z --z85-encode Encode (armor) something to Z85 encoding.
If used with encryption or singing operation -a --armor If used with encryption or singing operation
encode its output. Otherwise encode a plain --textmode encode its output. Otherwise encode a plain
file. Use -I and -O respectively, otherwise it file. Use -I and -O respectively, otherwise it
uses stdin/stdout. uses stdin/stdout.
-Z --z85-decode Decode (dearmor) something from Z85 encoding. -Z --z85-decode Decode (dearmor) something from Z85 encoding.

39
man/pcp1.pod
View File

@@ -15,8 +15,9 @@ Pretty Curved Privacy - File encryption using eliptic curve cryptography.
General Options: General Options:
-h --help Print this help message. -h --help Print this help message.
-v --version Print program version. --version Print program version.
-D --debug Enable debug output. -D --debug Enable debug output.
-v --verbose Enable verbose output.
-V --vault <vaultfile> Specify an alternate vault file. -V --vault <vaultfile> Specify an alternate vault file.
-O --outfile <file> Output file. STDOUT if unspecified. -O --outfile <file> Output file. STDOUT if unspecified.
-I --infile <file> Input file. STDIN if unspecified. -I --infile <file> Input file. STDIN if unspecified.
@@ -69,29 +70,33 @@ Pretty Curved Privacy - File encryption using eliptic curve cryptography.
key export and encryption. key export and encryption.
-t --text Print textual representation of some -t --text Print textual representation of some
item. Specify -V to get info about a item. Specify -V to get info about a
vault, -i to get info about a key id vault, -i to get info about a key id
installed in the vault or -I in which installed in the vault or -I in which
case it determines itself what kind of case it determines itself what kind of
file it is. file it is.
-h --help Print this help message. -h --help Print this help message.
-v --version Print program version. --version Print program version.
-D --debug Enable debug output. -D --debug Enable debug output.
-v --verbose Enable verbose output.
Keymanagement Options: Keymanagement Options:
-k --keygen Generate a CURVE25519 secret key. If -k --keygen Generate a CURVE25519 secret key. If
the generated key is the first one in the generated key is the first one in
your vault, it will become the primary your vault, it will become the primary
secret key. If an output file (-O) has secret key. If an output file (-O) has
been specified, don't store the generated been specified, don't store the generated
key to the vault but export it to the key to the vault but export it to the
file instead. You will be asked for file instead. You will be asked for
an owner, mail and a passphrase. If you an owner, mail and a passphrase. If you
leave the passphrase empty, the key will leave the passphrase empty, the key will
be stored unencrypted. be stored unencrypted.
-l --listkeys List all keys currently stored in your -l --listkeys List all keys currently stored in your
vault. Only the key id's and some info vault. Only the key id's and some info
about the keys will be printed, not the about the keys will be printed, not the
actual keys. 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 -R --remove-key Remove a key from the vault. Requires
option -i <keyid>. option -i <keyid>.
-s --export-secret Export a secret key. If your vault only -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. given, export the primary secret key.
Use -O to export to a file. Use -O to export to a file.
-p --export-public Export a public key. If no key id have -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. primary secret key will be exported.
Use -O to export to a file. Use -O to export to a file.
-S --import-secret Import a secret key. Use -I to import -S --import-secret Import a secret key. Use -I to import
from a file. from a file.
-P --import-public Import a public key. Use -I to import -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 -y --export-yaml Export all keys stored in your vault
as YAML formatted text. Use -O to put as YAML formatted text. Use -O to put
the export into a file. the export into a file.
@@ -165,8 +170,8 @@ Pretty Curved Privacy - File encryption using eliptic curve cryptography.
Encoding Options: Encoding Options:
-z --z85-encode Encode (armor) something to Z85 encoding. -z --z85-encode Encode (armor) something to Z85 encoding.
If used with encryption or singing operation -a --armor If used with encryption or singing operation
encode its output. Otherwise encode a plain --textmode encode its output. Otherwise encode a plain
file. Use -I and -O respectively, otherwise it file. Use -I and -O respectively, otherwise it
uses stdin/stdout. uses stdin/stdout.
-Z --z85-decode Decode (dearmor) something from Z85 encoding. -Z --z85-decode Decode (dearmor) something from Z85 encoding.

3
src/usage.h
View File

@@ -10,8 +10,9 @@
"\n" \ "\n" \
"General Options:\n" \ "General Options:\n" \
"-h --help Print this help message.\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" \ "-D --debug Enable debug output.\n" \
"-v --verbose Enable verbose output.\n" \
"-V --vault <vaultfile> Specify an alternate vault file.\n" \ "-V --vault <vaultfile> Specify an alternate vault file.\n" \
"-O --outfile <file> Output file. STDOUT if unspecified.\n" \ "-O --outfile <file> Output file. STDOUT if unspecified.\n" \
"-I --infile <file> Input file. STDIN if unspecified.\n" \ "-I --infile <file> Input file. STDIN if unspecified.\n" \

3
src/usage.txt
View File

@@ -8,8 +8,9 @@ Usage: pcp1 [ --help | --version ]
General Options: General Options:
-h --help Print this help message. -h --help Print this help message.
-v --version Print program version. --version Print program version.
-D --debug Enable debug output. -D --debug Enable debug output.
-v --verbose Enable verbose output.
-V --vault <vaultfile> Specify an alternate vault file. -V --vault <vaultfile> Specify an alternate vault file.
-O --outfile <file> Output file. STDOUT if unspecified. -O --outfile <file> Output file. STDOUT if unspecified.
-I --infile <file> Input file. STDIN if unspecified. -I --infile <file> Input file. STDIN if unspecified.