Mostly documentation file updates.

git-svn-id: file:///home/mbr/svn/fwknop/trunk@218 510a4753-2344-4c79-9c09-4d669213fbeb
This commit is contained in:
Damien Stuart
2010-06-19 01:15:19 +00:00
parent dc6058d3a5
commit 63b4da38dc
5 changed files with 57 additions and 21 deletions
+21
View File
@@ -17,3 +17,24 @@ items on succesive line without intervening lines (i.e. the AUTHORS section
of the generated man page). In those cases, simply change the ".sp"
between those lines to ".br".
Generating HTML versions of the documentation:
Here are some of the commands used to create/generate HTML versions of
the fwknop documentation.
For the libfko API doc, you could just do a "make html" to create a
libfki.html directory with a reasonable set of HTML pages. You can also
use "texi2html" which give a bit more flexibility. For example:
texi2html --noheader --nomenu --toc-links libfko.texi
Will generate a single HTML document. With this, the table of contents is
put at the end of the document, but it is not hard to edit the file and to
relocate it to the top.
For creating HTML versions of the man pages, simply use the "-f xhtml"
option to the "a2x" command:
a2x -f xhtml fwknopd.man.asciidoc
+6 -5
View File
@@ -106,7 +106,8 @@ REQUIRED ARGUMENTS
One of these options (see below) is required to tell the remote
*fwknopd* daemon what IP should be let through the local firewall. It
is recommend to use the *-R* or *-a* options instead of *-s* in order
to harden SPA communications against possible MITM attacks.
to harden SPA communications against possible Man-In-The-Middle (MITM)
attacks.
GENERAL OPTIONS
@@ -400,7 +401,7 @@ associated with www.yahoo.com:
DEPENDENCIES
------------
*fwknop* requires 'libfko' (which is normally included with both source and
binary distributions.
binary distributions).
For GPG functionality, GnuPG must also be correctly installed and configured.
@@ -417,14 +418,14 @@ then run it through a decrypt/decode cycle and print it again.
SEE ALSO
--------
fwknopd(8), iptables(8), gpg(1), gpg-agent(1), libfko documentation.
fwknopd(8), iptables(8), gpg(1), libfko documentation.
More information on Single Packet Authorization can be found in the paper
``Single Packet Authorization with fwknop'' available at
'http://www.cipherdyne.org/fwknop/docs/SPA.html'.
AUTHOR
------
AUTHORS
-------
Damien Stuart <dstuart@dstuart.org>
Michael Rash <mbr@cipherdyne.org>
+4 -4
View File
@@ -525,7 +525,7 @@ rc = fko_new(&ctx);
if(rc != FKO_SUCCESS)
@{
fprintf(stderr, "Error %i from fko_new: %s\n", fko_errstr(rc));
fprintf(stderr, "Error %i from fko_new: %s\n", rc, fko_errstr(rc));
exit(1);
@}
@end example
@@ -569,7 +569,7 @@ rc = fko_new_with_data(&ctx, spa_data, key);
if(rc != FKO_SUCCESS)
@{
fprintf(stderr, "Error %i from fko_new_with_data\n");
fprintf(stderr, "Error %i from fko_new_with_data: %s\n", rc, fkoerrstr(rc));
exit(1);
@}
@end example
@@ -594,7 +594,7 @@ rc = fko_new_with_data(&ctx, spa_data, NULL);
if(rc != FKO_SUCCESS)
@{
fprintf(stderr, "Error %i from fko_new_with_data\n");
fprintf(stderr, "Error from fko_new_with_data: %s\n", fko_errstr(rc));
exit(1);
@}
@@ -615,7 +615,7 @@ rc = fko_decrypt_spa_data(ctx, key);
if(rc != FKO_SUCCESS)
@{
fprintf(stderr, "Error %i from fko_decrypt_spa_data\n");
fprintf(stderr, "Error from fko_decrypt_spa_data: %s\n", fko_errstr(rc));
exit(1);
@}
@end example