batman-adv: Add documentation.

diff --git a/man/Makefile b/man/Makefile
index d4d266389310ddb1d1e57848e710340bc4044ee6..537c29b32d30c5e8ff28bb26aea8c3721d0c7d98 100644 (file)
--- a/man/Makefile
+++ b/man/Makefile
@@ -30,6 +30,8 @@ MANPAGES8   = \
        network-config.8 \
        network-device.8 \
        network-dns-server.8 \
+       network-port-batman-adv.8 \
+       network-port-batman-adv-port.8 \
        network-route.8 \
        network-zone.8 \
        network-zone-bridge.8 \

diff --git a/man/network-port-batman-adv-port.8.in b/man/network-port-batman-adv-port.8.in
new file mode 100644 (file)
index 0000000..97b6c66
--- /dev/null
+++ b/man/network-port-batman-adv-port.8.in
@@ -0,0 +1,62 @@
+.TH network-port-batman-adv-port 8 "11 Mar 2013" "@VERSION@" "network man page"
+
+.SH NAME
+network-port-batman-adv-port \- Network Configuration Control Program
+
+.SH SYNOPSIS
+\fBnetwork [OPTIONS] port create batman-adv-port ...\fR
+.P
+Parameters may be edited with the following command:
+.P
+\fBnetwork [OPTIONS] port <port> edit ...\fR
+
+.SH DESCRIPTION
+This hook configures a wireless device that is then used as a port
+in the batman-adv hook.
+
+.SH OPTIONS
+The \fBbatman-adv-port\fR hook offers various configuration options:
+
+\fB--address\fR = ...
+.RS 4
+Define the MAC address of the interface. If no address is defined,
+a random one will be generated.
+.RE
+.PP
+
+\fB--channel\fR = [0-9]+
+.RS 4
+Set the channel number of the channel that should be used for
+the wireless network.
+.RE
+.PP
+
+\fB--country-code\fR = ...
+.RS 4
+Set the country code for the wireless interface.
+.RE
+.PP
+
+\fB--phy\fR = ...
+.RS 4
+Use this wireless phy to create the interface.
+.RE
+.PP
+
+\fB--ssid\fR = ...
+.RS 4
+Define the ESSID of the wireless network.
+.RE
+.PP
+
+\fB--mesh-id\fR = ...
+.RS 4
+Define the mesh id or BSSID of the wireless network.
+.RE
+.PP
+
+.SH SEE ALSO
+network(8), network-port-batman-adv(8)
+
+.SH AUTHOR
+Michael Tremer (michael.tremer@ipfire.org)

diff --git a/man/network-port-batman-adv.8.in b/man/network-port-batman-adv.8.in
new file mode 100644 (file)
index 0000000..8e2c88a
--- /dev/null
+++ b/man/network-port-batman-adv.8.in
@@ -0,0 +1,50 @@
+.TH network-port-batman-adv 8 "11 Mar 2013" "@VERSION@" "network man page"
+
+.SH NAME
+network-port-batman-adv \- Network Configuration Control Program
+
+.SH SYNOPSIS
+\fBnetwork [OPTIONS] port create batman-adv ...\fR
+.P
+Parameters may be edited with the following command:
+.P
+\fBnetwork [OPTIONS] port <port> edit ...\fR
+
+.SH DESCRIPTION
+The batman-adv hook creates a batman-adv soft interface, which is
+used to bridge several hard interfaces (wireless adapters, etc.).
+
+.SH OPTIONS
+The \fBbatman-adv\fR hook offers various configuration options:
+
+\fB--address\fR = ...
+.RS 4
+Define the MAC address of the interface. If no address is defined,
+a random one will be generated.
+.RE
+.PP
+
+\fB--slaves\fR = ... (only on create)
+.RS 4
+Define a list of ports, which should be used as slaves.
+All slaves must be \fBbatman-adv-ports\fR ports.
+.RE
+.PP
+
+\fB--add-slave\fR = ... (only on edit)
+.RS 4
+Adds an additional slave port.
+.RE
+.PP
+
+\fB--del-slave\fR = ... (only on edit)
+.RS 4
+Removes a slave port.
+.RE
+.PP
+
+.SH SEE ALSO
+network(8), network-port-batman-adv-port(8)
+
+.SH AUTHOR
+Michael Tremer (michael.tremer@ipfire.org)