blob: 8a8f9375ee56a6b0e9bc56e6aa9d149a54ef49f7 [file] [log] [blame]
San Mehatffd68722010-01-20 09:56:15 -08001
2This is the README for the DNSmasq webmin module.
3
4Problems:
5
61) There's only basic error checking - if you enter some bad
7addresses or names, they will go straight into the config file
8although we do check for things like IP addresses being of
9the correct form (no letters, 4 groups of up to 3 digits
10separated by dots etc). One thing that ISN'T CHECKED FOR is
11that IP dotted quads are all numbers < 256. Another is that
12netmasks are logical (you could enter a netmask of 255.0.255.0
13for example). Essentially, if it'll pass the config file
14regex scanner (and the above examples will), it won't be
15flagged as "bad" even if it is a big no-no for dnsmasq itself.
16
172) Code is ugly and a kludge - I ain't a programmer! There are probably
18a lot of things that could be done to tidy up the code - eg,
19it probably wouldn't hurt to move some common stuff into the lib file.
20
213) I've used the %text hash and written an english lang file, but
22I am mono-lingual so no other language support as yet.
23
244) for reasons unknown to me, the icon does not appear properly
25on the servers page of webmin (at least it doesn't for me!)
26
275) icons have been shamelessly stolen from the ipfilter module,
28specifically the up and down arrows.
29
306) if you delete an item, the config file will contain
31an otherwise empty, but commented line. This means that if
32you add some new stuff, then delete it, the config file
33will have a number of lines at the end that are just comments.
34Therefore, the config file could possibly grow quite large.
35
367) NO INCLUDE FILES!
37if you use an include file, it'll be flagged as an error.
38OK if the include file line is commented out though.
39
408) deprecated lines not supported (eg user and group) - they
41may produce an error! (user and group don't, but you can't change
42them)
43
44IOW, it works, it's just not very elegant and not very robust.
45
46Hope you find it useful though - I do, as I prevents me having to ever
47wade through the config file and man pages again.
48
49If you modify it, or add a language file, and you have a spare moment,
50please e-mail me - I won't be upset at all if you fix my poor coding!
51(rather the opposite - I'd be pleased someone found it usefull)
52
53Cheers,
54 Neil Fisher <neil@magnecor.com.au>