From e3a2289d70f79b0527bad40bc674090cdfeee9d0 Mon Sep 17 00:00:00 2001 From: Michael Rash Date: Wed, 19 Jun 2013 23:37:19 -0400 Subject: [PATCH] [client] man page update to include GPG_SIGNING_PW synonym for KEY variable in GPG mode --- client/fwknop.8.in | 18 ++++++++++++++++-- doc/fwknop.man.asciidoc | 11 +++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/client/fwknop.8.in b/client/fwknop.8.in index 716b572f..fe388824 100644 --- a/client/fwknop.8.in +++ b/client/fwknop.8.in @@ -2,12 +2,12 @@ .\" Title: fwknop .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.76.1 -.\" 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\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\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\fR .RS 4 Specify the GPG key name or ID for signing the GPG\-encrypted SPA data (\fI\-\-gpg\-signer\-key\fR)\&. diff --git a/doc/fwknop.man.asciidoc b/doc/fwknop.man.asciidoc index 2a0c040a..cd8576f8 100644 --- a/doc/fwknop.man.asciidoc +++ b/doc/fwknop.man.asciidoc @@ -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* '':: + 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* '':: + 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* '':: Specify the GPG key name or ID for signing the GPG-encrypted SPA data ('--gpg-signer-key').