.TH PEWIT 8 "15 Sep 2003" "PEWIT version @VERSION@" Nexedi
.SH NAME
pewit.conf \- PEWIT configuration file
.SH DESCRIPTION
.B "pewit.conf"
is the configuration file for \fBPEWIT\fR.
Each line, which starts by '#', is a comment and just ignored.
Also, you may insert spaces as you wish.
.LP
The file contains entries of either of these forms:
.RS
\fINAME\fR \fB=\fR \fIVALUE\fR
.RE
and
.RS
\fINAME\fR \fB{ ... }\fR
.RE
.LP
The latter form defines a group of definitions, while the former is
one definition. if \fIVALUE\fR is a string instead of a number,
you must quote the string by double-quotes.
.TP
\fBmode\fR \fB=\fR [ \fB"master"\fR | \fB"slave"\fR ]
Specify in which mode PEWIT runs.
.TP
\fBinner\-device {\fR ... \fB}\fR
Specify the inner device of the machine. This is normally a virtual
ethernet device provided with TUN/TAP. See the DEVICE section
for more details.
.TP
\fBouter\-device {\fR ... \fB}\fR
Specify the outer device of the machine. This is normally a wireless
ethernet device. See the DEVICE section for more details.
.TP
\fBtimeout =\fR \fIMS\fR
The timeout to wait for a reply from slave, in milliseconds. This is
optional and only effective for master.
.TP
\fBsend-time =\fR \fIMS\fR
The maximum amount of time to send packets, in milliseconds. This is
optional and only effective for master.
.TP
\fBaggregation-time =\fR \fIMS\fR
The maximum amount of time to aggregate packets, in milliseconds. This is
optional and only effective for master.
.TP
\fBslave {\fR ... \fB}\fR
Define a slave pewit. You may define as many slaves as necessary.
This is used only by master. See the SLAVE section for more details.
.SH DEVICE
The groups \fBinner\-device\fR and \fBouter\-device\fR have similar structures.
Each of them defines a device to be used and some optional parameters.
.TP
\fBtype =\fR [ \fB"tuntap"\fR | \fB"packet"\fR ]
Choose either of them. \fBtuntap\fR is for a virtual ethernet device
usually used in the inner device. \fBpacket\fR is for a physical ethernet
device and supported by Linux's packet socket driver.
.TP
\fBname =\fR \fIDEV\fR
This specifies the name of an ethernet device.
.TP
\fBaddress =\fR \fIADDR\fR
The IP address of the device to be used. Only IPv4 is supported at the
moment. This is optional but it is better to specify this for the inner
device.
.TP
\fBbroadcast =\fR \fIBRADDR\fR
The broadcast IP address of the device to be used. Only IPv4 is supported
at the moment. This is optional but it is better to specify this for the
inner device.
.TP
\fBhardware\-address =\fR \fIHWADDR\fR
The MAC address of the device. Normally, you don't have to set this, 
because TUN/TAP automatically chooses an unique address.
.SH SLAVE
The group \fBslave\fR defines a slave pewit. You only need to set
one parameter for each slave.
.TP
\fBhardware\-address =\fR \fIHWADDR\fR
The MAC address of the outer device of the slave. Be careful, because
if you make a mistake here, the slave cannot send any data.
.SH "SEE ALSO"
\fIpewit(8)\fR,
\fIhttp://pewit.org\fR