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