1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-05 12:05:58 +01:00
pgpainless/pgpainless-cli/packaging/man/pgpainless-cli.1

233 lines
3.1 KiB
Groff
Raw Normal View History

'\" t
.\" Title: pgpainless-cli
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\" Manual: PGPainless-CLI Manual
.\" Source:
.\" Language: English
.\"
.TH "PGPAINLESS\-CLI" "1" "" "" "PGPainless\-CLI Manual"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
. mso www.tmac
. am URL
. ad l
. .
. am MTO
. ad l
. .
. LINKSTYLE blue R < >
.\}
.SH "NAME"
pgpainless\-cli \- Stateless OpenPGP Protocol
.SH "SYNOPSIS"
.sp
2022-11-06 15:08:07 +01:00
\fBpgpainless\-cli\fP [\fB\-\-stacktrace\fP] [COMMAND]
.SH "DESCRIPTION"
2022-11-06 15:08:07 +01:00
.SH "OPTIONS"
.sp
\fB\-\-stacktrace\fP
.RS 4
Print stacktrace
2022-11-06 15:08:07 +01:00
.RE
.SH "COMMANDS"
.sp
2023-07-12 16:00:54 +02:00
\fBversion\fP
.RS 4
2023-07-12 16:00:54 +02:00
Display version information about the tool
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBlist\-profiles\fP
.RS 4
2023-07-12 16:00:54 +02:00
Emit a list of profiles supported by the identified subcommand
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBgenerate\-key\fP
.RS 4
2023-07-12 16:00:54 +02:00
Generate a secret key
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBchange\-key\-password\fP
.RS 4
2023-07-12 16:00:54 +02:00
Update the password of a key
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBrevoke\-key\fP
.RS 4
2023-07-12 16:00:54 +02:00
Generate revocation certificates
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBextract\-cert\fP
.RS 4
2023-07-12 16:00:54 +02:00
Extract a public key certificate from a secret key
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBsign\fP
.RS 4
2023-07-12 16:00:54 +02:00
Create a detached message signature
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBverify\fP
.RS 4
2023-07-12 16:00:54 +02:00
Verify a detached signature
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBencrypt\fP
.RS 4
2023-07-12 16:00:54 +02:00
Encrypt a message from standard input
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBdecrypt\fP
.RS 4
Decrypt a message
.RE
.sp
\fBinline\-detach\fP
.RS 4
2023-07-12 16:00:54 +02:00
Split signatures from a clearsigned message
.RE
.sp
\fBinline\-sign\fP
.RS 4
2023-07-12 16:00:54 +02:00
Create an inline\-signed message
.RE
.sp
\fBinline\-verify\fP
.RS 4
2023-07-12 16:00:54 +02:00
Verify an inline\-signed message
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBarmor\fP
2023-04-27 15:23:37 +02:00
.RS 4
2023-07-12 16:00:54 +02:00
Add ASCII Armor to standard input
2023-04-27 15:23:37 +02:00
.RE
.sp
2023-07-12 16:00:54 +02:00
\fBdearmor\fP
.RS 4
2023-07-12 16:00:54 +02:00
Remove ASCII Armor from standard input
.RE
.sp
\fBhelp\fP
.RS 4
Stateless OpenPGP Protocol
.RE
.sp
\fBgenerate\-completion\fP
.RS 4
2022-11-06 15:08:07 +01:00
Stateless OpenPGP Protocol
.RE
.SH "EXIT CODES:"
.sp
\fB0\fP
.RS 4
Successful program execution
.RE
.sp
\fB1\fP
.RS 4
Generic program error
.RE
.sp
\fB3\fP
.RS 4
Verification requested but no verifiable signature found
.RE
.sp
\fB13\fP
.RS 4
Unsupported asymmetric algorithm
.RE
.sp
\fB17\fP
.RS 4
Certificate is not encryption capable
.RE
.sp
\fB19\fP
.RS 4
Usage error: Missing argument
.RE
.sp
\fB23\fP
.RS 4
Incomplete verification instructions
.RE
.sp
\fB29\fP
.RS 4
Unable to decrypt
.RE
.sp
\fB31\fP
.RS 4
Password is not human\-readable
.RE
.sp
\fB37\fP
.RS 4
Unsupported Option
.RE
.sp
\fB41\fP
.RS 4
Invalid data or data of wrong type encountered
.RE
.sp
\fB53\fP
.RS 4
Non\-text input received where text was expected
.RE
.sp
\fB59\fP
.RS 4
Output file already exists
.RE
.sp
\fB61\fP
.RS 4
Input file does not exist
.RE
.sp
\fB67\fP
.RS 4
Cannot unlock password protected secret key
.RE
.sp
\fB69\fP
.RS 4
Unsupported subcommand
.RE
.sp
\fB71\fP
.RS 4
Unsupported special prefix (e.g. "@ENV/@FD") of indirect parameter
.RE
.sp
\fB73\fP
.RS 4
Ambiguous input (a filename matching the designator already exists)
.RE
.sp
\fB79\fP
.RS 4
Key is not signing capable
2023-04-27 15:23:37 +02:00
.RE
.sp
\fB83\fP
.RS 4
Options were supplied that are incompatible with each other
.RE
.sp
\fB89\fP
.RS 4
The requested profile is unsupported, or the indicated subcommand does not accept profiles
.RE