Rename manpages
[icmp-dn.git] / src / nss-icmp.conf.5.in
1 .\"
2 .\" Copyright (c) 2006 Fredrik Tolf <fredrik@dolda2000.com>
3 .\"
4 .\" This is free documentation; you can redistribute it and/or
5 .\" modify it under the terms of the GNU General Public License as
6 .\" published by the Free Software Foundation; either version 2 of
7 .\" the License, or (at your option) any later version.
8 .\"
9 .\" The GNU General Public License's references to "object code"
10 .\" and "executables" are to be interpreted as the output of any
11 .\" document formatting or typesetting system, including
12 .\" intermediate and printed output.
13 .\"
14 .\" This manual is distributed in the hope that it will be useful,
15 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 .\" GNU General Public License for more details.
18 .\"
19 .\" You should have received a copy of the GNU General Public
20 .\" License along with this manual; if not, write to the Free
21 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
22 .\" USA.
23 .\"
24 .TH NSS-ICMP.CONF 5 "12 Jan 2006" "icmpdn 0.3" "ICMP Hostname Manual"
25 .SH NAME
26 nss-icmp.conf - Configuration file for the nss-icmp nameswitch module
27 .SH DESCRIPTION
28 \fB/etc/nss-icmp.conf\fP is an ASCII file which controls certain
29 operating parameters for the \fBnss-icmp\fP(7) nameswitch module. Each
30 line in the file takes the form of a key-value pair, seperated by
31 whitespace. Some keys may not have a value. Lines beginning with a
32 hash sign (#) are interpreted as comments, and thus ignored.
33 .P
34 Valid entries are:
35 .TP
36 \fBtimeout\fP \fImilliseconds\fP
37 Instructs \fBnss-icmp\fP to pass the -t option to \fBidnlookup\fP(1),
38 which changes the default time-out for nonresponsive hosts to the
39 specified number of milliseconds.
40 .TP
41 \fBttlnotfount\fP \fIseconds\fP
42 Specifies the TTL (Time-to-Live) value to use when caching a
43 non-responsive host. In other word, if a host is found to be
44 non-responsive (i.e. times out), the same address will not retried
45 again until the specified time has passed, as to prevent annoying
46 time-outs.
47 .TP
48 \fBnocache\fP
49 If this directive is present, \fBnss-icmp\fP will not use its
50 cache. Since this makes reverse hostname lookups slower, especially in
51 the case of non-responsive hosts, the use of this directive is
52 generally not recommended, but may be useful in certain debugging
53 situtations.
54 .SH AUTHOR
55 Fredrik Tolf <fredrik@dolda2000.com>
56 .SH SEE ALSO
57 \fBnss-icmp\fP(7), \fBidnlookup\fP(1), \fIRFC 1788\fP