From 1c21d58786e11abe05a9632def2ffb087d6447c4 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 16 Oct 2003 23:00:13 +0000 Subject: documentation added git-svn-id: file:///home/lennart/svn/public/waproamd/trunk@22 022f378f-78c4-0310-b860-d162c87e6274 --- man/waproamd.8.xml.in | 359 +++++++++++++++++++++++++------------------------- 1 file changed, 180 insertions(+), 179 deletions(-) (limited to 'man') diff --git a/man/waproamd.8.xml.in b/man/waproamd.8.xml.in index 73ff3ea..e00667a 100644 --- a/man/waproamd.8.xml.in +++ b/man/waproamd.8.xml.in @@ -22,182 +22,183 @@ Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. --> - - - - waproamd [options] - - -

waproamd is a roaming daemon for wireless NICs - supporting the Linux wireless extensions. It is intended to - configure the WEP keys according to the networks found.

- -

As long as the local NIC is not associated to any wireless - network waproamd scans iteratively for them. If one is detected, - a script in @sysconfdir@/waproamd/scripts/ named - after the MAC address of the access point is called. If this - script is not existent, - @sysconfdir@/waproamd/scripts/default is called - instead. The first argument to this script is "start". If the - association is lost, the same script is run with the argument - "stop". While the NIC is associated no scans are issued.

- -

waproamd is intended to be used together with - ifplugd. Whenever an association succeeds, ifplugd detects it - and runs further configuration commands for it.

- -

If multiple WLANs are detected at the same time, the network - which is detected by the hardware first is selected. However, - networks where a matching script exists take precedence.

- -

waproamd requires a network driver supporting the Linux - wireless extensions v15 or newer. The driver needs to support - scanning for wireless networks, which may be tested by running - "iwlist scan". If the driver supports the wireless event - subsystem, waproamd may use it to improve latency - behaviour. It is not required, however.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -

@sysconfdir@/waproamd/waproamd.conf: this file is sourced - by the init script @sysconfdir@/init.d/waproamd and - contains the interface to be monitored and the options to be - used.

- -

@sysconfdir@/waproamd/scripts/<AP MAC - address>: this is called whenever a wireless network - controlled by an AP with a matching address is detected. The MAC - address is formatted lowercase. Takes the same arguments as the - following script:

- -

@sysconfdir@/waproamd/scripts/default: this is - the script which is called whenever no script named after the - AP MAC address is found. It takes a single argument: either - "start" or "stop". An environment variable AP is set to the - MAC address of the access point found. An environment variable - IFACE is set to the network interface name. The default - implementation of this script looks for a file - @sysconfdir@/waproamd/keys/<AP MAC - address>.wep. If it exists its contents is used to - set the WEP key of the NIC. Otherwise the script looks for a - file @sysconfdir@/waproamd/keys/<AP - MAC address>.aes. If it exists the AES WEP rekeying daemon - is called. Otherwise WEP - encryption is disabled.

- - -

/var/run/waproamd.<iface>.pid: the pid file - for waproamd.

- -
-
-

SIGINT, SIGTERM, SIGTQUIT waproamd will quit. This is issued by passing -k to waproamd.

-

SIGHUP waproamd will rescan for available networks immediately.

-
- -
-

waproamd was written by Lennart Poettering - <@PACKAGE_BUGREPORT@>. waproamd is available - at -

-
- -
-

- , , , -

-
- -
-

This man page was written using by Oliver Kurth.

-
- - + + + + waproamd [options] + + + + +

waproamd is a roaming daemon for wireless NICs supporting the + Linux wireless extensions. It is intended to configure the WEP + keys according to the networks found.

+ +

As long as the local NIC is not associated to any wireless + network waproamd scans iteratively for them. If one is detected, a + script in @sysconfdir@/waproamd/scripts/ named after + the MAC address of the access point is called. If this script is + not existent, @sysconfdir@/waproamd/scripts/default + is called instead. The first argument to this script is + "start". If the association is lost, the same script is run with + the argument "stop". While the NIC is associated no scans are + issued.

+ +

waproamd is intended to be used together with ifplugd. Whenever + an association succeeds, ifplugd detects it and runs further + configuration commands for it.

+ +

If multiple WLANs are detected at the same time, the network + which is detected by the hardware first is selected. However, + networks where a matching script exists take precedence.

+ +

waproamd requires a network driver supporting the Linux + wireless extensions v15 or newer. The driver needs to support + scanning for wireless networks, which may be tested by running + "iwlist scan". If the driver supports the wireless event + subsystem, waproamd may use it to improve latency behaviour. It is + not required, however.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

@sysconfdir@/waproamd/waproamd.conf: this file is sourced + by the init script @sysconfdir@/init.d/waproamd and + contains the interface to be monitored and the options to be + used.

+ +

@sysconfdir@/waproamd/scripts/<AP MAC + address>: this is called whenever a wireless network + controlled by an AP with a matching address is detected. The MAC + address is formatted lowercase. Takes the same arguments as the + following script:

+ +

@sysconfdir@/waproamd/scripts/default: this is + the script which is called whenever no script named after the + AP MAC address is found. It takes a single argument: either + "start" or "stop". An environment variable AP is set to the + MAC address of the access point found. An environment variable + IFACE is set to the network interface name. The default + implementation of this script looks for a file + @sysconfdir@/waproamd/keys/<AP MAC + address>.wep. If it exists its contents is used to + set the WEP key of the NIC. Otherwise the script looks for a + file @sysconfdir@/waproamd/keys/<AP + MAC address>.aes. If it exists the AES WEP rekeying daemon + is called. Otherwise WEP + encryption is disabled.

+ + +

/var/run/waproamd.<iface>.pid: the pid file + for waproamd.

+ +
+
+

SIGINT, SIGTERM, SIGQUIT waproamd will quit. This is issued by passing -k to waproamd.

+

SIGHUP waproamd will rescan for available networks immediately.

+
+ +
+

waproamd was written by Lennart Poettering + <@PACKAGE_BUGREPORT@>. waproamd is available + at +

+
+ +
+

+ , , , +

+
+ +
+

This man page was written using by Oliver Kurth.

+
+ + -- cgit