Update documentation
[public/hosts.git] / README
1 INSTALL
2 -------
3
4 $ virtualenv .venv
5 $ . .venv/bin/activate
6 $ pip install -r requirements.txt
7
8 GENERATE
9 --------
10
11 $ . .venv/bin/activate
12 $ ./generate_hosts.py < hosts.in > hosts
13
14
15 FORMAT OF HOSTS
16 ---------------
17
18 There are 4 types of lines:
19
20 - Whitespace
21 - Lines starting with # are a comment
22 - Lines starting with a ! are copied word-for-word (minues the bang)
23 - Other lines are resolved through DNS
24
25 EXAMPLE
26 -------
27
28 * hosts.in
29
30 # HOSTS
31 !127.0.0.1 localhost
32 hostname.csclub.uwaterloo.ca
33
34 * hosts
35 127.0.0.1 localhost
36 129.97.134.111 hostname.csclub.uwaterloo.ca hostname