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