load system config file; document config options
[linksys-wrt3g-tools.git] / README
1 Linksys WRT3G UMTS router tools
2 ===============================
3
4 Tools to retrieve status information from a WRT3G Linksys router,
5  reboot it and a munin plugin to track the connection state.
6
7
8 The routers are also known under the names:
9 - Wireless-G Router for 3G/UMTS Broadband
10 - Linksys WRT54G3G-EU Wireless-G UMTS Router
11 - WRT54G3G
12
13
14 Configuration
15 -------------
16 The tools can be configured in three ways:
17 1. Commandline options
18    Use --help to get an overview
19
20 2. User configuration file
21    ~/.config/linksys-wrt3g-tools
22
23 3. System configuration file
24    /etc/linksys-wrt3g-tools
25
26 The configuration files are normal ini-style files with key=value
27 lines. Supported configuration options in the files are
28  - host
29  - user
30  - password
31
32
33 Dependencies
34 ------------
35 - PEAR Config package
36 - PEAR System_Folders package