Skip to content

Commit e45d33f

Browse files
committed
pretty hand-crafted manpage
1 parent c62133d commit e45d33f

File tree

1 file changed

+58
-9
lines changed

1 file changed

+58
-9
lines changed

doc/rotonda.1

Lines changed: 58 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,22 @@
22
.SH NAME
33
rotonda - A modular analytical BGP Engine
44
.SH SYNOPSIS
5-
rotonda -c, --config <FILE>
65

7-
rotonda -h, --help
6+
.B rotonda
7+
[options]
8+
89

9-
rotonda -V, --version
1010
.SH DESCRIPTION
11-
Roll your own BGP applications with programmable RIBs and Filters.
12-
BGP applications that you can build with Rotonda include, but are
13-
not limited to, a route monitor|collector|server|reflector, all
14-
this without modifying a single line in the source code of Rotonda.
11+
Roll your own BGP/BMP applications with programmable RIBs and Filters.
1512

1613
For more information please consult the online documentation at:
17-
https://rotonda.docs.nlnetlabs.nl/en/stable/
14+
https://rotonda.docs.nlnetlabs.nl/en/latest/
1815

1916
.SH OPTIONS
2017
The available options are:
2118

2219
.TP
23-
.BI -c,\ --config\ <FILE>
20+
.BI \-c\ path \fR,\ \fB\-\-config= path
2421
Specify the path to the config file to load. If no file is specified, default
2522
values will be used for all settings.
2623

@@ -31,3 +28,55 @@ Prints help information.
3128
.TP
3229
.BI -V,\ --version
3330
Prints version information.
31+
32+
.SH OPTIONS RELATED TO LOGGING
33+
34+
.TP
35+
.BI -q,\ --quiet
36+
Log less information, twice for no information
37+
38+
.TP
39+
.BI -v,\ --verbose
40+
Log more information, twice or thrice for even more
41+
42+
.TP
43+
.BI --logfile= path
44+
Log to this file
45+
46+
.TP
47+
.BI --syslog
48+
Log to syslog
49+
50+
.TP
51+
.BI --syslog-facility= facility
52+
Facility to use for syslog logging [default: daemon]
53+
54+
.SH OPTIONS FOR USE WITH THE EMBEDDED CONFIG FILE
55+
56+
.TP
57+
.BI --print-config-and-exit
58+
Prints the configuration that will be used and then exits
59+
60+
.TP
61+
.BI --http-listen= addr:port
62+
Listen for HTTP connections on this address
63+
64+
.TP
65+
.BI --bgp-listen= addr:port
66+
Listen for BGP connections on this address
67+
68+
.TP
69+
.BI --bmp-tracing-mode= Off | IfRequested | On
70+
Whether and how to enable tracing of BMP messages
71+
72+
.TP
73+
.BI --bmp-listen= addr:port
74+
Listen for BMP connections on this address
75+
76+
.TP
77+
.BI --bmp-proxy-destination= addr:port
78+
Proxy BMP connections to this address
79+
80+
.TP
81+
.BI --mqtt-destination= addr | addr:port
82+
Publish MQTT messages to this address [default port: 1883]

0 commit comments

Comments
 (0)