diff options
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/.gitignore | 4 | ||||
-rw-r--r-- | doc/man/Makefile.am | 36 | ||||
-rw-r--r-- | doc/man/gnunet-config.1 | 2 | ||||
-rw-r--r-- | doc/man/gnunet-namestore-dbtool.1 | 87 | ||||
-rw-r--r-- | doc/man/gnunet-search.1 | 8 |
5 files changed, 118 insertions, 19 deletions
diff --git a/doc/man/.gitignore b/doc/man/.gitignore index 38ed67872..decad311d 100644 --- a/doc/man/.gitignore +++ b/doc/man/.gitignore | |||
@@ -3,3 +3,7 @@ groff_lint.log | |||
3 | *.html | 3 | *.html |
4 | gnunet-c-tutorial.7 | 4 | gnunet-c-tutorial.7 |
5 | gnunet-documentation.7 | 5 | gnunet-documentation.7 |
6 | gana.* | ||
7 | gnunet.* | ||
8 | gnunet-dev.* | ||
9 | lsd.* | ||
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index e7045e8bf..be7a810f8 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am | |||
@@ -5,16 +5,6 @@ gnunet.conf.5: gnunet.conf.5.in Makefile | |||
5 | 5 | ||
6 | CLEANFILES = gnunet.conf.5 | 6 | CLEANFILES = gnunet.conf.5 |
7 | 7 | ||
8 | if TEXI2MDOC_GENERATION | ||
9 | gnunet-tutorial.7: Makefile | ||
10 | @texi2mdoc -I../tutorial:../tutorial/chapters ../tutorial/tutorial.texi > gnunet-tutorial.7 | ||
11 | |||
12 | gnunet-documentation.7: Makefile | ||
13 | @texi2mdoc -I../handbook:../handbook/chapters ../handbook/gnunet.texi > gnunet-documentation.7 | ||
14 | |||
15 | CLEANFILES += gnunet-documentation.7 gnunet-tutorial.7 | ||
16 | endif | ||
17 | |||
18 | if HAVE_EXPERIMENTAL | 8 | if HAVE_EXPERIMENTAL |
19 | if HAVE_MANDOC | 9 | if HAVE_MANDOC |
20 | # After I went through the alternatives with the focus | 10 | # After I went through the alternatives with the focus |
@@ -46,6 +36,27 @@ endif | |||
46 | endif | 36 | endif |
47 | 37 | ||
48 | man_MANS = \ | 38 | man_MANS = \ |
39 | gnunet.1 \ | ||
40 | gnunet.2 \ | ||
41 | gnunet.3 \ | ||
42 | gnunet.4 \ | ||
43 | gnunet.5 \ | ||
44 | gnunet.6 \ | ||
45 | gnunet.7 \ | ||
46 | gnunet.8 \ | ||
47 | gnunet.9 \ | ||
48 | gana.1 \ | ||
49 | gana.2 \ | ||
50 | gana.3 \ | ||
51 | gana.4 \ | ||
52 | gana.5 \ | ||
53 | gnunet-dev.1 \ | ||
54 | gnunet-dev.2 \ | ||
55 | gnunet-dev.3 \ | ||
56 | gnunet-dev.4 \ | ||
57 | gnunet-dev.5 \ | ||
58 | gnunet-dev.6 \ | ||
59 | lsd.1 \ | ||
49 | gnunet.conf.5 \ | 60 | gnunet.conf.5 \ |
50 | gnunet-arm.1 \ | 61 | gnunet-arm.1 \ |
51 | gnunet-ats.1 \ | 62 | gnunet-ats.1 \ |
@@ -71,6 +82,7 @@ man_MANS = \ | |||
71 | gnunet-namecache.1 \ | 82 | gnunet-namecache.1 \ |
72 | gnunet-namestore.1 \ | 83 | gnunet-namestore.1 \ |
73 | gnunet-namestore-fcfsd.1 \ | 84 | gnunet-namestore-fcfsd.1 \ |
85 | gnunet-namestore-dbtool.1 \ | ||
74 | gnunet-nat.1 \ | 86 | gnunet-nat.1 \ |
75 | gnunet-nat-auto.1 \ | 87 | gnunet-nat-auto.1 \ |
76 | gnunet-nat-server.1 \ | 88 | gnunet-nat-server.1 \ |
@@ -95,10 +107,6 @@ man_MANS = \ | |||
95 | gnunet-vpn.1 \ | 107 | gnunet-vpn.1 \ |
96 | gnunet-zoneimport.1 | 108 | gnunet-zoneimport.1 |
97 | 109 | ||
98 | if TEXI2MDOC_GENERATION | ||
99 | man_MANS += gnunet-tutorial.7 gnunet-documentation.7 | ||
100 | endif | ||
101 | |||
102 | EXTRA_DIST = ${man_MANS} \ | 110 | EXTRA_DIST = ${man_MANS} \ |
103 | gnunet.conf.5.in \ | 111 | gnunet.conf.5.in \ |
104 | produce_html.sh.in \ | 112 | produce_html.sh.in \ |
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1 index 93d943758..c454765cf 100644 --- a/doc/man/gnunet-config.1 +++ b/doc/man/gnunet-config.1 | |||
@@ -47,7 +47,7 @@ | |||
47 | .Sh DESCRIPTION | 47 | .Sh DESCRIPTION |
48 | .Nm | 48 | .Nm |
49 | can be used to read or modify GNUnet configuration files. | 49 | can be used to read or modify GNUnet configuration files. |
50 | It can also provide informations to properly build applications on top of | 50 | It can also provide information to properly build applications on top of |
51 | GNUnet, like appropriate values for CFLAGS or the installation prefix. | 51 | GNUnet, like appropriate values for CFLAGS or the installation prefix. |
52 | .Bl -tag -width indent | 52 | .Bl -tag -width indent |
53 | .It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND | 53 | .It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND |
diff --git a/doc/man/gnunet-namestore-dbtool.1 b/doc/man/gnunet-namestore-dbtool.1 new file mode 100644 index 000000000..af882209b --- /dev/null +++ b/doc/man/gnunet-namestore-dbtool.1 | |||
@@ -0,0 +1,87 @@ | |||
1 | .\" This file is part of GNUnet. | ||
2 | .\" Copyright (C) 2001-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 September 30, 2022 | ||
25 | .Dt GNUNET-NAMESTORE-DBTOOL 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-namestore-dbtool | ||
29 | .Nd manipulate GNU Name System (GNS) namestore database | ||
30 | .Sh SYNOPSIS | ||
31 | .Nm | ||
32 | .Op Fl i | -initialize | ||
33 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
34 | .Op Fl r | -reset | ||
35 | .Op Fl h | -help | ||
36 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
37 | .Op Fl p Ar PLUGIN | Fl -plugin= Ns Ar PLUGIN | ||
38 | .Op Fl v | -version | ||
39 | .Sh DESCRIPTION | ||
40 | .Nm | ||
41 | can be used to initialize or reset the namestore database. | ||
42 | .Pp | ||
43 | The options are as follows: | ||
44 | .Bl -tag -width indent | ||
45 | .It Fl i | -initialize | ||
46 | Desired operation is initialization of a database. | ||
47 | .It Fl p Ar PLUGINNAME | Fl -plugin= Ns Ar PLUGINNAME | ||
48 | Use the plugin PLUGINNAME. | ||
49 | .It Fl r | -reset | ||
50 | Desired operation is reset and reinitialization of a database | ||
51 | .It Fl h | -help | ||
52 | Print short help on options. | ||
53 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
54 | Use LOGLEVEL for logging. | ||
55 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
56 | .It Fl v | -version | ||
57 | Print GNUnet version number. | ||
58 | .El | ||
59 | .\".Sh EXAMPLES | ||
60 | .\".Sh FILES | ||
61 | .Sh SEE ALSO | ||
62 | .Xr gnunet-gns 1 , | ||
63 | .Xr gnunet-namestore 1 | ||
64 | .sp | ||
65 | The full documentation for GNUnet is maintained as a Texinfo manual. | ||
66 | If the | ||
67 | .Xr info 1 | ||
68 | and gnunet programs are properly installed at your site, the command | ||
69 | .Pp | ||
70 | .Dl info gnunet | ||
71 | .Pp | ||
72 | should give you access to the complete handbook, | ||
73 | .Pp | ||
74 | .Dl info gnunet-c-tutorial | ||
75 | .Pp | ||
76 | will give you access to a tutorial for developers. | ||
77 | .sp | ||
78 | Depending on your installation, this information is also available in | ||
79 | .Xr gnunet 7 and | ||
80 | .Xr gnunet-c-tutorial 7 . | ||
81 | .\".Sh HISTORY | ||
82 | .\".Sh AUTHORS | ||
83 | .Sh BUGS | ||
84 | Report bugs by using | ||
85 | .Lk https://bugs.gnunet.org | ||
86 | or by sending electronic mail to | ||
87 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1 index a3c6e8ece..3145842a4 100644 --- a/doc/man/gnunet-search.1 +++ b/doc/man/gnunet-search.1 | |||
@@ -90,7 +90,7 @@ defaults to | |||
90 | is missing too | 90 | is missing too |
91 | .Fl -dir-printf | 91 | .Fl -dir-printf |
92 | defaults to | 92 | defaults to |
93 | .Ql #%n:\engnunet-download -o "%f" -R %u\en\en Ns | 93 | .Ql #%n:\engnunet-download -o Qo %f Qc -R %u\en\en Ns |
94 | \&. | 94 | \&. |
95 | .It Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT | 95 | .It Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT |
96 | Write the search results according to | 96 | Write the search results according to |
@@ -171,7 +171,7 @@ character followed by any other character not listed above is treated as an ordi | |||
171 | If missing, | 171 | If missing, |
172 | .Fl -printf | 172 | .Fl -printf |
173 | defaults to | 173 | defaults to |
174 | .Ql #%n:\engnunet-download -o "%f" %u\en\en Ns | 174 | .Ql #%n:\engnunet-download -o Qo %f Qc %u\en\en Ns |
175 | \&. | 175 | \&. |
176 | .It Fl h | -help | 176 | .It Fl h | -help |
177 | Print the help page. | 177 | Print the help page. |
@@ -251,8 +251,8 @@ argument is required). | |||
251 | .It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY | 251 | .It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY |
252 | Automatically timeout search after | 252 | Automatically timeout search after |
253 | .Ar DELAY . | 253 | .Ar DELAY . |
254 | The value given must be a number followed by a space and a time unit, for example "500 ms". | 254 | The value given must be a number followed by a space and a time unit, for example |
255 | Note that the quotes are required on the shell. Without a unit it defaults to microseconds (1000000 = 1 second). | 255 | .Qo 500 ms Qc . Note that the quotes are required on the shell. Without a unit it defaults to microseconds (1000000 = 1 second). |
256 | If 0 or omitted the search runs until gnunet-search is aborted with CTRL-C. | 256 | If 0 or omitted the search runs until gnunet-search is aborted with CTRL-C. |
257 | .It Fl v | -version | 257 | .It Fl v | -version |
258 | print the version number | 258 | print the version number |