[hcoop/zz_old/debian/djbdns.git] / debian / djbdns-man / tinydns-edit.8

.TH tinydns-edit 8

.SH NAME
tinydns-edit \- edit the (source form of the) database served by tinydns/axfrdns

.SH SYNOPSIS
.B tinydns-edit
.I data
.I data.tmp
add
.I type
.I name
.I address

.SH DESCRIPTION
.B tinydns-edit
edits the
.I data
file, which is the source form of the database that is compiled by
.BR tinydns-data (8)
and that is served by
.BR tinydns (8)
and
.BR axfrdns (8).
The update to
.I data
is performed atomically, by first writing the updated database content to the file
.I data.tmp
and then renaming
.I data.tmp
to
.I data .
The two files must, of course, reside on the same volume in order that this can be achieved.
.PP
On success,
.I tinydns-edit
returns zero.  If, for any reason, an error occurs it will exit with a non-zero code and
.I data
will not be changed.
.PP
With the "add" verb, 
.I tinydns-edit
appends to the database a record whose type is determined by
.I type ,
with the fully-qualified name
.I name
and the IP address
.I address .
.I type
can be one of:
.IP ns
A '.' record is created.  This record specifies that the domain
.I name
is published by a DNS content server that is listening on the IP address
.I address .
.IP
The name of the DNS content server is not directly specifiable.  Names are automatically assigned by
.I tinydns-edit
itself, following the pattern
.I [a-z].ns.name .
.I tinydns-edit
will assign the first letter of the alphabet that is not already used in another '.' or '&' record as the name of a DNS content server.
If no letters of the alphabet remain unused,
.I tinydns-edit
will fail.
.IP
If a '.' or '&' record for the domain already exists, proxy DNS servers are allowed to cache the new record for the same length of time as they are allowed to cache the existing records.
Otherwise, proxy DNS servers are allowed to cache the record for up to 3 days.
.IP childns
A '&' record is created.  This record specifies that queries for names in the domain
.I name
should be referred to a ("child") DNS content server that is listening on the IP address
.I address .
.IP
The name of the DNS content server is not directly specifiable.  Names are automatically assigned by
.I tinydns-edit
itself, following the pattern
.I [a-z].ns.name .
.I tinydns-edit
will assign the first letter of the alphabet that is not already used in another '.' or '&' record as the name of a DNS content server.
If no letters of the alphabet remain unused,
.I tinydns-edit
will fail.
.IP
If a '.' or '&' record for the domain already exists, proxy DNS servers are allowed to cache the new record for the same length of time as they are allowed to cache the existing records.
Otherwise, proxy DNS servers are allowed to cache the record for up to 3 days.
.IP mx
A '@' record is created.  This record specifies that mail to names in the domain
.I name
should be sent to an SMTP server that is listening on the IP address
.I address .
.IP
The name of the SMTP server is not directly specifiable.  Names are automatically assigned by
.I tinydns-edit
itself, following the pattern
.I [a-z].mx.name .
.I tinydns-edit
will assign the first letter of the alphabet that is not already used in another '@' record as the name of an SMTP server.
If no letters of the alphabet remain unused,
.I tinydns-edit
will fail.
.IP
It is not possible to specify the 
.I distance 
value for the SMTP server.  
.I tinydns-edit
will leave that field blank, meaning that 
.I tinydns-data (8)
will use whatever the default value is.
.IP
If a '@' record for the domain already exists, proxy DNS servers are allowed to cache the new record for the same length of time as they are allowed to cache the existing records.
Otherwise, proxy DNS servers are allowed to cache the record for up to 1 day.
.IP host
A '=' record is created, that proxy DNS servers are allowed to cache for up to 1 day.  This record specifies that the name
.I name
maps to the IP address
.I address 
and vice versa.
.IP
.I tinydns-edit
will fail if a '=' record already exists that uses either
.I name
or
.I address .
.IP alias
A '+' record is created, that proxy DNS servers are allowed to cache for up to 1 day.  This record specifies that the name
.I name
maps to the IP address
.I address 
but that there is no reverse mapping.
.IP
Because this is an alias record,
.I tinydns-edit
will not fail if there happen to already be existing records that use
.I address .

.SH SEE ALSO
tinydns-data(8),

http://cr.yp.to/djbdns.html

