]> git.refcnt.org Git - distdns.git/blob - distdns.pod
First draft of documentation
[distdns.git] / distdns.pod
1 =head1 NAME
2
3 distdns - Distribute hostnames between clients
4
5 =head1 SYNOPSIS
6
7 ./client.pl [options]
8
9 =head1 DESCRIPTION
10
11 The distdns scripts originated as an alternative to established dynamic DNS services.
12
13 It features basically two scripts: client-side F<client.pl> and server-side F<server.cgi>.
14 The client sends (once configured) personal network/computer/user name data to the server
15 which stores it as JSON if access is granted and data is complete.
16
17 When F<client.pl> is invoked (preferably by a scheduler, for example: cronjob), it also
18 receives hostnames with according IP addresses which are written to a matching network
19 marker within the hosts file. This allows then to use these hostnames to connect to
20 machines.
21
22 =head1 OPTIONS
23
24 -d, --debug server debugging
25 -h, --help this help screen
26 -i, --init initialize session data
27
28 =over 4
29
30 =item * C<-d, --debug>
31
32 Enable "server debugging" in order to communicate fatal errors back to the client script.
33
34 =item * C<-h, --help>
35
36 Show usage screen.
37
38 =item * C<-i, --init>
39
40 Initialize session data prior to using client/server script regularly.
41
42 =back
43
44 =head1 AUTHORS
45
46 Michel Ketterle, Steven Schubiger
47
48 =cut