mirror of
https://github.com/pgpainless/pgpainless.git
synced 2025-09-10 18:59:39 +02:00
Add manpages, script to generate manpages
This commit is contained in:
parent
fb5f039991
commit
a1eceaf8e1
17 changed files with 2397 additions and 0 deletions
170
pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1
Normal file
170
pgpainless-cli/packaging/man/pgpainless-cli-encrypt.1
Normal file
|
@ -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
|
Loading…
Add table
Add a link
Reference in a new issue