| 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 7 "12 Jan 2006" "icmpdn @VERSION@" "ICMP Hostname Manual" |
| 25 | .SH NAME |
| 26 | nss-icmp - A nameservice hostname module for ICMP |
| 27 | .SH DESCRIPTION |
| 28 | The \fBnss-icmp\fP nameservice module provides reverse hostname lookup |
| 29 | over ICMP. If installed in \fB/etc/nsswitch.conf\fP, it will act on |
| 30 | programs calling \fBgethostbyaddr\fP(3) and related functions and |
| 31 | attempt to request the specified host's fully qualified domain name |
| 32 | over ICMP. |
| 33 | .P |
| 34 | In order to do so, \fBnss-icmp\fP relies on the \fBidnlookup\fP(1) |
| 35 | program being installed on the system. It also implements a cache, |
| 36 | which will remember the remote host's response for as long as the TTL |
| 37 | (Time-to-Live) value in the response specifies. It will also remember |
| 38 | non-responsive hosts, so that time-outs will not have to happen twice. |
| 39 | .P |
| 40 | The first time \fBnss-icmp\fP is called, it will read a configuration |
| 41 | file, which by default will be named \fB/etc/nss-icmp.conf\fP |
| 42 | (although this name can be changed during compilation). The |
| 43 | configuration file specifies certain parameters to control how |
| 44 | \fBnss-icmp\fP operates. Its file format is described in the |
| 45 | \fBnss-icmp.conf\fP(5) man page. |
| 46 | .SH AUTHOR |
| 47 | Fredrik Tolf <fredrik@dolda2000.com> |
| 48 | .SH SEE ALSO |
| 49 | \fBidnlookup\fP(1), \fBicmpdnd\fP(8), \fBnsswitch.conf\fP(5), |
| 50 | \fBnss-icmp.conf\fP(5), \fIRFC 1788\fP |