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