From fe80b1185ec83180e8e36a0a006a2038abb5dbd2 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Sun, 24 Mar 2024 16:43:27 +0100 Subject: [PATCH] Update man pages --- pgpainless-cli/packaging/man/pgpainless-cli-armor.1 | 7 +------ pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1 | 11 +++-------- pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1 | 8 ++++---- pgpainless-cli/packaging/man/pgpainless-cli-version.1 | 4 ++-- pgpainless-cli/rewriteManPages.sh | 2 ++ 5 files changed, 12 insertions(+), 20 deletions(-) diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-armor.1 b/pgpainless-cli/packaging/man/pgpainless-cli-armor.1 index 98e98857..0d948dfd 100644 --- a/pgpainless-cli/packaging/man/pgpainless-cli-armor.1 +++ b/pgpainless-cli/packaging/man/pgpainless-cli-armor.1 @@ -30,16 +30,11 @@ pgpainless\-cli\-armor \- Add ASCII Armor to standard input .SH "SYNOPSIS" .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 "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 -.sp \fB\-\-stacktrace\fP .RS 4 Print stacktrace diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1 b/pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1 index 9a3c80a7..eb843e18 100644 --- a/pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1 +++ b/pgpainless-cli/packaging/man/pgpainless-cli-decrypt.1 @@ -31,8 +31,8 @@ pgpainless\-cli\-decrypt \- Decrypt a message .SH "SYNOPSIS" .sp \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\-\-verify\-out\fP=\fIVERIFICATIONS\fP] [\fB\-\-verify\-with\fP=\fICERT\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...] .SH "DESCRIPTION" @@ -49,7 +49,7 @@ Can be used to learn the session key on successful decryption Print stacktrace .RE .sp -\fB\-\-verify\-not\-after\fP=\fIDATE\fP +\fB\-\-verifications\-out\fP=\fIVERIFICATIONS\fP, \fB\-\-verify\-not\-after\fP=\fIDATE\fP .RS 4 ISO\-8601 formatted UTC date (e.g. \(aq2020\-11\-23T16:35Z) .sp @@ -69,11 +69,6 @@ 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 diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1 b/pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1 index 29f1d1f1..3cf7aefc 100644 --- a/pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1 +++ b/pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1 @@ -31,9 +31,9 @@ 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\-\-sign\-with\fP=\fIKEY\fP]... -[\fB\-\-with\-key\-password\fP=\fIPASSWORD\fP]... [\fB\-\-with\-password\fP=\fIPASSWORD\fP]... -[\fICERTS\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" @@ -53,7 +53,7 @@ ASCII armor the output Profile identifier to switch between profiles .RE .sp -\fB\-\-sign\-with\fP=\fIKEY\fP +\fB\-\-session\-key\-out\fP=\fISESSIONKEY\fP, \fB\-\-sign\-with\fP=\fIKEY\fP .RS 4 Sign the output with a private key .RE diff --git a/pgpainless-cli/packaging/man/pgpainless-cli-version.1 b/pgpainless-cli/packaging/man/pgpainless-cli-version.1 index 87db756a..c552bbe0 100644 --- a/pgpainless-cli/packaging/man/pgpainless-cli-version.1 +++ b/pgpainless-cli/packaging/man/pgpainless-cli-version.1 @@ -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] +\fBpgpainless\-cli version\fP [\fB\-\-stacktrace\fP] [\fB\-\-extended\fP | \fB\-\-backend\fP | \fB\-\-pgpainless\-cli\-spec\fP | \fB\-\-sopv\fP] .SH "DESCRIPTION" .SH "OPTIONS" @@ -50,7 +50,7 @@ Print an extended version string Print the latest revision of the SOP specification targeted by the implementation .RE .sp -\fB\-\-stacktrace\fP +\fB\-\-sopv\fP, \fB\-\-stacktrace\fP .RS 4 Print stacktrace .RE \ No newline at end of file diff --git a/pgpainless-cli/rewriteManPages.sh b/pgpainless-cli/rewriteManPages.sh index 37b4fdf3..730af68d 100755 --- a/pgpainless-cli/rewriteManPages.sh +++ b/pgpainless-cli/rewriteManPages.sh @@ -13,12 +13,14 @@ do SRC="${page##*/}" DEST="${SRC/sop/pgpainless-cli}" sed \ + -e 's/sopv/PLACEHOLDERV/g' \ -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' \ + -e 's/PLACEHOLDERV/sopv/g' \ $page > $DEST_DIR/$DEST done