Merge remote-tracking branch 'origin/master' into credentials
[oweals/gnunet.git] / doc / man / gnunet-dns2gns.1
1 .TH GNUNET\-DNS2GNS 1 "Oct 25, 2012" "GNUnet"
2
3 .SH NAME
4 gnunet\-dns2gns \- run a DNS-to-GNS proxy
5
6 .SH SYNOPSIS
7 .B gnunet\-dns2gns
8 .RI [ options ]
9 .br
10
11 .SH DESCRIPTION
12 Most users will not want to run an DNS to GADS proxy/gateway and thus will not need this program.
13
14 \fBgnunet\-dns2gns\fP runs a DNS resolver which delegates requests to the ".gads" and ".zkey" zones to GADS.  All other requests are forwarded to DNS.  This DNS proxy is useful for enabling non-personalized GADS\-resolution to an entire network or to offer GADS\-resolution to DNS users.
15
16 A DNS\-to\-GNS proxy using gnunet\-dns2gns is available at ".zkey.eu"
17
18 If you do not want to specify a public key and are the owner of the zone that gnunet\-dns2gns will use for GNS lookups, you need to first create a pseudonym (using "gnunet\-identity \-C NAME"), and then assign it to be used for the "dns2gns" service using "gnunet\-identity \-e NAME \-s dns2gns".  After that, you can start the dns2gns service (possibly using gnunet\-arm) without specifying a public key using "\-z".
19
20 .SH OPTIONS
21 .B
22 .IP "\-c FILENAME,  \-\-config=FILENAME"
23 Use the configuration file FILENAME.
24 .B
25 .IP "\-d IP,  \-\-dns=IP"
26 IP address of a recursive DNS resolver that should be used for non-GADS hostnames.
27 .B
28 .IP "\-f NAME,  \-\-fcfs=NAME"
29 Authoritative FCFS suffix to use.  This is the name under which the local zone's names will be made available.  Default is "fcfs.zkey.eu".
30 .B
31 .IP "\-h, \-\-help"
32 Print short help on options.
33 .B
34 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
35 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
36 .B
37 .IP "\-s SUFFIX,  \-\-suffix=SUFFIX"
38 Authoritative DNS suffix to use.  This is the name under which the GADS ".zkey" zone is mapped into the DNS namespace.  Default is "zkey.eu".
39 .B
40 .IP "\-v, \-\-version"
41 Print GNUnet version number.
42 .B
43 .IP "\-z PUBLICKEY, \-\-zone=PUBLICKEY"
44 Use PUBLICKEY for the zone to resolve GNS names in.  The PUBLICKEY must be encoded in the text format which can be obtained using gnunet\-ecc, seen in PKEY records and output by gnunet\-identity.  If this option is not specified, the default ego associated by gnunet\-identity for the "dns2gns" subsystem will be used.
45
46
47 .SH BUGS
48 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org>
49
50 .SH SEE ALSO
51 gnunet\-gns\-fcfs(1), gnunet\-gns(1), gnunet\-identity(1)