From 4abc116e3d8718abded87cda20b7ae1b5cc7e913 Mon Sep 17 00:00:00 2001
From: Martin Hoffmann <hn@nvnc.de>
Date: Tue, 12 Feb 2019 14:08:36 +0100
Subject: [PATCH] Add documentation.

---
 doc/routinator.1 | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/doc/routinator.1 b/doc/routinator.1
index 0e875f7..545b159 100644
--- a/doc/routinator.1
+++ b/doc/routinator.1
@@ -312,7 +312,7 @@ Routinator supports both protocol version 0 defined in RFC 6810 and version
 1 defined in RFC 8210. However, it does not support router keys introduced
 in version 1.
 .TP
-.BI \-l\ addr:port\fR, \ \-\-listen= addr:port
+.BI \-l\  addr:port\fR,\ \fB\-\-listen=\fIaddr:port
 Specifies the local address and port to listen on for incoming RTR
 connections. IPv6 addresses must be enclosed in square brackets. You can
 provide the option multiple times to let Routinator listen on multiple
@@ -324,6 +324,15 @@ Note how this is a localhost address for security reasons. We also don't
 use the standard RTR port 323 as this is a privileged port that would
 require Routinator to be run as root or otherwise receive permission which
 otherwise isn't necessary at all.
+.TP
+.BI \-\-listen\-http= addr:port
+Specifies the address and port to listen on for incoming HTTP connections.
+See
+.B HTTP SERVICE
+below for more information on the HTTP service provided by Routinator.
+.IP
+If this option is omitted, no HTTP service will be provided.
+
 .TP
 .BI \-\-refresh= seconds
 The amount of seconds the server should wait after having finished updating
@@ -555,6 +564,35 @@ process.
 A string value containing the path any daemon process should use as its
 root directory.
 
+.SH HTTP SERVICE
+When run in
+.B rtrd
+mode, Routinator can provide an HTTP service in addtion to the RTR service.
+The primary intention of this service is to allow integration into
+monitoring systems. The service only supports GET requests with the following
+paths:
+
+.TP
+.B /csv
+Returns the current set of VRPs in
+.B csv
+output format.
+.TP
+.B /json
+Returns the current set of VRPs in
+.B json
+output format.
+.TP
+.B /openbgpd
+Returns the current set of VRPs in
+.B openbgpd
+output format.
+.TP
+.B /rpsl
+Returns the current set of VRPs in
+.B rpsl
+output format.
+
 .SH RELAXED VALIDATION
 The documents defining RPKI include a number of very strict rules
 regarding the formatting of the objects published in the RPKI repository.