mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-12-22 19:08:00 +01:00
Update man pages
This commit is contained in:
parent
eb45dee04f
commit
558036c485
11 changed files with 129 additions and 42 deletions
|
@ -30,41 +30,21 @@
|
||||||
pgpainless\-cli\-decrypt \- Decrypt a message from standard input
|
pgpainless\-cli\-decrypt \- Decrypt a message from standard input
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
.sp
|
.sp
|
||||||
\fBpgpainless\-cli decrypt\fP [\fB\-\-stacktrace\fP] [\fB\-\-not\-after\fP=\fIDATE\fP] [\fB\-\-not\-before\fP=\fIDATE\fP]
|
\fBpgpainless\-cli decrypt\fP [\fB\-\-stacktrace\fP] [\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP]
|
||||||
[\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP] [\fB\-\-verify\-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\-\-verify\-out\fP=\fIVERIFICATIONS\fP] [\fB\-\-verify\-with\fP=\fICERT\fP]...
|
||||||
[\fB\-\-with\-password\fP=\fIPASSWORD\fP]... [\fB\-\-with\-session\-key\fP=\fISESSIONKEY\fP]...
|
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fB\-\-with\-password\fP=\fIPASSWORD\fP]...
|
||||||
[\fIKEY\fP...]
|
[\fB\-\-with\-session\-key\fP=\fISESSIONKEY\fP]... [\fIKEY\fP...]
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
|
|
||||||
.SH "OPTIONS"
|
.SH "OPTIONS"
|
||||||
.sp
|
.sp
|
||||||
\fB\-\-not\-after\fP=\fIDATE\fP
|
|
||||||
.RS 4
|
|
||||||
ISO\-8601 formatted UTC date (e.g. \(aq2020\-11\-23T16:35Z)
|
|
||||||
.sp
|
|
||||||
Reject signatures with a creation date not in range.
|
|
||||||
.sp
|
|
||||||
Defaults to current system time (\(aqnow\(aq).
|
|
||||||
.sp
|
|
||||||
Accepts special value \(aq\-\(aq for end of time.
|
|
||||||
.RE
|
|
||||||
.sp
|
|
||||||
\fB\-\-not\-before\fP=\fIDATE\fP
|
|
||||||
.RS 4
|
|
||||||
ISO\-8601 formatted UTC date (e.g. \(aq2020\-11\-23T16:35Z)
|
|
||||||
.sp
|
|
||||||
Reject signatures with a creation date not in range.
|
|
||||||
.sp
|
|
||||||
Defaults to beginning of time (\(aq\-\(aq).
|
|
||||||
.RE
|
|
||||||
.sp
|
|
||||||
\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP
|
\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP
|
||||||
.RS 4
|
.RS 4
|
||||||
Can be used to learn the session key on successful decryption
|
Can be used to learn the session key on successful decryption
|
||||||
.RE
|
.RE
|
||||||
.sp
|
.sp
|
||||||
\fB\-\-stacktrace\fP, \fB\-\-verify\-out, \-\-verifications\-out\fP=\fIVERIFICATIONS\fP
|
\fB\-\-stacktrace\fP, \fB\-\-verify\-not\-after\fP=\fIDATE\fP, \fB\-\-verify\-not\-before\fP=\fIDATE\fP, \fB\-\-verify\-out, \-\-verifications\-out\fP=\fIVERIFICATIONS\fP
|
||||||
.RS 4
|
.RS 4
|
||||||
Emits signature verification status to the designated output
|
Emits signature verification status to the designated output
|
||||||
.RE
|
.RE
|
||||||
|
@ -87,7 +67,7 @@ Symmetric passphrase to decrypt the message with.
|
||||||
.sp
|
.sp
|
||||||
Enables decryption based on any "SKESK" packets in the "CIPHERTEXT".
|
Enables decryption based on any "SKESK" packets in the "CIPHERTEXT".
|
||||||
.sp
|
.sp
|
||||||
Is an INDIRECT data type (e.g. file, environment variable, file descriptor...)
|
Is an INDIRECT data type (e.g. file, environment variable, file descriptor...).
|
||||||
.RE
|
.RE
|
||||||
.sp
|
.sp
|
||||||
\fB\-\-with\-session\-key\fP=\fISESSIONKEY\fP
|
\fB\-\-with\-session\-key\fP=\fISESSIONKEY\fP
|
||||||
|
@ -96,7 +76,7 @@ Symmetric message key (session key).
|
||||||
.sp
|
.sp
|
||||||
Enables decryption of the "CIPHERTEXT" using the session key directly against the "SEIPD" packet.
|
Enables decryption of the "CIPHERTEXT" using the session key directly against the "SEIPD" packet.
|
||||||
.sp
|
.sp
|
||||||
Is an INDIRECT data type (e.g. file, environment variable, file descriptor...)
|
Is an INDIRECT data type (e.g. file, environment variable, file descriptor...).
|
||||||
.RE
|
.RE
|
||||||
.SH "ARGUMENTS"
|
.SH "ARGUMENTS"
|
||||||
.sp
|
.sp
|
||||||
|
|
|
@ -31,8 +31,9 @@ pgpainless\-cli\-encrypt \- Encrypt a message from standard input
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
.sp
|
.sp
|
||||||
\fBpgpainless\-cli encrypt\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-as\fP=\fI{binary|text}\fP]
|
\fBpgpainless\-cli encrypt\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-as\fP=\fI{binary|text}\fP]
|
||||||
[\fB\-\-sign\-with\fP=\fIKEY\fP]... [\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]...
|
[\fB\-\-profile\fP=\fIPROFILE\fP] [\fB\-\-sign\-with\fP=\fIKEY\fP]...
|
||||||
[\fB\-\-with\-password\fP=\fIPASSWORD\fP]... [\fICERTS\fP...]
|
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fB\-\-with\-password\fP=\fIPASSWORD\fP]...
|
||||||
|
[\fICERTS\fP...]
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
|
|
||||||
.SH "OPTIONS"
|
.SH "OPTIONS"
|
||||||
|
@ -47,6 +48,11 @@ Type of the input data. Defaults to \(aqbinary\(aq
|
||||||
ASCII armor the output
|
ASCII armor the output
|
||||||
.RE
|
.RE
|
||||||
.sp
|
.sp
|
||||||
|
\fB\-\-profile\fP=\fIPROFILE\fP
|
||||||
|
.RS 4
|
||||||
|
Profile identifier to switch between profiles
|
||||||
|
.RE
|
||||||
|
.sp
|
||||||
\fB\-\-sign\-with\fP=\fIKEY\fP
|
\fB\-\-sign\-with\fP=\fIKEY\fP
|
||||||
.RS 4
|
.RS 4
|
||||||
Sign the output with a private key
|
Sign the output with a private key
|
||||||
|
@ -63,7 +69,7 @@ Is an INDIRECT data type (e.g. file, environment variable, file descriptor...).
|
||||||
.RS 4
|
.RS 4
|
||||||
Encrypt the message with a password.
|
Encrypt the message with a password.
|
||||||
.sp
|
.sp
|
||||||
Is an INDIRECT data type (e.g. file, environment variable, file descriptor...)
|
Is an INDIRECT data type (e.g. file, environment variable, file descriptor...).
|
||||||
.RE
|
.RE
|
||||||
.SH "ARGUMENTS"
|
.SH "ARGUMENTS"
|
||||||
.sp
|
.sp
|
||||||
|
|
|
@ -153,3 +153,13 @@ Ambiguous input (a filename matching the designator already exists)
|
||||||
.RS 4
|
.RS 4
|
||||||
Key is not signing capable
|
Key is not signing capable
|
||||||
.RE
|
.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
|
|
@ -30,8 +30,8 @@
|
||||||
pgpainless\-cli\-generate\-key \- Generate a secret key
|
pgpainless\-cli\-generate\-key \- Generate a secret key
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
.sp
|
.sp
|
||||||
\fBpgpainless\-cli generate\-key\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]
|
\fBpgpainless\-cli generate\-key\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-profile\fP=\fIPROFILE\fP]
|
||||||
[\fIUSERID\fP...]
|
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP] [\fIUSERID\fP...]
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
|
|
||||||
.SH "OPTIONS"
|
.SH "OPTIONS"
|
||||||
|
@ -41,6 +41,11 @@ pgpainless\-cli\-generate\-key \- Generate a secret key
|
||||||
ASCII armor the output
|
ASCII armor the output
|
||||||
.RE
|
.RE
|
||||||
.sp
|
.sp
|
||||||
|
\fB\-\-profile\fP=\fIPROFILE\fP
|
||||||
|
.RS 4
|
||||||
|
Profile identifier to switch between profiles
|
||||||
|
.RE
|
||||||
|
.sp
|
||||||
\fB\-\-stacktrace\fP, \fB\-\-with\-key\-password\fP=\fIPASSWORD\fP
|
\fB\-\-stacktrace\fP, \fB\-\-with\-key\-password\fP=\fIPASSWORD\fP
|
||||||
.RS 4
|
.RS 4
|
||||||
Password to protect the private key with
|
Password to protect the private key with
|
||||||
|
|
|
@ -148,3 +148,13 @@ Ambiguous input (a filename matching the designator already exists)
|
||||||
.RS 4
|
.RS 4
|
||||||
Key is not signing capable
|
Key is not signing capable
|
||||||
.RE
|
.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
|
|
@ -30,20 +30,19 @@
|
||||||
pgpainless\-cli\-inline\-sign \- Create an inline\-signed message from data on standard input
|
pgpainless\-cli\-inline\-sign \- Create an inline\-signed message from data on standard input
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
.sp
|
.sp
|
||||||
\fBpgpainless\-cli inline\-sign\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-as\fP=
|
\fBpgpainless\-cli inline\-sign\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-stacktrace\fP] [\fB\-\-as\fP=\fI{binary|text|clearsigned}\fP]
|
||||||
\fI{binary|text|cleartextsigned}\fP]
|
|
||||||
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fIKEYS\fP...]
|
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fIKEYS\fP...]
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
|
|
||||||
.SH "OPTIONS"
|
.SH "OPTIONS"
|
||||||
.sp
|
.sp
|
||||||
\fB\-\-as\fP=\fI{binary|text|cleartextsigned}\fP
|
\fB\-\-as\fP=\fI{binary|text|clearsigned}\fP
|
||||||
.RS 4
|
.RS 4
|
||||||
Specify the signature format of the signed message
|
Specify the signature format of the signed message.
|
||||||
.sp
|
.sp
|
||||||
\(aqtext\(aq and \(aqbinary\(aq will produce inline\-signed messages.
|
\(aqtext\(aq and \(aqbinary\(aq will produce inline\-signed messages.
|
||||||
.sp
|
.sp
|
||||||
\(aqcleartextsigned\(aq will make use of the cleartext signature framework.
|
\(aqclearsigned\(aq will make use of the cleartext signature framework.
|
||||||
.sp
|
.sp
|
||||||
Defaults to \(aqbinary\(aq.
|
Defaults to \(aqbinary\(aq.
|
||||||
.sp
|
.sp
|
||||||
|
|
46
pgpainless-cli/packaging/man/pgpainless-cli-list-profiles.1
Normal file
46
pgpainless-cli/packaging/man/pgpainless-cli-list-profiles.1
Normal file
|
@ -0,0 +1,46 @@
|
||||||
|
'\" t
|
||||||
|
.\" Title: pgpainless-cli-list-profiles
|
||||||
|
.\" Author: [see the "AUTHOR(S)" section]
|
||||||
|
.\" Generator: Asciidoctor 2.0.10
|
||||||
|
.\" Manual: PGPainless-CLI Manual
|
||||||
|
.\" Source:
|
||||||
|
.\" Language: English
|
||||||
|
.\"
|
||||||
|
.TH "PGPAINLESS\-CLI\-LIST\-PROFILES" "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\-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
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
.sp
|
||||||
|
\fB\-\-stacktrace\fP
|
||||||
|
.RS 4
|
||||||
|
.RE
|
||||||
|
.SH "ARGUMENTS"
|
||||||
|
.sp
|
||||||
|
\fICOMMAND\fP
|
||||||
|
.RS 4
|
||||||
|
Subcommand for which to list profiles
|
||||||
|
.RE
|
|
@ -38,7 +38,7 @@ pgpainless\-cli\-sign \- Create a detached signature on the data from standard i
|
||||||
.sp
|
.sp
|
||||||
\fB\-\-as\fP=\fI{binary|text}\fP
|
\fB\-\-as\fP=\fI{binary|text}\fP
|
||||||
.RS 4
|
.RS 4
|
||||||
Specify the output format of the signed message
|
Specify the output format of the signed message.
|
||||||
.sp
|
.sp
|
||||||
Defaults to \(aqbinary\(aq.
|
Defaults to \(aqbinary\(aq.
|
||||||
.sp
|
.sp
|
||||||
|
@ -47,7 +47,7 @@ If \(aq\-\-as=text\(aq and the input data is not valid UTF\-8, sign fails with r
|
||||||
.sp
|
.sp
|
||||||
\fB\-\-micalg\-out\fP=\fIMICALG\fP
|
\fB\-\-micalg\-out\fP=\fIMICALG\fP
|
||||||
.RS 4
|
.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)
|
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).
|
||||||
.RE
|
.RE
|
||||||
.sp
|
.sp
|
||||||
\fB\-\-[no\-]armor\fP
|
\fB\-\-[no\-]armor\fP
|
||||||
|
|
|
@ -36,7 +36,18 @@ pgpainless\-cli\-verify \- Verify a detached signature over the data from standa
|
||||||
|
|
||||||
.SH "OPTIONS"
|
.SH "OPTIONS"
|
||||||
.sp
|
.sp
|
||||||
\fB\-\-not\-after\fP=\fIDATE\fP, \fB\-\-not\-before\fP=\fIDATE\fP
|
\fB\-\-not\-after\fP=\fIDATE\fP
|
||||||
|
.RS 4
|
||||||
|
ISO\-8601 formatted UTC date (e.g. \(aq2020\-11\-23T16:35Z)
|
||||||
|
.sp
|
||||||
|
Reject signatures with a creation date not in range.
|
||||||
|
.sp
|
||||||
|
Defaults to current system time ("now").
|
||||||
|
.sp
|
||||||
|
Accepts special value "\-" for end of time.
|
||||||
|
.RE
|
||||||
|
.sp
|
||||||
|
\fB\-\-not\-before\fP=\fIDATE\fP
|
||||||
.RS 4
|
.RS 4
|
||||||
ISO\-8601 formatted UTC date (e.g. \(aq2020\-11\-23T16:35Z)
|
ISO\-8601 formatted UTC date (e.g. \(aq2020\-11\-23T16:35Z)
|
||||||
.sp
|
.sp
|
||||||
|
|
|
@ -30,7 +30,7 @@
|
||||||
pgpainless\-cli\-version \- Display version information about the tool
|
pgpainless\-cli\-version \- Display version information about the tool
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
.sp
|
.sp
|
||||||
\fBpgpainless\-cli version\fP [\fB\-\-stacktrace\fP] [\fB\-\-extended\fP | \fB\-\-backend\fP]
|
\fBpgpainless\-cli version\fP [\fB\-\-stacktrace\fP] [\fB\-\-extended\fP | \fB\-\-backend\fP | \fB\-\-pgpainless\-cli\-spec\fP]
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
|
|
||||||
.SH "OPTIONS"
|
.SH "OPTIONS"
|
||||||
|
@ -45,6 +45,11 @@ Print information about the cryptographic backend
|
||||||
Print an extended version string
|
Print an extended version string
|
||||||
.RE
|
.RE
|
||||||
.sp
|
.sp
|
||||||
|
\fB\-\-pgpainless\-cli\-spec\fP
|
||||||
|
.RS 4
|
||||||
|
Print the latest revision of the SOP specification targeted by the implementation
|
||||||
|
.RE
|
||||||
|
.sp
|
||||||
\fB\-\-stacktrace\fP
|
\fB\-\-stacktrace\fP
|
||||||
.RS 4
|
.RS 4
|
||||||
.RE
|
.RE
|
|
@ -101,6 +101,11 @@ Create an inline\-signed message from data on standard input
|
||||||
Verify inline\-signed data from standard input
|
Verify inline\-signed data from standard input
|
||||||
.RE
|
.RE
|
||||||
.sp
|
.sp
|
||||||
|
\fBlist\-profiles\fP
|
||||||
|
.RS 4
|
||||||
|
Emit a list of profiles supported by the identified subcommand
|
||||||
|
.RE
|
||||||
|
.sp
|
||||||
\fBversion\fP
|
\fBversion\fP
|
||||||
.RS 4
|
.RS 4
|
||||||
Display version information about the tool
|
Display version information about the tool
|
||||||
|
@ -206,3 +211,13 @@ Ambiguous input (a filename matching the designator already exists)
|
||||||
.RS 4
|
.RS 4
|
||||||
Key is not signing capable
|
Key is not signing capable
|
||||||
.RE
|
.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
|
Loading…
Reference in a new issue