PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-26 06:12:06 +01:00
Code Issues Releases Wiki Activity

Update pgpainless-cli usage documentation

Browse source
This commit is contained in:
Paul Schaub 2024-03-30 18:52:49 +01:00
parent 1f9b65e3d2
commit 32d62c6610
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 21 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/source/pgpainless-cli/usage.md
View file

@ -82,23 +82,26 @@ Stateless OpenPGP Protocol
Usage: pgpainless-cli [--stacktrace] [COMMAND] Usage: pgpainless-cli [--stacktrace] [COMMAND]
Options: Options:
--stacktrace Print Stacktrace --stacktrace Print stacktrace
Commands: Commands:
help Display usage information for the specified subcommand version Display version information about the tool
list-profiles Emit a list of profiles supported by the identified
subcommand
generate-key Generate a secret key
change-key-password Update the password of a key
revoke-key Generate revocation certificates
extract-cert Extract a public key certificate from a secret key
sign Create a detached message signature
verify Verify a detached signature
encrypt Encrypt a message from standard input
decrypt Decrypt a message
inline-detach Split signatures from a clearsigned message
inline-sign Create an inline-signed message
inline-verify Verify an inline-signed message
armor Add ASCII Armor to standard input armor Add ASCII Armor to standard input
dearmor Remove ASCII Armor from standard input dearmor Remove ASCII Armor from standard input
decrypt Decrypt a message from standard input help Display usage information for the specified subcommand
inline-detach Split signatures from a clearsigned message
encrypt Encrypt a message from standard input
extract-cert Extract a public key certificate from a secret key from
standard input
generate-key Generate a secret key
sign Create a detached signature on the data from standard input
verify Verify a detached signature over the data from standard input
inline-sign Create an inline-signed message from data on standard input
inline-verify Verify inline-signed data from standard input
version Display version information about the tool
Exit Codes: Exit Codes:
0 Successful program execution 0 Successful program execution
@ -120,6 +123,9 @@ Exit Codes:
71 Unsupported special prefix (e.g. "@ENV/@FD") of indirect parameter 71 Unsupported special prefix (e.g. "@ENV/@FD") of indirect parameter
73 Ambiguous input (a filename matching the designator already exists) 73 Ambiguous input (a filename matching the designator already exists)
79 Key is not signing capable 79 Key is not signing capable
83 Options were supplied that are incompatible with each other
89 The requested profile is unsupported, or the indicated subcommand does
not accept profiles
``` ```
To get help on a subcommand, e.g. `encrypt`, just call the help subcommand followed by the subcommand you To get help on a subcommand, e.g. `encrypt`, just call the help subcommand followed by the subcommand you