]> CyberLeo.Net >> Repos - FreeBSD/releng/10.0.git/blob - contrib/unbound/doc/unbound-host.1
- Copy stable/10 (r259064) to releng/10.0 as part of the
[FreeBSD/releng/10.0.git] / contrib / unbound / doc / unbound-host.1
1 .TH "unbound\-host" "1" "Mar 21, 2013" "NLnet Labs" "unbound 1.4.20"
2 .\"
3 .\" unbound-host.1 -- unbound DNS lookup utility
4 .\"
5 .\" Copyright (c) 2007, NLnet Labs. All rights reserved.
6 .\"
7 .\" See LICENSE for the license.
8 .\"
9 .\"
10 .SH "NAME"
11 .LP
12 .B unbound\-host
13 \- unbound DNS lookup utility
14 .SH "SYNOPSIS"
15 .LP
16 .B unbound\-host
17 .RB [ \-vdhr46 ]
18 .RB [ \-c 
19 .IR class ]
20 .RB [ \-t
21 .IR type ]
22 .I hostname
23 .RB [ \-y
24 .IR key ]
25 .RB [ \-f
26 .IR keyfile ]
27 .RB [ \-F
28 .IR namedkeyfile ]
29 .RB [ \-C
30 .IR configfile ]
31 .SH "DESCRIPTION"
32 .LP
33 .B Unbound\-host
34 uses the unbound validating resolver to query for the hostname and display
35 results. With the \fB\-v\fR option it displays validation 
36 status: secure, insecure, bogus (security failure).
37 .P
38 By default it reads no configuration file whatsoever.  It attempts to reach
39 the internet root servers.  With \fB\-C\fR an unbound config file and with
40 \fB\-r\fR resolv.conf can be read.
41 .P
42 The available options are:
43 .TP
44 .I hostname
45 This name is resolved (looked up in the DNS).
46 If a IPv4 or IPv6 address is given, a reverse lookup is performed.
47 .TP
48 .B \-h
49 Show the version and commandline option help.
50 .TP
51 .B \-v
52 Enable verbose output and it shows validation results, on every line.
53 Secure means that the NXDOMAIN (no such domain name), nodata (no such data)
54 or positive data response validated correctly with one of the keys.
55 Insecure means that that domain name has no security set up for it.
56 Bogus (security failure) means that the response failed one or more checks,
57 it is likely wrong, outdated, tampered with, or broken.
58 .TP
59 .B \-d
60 Enable debug output to stderr. One \-d shows what the resolver and validator
61 are doing and may tell you what is going on. More times, \-d \-d, gives a
62 lot of output, with every packet sent and received.
63 .TP
64 .B \-c \fIclass
65 Specify the class to lookup for, the default is IN the internet class.
66 .TP
67 .B \-t \fItype
68 Specify the type of data to lookup. The default looks for IPv4, IPv6 and
69 mail handler data, or domain name pointers for reverse queries.
70 .TP
71 .B \-y \fIkey
72 Specify a public key to use as trust anchor. This is the base for a chain
73 of trust that is built up from the trust anchor to the response, in order
74 to validate the response message. Can be given as a DS or DNSKEY record.
75 For example \-y "example.com DS 31560 5 1 1CFED84787E6E19CCF9372C1187325972FE546CD".
76 .TP
77 .B \-f \fIkeyfile
78 Reads keys from a file. Every line has a DS or DNSKEY record, in the format
79 as for \-y. The zone file format, the same as dig and drill produce.
80 .TP
81 .B \-F \fInamedkeyfile
82 Reads keys from a BIND\-style named.conf file. Only the trusted\-key {}; entries
83 are read.
84 .TP
85 .B \-C \fIconfigfile
86 Uses the specified unbound.conf to prime
87 .IR libunbound (3).
88 .TP
89 .B \-r
90 Read /etc/resolv.conf, and use the forward DNS servers from there (those could
91 have been set by DHCP).  More info in
92 .IR resolv.conf (5).
93 Breaks validation if those servers do not support DNSSEC.
94 .TP
95 .B \-4
96 Use solely the IPv4 network for sending packets.
97 .TP
98 .B \-6
99 Use solely the IPv6 network for sending packets.
100 .SH "EXAMPLES"
101 .LP
102 Some examples of use. The keys shown below are fakes, thus a security failure
103 is encountered.
104 .P
105 $ unbound\-host www.example.com
106 .P
107 $ unbound\-host \-v \-y "example.com DS 31560 5 1 1CFED84787E6E19CCF9372C1187325972FE546CD" www.example.com
108 .P
109 $ unbound\-host \-v \-y "example.com DS 31560 5 1 1CFED84787E6E19CCF9372C1187325972FE546CD" 192.0.2.153
110 .SH "EXIT CODE"
111 The unbound\-host program exits with status code 1 on error, 
112 0 on no error. The data may not be available on exit code 0, exit code 1
113 means the lookup encountered a fatal error.
114 .SH "SEE ALSO"
115 \fIunbound.conf\fR(5), 
116 \fIunbound\fR(8).