From a1eceaf8e10e2e0c0255057e99a6e84cb280e5f2 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Mon, 8 Aug 2022 00:23:58 +0200 Subject: [PATCH] Add manpages, script to generate manpages --- .reuse/dep5 | 9 + .../packaging/man/pgpainless-cli-armor.1 | 138 ++++++++++++ .../packaging/man/pgpainless-cli-dearmor.1 | 132 ++++++++++++ .../packaging/man/pgpainless-cli-decrypt.1 | 201 +++++++++++++++++ .../packaging/man/pgpainless-cli-encrypt.1 | 170 +++++++++++++++ .../man/pgpainless-cli-extract-cert.1 | 138 ++++++++++++ .../man/pgpainless-cli-generate-completion.1 | 151 +++++++++++++ .../man/pgpainless-cli-generate-key.1 | 152 +++++++++++++ .../packaging/man/pgpainless-cli-help.1 | 146 +++++++++++++ .../man/pgpainless-cli-inline-detach.1 | 143 ++++++++++++ .../man/pgpainless-cli-inline-sign.1 | 165 ++++++++++++++ .../man/pgpainless-cli-inline-verify.1 | 165 ++++++++++++++ .../packaging/man/pgpainless-cli-sign.1 | 164 ++++++++++++++ .../packaging/man/pgpainless-cli-verify.1 | 153 +++++++++++++ .../packaging/man/pgpainless-cli-version.1 | 143 ++++++++++++ pgpainless-cli/packaging/man/pgpainless-cli.1 | 203 ++++++++++++++++++ pgpainless-cli/rewriteManPages.sh | 24 +++ 17 files changed, 2397 insertions(+) create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-armor.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-dearmor.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-extract-cert.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-generate-completion.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-generate-key.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-help.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-inline-detach.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-inline-sign.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-inline-verify.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-sign.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-verify.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli-version.1 create mode 100644 pgpainless-cli/packaging/man/pgpainless-cli.1 create mode 100755 pgpainless-cli/rewriteManPages.sh diff --git a/.reuse/dep5 b/.reuse/dep5 index 28dd7917..96efa937 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -60,3 +60,12 @@ License: CC0-1.0 Files: _layouts/* Copyright: 2022 Paul Schaub , 2017 Steve Smith License: CC-BY-SA-3.0 + +# Man Pages +Files: pgpainless-cli/rewriteManPages.sh +Copyright: 2022 Paul Schaub +License: Apache-2.0 + +Files: pgpainless-cli/packaging/man/* +Copyright: 2022 Paul Schaub +License: Apache-2.0 diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-armor.1 b/pgpainless-cli/packaging/man/pgpainless-cli-armor.1 new file mode 100644 index 00000000..bc0efe20 --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-armor.1 @@ -0,0 +1,138 @@ +'\" t +.\" Title: pgpainless-cli-armor +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-ARMOR" "1" "2022-08-07" "" "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\-armor \- Add ASCII Armor to standard input +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli armor\fP [\fB\-\-label\fP=\fI{auto|sig|key|cert|message}\fP] +.SH "DESCRIPTION" + +.SH "OPTIONS" +.sp +\fB\-\-label\fP=\fI{auto|sig|key|cert|message}\fP +.RS 4 +Label to be used in the header and tail of the armoring +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-dearmor.1 b/pgpainless-cli/packaging/man/pgpainless-cli-dearmor.1 new file mode 100644 index 00000000..0dacf89c --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-dearmor.1 @@ -0,0 +1,132 @@ +'\" t +.\" Title: pgpainless-cli-dearmor +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-DEARMOR" "1" "2022-08-07" "" "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\-dearmor \- Remove ASCII Armor from standard input +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli dearmor\fP +.SH "DESCRIPTION" + +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1 b/pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1 new file mode 100644 index 00000000..c97eb7e9 --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1 @@ -0,0 +1,201 @@ +'\" t +.\" Title: pgpainless-cli-decrypt +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-DECRYPT" "1" "2022-08-07" "" "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\-decrypt \- Decrypt a message from standard input +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli decrypt\fP [\fB\-\-not\-after\fP=\fIDATE\fP] [\fB\-\-not\-before\fP=\fIDATE\fP] +[\fB\-\-session\-key\-out\fP=\fISESSIONKEY\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\-\-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 +.RS 4 +Can be used to learn the session key on successful decryption +.RE +.sp +\fB\-\-verify\-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 +.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\-\-with\-password\fP=\fIPASSWORD\fP +.RS 4 +Symmetric passphrase to decrypt the message with. +.sp +Enables decryption based on any "SKESK" packets in the "CIPHERTEXT". +.RE +.sp +\fB\-\-with\-session\-key\fP=\fISESSIONKEY\fP +.RS 4 +Symmetric message key (session key). +.sp +Enables decryption of the "CIPHERTEXT" using the session key directly against the "SEIPD" packet. +.sp +Is an INDIRECT data type (e.g. file, environment variable, file descriptor...) +.RE +.SH "ARGUMENTS" +.sp +[\fIKEY\fP...] +.RS 4 +Secret keys to attempt decryption with +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1 b/pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1 new file mode 100644 index 00000000..78c8e434 --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1 @@ -0,0 +1,170 @@ +'\" t +.\" Title: pgpainless-cli-encrypt +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-ENCRYPT" "1" "2022-08-07" "" "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\-encrypt \- Encrypt a message from standard input +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli encrypt\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-as\fP=\fI{binary|text}\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" +.sp +\fB\-\-as\fP=\fI{binary|text}\fP +.RS 4 +Type of the input data. Defaults to \(aqbinary\(aq +.RE +.sp +\fB\-\-[no\-]armor\fP +.RS 4 +ASCII armor the output +.RE +.sp +\fB\-\-sign\-with\fP=\fIKEY\fP +.RS 4 +Sign the output with a private key +.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\-\-with\-password\fP=\fIPASSWORD\fP +.RS 4 +Encrypt the message with a password. +.sp +Is an INDIRECT data type (e.g. file, environment variable, file descriptor...) +.RE +.SH "ARGUMENTS" +.sp +[\fICERTS\fP...] +.RS 4 +Certificates the message gets encrypted to +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-extract-cert.1 b/pgpainless-cli/packaging/man/pgpainless-cli-extract-cert.1 new file mode 100644 index 00000000..7beaad14 --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-extract-cert.1 @@ -0,0 +1,138 @@ +'\" t +.\" Title: pgpainless-cli-extract-cert +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-EXTRACT\-CERT" "1" "2022-08-07" "" "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\-extract\-cert \- Extract a public key certificate from a secret key from standard input +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli extract\-cert\fP [\fB\-\-[no\-]armor\fP] +.SH "DESCRIPTION" + +.SH "OPTIONS" +.sp +\fB\-\-[no\-]armor\fP +.RS 4 +ASCII armor the output +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-generate-completion.1 b/pgpainless-cli/packaging/man/pgpainless-cli-generate-completion.1 new file mode 100644 index 00000000..dfc5448a --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-generate-completion.1 @@ -0,0 +1,151 @@ +'\" t +.\" Title: pgpainless-cli-generate-completion +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: generate-completion 4.6.3 +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-GENERATE\-COMPLETION" "1" "2022-08-07" "generate\-completion 4.6.3" "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\-generate\-completion \- Generate bash/zsh completion script for pgpainless\-cli. +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli generate\-completion\fP [\fB\-hV\fP] +.SH "DESCRIPTION" +.sp +Generate bash/zsh completion script for pgpainless\-cli. +Run the following command to give \f(CRpgpainless\-cli\fP TAB completion in the current shell: +.sp +.if n .RS 4 +.nf +source <(pgpainless\-cli generate\-completion) +.fi +.if n .RE +.SH "OPTIONS" +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Show this help message and exit. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Print version information and exit. +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-generate-key.1 b/pgpainless-cli/packaging/man/pgpainless-cli-generate-key.1 new file mode 100644 index 00000000..66d6d1b9 --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-generate-key.1 @@ -0,0 +1,152 @@ +'\" t +.\" Title: pgpainless-cli-generate-key +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-GENERATE\-KEY" "1" "2022-08-07" "" "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\-generate\-key \- Generate a secret key +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli generate\-key\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP] [\fI\fP...] +.SH "DESCRIPTION" + +.SH "OPTIONS" +.sp +\fB\-\-[no\-]armor\fP +.RS 4 +ASCII armor the output +.RE +.sp +\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP +.RS 4 +Password to protect the private key with +.sp +Is an INDIRECT data type (e.g. file, environment variable, file descriptor...). +.RE +.SH "ARGUMENTS" +.sp +[\fI\fP...] +.RS 4 +User\-ID, e.g. "Alice <\c +.MTO "alice\(atexample.com" "" ">"" +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-help.1 b/pgpainless-cli/packaging/man/pgpainless-cli-help.1 new file mode 100644 index 00000000..8688615a --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-help.1 @@ -0,0 +1,146 @@ +'\" t +.\" Title: pgpainless-cli-help +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-HELP" "1" "2022-08-07" "" "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\-help \- Display usage information for the specified subcommand +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli help\fP [\fB\-h\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\-h\fP, \fB\-\-help\fP +.RS 4 +Show usage help for the help command and exit. +.RE +.SH "ARGUMENTS" +.sp +[\fICOMMAND\fP] +.RS 4 +The COMMAND to display the usage help message for. +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-inline-detach.1 b/pgpainless-cli/packaging/man/pgpainless-cli-inline-detach.1 new file mode 100644 index 00000000..ccb4901a --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-inline-detach.1 @@ -0,0 +1,143 @@ +'\" t +.\" Title: pgpainless-cli-inline-detach +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-INLINE\-DETACH" "1" "2022-08-07" "" "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\-inline\-detach \- Split signatures from a clearsigned message +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli inline\-detach\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-signatures\-out\fP=\fISIGNATURES\fP] +.SH "DESCRIPTION" + +.SH "OPTIONS" +.sp +\fB\-\-[no\-]armor\fP +.RS 4 +ASCII armor the output +.RE +.sp +\fB\-\-signatures\-out\fP=\fISIGNATURES\fP +.RS 4 +Destination to which a detached signatures block will be written +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-inline-sign.1 b/pgpainless-cli/packaging/man/pgpainless-cli-inline-sign.1 new file mode 100644 index 00000000..90d8908f --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-inline-sign.1 @@ -0,0 +1,165 @@ +'\" t +.\" Title: pgpainless-cli-inline-sign +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-INLINE\-SIGN" "1" "2022-08-07" "" "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\-inline\-sign \- Create an inline\-signed message from data on standard input +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli inline\-sign\fP [\fB\-\-[no\-]armor\fP] [\fB\-\-as\fP=\fI{binary|text|cleartextsigned}\fP] +[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fIKEYS\fP...] +.SH "DESCRIPTION" + +.SH "OPTIONS" +.sp +\fB\-\-as\fP=\fI{binary|text|cleartextsigned}\fP +.RS 4 +Specify the signature format of the signed message +.sp +\(aqtext\(aq and \(aqbinary\(aq will produce inline\-signed messages. +.sp +\(aqcleartextsigned\(aq will make use of the cleartext signature framework. +.sp +Defaults to \(aqbinary\(aq. +.sp +If \(aq\-\-as=text\(aq and the input data is not valid UTF\-8, inline\-sign fails with return code 53. +.RE +.sp +\fB\-\-[no\-]armor\fP +.RS 4 +ASCII armor the output +.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 +.SH "ARGUMENTS" +.sp +[\fIKEYS\fP...] +.RS 4 +Secret keys used for signing +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-inline-verify.1 b/pgpainless-cli/packaging/man/pgpainless-cli-inline-verify.1 new file mode 100644 index 00000000..2f989285 --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-inline-verify.1 @@ -0,0 +1,165 @@ +'\" t +.\" Title: pgpainless-cli-inline-verify +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-INLINE\-VERIFY" "1" "2022-08-07" "" "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\-inline\-verify \- Verify inline\-signed data from standard input +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli inline\-verify\fP [\fB\-\-not\-after\fP=\fIDATE\fP] [\fB\-\-not\-before\fP=\fIDATE\fP] +[\fB\-\-verifications\-out\fP=\fI\fP] \fICERT\fP... +.SH "DESCRIPTION" + +.SH "OPTIONS" +.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 ("now"). +.sp +Accepts special value "\-" 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 ("\-"). +.RE +.sp +\fB\-\-verifications\-out\fP=\fI\fP +.RS 4 +File to write details over successful verifications to +.RE +.SH "ARGUMENTS" +.sp +\fICERT\fP... +.RS 4 +Public key certificates for signature verification +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-sign.1 b/pgpainless-cli/packaging/man/pgpainless-cli-sign.1 new file mode 100644 index 00000000..cc830e7f --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-sign.1 @@ -0,0 +1,164 @@ +'\" t +.\" Title: pgpainless-cli-sign +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-SIGN" "1" "2022-08-07" "" "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\-sign \- Create a detached signature on the data from standard input +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli sign\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" +.sp +\fB\-\-as\fP=\fI{binary|text}\fP +.RS 4 +Specify the output format of the signed message +.sp +Defaults to \(aqbinary\(aq. +.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) +.RE +.sp +\fB\-\-[no\-]armor\fP +.RS 4 +ASCII armor the output +.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 +.SH "ARGUMENTS" +.sp +[\fIKEYS\fP...] +.RS 4 +Secret keys used for signing +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-verify.1 b/pgpainless-cli/packaging/man/pgpainless-cli-verify.1 new file mode 100644 index 00000000..297f8374 --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-verify.1 @@ -0,0 +1,153 @@ +'\" t +.\" Title: pgpainless-cli-verify +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-VERIFY" "1" "2022-08-07" "" "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\-verify \- Verify a detached signature over the data from standard input +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli verify\fP [\fB\-\-not\-after\fP=\fIDATE\fP] [\fB\-\-not\-before\fP=\fIDATE\fP] \fISIGNATURE\fP \fICERT\fP... +.SH "DESCRIPTION" + +.SH "OPTIONS" +.sp +\fB\-\-not\-after\fP=\fIDATE\fP, \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 ("\-"). +.RE +.SH "ARGUMENTS" +.sp +\fISIGNATURE\fP +.RS 4 +Detached signature +.RE +.sp +\fICERT\fP... +.RS 4 +Public key certificates for signature verification +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-version.1 b/pgpainless-cli/packaging/man/pgpainless-cli-version.1 new file mode 100644 index 00000000..0a235d7a --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli-version.1 @@ -0,0 +1,143 @@ +'\" t +.\" Title: pgpainless-cli-version +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI\-VERSION" "1" "2022-08-07" "" "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\-version \- Display version information about the tool +.SH "SYNOPSIS" +.sp +\fBpgpainless\-cli version\fP [\fB\-\-extended\fP | \fB\-\-backend\fP] +.SH "DESCRIPTION" + +.SH "OPTIONS" +.sp +\fB\-\-backend\fP +.RS 4 +Print information about the cryptographic backend +.RE +.sp +\fB\-\-extended\fP +.RS 4 +Print an extended version string +.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 \ No newline at end of file diff --git a/pgpainless-cli/packaging/man/pgpainless-cli.1 b/pgpainless-cli/packaging/man/pgpainless-cli.1 new file mode 100644 index 00000000..171c394e --- /dev/null +++ b/pgpainless-cli/packaging/man/pgpainless-cli.1 @@ -0,0 +1,203 @@ +'\" t +.\" Title: pgpainless-cli +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2022-08-07 +.\" Manual: PGPainless-CLI Manual +.\" Source: +.\" Language: English +.\" +.TH "PGPAINLESS\-CLI" "1" "2022-08-07" "" "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 [COMMAND] +.SH "DESCRIPTION" + +.SH "COMMANDS" +.sp +\fBhelp\fP +.RS 4 +Display usage information for the specified subcommand +.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 +\fBdecrypt\fP +.RS 4 +Decrypt a message from standard input +.RE +.sp +\fBinline\-detach\fP +.RS 4 +Split signatures from a clearsigned message +.RE +.sp +\fBencrypt\fP +.RS 4 +Encrypt a message from standard input +.RE +.sp +\fBextract\-cert\fP +.RS 4 +Extract a public key certificate from a secret key from standard input +.RE +.sp +\fBgenerate\-key\fP +.RS 4 +Generate a secret key +.RE +.sp +\fBsign\fP +.RS 4 +Create a detached signature on the data from standard input +.RE +.sp +\fBverify\fP +.RS 4 +Verify a detached signature over the data from standard input +.RE +.sp +\fBinline\-sign\fP +.RS 4 +Create an inline\-signed message from data on standard input +.RE +.sp +\fBinline\-verify\fP +.RS 4 +Verify inline\-signed data from standard input +.RE +.sp +\fBversion\fP +.RS 4 +Display version information about the tool +.RE +.sp +\fBgenerate\-completion\fP +.RS 4 +Generate bash/zsh completion script for pgpainless\-cli. +.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 \ No newline at end of file diff --git a/pgpainless-cli/rewriteManPages.sh b/pgpainless-cli/rewriteManPages.sh new file mode 100755 index 00000000..321dbdde --- /dev/null +++ b/pgpainless-cli/rewriteManPages.sh @@ -0,0 +1,24 @@ +#!/usr/bin/env bash + +SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) +SOP_DIR=$(realpath $SCRIPT_DIR/../../sop-java) +[ ! -d "$SOP_DIR" ] && echo "sop-java repository MUST be cloned next to pgpainless repo" && exit 1; +SRC_DIR=$SOP_DIR/sop-java-picocli/build/docs/manpage +[ ! -d "$SRC_DIR" ] && echo "No sop manpages found." && exit 1; +DEST_DIR=$SCRIPT_DIR/packaging/man +mkdir -p $DEST_DIR + +for page in $SRC_DIR/* +do + SRC="${page##*/}" + DEST="${SRC/sop/pgpainless-cli}" + sed \ + -e 's#.\\" Title: sop#.\\" Title: pgpainless-cli#g' \ + -e 's/Manual: Sop Manual/Manual: PGPainless-CLI Manual/g' \ + -e 's/.TH "SOP/.TH "PGPAINLESS\\-CLI/g' \ + -e 's/"Sop Manual"/"PGPainless\\-CLI Manual"/g' \ + -e 's/\\fBsop/\\fBpgpainless\\-cli/g' \ + -e 's/sop/pgpainless\\-cli/g' \ + $page > $DEST_DIR/$DEST +done +