diff options
Diffstat (limited to 'doc/man/ouroboros.8')
| -rw-r--r-- | doc/man/ouroboros.8 | 63 |
1 files changed, 32 insertions, 31 deletions
diff --git a/doc/man/ouroboros.8 b/doc/man/ouroboros.8 index 0958f615..df328fcc 100644 --- a/doc/man/ouroboros.8 +++ b/doc/man/ouroboros.8 @@ -1,8 +1,8 @@ -.\" Ouroboros man pages CC-BY 2017 - 2020 -.\" Dimitri Staessens <dimitri.staessens@ugent.be> -.\" Sander Vrijders <sander.vrijders@ugent.be> +.\" Ouroboros man pages CC-BY 2017 - 2024 +.\" Dimitri Staessens <dimitri@ouroboros.rocks> +.\" Sander Vrijders <sander@ouroboros.rocks> -.TH OUROBOROS 8 2018-03-10 Ouroboros "Ouroboros User Manual" +.TH OUROBOROS 8 2020-11-29 Ouroboros "Ouroboros User Manual" .SH NAME @@ -99,10 +99,9 @@ In order to enroll an IPC process in a layer, some other member will have to be reachable over a lower layer. IPCPs that wrap a legacy transmission technology are all bootstrapped and thus need not enroll as they work directly over a physical connection. Ouroboros currently -supports IPCPs over shared memory (local), L1 (raptor, experimental), -L2 (eth-llc and eth-dix) and L3 (udp). The unicast and broadcast -layers require connections to be established between IPCP components -for its operation. +supports IPCPs over shared memory (local), L2 (eth-llc and eth-dix) +and L3 (udp). The unicast and broadcast layers require connections to +be established between IPCP components for its operation. \fBConnecting the management components\fR using \fImanagement flows\fR allows management information to be sent between IPCPs so @@ -124,8 +123,6 @@ creates an IPCP process of type \fItype\fR in the system with name .PP \fBlocal\fR - create a loopback IPCP. .PP -\fBraptor\fR - create an IPCP that attaches to a raptor NetFPGA device. -.PP \fBeth-llc\fR - create an IPCP that attaches to Ethernet using LLC frames. .PP \fBeth-dix\fR - create an IPCP that attaches to Ethernet using DIX frames. @@ -162,16 +159,6 @@ Values for [\fIparam\fR] are dependent on \fItype\fR: default: SHA3_256. .RE -\fBraptor\fR -.RS 4 -.PP -[hash \fIpolicy\fR] specifies the hash function used for the directory, -.br -\fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512. -.br -default: SHA3_256. -.RE - .PP \fBeth-llc\fR .RS 4 @@ -208,18 +195,14 @@ default: SHA3_256. .PP ip \fIip\fR specifies the local IP address to bind to .PP -[dns \fdns\fR] specifies an optional DDNS server that will be used for +[dns \fIdns\fR] specifies an optional DDNS server that will be used for the directory. .PP -[cport \fcport\fR] specifies a client UDP port that will be used for -sending packets. -.br -default: A random UDP port in the ephemeral range -.PP -[sport \fsport\fR] specifies a server UDP port that is used for +[port \fIport\fR] specifies a UDP port that is used for sending and receiving ouroboros traffic. This must be the same for the entire UDP layer. Parallel UDP layers should use different ports. This UDP port -needs to be forwarded if the server is behind a NAT. +needs to be forwarded if the server is behind a NAT and wants to +receive incoming requests. .br default: 3435 .RE @@ -247,11 +230,29 @@ default: flat. .PP [routing \fIpolicy\fR] specifies the routing policy. .br -\fIpolicy\fR: link_state, lfa. +\fIpolicy\fR: +.RS 4 +link_state: default shortest-path link-state routing. +.br +lfa: loop-free alternate resilient routing. +.br +ecmp: equal-cost multipath routing. +.RE .br default: link_state. .PP -[hash \fIpolicy\fR] specifies the hash function used for the directory, +[congestion \fIpolicy\fR] specifies the congestion avoidance policy. +.br +\fIpolicy\fR: +.RS 4 +none: no congestion avoidance. +.br +mb-ecn: Multi-bit explicit congestion notification and avoidance. +.RE +.br +default: mb-ecn. +.PP +[hash \fIpolicy\fR] specifies the hash function used for the directory. .br \fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512. .br @@ -265,7 +266,7 @@ name and the layer name. \fBbroadcast\fR .RS 4 .PP -[hash \fIpolicy\fR] specifies the hash function used for the layer name, +[hash \fIpolicy\fR] specifies the hash function used for the layer name. .br \fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512. .br |