aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRPKI Documentation Robot <docbot@rpki.net>2012-05-23 03:00:09 +0000
committerRPKI Documentation Robot <docbot@rpki.net>2012-05-23 03:00:09 +0000
commit0b771701b52d7b0fa0c324164433a8d195b83dd3 (patch)
tree0343c09da12c43a69aebde7298d55e2ef4495456 /doc
parent0d6024f1c55a1c4bd2e52a466da361589a826aa0 (diff)
Automatic pull of documentation from Wiki.
svn path=/trunk/; revision=4514
Diffstat (limited to 'doc')
-rw-r--r--doc/doc.RPKI.RP19
-rw-r--r--doc/doc.RPKI.RP.rcynic29
-rw-r--r--doc/manual.pdfbin460236 -> 460205 bytes
3 files changed, 20 insertions, 28 deletions
diff --git a/doc/doc.RPKI.RP b/doc/doc.RPKI.RP
index 9eabf043..19592222 100644
--- a/doc/doc.RPKI.RP
+++ b/doc/doc.RPKI.RP
@@ -93,8 +93,8 @@ On FreeBSD or MacOSX, this script might look like this:
#!/bin/sh -
/usr/sbin/chroot -u rcynic -g rcynic /var/rcynic /bin/rcynic -c /etc/
rcynic.conf || exit
- /usr/local/bin/python /var/rcynic/etc/rcynic.py /var/rcynic/data/rcynic.xml /
- var/rcynic/data/rcynic.html
+ /var/rcynic/bin/rcynic-html /var/rcynic/data/rcynic.xml /usr/local/www/data/
+ rcynic
cd /var/rpki-rtr
/usr/bin/su -m rcynic -c '/usr/local/bin/rtr-origin --cronjob /var/rcynic/
data/authenticated'
@@ -109,8 +109,7 @@ On Linux, the script might look like this:
#!/bin/sh -
/usr/sbin/chroot --userspec rcynic:rcynic /var/rcynic /bin/rcynic -c /etc/
rcynic.conf || exit
- /usr/local/bin/python /var/rcynic/etc/rcynic.py /var/rcynic/data/rcynic.xml /
- var/rcynic/data/rcynic.html
+ /var/rcynic/bin/rcynic-html /var/rcynic/data/rcynic.xml /var/www/rcynic
cd /var/rpki-rtr
/usr/bin/su -m rcynic -c '/usr/local/bin/rtr-origin --cronjob /var/rcynic/
data/authenticated'
@@ -162,10 +161,8 @@ Script for a downstream relying party using ssh might look like this:
do
/usr/sbin/chroot -u rcynic -g rcynic /var/rcynic /bin/rcynic -c /etc/
rcynic.conf -u /data/unauthenticated.${host}
- /usr/local/bin/python /var/rcynic/etc/rcynic.py /var/rcynic/data/rcynic.xml
- /var/rcynic/data/rcynic.html
- /bin/cp -p /var/rcynic/data/rcynic.html /var/rcynic/data/rcynic.$
- {host}.html
+ /var/rcynic/bin/rcynic-html /var/rcynic/data/rcynic.xml /usr/local/www/
+ data/rcynic.${host}
done
cd /var/rpki-rtr
/usr/bin/su -m rcynic -c '/usr/local/bin/rtr-origin --cronjob /var/rcynic/
@@ -195,10 +192,8 @@ configuration would look more like this:
do
/usr/sbin/chroot -u rcynic -g rcynic /var/rcynic /bin/rcynic -c /etc/
rcynic.conf -u /data/unauthenticated.${host}
- /usr/local/bin/python /var/rcynic/etc/rcynic.py /var/rcynic/data/rcynic.xml
- /var/rcynic/data/rcynic.html
- /bin/cp -p /var/rcynic/data/rcynic.html /var/rcynic/data/rcynic.$
- {host}.html
+ /var/rcynic/bin/rcynic-html /var/rcynic/data/rcynic.xml /usr/local/www/
+ data/rcynic.${host}
done
cd /var/rpki-rtr
/usr/bin/su -m rcynic -c '/usr/local/bin/rtr-origin --cronjob /var/rcynic/
diff --git a/doc/doc.RPKI.RP.rcynic b/doc/doc.RPKI.RP.rcynic
index 07aec45f..fe73ecbb 100644
--- a/doc/doc.RPKI.RP.rcynic
+++ b/doc/doc.RPKI.RP.rcynic
@@ -504,43 +504,40 @@ binary option:
**** rcynic.py ****
-An earlier attempt at what rcynic-html now does. Kept for backwards
-compatability, but will go away soon. Use rcynic-html instead.
+An earlier attempt at what rcynic-html now does. Kept briefly for backwards
+compatability, but no longer maintained and will go away soon. Use rcynic-html
+instead.
**** rcynic.xsl ****
-An earlier attempt at the same kind of HTML display as rcynic.py. XSLT was a
+An earlier attempt at the same kind of HTML display as rcynic-html. XSLT was a
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, lacks some of
-rcynic.py's features, and is no longer under development.
+warned that it's significantly slower than rcynic-html, lacks many features,
+and is no longer under development.
-Usage:
-
- $ xsltproc -o rcynic.html rcynic.xsl rcynic.xml
-
-**** show.xsl / show.sh ****
+**** rcynic-text ****
Provides a quick flat text summary of validation results. Useful primarily in
test scripts (smoketest uses it).
Usage:
- $ sh show.sh rcynic.xml
+ $ rcynic-text rcynic.xml
-**** validation_status.xsl / validation_status.awk ****
+**** validation_status.py ****
Provides a flat text translation of the detailed validation results. Useful
primarily for checking the detailed status of some particular object or set of
-objects, most likely using a program like grep or awk to filter the output.
+objects, most likely using a program like grep to filter the output.
Usage:
- $ awk -f validation_status.awk rcynic.xml
- $ awk -f validation_status.awk rcynic.xml | fgrep rpki.misbehaving.org
- $ awk -f validation_status.awk rcynic.xml | fgrep object_rejected
+ $ python validation_status.py rcynic.xml
+ $ python validation_status.py rcynic.xml | fgrep rpki.misbehaving.org
+ $ python validation_status.py rcynic.xml | fgrep object_rejected
***** Running rcynic chrooted *****
diff --git a/doc/manual.pdf b/doc/manual.pdf
index a1ae9d36..7b7d6a46 100644
--- a/doc/manual.pdf
+++ b/doc/manual.pdf
Binary files differ