Updated fwknop manpage to document both the use of stdin and fd commands.
authorFranck Joncourt <franck@debian.org>
Wed, 5 Jun 2013 19:38:26 +0000 (21:38 +0200)
committerFranck Joncourt <franck@debian.org>
Wed, 5 Jun 2013 19:38:26 +0000 (21:38 +0200)
client/fwknop.8.in
doc/fwknop.man.asciidoc

index df871d6..a1ce16b 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: 05/31/2013
+.\"      Date: 06/05/2013
 .\"    Manual: Fwknop Client
 .\"    Source: Fwknop Client
 .\"  Language: English
 .\"
-.TH "FWKNOP" "8" "05/31/2013" "Fwknop Client" "Fwknop Client"
+.TH "FWKNOP" "8" "06/05/2013" "Fwknop Client" "Fwknop Client"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -127,6 +127,16 @@ client prompt you for the key is generally more secure\&. Note also that if a ke
 rc file is a more powerful mechanism for specifying not only the key but other options as well\&.
 .RE
 .PP
+\fB\-\-stdin\fR
+.RS 4
+Read the encryption key/password from stdin\&. This can be used to send the data via a pipe for example\&. This command is similar to \-\-fd 0\&.
+.RE
+.PP
+\fB\-\-fd\fR=\fI<number>\fR
+.RS 4
+Specify the file descriptor number to read the key/password from\&. This command avoids the user being prompted for his password if none has been found in the user specific stanza, or none has been supplied on the command line\&. A file descriptor set to 0 is similar to the stdin command\&.
+.RE
+.PP
 \fB\-\-get\-hmac\-key\fR=\fI<file>\fR
 .RS 4
 Load an HMAC key/password from the specified file\&. Similarly to the format for the
index f6f7f05..f056c88 100644 (file)
@@ -158,6 +158,16 @@ GENERAL OPTIONS
     file is a more powerful mechanism for specifying not only the key but
     other options as well.
 
+*--stdin*::
+    Read the encryption key/password from stdin. This can be used to send
+    the data via a pipe for example. This command is similar to --fd 0.
+
+*--fd*='<number>'::
+    Specify the file descriptor number to read the key/password from. This
+    command avoids the user being prompted for his password if none has been
+    found in the user specific stanza, or none has been supplied on the
+    command line. A file descriptor set to 0 is similar to the stdin command.
+
 *--get-hmac-key*='<file>'::
     Load an HMAC key/password from the specified file.  Similarly to the
     format for the *--get-key* option, the HMAC key file contains a line for