Artyom A Anikeev

added basic info for man

... ... @@ -14,6 +14,7 @@ bond0_MODE=balance-rr
bond0_VLAN_N_BRIDGES=(
10.2:thor.ext
#Is it works?
10.3:cps
10.4
10.5
... ...
... ... @@ -5,23 +5,131 @@
.SH NAME
ipw \- simple network interface configuration
.SH SYNOPSIS
.B clsync [ ... ]
.B ipw [ ... ]
.SH DESCRIPTION
.B ipw
provides bonding, bridging and .1q tagging using sysfs and the
.BR ip (8)
utility.
.BR ip
(8) utility.
Simple configurational fiales are supported.
Simple configurational files are supported.
.SH COMMAND SYNTAX
TODO
.B fix
.RS 8
fixes current network state to configurational one.
.B ipw
tries to keep interfaces up during reconfiguretion, if possible.
.PP
.RE
.B down
.RS 8
bringes all interfaces down, deletes bondings and bridges.
.PP
.RE
.SH EXAMPLES
TODO
.RE
.SH FILES
.I /etc/ipw.conf
.RS 8
definition of network interfaces.
Lines starting with `#' are ignored. Note that end-of-line comments
are NOT supported, comments must be on a line of their own.
A line may be extended across multiple lines by making the last
character a backslash.
The file consists of D1Q_IFACES,
.BR $NAME _SLAVES,
.BR $NAME _MODE,
.BR $NAME _VLAN_N_BRIDGES,
.BR $NAME _IP
variables. Here is an example.
#This is a comment
D1Q_IFACES=(bond0 bond1)
bond0_SLAVES=(eth0 eth1)
bond1_SLAVES=(eth2)
bond0_MODE=balance-rr
bond0_VLAN_N_BRIDGES=(
10.2:thor.ext
10.3:cps
10.4
50
12:
:cps.int
)
bond1_VLAN_N_BRIDGES=(
441
:cps.int
)
thor_ext_IP=(
"addr add 10.10.2.2/24"
"route add default via 10.10.2.1"
)
vlan10_5_IP=(
"addr add 10.10.5.0/24"
)
.B VARIABLES
.HP
D1Q_IFACES
are required to identify bonging master names.
.HP
.BR $NAME _SLAVES
specifies slave interfaces for each master.
.HP
.BR $NAME _MODE
specifies bonding mode for each master. Default is 802.3ad.
.HP
.BR $NAME _VLAN_N_BRIDGES
specifies vlans and bridges for each master. Syntax is as foolow:
vlan.subvlan:bridge-name. Subvlan means parent (outer tag) vlan for
QinQ vlan (inner tag) interfaces (see 802.1ad).
Symbol `.' in bridge name is not a special symbol.
If :bridge is not set then "vlan$VLAN.$SUBVLAN"/"vlan$VLAN" is
used as bridge name
If bridge is set to "" then vlan inetrface is created without
creating a bridge to be enslaved by
If vlan.subvlan is set to "" then bridge is created without creating
and enslaving the vlan interface
.HP
.BR $NAME _IP
specifies commands for
.B ip
(8) uility for each interface, if required.
.PP
.RE
.SH AUTHOR
Dmitry Yu Okunev <dyokunev@ut.mephi.ru> 0x8E30679C
Artyom A Anikeev <anikeev@ut.mephi.ru> 0xB5385841
.RE
Dmitry Yu Okunev <dyokunev@ut.mephi.ru> 0x8E30679C
.SH SUPPORT
TODO
.SH "SEE ALSO"
.BR ip (8)
.BR ip (8).
... ...