File: tinydyndns-data.8.html

package info (click to toggle)
tinydyndns 0.4.2.debian1-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,432 kB
  • sloc: ansic: 10,256; sh: 291; makefile: 42
file content (108 lines) | stat: -rw-r--r-- 4,099 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108



<html>
<head>
<title>tinydyndns-data(8) manual page</title>
</head>
<body bgcolor='white'>
<a href='http://smarden.org/pape/'>G. Pape</a><br><a href='index.html'>tinydyndns</a><hr><p>

<h2><a name='sect0'>Name</a></h2>
tinydyndns-data - add or remove TYPE A record to or from data.cdb 
<h2><a name='sect1'>Synopsis</a></h2>
<b>tinydyndns-data</b>
add|remove <i>fqdns</i> 
<h2><a name='sect2'>Description</a></h2>
<i>fqdns</i> consists of one or more argument, each
specifying a fully qualified domain name (fqdn). <p>
<b>tinydyndns-data</b> adds a TYPE
A record to or removes it from data.cdb in the current directory. Other than
<i><b>tinydns-data</b>(8)</i>, <b>tinydyndns-data</b> does not know about the source file data
but changes the binary database data.cdb directly. <p>
<b>tinydyndns-data</b> reads data.cdb
and copies its data to data.tmp. While reading the records, <b>tinydyndns-data</b>
checks for each <i>fqdn</i> in <i>fqdns</i> if this hostname has a TYPE A record in data.cdb,
drops the record when called with the option <i>remove</i>, or refuses to add
the record when called with the option <i>add</i>. <p>
When called with the option
<i>add</i>, <b>tinydyndns-data</b> then adds all new <i>fqdn</i>s to data.tmp. The data of the
newly created records can optionally be controlled through the environment,
see below. Finally <b>tinydyndns-data</b> renames data.tmp to data.cdb. 
<h2><a name='sect3'>Options</a></h2>

<dl>

<dt>add
</dt>
<dd>For each <i>fqdn</i> in <i>fqdns</i>, add a TYPE A record for <i>fqdn</i> to data.cdb with the
default IP address (127.14.14.14). </dd>

<dt>remove </dt>
<dd>For each <i>fqdn</i> in <i>fqdns</i>, remove all
TYPE A records for <i>fqdn</i> from data.cdb. </dd>
</dl>

<h2><a name='sect4'>Environment</a></h2>

<dl>

<dt><i>IP</i> </dt>
<dd>The environment variable
<i>IP</i> overrides the default IP address (&lsquo;&lsquo;127.14.14.14&rsquo;&rsquo;) for newly created records.
<i>$IP</i> must be a valid IP address. </dd>

<dt><i>TTL</i> </dt>
<dd>time-to-live. The environment variable
<i>TTL</i> overrides the default time-to-live in seconds (0 if <i>TTD</i> is set, otherwise
5). <i>$TTL</i> must be an integer. </dd>

<dt><i>TTD</i> </dt>
<dd>time-to-die. <i>$TTD</i> must be an integer, specifying
a number of seconds. If <i>TTD</i> is set, the timestamp of newly created records
is set to the current time plus <i>$TTD</i> seconds, and <i>TTL</i> is set to zero by
default, so that <i><b>tinydns</b>(8)</i> interprets the timestamp as time-to-die. Note:
you probably want to adjust SOA ttl, or create a wildcard record, to prevent
DNS caches from caching nxdomain, when using this feature. </dd>

<dt><i>LOC</i> </dt>
<dd>location.
<i>$LOC</i> must be two characters long. If <i>LOC</i> is set, it specifies the client
location for newly created records. </dd>
</dl>

<h2><a name='sect5'>Exit Codes</a></h2>
<b>tinydyndns-data</b> exits 111 if
anything goes wrong and leaves data.cdb unchanged. <p>
<b>tinydyndns-data</b> exits 0
if all <i>fqdns</i> were processed and the new data.cdb was written. <p>
For each <i>fqdn</i>
in <i>fqdns</i> that <b>tinydyndns-data</b> was not able to remove or add (e.g., not there,
or already there), it increases the exit code by one and exits non-zero
(maximum is 100). 
<h2><a name='sect6'>Files</a></h2>
 ./data.cdb<br>
  ./data.tmp<br>
 
<h2><a name='sect7'>See Also</a></h2>
<i>tinydyndns-update(8)</i>, <i>tinydyndns-conf(8)</i> <p>
<i>http://smarden.org/tinydyndns/</i>

<h2><a name='sect8'>Author</a></h2>
Gerrit Pape &lt;pape@smarden.org&gt; <p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Description</a></li>
<li><a name='toc3' href='#sect3'>Options</a></li>
<li><a name='toc4' href='#sect4'>Environment</a></li>
<li><a name='toc5' href='#sect5'>Exit Codes</a></li>
<li><a name='toc6' href='#sect6'>Files</a></li>
<li><a name='toc7' href='#sect7'>See Also</a></li>
<li><a name='toc8' href='#sect8'>Author</a></li>
</ul>
</body>
</html>