Add manpages, script to generate manpages

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