Commit f7e96e07 authored by Juliusz Chroboczek's avatar Juliusz Chroboczek

Document the format of interface configuration.

parent d8c78034
...@@ -122,9 +122,32 @@ as a wireless hop with no packet losses. A cost of 255 or less is ...@@ -122,9 +122,32 @@ as a wireless hop with no packet losses. A cost of 255 or less is
interpreted as a wired link. interpreted as a wired link.
.SH CONFIG FILE FORMAT .SH CONFIG FILE FORMAT
The configuration file is a sequence of lines each of which specifies The configuration file is a sequence of lines each of which specifies
a filter entry. Each of these lines has the following format: either an interface or a filtering rule. Blank lines are ignored. Comments
are introduced with an octothorp
.RB `` # ''
and terminated by the end of line.
.SS Interface configuration
An interface is configured by a single line with the following format:
.IP .IP
.I filter selector... action .B interface
.I name
.RI [ parameter ...]
.PP
.I Name
is the name of the interface (something like
.BR eth0 ).
Each
.I parameter
specifies a parameter of the given interface. It can be one of:
.IP
.I (none defined yet)
.SS Filtering rules
A filtering rule is defined by a single line with the following format:
.IP
.I filter
.IR selector ...
.I action
.PP .PP
.I Filter .I Filter
specifies the filter to which this entry will be added, and can be one of specifies the filter to which this entry will be added, and can be one of
...@@ -133,7 +156,8 @@ specifies the filter to which this entry will be added, and can be one of ...@@ -133,7 +156,8 @@ specifies the filter to which this entry will be added, and can be one of
or or
.BR redistribute . .BR redistribute .
.I Selector Each
.I selector
specifies the conditions under which the given statement matches. It specifies the conditions under which the given statement matches. It
can be one of can be one of
.TP .TP
......
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