mirror of
https://github.com/pgpainless/pgpainless.git
synced 2025-12-05 03:41:07 +01:00
273 lines
No EOL
3.9 KiB
Groff
273 lines
No EOL
3.9 KiB
Groff
'\" 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
|
|
\fBpgpainless\-cli\fP [\fB\-\-debug\fP] [COMMAND]
|
|
.SH "DESCRIPTION"
|
|
|
|
.SH "OPTIONS"
|
|
.sp
|
|
\fB\-\-debug, \-\-stacktrace\fP
|
|
.RS 4
|
|
Print stacktrace
|
|
.RE
|
|
.SH "COMMANDS"
|
|
.sp
|
|
\fBversion\fP
|
|
.RS 4
|
|
Display version information about the tool
|
|
.RE
|
|
.sp
|
|
\fBlist\-profiles\fP
|
|
.RS 4
|
|
Emit a list of profiles supported by the identified subcommand
|
|
.RE
|
|
.sp
|
|
\fBgenerate\-key\fP
|
|
.RS 4
|
|
Generate a secret key
|
|
.RE
|
|
.sp
|
|
\fBchange\-key\-password\fP
|
|
.RS 4
|
|
Update the password of a key
|
|
.RE
|
|
.sp
|
|
\fBrevoke\-key\fP
|
|
.RS 4
|
|
Generate revocation certificates
|
|
.RE
|
|
.sp
|
|
\fBextract\-cert\fP
|
|
.RS 4
|
|
Extract a public key certificate from a secret key
|
|
.RE
|
|
.sp
|
|
\fBupdate\-key\fP
|
|
.RS 4
|
|
Keep a secret key up\-to\-date
|
|
.RE
|
|
.sp
|
|
\fBmerge\-certs\fP
|
|
.RS 4
|
|
Merge OpenPGP certificates from standard input with related elements from CERTS and emit the result to standard output
|
|
.RE
|
|
.sp
|
|
\fBcertify\-userid\fP
|
|
.RS 4
|
|
Certify OpenPGP Certificate User IDs
|
|
.RE
|
|
.sp
|
|
\fBvalidate\-userid\fP
|
|
.RS 4
|
|
Validate a UserID in an OpenPGP certificate
|
|
.RE
|
|
.sp
|
|
\fBsign\fP
|
|
.RS 4
|
|
Create a detached message signature
|
|
.RE
|
|
.sp
|
|
\fBverify\fP
|
|
.RS 4
|
|
Verify a detached signature
|
|
.RE
|
|
.sp
|
|
\fBencrypt\fP
|
|
.RS 4
|
|
Encrypt a message from standard input
|
|
.RE
|
|
.sp
|
|
\fBdecrypt\fP
|
|
.RS 4
|
|
Decrypt a message
|
|
.RE
|
|
.sp
|
|
\fBinline\-detach\fP
|
|
.RS 4
|
|
Split signatures from a clearsigned message
|
|
.RE
|
|
.sp
|
|
\fBinline\-sign\fP
|
|
.RS 4
|
|
Create an inline\-signed message
|
|
.RE
|
|
.sp
|
|
\fBinline\-verify\fP
|
|
.RS 4
|
|
Verify an inline\-signed message
|
|
.RE
|
|
.sp
|
|
\fBarmor\fP
|
|
.RS 4
|
|
Add ASCII Armor to standard input
|
|
.RE
|
|
.sp
|
|
\fBdearmor\fP
|
|
.RS 4
|
|
Remove ASCII Armor from standard input
|
|
.RE
|
|
.sp
|
|
\fBhelp\fP
|
|
.RS 4
|
|
Stateless OpenPGP Protocol
|
|
.RE
|
|
.sp
|
|
\fBgenerate\-completion\fP
|
|
.RS 4
|
|
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
|
|
.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
|
|
.sp
|
|
\fB97\fP
|
|
.RS 4
|
|
The implementation supports some form of hardware\-backed secret keys, but could not identify the hardware device
|
|
.RE
|
|
.sp
|
|
\fB101\fP
|
|
.RS 4
|
|
The implementation tried to use a hardware\-backed secret key, but the cryptographic hardware refused the operation for some reason other than a bad PIN or password
|
|
.RE
|
|
.sp
|
|
\fB103\fP
|
|
.RS 4
|
|
The primary key of a KEYS object is too weak or revoked
|
|
.RE
|
|
.sp
|
|
\fB107\fP
|
|
.RS 4
|
|
The CERTS object has no matching User ID
|
|
.RE |