.SH AUTHOR AND MODIFICATIONS
This manual page was created by Jonathan de Boyne Pollard on 2001-04-06.
.PP
2001-04-26: A new AUTHOR AND MODIFICATIONS section was added.
.BR axfrdns (8)
is now mentioned.
The description of how server names were auto-generated was clarified.
A cut-and-paste error in the description of the "mx" type was corrected.
Commit	Line	Data
b4588d5c GP	1	.TH tinydns-edit 8
	2
	3	.SH NAME
	4	tinydns-edit \- edit the (source form of the) database served by tinydns/axfrdns
	5
	6	.SH SYNOPSIS
	7	.B tinydns-edit
	8	.I data
	9	.I data.tmp
	10	add
	11	.I type
	12	.I name
	13	.I address
	14
	15	.SH DESCRIPTION
	16	.B tinydns-edit
	17	edits the
	18	.I data
	19	file, which is the source form of the database that is compiled by
	20	.BR tinydns-data (8)
	21	and that is served by
	22	.BR tinydns (8)
	23	and
	24	.BR axfrdns (8).
	25	The update to
	26	.I data
	27	is performed atomically, by first writing the updated database content to the file
	28	.I data.tmp
	29	and then renaming
	30	.I data.tmp
	31	to
	32	.I data .
	33	The two files must, of course, reside on the same volume in order that this can be achieved.
	34	.PP
	35	On success,
	36	.I tinydns-edit
	37	returns zero. If, for any reason, an error occurs it will exit with a non-zero code and
	38	.I data
	39	will not be changed.
	40	.PP
	41	With the "add" verb,
	42	.I tinydns-edit
	43	appends to the database a record whose type is determined by
	44	.I type ,
	45	with the fully-qualified name
	46	.I name
	47	and the IP address
	48	.I address .
	49	.I type
	50	can be one of:
	51	.IP ns
	52	A '.' record is created. This record specifies that the domain
	53	.I name
	54	is published by a DNS content server that is listening on the IP address
	55	.I address .
	56	.IP
	57	The name of the DNS content server is not directly specifiable. Names are automatically assigned by
	58	.I tinydns-edit
	59	itself, following the pattern
	60	.I [a-z].ns.name .
	61	.I tinydns-edit
	62	will assign the first letter of the alphabet that is not already used in another '.' or '&' record as the name of a DNS content server.
	63	If no letters of the alphabet remain unused,
	64	.I tinydns-edit
65	will fail.
66	.IP
67	If a '.' or '&' record for the domain already exists, proxy DNS servers are allowed to cache the new record for the same length of time as they are allowed to cache the existing records.
68	Otherwise, proxy DNS servers are allowed to cache the record for up to 3 days.
69	.IP childns
70	A '&' record is created. This record specifies that queries for names in the domain
71	.I name
72	should be referred to a ("child") DNS content server that is listening on the IP address
73	.I address .
74	.IP
75	The name of the DNS content server is not directly specifiable. Names are automatically assigned by
76	.I tinydns-edit
77	itself, following the pattern
78	.I [a-z].ns.name .
79	.I tinydns-edit
80	will assign the first letter of the alphabet that is not already used in another '.' or '&' record as the name of a DNS content server.
81	If no letters of the alphabet remain unused,
82	.I tinydns-edit
83	will fail.
84	.IP
85	If a '.' or '&' record for the domain already exists, proxy DNS servers are allowed to cache the new record for the same length of time as they are allowed to cache the existing records.
86	Otherwise, proxy DNS servers are allowed to cache the record for up to 3 days.
87	.IP mx
88	A '@' record is created. This record specifies that mail to names in the domain
89	.I name
90	should be sent to an SMTP server that is listening on the IP address
91	.I address .
92	.IP
93	The name of the SMTP server is not directly specifiable. Names are automatically assigned by
94	.I tinydns-edit
95	itself, following the pattern
96	.I [a-z].mx.name .
97	.I tinydns-edit
98	will assign the first letter of the alphabet that is not already used in another '@' record as the name of an SMTP server.
99	If no letters of the alphabet remain unused,
100	.I tinydns-edit
101	will fail.
102	.IP
103	It is not possible to specify the
104	.I distance
105	value for the SMTP server.
106	.I tinydns-edit
107	will leave that field blank, meaning that
108	.I tinydns-data (8)
109	will use whatever the default value is.
110	.IP
111	If a '@' record for the domain already exists, proxy DNS servers are allowed to cache the new record for the same length of time as they are allowed to cache the existing records.
112	Otherwise, proxy DNS servers are allowed to cache the record for up to 1 day.
113	.IP host
114	A '=' record is created, that proxy DNS servers are allowed to cache for up to 1 day. This record specifies that the name
115	.I name
116	maps to the IP address
117	.I address
118	and vice versa.
119	.IP
120	.I tinydns-edit
121	will fail if a '=' record already exists that uses either
122	.I name
123	or
124	.I address .
125	.IP alias
126	A '+' record is created, that proxy DNS servers are allowed to cache for up to 1 day. This record specifies that the name
127	.I name
128	maps to the IP address
129	.I address
130	but that there is no reverse mapping.
131	.IP
132	Because this is an alias record,
133	.I tinydns-edit
134	will not fail if there happen to already be existing records that use
135	.I address .
136
137	.SH SEE ALSO
138	tinydns-data(8),
139
140	http://cr.yp.to/djbdns.html
141
142	.SH AUTHOR AND MODIFICATIONS
143	This manual page was created by Jonathan de Boyne Pollard on 2001-04-06.
144	.PP
145	2001-04-26: A new AUTHOR AND MODIFICATIONS section was added.
146	.BR axfrdns (8)
147	is now mentioned.
148	The description of how server names were auto-generated was clarified.
149	A cut-and-paste error in the description of the "mx" type was corrected.