[client] man page update to include GPG_SIGNING_PW synonym for KEY variable in GPG...
authorMichael Rash <mbr@cipherdyne.org>
Thu, 20 Jun 2013 03:37:19 +0000 (23:37 -0400)
committerMichael Rash <mbr@cipherdyne.org>
Thu, 20 Jun 2013 03:37:19 +0000 (23:37 -0400)
client/fwknop.8.in
doc/fwknop.man.asciidoc

index 716b572..fe38882 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: fwknop
 .\"    Author: [see the "AUTHORS" section]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/18/2013
+.\"      Date: 06/19/2013
 .\"    Manual: Fwknop Client
 .\"    Source: Fwknop Client
 .\"  Language: English
 .\"
-.TH "FWKNOP" "8" "06/18/2013" "Fwknop Client" "Fwknop Client"
+.TH "FWKNOP" "8" "06/19/2013" "Fwknop Client" "Fwknop Client"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -816,6 +816,20 @@ interface with a GPG agent instance for the GPG key password (\fI\-\-gpg\-agent\
 environmental variable\&.
 .RE
 .PP
+\fBGPG_SIGNING_PW\fR \fI<passphrase>\fR
+.RS 4
+This is the passphrase that is used for signing SPA packet data in GPG encryption mode, and is a synonym for the
+\fIKEY\fR
+variable (i\&.e\&. the signing passphrase can be specified with the
+\fIKEY\fR
+variable instead)\&. The SPA packet is encrypted with the remote server key and signed with the local client key\&.
+.RE
+.PP
+\fBGPG_SIGNING_PW_BASE64\fR \fI<base64 encoded passphrase>\fR
+.RS 4
+Specify the GPG signing passphrase as a base64 encoded string\&. This allows non\-ascii characters to be included in the base64\-decoded key\&.
+.RE
+.PP
 \fBGPG_SIGNER\fR \fI<key ID or Name>\fR
 .RS 4
 Specify the GPG key name or ID for signing the GPG\-encrypted SPA data (\fI\-\-gpg\-signer\-key\fR)\&.
index 2a0c040..cd8576f 100644 (file)
@@ -659,6 +659,17 @@ description and its matching command-line option(s):
     key password ('--gpg-agent').  Agent information itself is specified with
     the 'GPG_AGENT_INFO' environmental variable.
 
+*GPG_SIGNING_PW* '<passphrase>'::
+    This is the passphrase that is used for signing SPA packet data in GPG
+    encryption mode, and is a synonym for the 'KEY' variable (i.e. the signing
+    passphrase can be specified with the 'KEY' variable instead).  The SPA
+    packet is encrypted with the remote server key and signed with the local
+    client key.
+
+*GPG_SIGNING_PW_BASE64* '<base64 encoded passphrase>'::
+    Specify the GPG signing passphrase as a base64 encoded string.  This allows
+    non-ascii characters to be included in the base64-decoded key.
+
 *GPG_SIGNER* '<key ID or Name>'::
     Specify the GPG key name or ID for signing the GPG-encrypted SPA data
     ('--gpg-signer-key').