mirror of
https://github.com/pgpainless/pgpainless.git
synced 2025-12-05 03:41:07 +01:00
Update man pages
This commit is contained in:
parent
8536ee798f
commit
ab758b24c1
GPG key ID:
62BEE9264BF17311
22 changed files with 454 additions and 101 deletions
|
|
@ -30,12 +30,12 @@
|
|||
pgpainless\-cli\-armor \- Add ASCII Armor to standard input
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli armor\fP [\fB\-\-stacktrace\fP]
|
||||
\fBpgpainless\-cli armor\fP [\fB\-\-debug\fP]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
76
pgpainless-cli/packaging/man/pgpainless-cli-certify-userid.1
Normal file
76
pgpainless-cli/packaging/man/pgpainless-cli-certify-userid.1
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
'\" t
|
||||
.\" Title: pgpainless-cli-certify-userid
|
||||
.\" Author: [see the "AUTHOR(S)" section]
|
||||
.\" Generator: Asciidoctor 2.0.10
|
||||
.\" Manual: PGPainless-CLI Manual
|
||||
.\" Source:
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "PGPAINLESS\-CLI\-CERTIFY\-USERID" "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\-certify\-userid \- Certify OpenPGP Certificate User IDs
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli certify\-userid\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP] [\fB\-\-no\-require\-self\-sig\fP]
|
||||
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... \fB\-\-userid\fP=\fIUSERID\fP...
|
||||
[\fB\-\-userid\fP=\fIUSERID\fP...]... [\fB\-\-\fP] \fIKEYS\fP...
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-[no\-]armor\fP
|
||||
.RS 4
|
||||
ASCII armor the output
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-no\-require\-self\-sig\fP
|
||||
.RS 4
|
||||
Certify the UserID regardless of whether self\-certifications are present
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-userid\fP=\fIUSERID\fP...
|
||||
.RS 4
|
||||
Identities that shall be certified
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP
|
||||
.RS 4
|
||||
Passphrase to unlock the secret key(s).
|
||||
.sp
|
||||
Is an INDIRECT data type (e.g. file, environment variable, file descriptor...).
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-\fP
|
||||
.RS 4
|
||||
This option can be used to separate command\-line options from the list of positional parameters.
|
||||
.RE
|
||||
.SH "ARGUMENTS"
|
||||
.sp
|
||||
\fIKEYS\fP...
|
||||
.RS 4
|
||||
Private keys
|
||||
.RE
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
pgpainless\-cli\-change\-key\-password \- Update the password of a key
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli change\-key\-password\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-new\-key\-password\fP
|
||||
\fBpgpainless\-cli change\-key\-password\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP] [\fB\-\-new\-key\-password\fP
|
||||
[=\fIPASSWORD\fP]] [\fB\-\-old\-key\-password\fP=\fIPASSWORD\fP]...
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
|
|
@ -38,6 +38,11 @@ Unlock all secret keys from STDIN using the given old passwords and emit them re
|
|||
If any (sub\-) key cannot be unlocked, this operation will exit with error code 67.
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-new\-key\-password\fP[=\fIPASSWORD\fP]
|
||||
.RS 4
|
||||
New password to lock the keys with.
|
||||
|
|
@ -59,9 +64,4 @@ Old passwords to unlock the keys with.
|
|||
Multiple passwords can be passed in, which are tested sequentially to unlock locked subkeys.
|
||||
.sp
|
||||
Is an INDIRECT data type (e.g. file, environment variable, file descriptor...).
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
|
|
@ -30,12 +30,12 @@
|
|||
pgpainless\-cli\-dearmor \- Remove ASCII Armor from standard input
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli dearmor\fP [\fB\-\-stacktrace\fP]
|
||||
\fBpgpainless\-cli dearmor\fP [\fB\-\-debug\fP]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
|
|
@ -30,26 +30,26 @@
|
|||
pgpainless\-cli\-decrypt \- Decrypt a message
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli decrypt\fP [\fB\-\-stacktrace\fP] [\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP]
|
||||
[\fB\-\-verifications\-out\fP=\fIVERIFICATIONS\fP] [\fB\-\-verify\-not\-after\fP=\fIDATE\fP]
|
||||
[\fB\-\-verify\-not\-before\fP=\fIDATE\fP] [\fB\-\-verify\-with\fP=\fICERT\fP]...
|
||||
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fB\-\-with\-password\fP=\fIPASSWORD\fP]...
|
||||
[\fB\-\-with\-session\-key\fP=\fISESSIONKEY\fP]... [\fIKEY\fP...]
|
||||
\fBpgpainless\-cli decrypt\fP [\fB\-\-debug\fP] [\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP] [\fB\-\-verify\-not\-after\fP=\fIDATE\fP]
|
||||
[\fB\-\-verify\-not\-before\fP=\fIDATE\fP] [\fB\-\-verify\-out\fP=\fIVERIFICATIONS\fP]
|
||||
[\fB\-\-verify\-with\fP=\fICERT\fP]... [\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]...
|
||||
[\fB\-\-with\-password\fP=\fIPASSWORD\fP]... [\fB\-\-with\-session\-key\fP=\fISESSIONKEY\fP]...
|
||||
[\fIKEY\fP...]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP
|
||||
.RS 4
|
||||
Can be used to learn the session key on successful decryption
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-verifications\-out\fP=\fIVERIFICATIONS\fP, \fB\-\-verify\-not\-after\fP=\fIDATE\fP
|
||||
\fB\-\-verify\-not\-after\fP=\fIDATE\fP
|
||||
.RS 4
|
||||
ISO\-8601 formatted UTC date (e.g. \(aq2020\-11\-23T16:35Z)
|
||||
.sp
|
||||
|
|
@ -69,6 +69,11 @@ Reject signatures with a creation date not in range.
|
|||
Defaults to beginning of time (\(aq\-\(aq).
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-verify\-out, \-\-verifications\-out\fP=\fIVERIFICATIONS\fP
|
||||
.RS 4
|
||||
Emits signature verification status to the designated output
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-verify\-with\fP=\fICERT\fP
|
||||
.RS 4
|
||||
Certificates for signature verification
|
||||
|
|
|
|||
|
|
@ -30,10 +30,10 @@
|
|||
pgpainless\-cli\-encrypt \- Encrypt a message from standard input
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli encrypt\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-as\fP=\fI{binary|text}\fP]
|
||||
[\fB\-\-profile\fP=\fIPROFILE\fP] [\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP]
|
||||
[\fB\-\-sign\-with\fP=\fIKEY\fP]... [\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]...
|
||||
[\fB\-\-with\-password\fP=\fIPASSWORD\fP]... [\fICERTS\fP...]
|
||||
\fBpgpainless\-cli encrypt\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP] [\fB\-\-as\fP=\fI{binary|text}\fP] [\fB\-\-profile\fP=\fIPROFILE\fP]
|
||||
[\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP] [\fB\-\-sign\-with\fP=\fIKEY\fP]...
|
||||
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fB\-\-with\-password\fP=\fIPASSWORD\fP]...
|
||||
[\fICERTS\fP...]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
|
|
@ -43,6 +43,11 @@ pgpainless\-cli\-encrypt \- Encrypt a message from standard input
|
|||
Type of the input data. Defaults to \(aqbinary\(aq
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-[no\-]armor\fP
|
||||
.RS 4
|
||||
ASCII armor the output
|
||||
|
|
@ -58,11 +63,6 @@ Profile identifier to switch between profiles
|
|||
Sign the output with a private key
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP
|
||||
.RS 4
|
||||
Passphrase to unlock the secret key(s).
|
||||
|
|
|
|||
|
|
@ -30,18 +30,18 @@
|
|||
pgpainless\-cli\-extract\-cert \- Extract a public key certificate from a secret key
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli extract\-cert\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP]
|
||||
\fBpgpainless\-cli extract\-cert\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP]
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
Read a secret key from STDIN and emit the public key certificate to STDOUT.
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-[no\-]armor\fP
|
||||
.RS 4
|
||||
ASCII armor the output
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
pgpainless\-cli\-generate\-completion \- Stateless OpenPGP Protocol
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli generate\-completion\fP [\fB\-hV\fP] [\fB\-\-stacktrace\fP]
|
||||
\fBpgpainless\-cli generate\-completion\fP [\fB\-hV\fP] [\fB\-\-debug\fP]
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
Generate bash/zsh completion script for pgpainless\-cli.
|
||||
|
|
@ -43,16 +43,16 @@ source <(pgpainless\-cli generate\-completion)
|
|||
.if n .RE
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-h\fP, \fB\-\-help\fP
|
||||
.RS 4
|
||||
Show this help message and exit.
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-V\fP, \fB\-\-version\fP
|
||||
.RS 4
|
||||
Print version information and exit.
|
||||
|
|
@ -162,4 +162,24 @@ Options were supplied that are incompatible with each other
|
|||
\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
|
||||
|
|
@ -30,12 +30,17 @@
|
|||
pgpainless\-cli\-generate\-key \- Generate a secret key
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli generate\-key\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-signing\-only\fP] [\fB\-\-stacktrace\fP]
|
||||
[\fB\-\-profile\fP=\fIPROFILE\fP] [\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP] [\fIUSERID\fP...]
|
||||
\fBpgpainless\-cli generate\-key\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP] [\fB\-\-signing\-only\fP] [\fB\-\-profile\fP=\fIPROFILE\fP]
|
||||
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP] [\fIUSERID\fP...]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-[no\-]armor\fP
|
||||
.RS 4
|
||||
ASCII armor the output
|
||||
|
|
@ -51,11 +56,6 @@ Profile identifier to switch between profiles
|
|||
Generate a key that can only be used for signing
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP
|
||||
.RS 4
|
||||
Password to protect the private key with
|
||||
|
|
|
|||
|
|
@ -30,22 +30,22 @@
|
|||
pgpainless\-cli\-help \- Stateless OpenPGP Protocol
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli help\fP [\fB\-h\fP] [\fB\-\-stacktrace\fP] [\fICOMMAND\fP]
|
||||
\fBpgpainless\-cli help\fP [\fB\-h\fP] [\fB\-\-debug\fP] [\fICOMMAND\fP]
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
When no COMMAND is given, the usage help for the main command is displayed.
|
||||
If a COMMAND is specified, the help for that command is shown.
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-h\fP, \fB\-\-help\fP
|
||||
.RS 4
|
||||
Show usage help for the help command and exit.
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.SH "ARGUMENTS"
|
||||
.sp
|
||||
[\fICOMMAND\fP]
|
||||
|
|
@ -157,4 +157,24 @@ Options were supplied that are incompatible with each other
|
|||
\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
|
||||
|
|
@ -30,11 +30,16 @@
|
|||
pgpainless\-cli\-inline\-detach \- Split signatures from a clearsigned message
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli inline\-detach\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-signatures\-out\fP=\fISIGNATURES\fP]
|
||||
\fBpgpainless\-cli inline\-detach\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP] [\fB\-\-signatures\-out\fP=\fISIGNATURES\fP]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-[no\-]armor\fP
|
||||
.RS 4
|
||||
ASCII armor the output
|
||||
|
|
@ -43,9 +48,4 @@ ASCII armor the output
|
|||
\fB\-\-signatures\-out\fP=\fISIGNATURES\fP
|
||||
.RS 4
|
||||
Destination to which a detached signatures block will be written
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
pgpainless\-cli\-inline\-sign \- Create an inline\-signed message
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli inline\-sign\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-as\fP=\fI{binary|text|clearsigned}\fP]
|
||||
\fBpgpainless\-cli inline\-sign\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP] [\fB\-\-as\fP=\fI{binary|text|clearsigned}\fP]
|
||||
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fIKEYS\fP...]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
|
|
@ -49,16 +49,16 @@ Defaults to \(aqbinary\(aq.
|
|||
If \(aq\-\-as=text\(aq and the input data is not valid UTF\-8, inline\-sign fails with return code 53.
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-[no\-]armor\fP
|
||||
.RS 4
|
||||
ASCII armor the output
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP
|
||||
.RS 4
|
||||
Passphrase to unlock the secret key(s).
|
||||
|
|
|
|||
|
|
@ -30,12 +30,17 @@
|
|||
pgpainless\-cli\-inline\-verify \- Verify an inline\-signed message
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli inline\-verify\fP [\fB\-\-stacktrace\fP] [\fB\-\-not\-after\fP=\fIDATE\fP] [\fB\-\-not\-before\fP=\fIDATE\fP]
|
||||
\fBpgpainless\-cli inline\-verify\fP [\fB\-\-debug\fP] [\fB\-\-not\-after\fP=\fIDATE\fP] [\fB\-\-not\-before\fP=\fIDATE\fP]
|
||||
[\fB\-\-verifications\-out\fP=\fIVERIFICATIONS\fP] [\fICERT\fP...]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-not\-after\fP=\fIDATE\fP
|
||||
.RS 4
|
||||
ISO\-8601 formatted UTC date (e.g. \(aq2020\-11\-23T16:35Z)
|
||||
|
|
@ -56,11 +61,6 @@ Reject signatures with a creation date not in range.
|
|||
Defaults to beginning of time ("\-").
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-verifications\-out\fP=\fIVERIFICATIONS\fP
|
||||
.RS 4
|
||||
File to write details over successful verifications to
|
||||
|
|
|
|||
|
|
@ -30,12 +30,12 @@
|
|||
pgpainless\-cli\-list\-profiles \- Emit a list of profiles supported by the identified subcommand
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli list\-profiles\fP [\fB\-\-stacktrace\fP] \fICOMMAND\fP
|
||||
\fBpgpainless\-cli list\-profiles\fP [\fB\-\-debug\fP] \fICOMMAND\fP
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
|
|
|
|||
53
pgpainless-cli/packaging/man/pgpainless-cli-merge-certs.1
Normal file
53
pgpainless-cli/packaging/man/pgpainless-cli-merge-certs.1
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
'\" t
|
||||
.\" Title: pgpainless-cli-merge-certs
|
||||
.\" Author: [see the "AUTHOR(S)" section]
|
||||
.\" Generator: Asciidoctor 2.0.10
|
||||
.\" Manual: PGPainless-CLI Manual
|
||||
.\" Source:
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "PGPAINLESS\-CLI\-MERGE\-CERTS" "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\-merge\-certs \- Merge OpenPGP certificates from standard input with related elements from CERTS and emit the result to standard output
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli merge\-certs\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP] [\fICERTS\fP...]
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
Only certificates that were part of standard input will be emitted to standard output
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-[no\-]armor\fP
|
||||
.RS 4
|
||||
ASCII armor the output
|
||||
.RE
|
||||
.SH "ARGUMENTS"
|
||||
.sp
|
||||
[\fICERTS\fP...]
|
||||
.RS 4
|
||||
OpenPGP certificates from which updates shall be merged into the base certificates from standard input
|
||||
.RE
|
||||
|
|
@ -30,23 +30,23 @@
|
|||
pgpainless\-cli\-revoke\-key \- Generate revocation certificates
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli revoke\-key\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]
|
||||
\fBpgpainless\-cli revoke\-key\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP] [\fB\-\-with\-key\-password\fP[=\fIPASSWORD\fP...]]...
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
Emit revocation certificates for secret keys from STDIN to STDOUT.
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-[no\-]armor\fP
|
||||
.RS 4
|
||||
ASCII armor the output
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP
|
||||
\fB\-\-with\-key\-password\fP[=\fIPASSWORD\fP...]
|
||||
.RS 4
|
||||
Passphrase to unlock the secret key(s).
|
||||
.sp
|
||||
|
|
|
|||
|
|
@ -30,8 +30,8 @@
|
|||
pgpainless\-cli\-sign \- Create a detached message signature
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli sign\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-as\fP=\fI{binary|text}\fP]
|
||||
[\fB\-\-micalg\-out\fP=\fIMICALG\fP] [\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fIKEYS\fP...]
|
||||
\fBpgpainless\-cli sign\fP [\fB\-\-debug\fP] [\fB\-\-[no\-]armor\fP] [\fB\-\-as\fP=\fI{binary|text}\fP] [\fB\-\-micalg\-out\fP=\fIMICALG\fP]
|
||||
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fIKEYS\fP...]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
|
|
@ -45,6 +45,11 @@ Defaults to \(aqbinary\(aq.
|
|||
If \(aq\-\-as=text\(aq and the input data is not valid UTF\-8, sign fails with return code 53.
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-micalg\-out\fP=\fIMICALG\fP
|
||||
.RS 4
|
||||
Emits the digest algorithm used to the specified file in a way that can be used to populate the micalg parameter for the PGP/MIME Content\-Type (RFC3156).
|
||||
|
|
@ -55,11 +60,6 @@ Emits the digest algorithm used to the specified file in a way that can be used
|
|||
ASCII armor the output
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP
|
||||
.RS 4
|
||||
Passphrase to unlock the secret key(s).
|
||||
|
|
|
|||
72
pgpainless-cli/packaging/man/pgpainless-cli-update-key.1
Normal file
72
pgpainless-cli/packaging/man/pgpainless-cli-update-key.1
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
'\" t
|
||||
.\" Title: pgpainless-cli-update-key
|
||||
.\" Author: [see the "AUTHOR(S)" section]
|
||||
.\" Generator: Asciidoctor 2.0.10
|
||||
.\" Manual: PGPainless-CLI Manual
|
||||
.\" Source:
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "PGPAINLESS\-CLI\-UPDATE\-KEY" "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\-update\-key \- Keep a secret key up\-to\-date
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli update\-key\fP [\fB\-\-debug\fP] [\fB\-\-no\-added\-capabilities\fP] [\fB\-\-[no\-]armor\fP]
|
||||
[\fB\-\-signing\-only\fP] [\fB\-\-merge\-certs\fP=\fICERTS\fP]...
|
||||
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]...
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-merge\-certs\fP=\fICERTS\fP
|
||||
.RS 4
|
||||
Merge additional elements found in the corresponding CERTS objects into the updated secret keys
|
||||
.sp
|
||||
This can be used, for example, to absorb a third\-party certification into the Transferable Secret Key
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-no\-added\-capabilities\fP
|
||||
.RS 4
|
||||
Do not add feature support for new mechanisms, which the key did not previously support
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-[no\-]armor\fP
|
||||
.RS 4
|
||||
ASCII armor the output
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-signing\-only\fP
|
||||
.RS 4
|
||||
TODO: Document
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP
|
||||
.RS 4
|
||||
Passphrase to unlock the secret key(s).
|
||||
.sp
|
||||
Is an INDIRECT data type (e.g. file, environment variable, file descriptor...).
|
||||
.RE
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
'\" t
|
||||
.\" Title: pgpainless-cli-validate-userid
|
||||
.\" Author: [see the "AUTHOR(S)" section]
|
||||
.\" Generator: Asciidoctor 2.0.10
|
||||
.\" Manual: PGPainless-CLI Manual
|
||||
.\" Source:
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "PGPAINLESS\-CLI\-VALIDATE\-USERID" "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\-validate\-userid \- Validate a UserID in an OpenPGP certificate
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli validate\-userid\fP [\fB\-\-addr\-spec\-only\fP] [\fB\-\-debug\fP] [\fB\-\-validate\-at\fP=\fI<validateAt>\fP]
|
||||
[\fB\-\-\fP] \fIUSERID\fP \fICERTS\fP...
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-addr\-spec\-only\fP
|
||||
.RS 4
|
||||
Treat the USERID as an email address, match only against the email address part of each correctly bound UserID
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-validate\-at\fP=\fI<validateAt>\fP, \fB\-\-\fP
|
||||
.RS 4
|
||||
This option can be used to separate command\-line options from the list of positional parameters.
|
||||
.RE
|
||||
.SH "ARGUMENTS"
|
||||
.sp
|
||||
\fIUSERID\fP
|
||||
.RS 4
|
||||
UserID
|
||||
.RE
|
||||
.sp
|
||||
\fICERTS\fP...
|
||||
.RS 4
|
||||
Authority OpenPGP certificates
|
||||
.RE
|
||||
|
|
@ -30,13 +30,17 @@
|
|||
pgpainless\-cli\-verify \- Verify a detached signature
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli verify\fP [\fB\-\-stacktrace\fP] [\fB\-\-not\-after\fP=\fIDATE\fP] [\fB\-\-not\-before\fP=\fIDATE\fP] \fISIGNATURE\fP
|
||||
\fICERT\fP...
|
||||
\fBpgpainless\-cli verify\fP [\fB\-\-debug\fP] [\fB\-\-not\-after\fP=\fIDATE\fP] [\fB\-\-not\-before\fP=\fIDATE\fP] \fISIGNATURE\fP \fICERT\fP...
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
Verify a detached signature over some data from STDIN.
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-not\-after\fP=\fIDATE\fP
|
||||
.RS 4
|
||||
ISO\-8601 formatted UTC date (e.g. \(aq2020\-11\-23T16:35Z)
|
||||
|
|
@ -56,11 +60,6 @@ Reject signatures with a creation date not in range.
|
|||
.sp
|
||||
Defaults to beginning of time ("\-").
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.SH "ARGUMENTS"
|
||||
.sp
|
||||
\fISIGNATURE\fP
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@
|
|||
pgpainless\-cli\-version \- Display version information about the tool
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli version\fP [\fB\-\-stacktrace\fP] [\fB\-\-extended\fP | \fB\-\-backend\fP | \fB\-\-pgpainless\-cli\-spec\fP | \fB\-\-sopv\fP]
|
||||
\fBpgpainless\-cli version\fP [\fB\-\-debug\fP] [\fB\-\-extended\fP | \fB\-\-backend\fP | \fB\-\-pgpainless\-cli\-spec\fP | \fB\-\-sopv\fP]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
|
|
@ -40,6 +40,11 @@ pgpainless\-cli\-version \- Display version information about the tool
|
|||
Print information about the cryptographic backend
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-extended\fP
|
||||
.RS 4
|
||||
Print an extended version string
|
||||
|
|
@ -50,7 +55,7 @@ Print an extended version string
|
|||
Print the latest revision of the SOP specification targeted by the implementation
|
||||
.RE
|
||||
.sp
|
||||
\fB\-\-sopv\fP, \fB\-\-stacktrace\fP
|
||||
\fB\-\-sopv\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
Print the SOPV API version
|
||||
.RE
|
||||
|
|
@ -30,12 +30,12 @@
|
|||
pgpainless\-cli \- Stateless OpenPGP Protocol
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBpgpainless\-cli\fP [\fB\-\-stacktrace\fP] [COMMAND]
|
||||
\fBpgpainless\-cli\fP [\fB\-\-debug\fP] [COMMAND]
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
\fB\-\-stacktrace\fP
|
||||
\fB\-\-debug, \-\-stacktrace\fP
|
||||
.RS 4
|
||||
Print stacktrace
|
||||
.RE
|
||||
|
|
@ -71,6 +71,26 @@ Generate revocation certificates
|
|||
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
|
||||
|
|
@ -230,4 +250,24 @@ Options were supplied that are incompatible with each other
|
|||
\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
|
||||
Loading…
Add table
Add a link
Reference in a new issue