PGPainless/pgpainless
PGPainless
/
pgpainless
mirror of https://github.com/pgpainless/pgpainless.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update pgpainless-cli usage documentation

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

36
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
armor Add ASCII Armor to standard input list-profiles Emit a list of profiles supported by the identified
dearmor Remove ASCII Armor from standard input subcommand
decrypt Decrypt a message from standard input generate-key Generate a secret key
inline-detach Split signatures from a clearsigned message change-key-password Update the password of a key
encrypt Encrypt a message from standard input revoke-key Generate revocation certificates
extract-cert Extract a public key certificate from a secret key from extract-cert Extract a public key certificate from a secret key
standard input sign Create a detached message signature
generate-key Generate a secret key verify Verify a detached signature
sign Create a detached signature on the data from standard input encrypt Encrypt a message from standard input
verify Verify a detached signature over the data from standard input decrypt Decrypt a message
inline-sign Create an inline-signed message from data on standard input inline-detach Split signatures from a clearsigned message
inline-verify Verify inline-signed data from standard input inline-sign Create an inline-signed message
version Display version information about the tool inline-verify Verify an inline-signed message
armor Add ASCII Armor to standard input
dearmor Remove ASCII Armor from standard input
help Display usage information for the specified subcommand
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