aboutsummaryrefslogtreecommitdiff
path: root/rpkid.with_tls/doc/README
diff options
context:
space:
mode:
authorRob Austein <sra@hactrn.net>2010-10-07 00:12:50 +0000
committerRob Austein <sra@hactrn.net>2010-10-07 00:12:50 +0000
commit8ada594d05c4e79fc2e3a13b50489bb75bd90cae (patch)
tree96b1f0a63a0f75cfa49078f1768d13c772c5636a /rpkid.with_tls/doc/README
parentfe3d8174f81370ca80d1d47158959ec3eb9d4eee (diff)
Stash a copy of pre-conversion (with TLS) tree temporarily, in case of
problems during switchover. Will clean this up after testbed is back up without TLS. svn path=/rpkid.with_tls; revision=3464
Diffstat (limited to 'rpkid.with_tls/doc/README')
-rw-r--r--rpkid.with_tls/doc/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/rpkid.with_tls/doc/README b/rpkid.with_tls/doc/README
new file mode 100644
index 00000000..8430bcf0
--- /dev/null
+++ b/rpkid.with_tls/doc/README
@@ -0,0 +1,17 @@
+$Id$
+
+Documentation for rpkid and friends.
+
+Most of the files in this directory are automatically generated from
+the source code. Most of the hand-written documentation for rpkid and
+friends is written using Doxygen markup so that it will all appear in
+the manual.
+
+The primary tool for generating documentation is Doxygen, which
+produces the HTML and PDF versions of the manual. Certain pages are
+also dumped from HTML to flat text.
+
+See rpkid/Makefile for details on how all this happens.
+
+The full manual is available in both PDF and HTML formats; the PDF is
+in manual.pdf, the HTML is in a compressed tarball manual.tar.gz.