diff options
| author | RPKI Documentation Robot <docbot@rpki.net> | 2012-05-16 00:01:49 +0000 |
|---|---|---|
| committer | RPKI Documentation Robot <docbot@rpki.net> | 2012-05-16 00:01:49 +0000 |
| commit | 53389d949cbe4a338341a5bddc4940065c80b74b (patch) | |
| tree | ea79970e6830f92eaaaa31f45c05e448234bf2b2 | |
| parent | c914bdc450530fd1bbc156ff3281750e43a1e6f9 (diff) | |
Automatic pull of documentation from Wiki.
svn path=/trunk/; revision=4494
| -rw-r--r-- | doc/doc.RPKI.CA.UI.GUI | 3 | ||||
| -rw-r--r-- | doc/doc.RPKI.RP.rcynic | 23 | ||||
| -rw-r--r-- | doc/manual.pdf | bin | 458675 -> 458733 bytes |
3 files changed, 22 insertions, 4 deletions
diff --git a/doc/doc.RPKI.CA.UI.GUI b/doc/doc.RPKI.CA.UI.GUI index 5949c589..e69de29b 100644 --- a/doc/doc.RPKI.CA.UI.GUI +++ b/doc/doc.RPKI.CA.UI.GUI @@ -1,3 +0,0 @@ -****** RPKI CA Engine GUI Interface ****** - -Documentation not written yet. diff --git a/doc/doc.RPKI.RP.rcynic b/doc/doc.RPKI.RP.rcynic index a8dbaeca..1cd14f97 100644 --- a/doc/doc.RPKI.RP.rcynic +++ b/doc/doc.RPKI.RP.rcynic @@ -489,6 +489,26 @@ Usage: $ python rcynic.py rcynic.xml rcynic.html +rcynic.py can also generate a more complicated set of HTML pages including +graphs showing a history of rsync transfer time and repository object count for +each repository rcynic found during its tree walk. In this mode, rcynic.py +needs an output directory (which it will create, if needed) because it has to +write several graphs and an HTML page for each repository, as well as a master +HTML file which it will write out as index.html in the specified directory. + +This mode requires rrdtool, a specialized database and graphing engine designed +for this sort of work. + +Usage: + + $ python rcynic.py --show-graphs rcynic.xml /web/server/directory/ + +If rrdtool isn't on rcynic.py's search path and you need to give its location +explictly, you can do so using the --rrdtool-binary option: + + $ python rcynic.py --show-graphs --rrdtoolbinary /some/where/unusual/rrdtool + rcynic.xml /web/server/directory/ + **** rcynic.xsl **** An earlier attempt at the same kind of HTML display as rcynic.py. XSLT was a @@ -496,7 +516,8 @@ convenient language for our initial attempts at this, but as the processing got more and more complex, the speed and flexibility restrictions of XSLT became prohibitive. If for some reason XSLT works better in your environment than Python, you might find this stylesheet to be a useful starting point, but be -warned that it is significantly slower than rcynic.py. +warned that it is significantly slower than rcynic.py, lacks some of +rcynic.py's features, and is no longer under development. Usage: diff --git a/doc/manual.pdf b/doc/manual.pdf Binary files differindex 3db3e677..d2fc3bcd 100644 --- a/doc/manual.pdf +++ b/doc/manual.pdf |