20ef34dddc3846b6dddda2385e73b7aefc3d1a44
[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. Environment variables
21
22 3. User configuration file
23    ~/.config/linksys-wrt3g-tools
24
25 4. System configuration file
26    /etc/linksys-wrt3g-tools
27
28 The configuration files are normal ini-style files with key=value
29 lines.
30 Supported configuration options in the files, and environment variables, are
31  - host
32  - user
33  - password
34 (lowercase)
35
36
37 Dependencies
38 ------------
39 - PEAR Config package
40 - PEAR System_Folders package