make html in doc/man using mandoc (sans Toc feature)
[oweals/gnunet.git] / doc / man / gnunet-gns.1
1 .TH GNUNET\-GNS 1 "March 23, 2018" "GNUnet"
2 .SH NAME
3 gnunet\-gns \- Access to GNU Name System
4 .SH SYNOPSIS
5 .B gnunet\-gns
6 .RI [ options ]
7 .SH DESCRIPTION
8 \fBgnunet\-gns\fP can be used to lookup and process GNU Name Service
9 names.
10 .SH OPTIONS
11 .IP "\-c FILENAME,  \-\-config=FILENAME"
12 Use the configuration file FILENAME.
13 .IP "\-r, \-\-raw"
14 No unneeded output.
15 This is a quiet mode where only important information is displayed.
16 For example a lookup for an IP address will only yield the IP address,
17 no descriptive text.
18 .IP "\-h, \-\-help"
19 Print short help on options.
20 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
21 Use LOGLEVEL for logging.
22 Valid values are DEBUG, INFO, WARNING and ERROR.
23 .IP "\-u NAME, \-\-lookup=NAME"
24 Name to lookup.
25 Resolve the specified name using the GNU Name System.
26 .IP "\-t TYPE, \-\-type=TYPE"
27 Resource Record Type (TYPE) to look for.
28 Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA,
29 MX, LEHO, VPN, REV, PTR, TXT.
30 Defaults to "A".
31 .IP "\-v, \-\-version"
32 Print GNUnet version number.
33 .SH RETURN VALUE
34 gnunet\-gns will return 0 on success, 1 on internal failures, 2 on
35 launch failures, 4 if the given name is not configured to use GNS.
36 .SH BUGS
37 Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
38 electronic mail to <gnunet\-developers@gnu.org>
39 .SH SEE ALSO
40 \fBgnunet\-namestore\fP(1), \fBgnunet\-identity\fP(1)
41 .PP
42 The full documentation for
43 .B gnunet
44 is maintained as a Texinfo manual.  If the
45 .B info
46 and
47 .B gnunet
48 programs are properly installed at your site, the command
49 .IP
50 .B info gnunet
51 .PP
52 should give you access to the complete handbook,
53 .IP
54 .B info gnunet-c-tutorial
55 .PP
56 will give you access to a tutorial for developers.
57 .PP
58 Depending on your installation, this information is also
59 available in
60 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).