diff options
author | Martin Schanzenbach <schanzen@gnunet.org> | 2022-10-21 11:17:53 +0900 |
---|---|---|
committer | Martin Schanzenbach <schanzen@gnunet.org> | 2022-10-21 11:17:53 +0900 |
commit | fb0ee05fb2793f2cd5fd71f0ea72390094a2a828 (patch) | |
tree | 0d5fe62f9ad04b177c3fe00783d719c84ccaf54d /doc | |
parent | 2321a2f860be63fb313ba076376b2d22c3edbf7a (diff) | |
download | gnunet-fb0ee05fb2793f2cd5fd71f0ea72390094a2a828.tar.gz gnunet-fb0ee05fb2793f2cd5fd71f0ea72390094a2a828.zip |
- add gnunet-namestore-zonefile man page
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/Makefile.am | 1 | ||||
-rw-r--r-- | doc/man/gnunet-namestore-zonefile.1 | 97 |
2 files changed, 98 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index be7a810f8..2dec9af71 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am | |||
@@ -83,6 +83,7 @@ man_MANS = \ | |||
83 | gnunet-namestore.1 \ | 83 | gnunet-namestore.1 \ |
84 | gnunet-namestore-fcfsd.1 \ | 84 | gnunet-namestore-fcfsd.1 \ |
85 | gnunet-namestore-dbtool.1 \ | 85 | gnunet-namestore-dbtool.1 \ |
86 | gnunet-namestore-zonefile.1 \ | ||
86 | gnunet-nat.1 \ | 87 | gnunet-nat.1 \ |
87 | gnunet-nat-auto.1 \ | 88 | gnunet-nat-auto.1 \ |
88 | gnunet-nat-server.1 \ | 89 | gnunet-nat-server.1 \ |
diff --git a/doc/man/gnunet-namestore-zonefile.1 b/doc/man/gnunet-namestore-zonefile.1 new file mode 100644 index 000000000..2b602b8df --- /dev/null +++ b/doc/man/gnunet-namestore-zonefile.1 | |||
@@ -0,0 +1,97 @@ | |||
1 | .\" This file is part of GNUnet. | ||
2 | .\" Copyright (C) 2022 GNUnet e.V. | ||
3 | .\" | ||
4 | .\" Permission is granted to copy, distribute and/or modify this document | ||
5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | ||
6 | .\" any later version published by the Free Software Foundation; with no | ||
7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | ||
8 | .\" copy of the license is included in the file | ||
9 | .\" FDL-1.3. | ||
10 | .\" | ||
11 | .\" A copy of the license is also available from the Free Software | ||
12 | .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}. | ||
13 | .\" | ||
14 | .\" Alternately, this document is also available under the General | ||
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" GPL3. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd Friday 21, 2022 | ||
25 | .Dt GNUNET-NAMESTORE-ZONEFILE 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-namestore-zonefile | ||
29 | .Nd Import GNU Name System (GNS) zone data using zonefiles. | ||
30 | .Sh SYNOPSIS | ||
31 | .Nm | ||
32 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
33 | .Op Fl h | -help | ||
34 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
35 | .Op Fl v | -version | ||
36 | .Op Fl z Ar EGO | Fl -zone= Ns Ar EGO | ||
37 | .Sh DESCRIPTION | ||
38 | .Nm | ||
39 | can be used to manipulate records in a GNS zone. | ||
40 | .Pp | ||
41 | The zonefile is read from standard input. | ||
42 | .Pp | ||
43 | $ORIGIN entries in the zonefile will be treated as ego names (without the trailing ".") and created if missing. | ||
44 | .Pp | ||
45 | To implicity give an initial $ORIGIN, use the --ego flag. | ||
46 | .Pp | ||
47 | All records will be created public and with relative expiration times set to the value provided in $TTL entries. | ||
48 | .Pp | ||
49 | The options are as follows: | ||
50 | .Bl -tag -width indent | ||
51 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
52 | Use the configuration file FILENAME. | ||
53 | .It Fl h | -help | ||
54 | Print short help on options. | ||
55 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
56 | Use LOGLEVEL for logging. | ||
57 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
58 | .It Fl v | -version | ||
59 | Print GNUnet version number. | ||
60 | .It Fl z Ar EGO | Fl -zone= Ns Ar EGO | ||
61 | Specifies the name of the ego controlling the private key for the | ||
62 | zone. If not provided, we will attempt to use the default identity set | ||
63 | for the "namestore". Alternatively, a private key may be passed in | ||
64 | Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment | ||
65 | variable. The latter is useful to improve performance of tools like | ||
66 | Ascension as it allows the command to skip IPC with the identity | ||
67 | management subsystem. | ||
68 | .El | ||
69 | .\".Sh EXAMPLES | ||
70 | .\".Sh FILES | ||
71 | .Sh SEE ALSO | ||
72 | .Xr gnunet-gns 1 , | ||
73 | .Xr gnunet-namestore 1 | ||
74 | .sp | ||
75 | The full documentation for GNUnet is maintained as a Texinfo manual. | ||
76 | If the | ||
77 | .Xr info 1 | ||
78 | and gnunet programs are properly installed at your site, the command | ||
79 | .Pp | ||
80 | .Dl info gnunet | ||
81 | .Pp | ||
82 | should give you access to the complete handbook, | ||
83 | .Pp | ||
84 | .Dl info gnunet-c-tutorial | ||
85 | .Pp | ||
86 | will give you access to a tutorial for developers. | ||
87 | .sp | ||
88 | Depending on your installation, this information is also available in | ||
89 | .Xr gnunet 7 and | ||
90 | .Xr gnunet-c-tutorial 7 . | ||
91 | .\".Sh HISTORY | ||
92 | .\".Sh AUTHORS | ||
93 | .Sh BUGS | ||
94 | Report bugs by using | ||
95 | .Lk https://bugs.gnunet.org | ||
96 | or by sending electronic mail to | ||
97 | .Aq Mt gnunet-developers@gnu.org . | ||