Commit f8c441d7 authored by Juliusz Chroboczek's avatar Juliusz Chroboczek

Manual page improvements.

parent 4e27473a
...@@ -9,39 +9,51 @@ sroamd \- simple roaming daemon ...@@ -9,39 +9,51 @@ sroamd \- simple roaming daemon
] ]
.IR interface ... .IR interface ...
.SH DESCRIPTION .SH DESCRIPTION
.B Sroamd The
makes it possible to seamlessly roam between IP links (e.g. WiFi .B sroamd
access points) with no changes to clients. There is no central controller, daemon implements a distributed protocol thatmakes it possible to
and no tunnelling is involved. seamlessly roam between IP links (e.g. WiFi access points) with no changes
to clients. There is no central controller, and no tunnelling is
involved.
The daemon implements a custom DHCPv4 server, an IPv4 RA server and The daemon implements a custom DHCPv4 server, an IPv4 Router Advertisement
a custom peer-to-peer flooding algorithm. It depends on hostapd for (RA) server, and a custom peer-to-peer flooding algorithm. It requires
link-layer configuration, and a routing protocol able to efficiently deal an external agent such as
with host routes (for example Babel). .B hostapd
to perform link-layer configuration, and a routing protocol such as
.I Babel
to distribute host routes within the roaming domain.
.SH OPTIONS .SH OPTIONS
.TP .TP
.BI \-d " level" .BI \-d " level"
Set the verbosity of debugging messages. Set the verbosity of debugging messages.
.TP .TP
.BI \-P " prefix" .BI \-P " prefix"
Configure the prefix used for roaming clients. \TP \BI \-N Configure the Set the prefix used for roaming clients. This option may be specified
nameserver address that will be announced to clients over DHCPv4 or IPv6 twice, once with an IPv4 prefix and once with an IPv6 prefix.
RA. .TP
.BI \-N " address"
Configure the nameserver address that will be announced to clients over
DHCPv4 or IPv6 RA. This option may be specified multiple times, in which
case all prefixes will be announced to clients.
.TP .TP
.BI \-a " address" .BI \-a " address"
Bind the DHCPv4 server to the given address. Bind the DHCPv4 server to the given address. This is optional, and if
used must be set to the IPv4 address assigned to the interface or
interfaces that support roaming.
.TP .TP
.BI \-f " port" .BI \-f " port"
Set the local port used by the flooding protocol. If this is not set, Set the local UDP port used by the flooding protocol. If this is not set,
flooding is disabled. flooding is disabled.
.TP .TP
.BI \-F " address:port" .BI \-F " address:port"
Configure a neighbour for the flooding protocol. There is no automatic Specify the address of a remote peer for the flooding protocol. There is
neighbour discovery, you must configure enough neighbours to ensure that no automatic neighbour discovery, you must configure enough peers to
your network remains connected. The remote address must be a unicast ensure that the network remains connected. The address must be a unicast
address, either IPv4 or IPv6. address, either IPv4 or IPv6; in the latter case, the address must be
specified within square brackets.
.SH SEE ALSO .SH SEE ALSO
.BR babeld (8). .BR babeld (8).
.SH AUTHOR .SH AUTHOR
Juliusz Chroboczek Juliusz Chroboczek
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment