diff options
author | ng0 <ng0@n0.is> | 2019-04-03 11:51:43 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-04-03 11:51:43 +0000 |
commit | 054ad19768b96d82b1058e289fdf3fb972f63a2e (patch) | |
tree | 3d32df9bd8762c29a8a4716f46c0daa33f823a25 /doc | |
parent | 7c5db4fe9d6e9a5790ba59f4f5d4889042581bb3 (diff) | |
download | gnunet-054ad19768b96d82b1058e289fdf3fb972f63a2e.tar.gz gnunet-054ad19768b96d82b1058e289fdf3fb972f63a2e.zip |
man: gns
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/gnunet-gns.1 | 115 |
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 |
3 | gnunet\-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 | 7 | access to GNU Name System |
8 | \fBgnunet\-gns\fP can be used to lookup and process GNU Name Service | 8 | .Sh SYNOPSIS |
9 | names. | 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 | ||
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 | ||
12 | Use the configuration file FILENAME. | 23 | Use the configuration file FILENAME. |
13 | .IP "\-r, \-\-raw" | 24 | .It Fl h | \-help |
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. | 25 | Print short help on options. |
20 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 26 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
21 | Use LOGLEVEL for logging. | 27 | Use LOGLEVEL for logging. |
22 | Valid values are DEBUG, INFO, WARNING and ERROR. | 28 | Valid values are DEBUG, INFO, WARNING and ERROR. |
23 | .IP "\-u NAME, \-\-lookup=NAME" | 29 | .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
24 | Name to lookup. | 30 | Write logs to FILENAME. |
25 | Resolve the specified name using the GNU Name System. | 31 | .It Fl r | \-raw |
26 | .IP "\-t TYPE, \-\-type=TYPE" | 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 | ||
27 | Resource Record Type (TYPE) to look for. | 36 | Resource Record Type (TYPE) to look for. |
28 | Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, | 37 | Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, MX, LEHO, VPN, REV, PTR, TXT. |
29 | MX, LEHO, VPN, REV, PTR, TXT. | ||
30 | Defaults to "A". | 38 | Defaults to "A". |
31 | .IP "\-v, \-\-version" | 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 | ||
32 | Print GNUnet version number. | 43 | Print GNUnet version number. |
33 | .SH RETURN VALUE | 44 | .El |
34 | gnunet\-gns will return 0 on success, 1 on internal failures, 2 on | 45 | .Sh DIAGNOSTICS |
46 | .Nm | ||
47 | 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. | 48 | launch failures, 4 if the given name is not configured to use GNS. |
36 | .SH BUGS | 49 | .Sh SEE ALSO |
37 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 50 | .Xr gnunet-namestore 1 , |
38 | electronic 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) | 53 | The full documentation for gnunet is maintained as a Texinfo manual. |
41 | .PP | 54 | If the |
42 | The full documentation for | 55 | .Xr info 1 |
43 | .B gnunet | 56 | and gnunet programs are properly installed at your site, the command |
44 | is maintained as a Texinfo manual. If the | 57 | .Pp |
45 | .B info | 58 | .Dl info gnunet |
46 | and | 59 | .Pp |
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, | 60 | should 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 |
56 | will give you access to a tutorial for developers. | 64 | will give you access to a tutorial for developers. |
57 | .PP | 65 | .sp |
58 | Depending on your installation, this information is also | 66 | Depending on your installation, this information is also available in |
59 | available 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 | ||
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 . | ||