PGPainless/pgpainless
PGPainless
/
pgpainless
mirror of https://github.com/pgpainless/pgpainless.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update man pages

This commit is contained in:
Paul Schaub 2024-03-24 16:43:27 +01:00
parent 8066650584
commit fe80b1185e
Signed by: vanitasvitae
GPG Key ID: 62BEE9264BF17311
5 changed files with 12 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pgpainless-cli/packaging/man/pgpainless-cli-armor.1
View File

@ -30,16 +30,11 @@
pgpainless\-cli\-armor \- Add ASCII Armor to standard input pgpainless\-cli\-armor \- Add ASCII Armor to standard input
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
\fBpgpainless\-cli armor\fP [\fB\-\-stacktrace\fP] [\fB\-\-label\fP=\fI{auto|sig|key|cert|message}\fP] \fBpgpainless\-cli armor\fP [\fB\-\-stacktrace\fP]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.SH "OPTIONS" .SH "OPTIONS"
.sp .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
.sp
\fB\-\-stacktrace\fP \fB\-\-stacktrace\fP
.RS 4 .RS 4
Print stacktrace Print stacktrace

11
pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1
View File

@ -31,8 +31,8 @@ pgpainless\-cli\-decrypt \- Decrypt a message
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
\fBpgpainless\-cli decrypt\fP [\fB\-\-stacktrace\fP] [\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP] \fBpgpainless\-cli decrypt\fP [\fB\-\-stacktrace\fP] [\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP]
[\fB\-\-verify\-not\-after\fP=\fIDATE\fP] [\fB\-\-verify\-not\-before\fP=\fIDATE\fP] [\fB\-\-verifications\-out\fP=\fIVERIFICATIONS\fP] [\fB\-\-verify\-not\-after\fP=\fIDATE\fP]
[\fB\-\-verify\-out\fP=\fIVERIFICATIONS\fP] [\fB\-\-verify\-with\fP=\fICERT\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\-key\-password\fP=\fIPASSWORD\fP]... [\fB\-\-with\-password\fP=\fIPASSWORD\fP]...
[\fB\-\-with\-session\-key\fP=\fISESSIONKEY\fP]... [\fIKEY\fP...] [\fB\-\-with\-session\-key\fP=\fISESSIONKEY\fP]... [\fIKEY\fP...]
.SH "DESCRIPTION" .SH "DESCRIPTION"
@ -49,7 +49,7 @@ Can be used to learn the session key on successful decryption
Print stacktrace Print stacktrace
.RE .RE
.sp .sp
\fB\-\-verify\-not\-after\fP=\fIDATE\fP \fB\-\-verifications\-out\fP=\fIVERIFICATIONS\fP, \fB\-\-verify\-not\-after\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
@ -69,11 +69,6 @@ Reject signatures with a creation date not in range.
Defaults to beginning of time (\(aq\-\(aq). Defaults to beginning of time (\(aq\-\(aq).
.RE .RE
.sp .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 \fB\-\-verify\-with\fP=\fICERT\fP
.RS 4 .RS 4
Certificates for signature verification Certificates for signature verification

8
pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1
View File

@ -31,9 +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\-\-profile\fP=\fIPROFILE\fP] [\fB\-\-sign\-with\fP=\fIKEY\fP]... [\fB\-\-profile\fP=\fIPROFILE\fP] [\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP]
[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fB\-\-with\-password\fP=\fIPASSWORD\fP]... [\fB\-\-sign\-with\fP=\fIKEY\fP]... [\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]...
[\fICERTS\fP...] [\fB\-\-with\-password\fP=\fIPASSWORD\fP]... [\fICERTS\fP...]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.SH "OPTIONS" .SH "OPTIONS"
@ -53,7 +53,7 @@ ASCII armor the output
Profile identifier to switch between profiles Profile identifier to switch between profiles
.RE .RE
.sp .sp
\fB\-\-sign\-with\fP=\fIKEY\fP \fB\-\-session\-key\-out\fP=\fISESSIONKEY\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
.RE .RE

4
pgpainless-cli/packaging/man/pgpainless-cli-version.1
View File

@ -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 | \fB\-\-pgpainless\-cli\-spec\fP] \fBpgpainless\-cli version\fP [\fB\-\-stacktrace\fP] [\fB\-\-extended\fP | \fB\-\-backend\fP | \fB\-\-pgpainless\-cli\-spec\fP | \fB\-\-sopv\fP]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.SH "OPTIONS" .SH "OPTIONS"
@ -50,7 +50,7 @@ Print an extended version string
Print the latest revision of the SOP specification targeted by the implementation Print the latest revision of the SOP specification targeted by the implementation
.RE .RE
.sp .sp
\fB\-\-stacktrace\fP \fB\-\-sopv\fP, \fB\-\-stacktrace\fP
.RS 4 .RS 4
Print stacktrace Print stacktrace
.RE .RE

2
pgpainless-cli/rewriteManPages.sh
View File

@ -13,12 +13,14 @@ do
SRC="${page##*/}" SRC="${page##*/}"
DEST="${SRC/sop/pgpainless-cli}" DEST="${SRC/sop/pgpainless-cli}"
sed \ sed \
-e 's/sopv/PLACEHOLDERV/g' \
-e 's#.\\" Title: sop#.\\" Title: pgpainless-cli#g' \ -e 's#.\\" Title: sop#.\\" Title: pgpainless-cli#g' \
-e 's/Manual: Sop Manual/Manual: PGPainless-CLI Manual/g' \ -e 's/Manual: Sop Manual/Manual: PGPainless-CLI Manual/g' \
-e 's/.TH "SOP/.TH "PGPAINLESS\\-CLI/g' \ -e 's/.TH "SOP/.TH "PGPAINLESS\\-CLI/g' \
-e 's/"Sop Manual"/"PGPainless\\-CLI Manual"/g' \ -e 's/"Sop Manual"/"PGPainless\\-CLI Manual"/g' \
-e 's/\\fBsop/\\fBpgpainless\\-cli/g' \ -e 's/\\fBsop/\\fBpgpainless\\-cli/g' \
-e 's/sop/pgpainless\\-cli/g' \ -e 's/sop/pgpainless\\-cli/g' \
-e 's/PLACEHOLDERV/sopv/g' \
$page > $DEST_DIR/$DEST $page > $DEST_DIR/$DEST
done done