aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/.gitignore4
-rw-r--r--doc/man/Makefile.am31
-rw-r--r--doc/man/README8
-rw-r--r--doc/man/gnunet-arm.1198
-rw-r--r--doc/man/gnunet-ats.1171
-rw-r--r--doc/man/gnunet-bcd.15
-rw-r--r--doc/man/gnunet-cadet.112
-rw-r--r--doc/man/gnunet-config.114
-rw-r--r--doc/man/gnunet-conversation-test.14
-rw-r--r--doc/man/gnunet-conversation.16
-rw-r--r--doc/man/gnunet-dns2gns.1108
-rw-r--r--doc/man/gnunet-ecc.18
-rw-r--r--doc/man/gnunet-gns-proxy-setup-ca.164
-rw-r--r--doc/man/gnunet-gns-proxy.16
-rw-r--r--doc/man/gnunet-gns.17
-rw-r--r--doc/man/gnunet-namecache.16
-rw-r--r--doc/man/gnunet-namestore-fcfsd.15
-rw-r--r--doc/man/gnunet-namestore.119
-rw-r--r--doc/man/gnunet-nat-auto.15
-rw-r--r--doc/man/gnunet-nat-server.11
-rw-r--r--doc/man/gnunet-nat.110
-rw-r--r--doc/man/gnunet-nse.165
-rw-r--r--doc/man/gnunet-peerinfo.111
-rw-r--r--doc/man/gnunet-publish.16
-rw-r--r--doc/man/gnunet-qr.188
-rw-r--r--doc/man/gnunet-resolver.16
-rw-r--r--doc/man/gnunet-revocation.18
-rw-r--r--doc/man/gnunet-scalarproduct.18
-rw-r--r--doc/man/gnunet-scrypt.112
-rw-r--r--doc/man/gnunet-statistics.1146
-rw-r--r--doc/man/gnunet-testbed-profiler.1110
-rw-r--r--doc/man/gnunet-testing-run-service.193
-rw-r--r--doc/man/gnunet-testing.1108
-rw-r--r--doc/man/gnunet-timeout.172
-rw-r--r--doc/man/gnunet-transport-certificate-creation.169
-rw-r--r--doc/man/gnunet-transport.1142
-rw-r--r--doc/man/gnunet-unindex.1109
-rw-r--r--doc/man/gnunet-uri.191
-rw-r--r--doc/man/gnunet-vpn.1139
-rw-r--r--doc/man/gnunet-zoneimport.1184
-rw-r--r--doc/man/gnunet.conf.5.in41
-rwxr-xr-xdoc/man/produce_html.sh14
-rwxr-xr-xdoc/man/texi2mdoc-generation.sh15
43 files changed, 1230 insertions, 999 deletions
diff --git a/doc/man/.gitignore b/doc/man/.gitignore
index ffd69e11b..38ed67872 100644
--- a/doc/man/.gitignore
+++ b/doc/man/.gitignore
@@ -1 +1,5 @@
1gnunet.conf.5 1gnunet.conf.5
2groff_lint.log
3*.html
4gnunet-c-tutorial.7
5gnunet-documentation.7
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 53d97b6b9..509e33be7 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -5,7 +5,23 @@ do_subst = $(SED) -e 's,[@]SYSCONFDIR[@],$(sysconfdir),g'
5gnunet.conf.5: gnunet.conf.5.in Makefile 5gnunet.conf.5: gnunet.conf.5.in Makefile
6 $(do_subst) < $(srcdir)/gnunet.conf.5.in > gnunet.conf.5 6 $(do_subst) < $(srcdir)/gnunet.conf.5.in > gnunet.conf.5
7 7
8CLEANFILES = gnunet.conf.5 8if TEXI2MDOC_GENERATION
9gnunet-c-tutorial.7: Makefile gnunet-tutorial.7
10 @echo generated texi2mdoc output || true
11
12gnunet-tutorial.7: Makefile
13 $(SH) $(srcdir)/texi2mdoc-generation.sh || true
14
15endif
16
17CLEANFILES = gnunet.conf.5 *.html
18
19if TEXI2MDOC_GENERATION
20CLEANFILES += gnunet-documentation.7 gnunet-c-tutorial.7
21endif
22
23html:
24 $(SH) $(srcdir)/produce_html.sh
9 25
10man_MANS = \ 26man_MANS = \
11 gnunet.conf.5 \ 27 gnunet.conf.5 \
@@ -26,6 +42,7 @@ man_MANS = \
26 gnunet-fs.1 \ 42 gnunet-fs.1 \
27 gnunet-gns.1 \ 43 gnunet-gns.1 \
28 gnunet-gns-proxy.1 \ 44 gnunet-gns-proxy.1 \
45 gnunet-gns-proxy-setup-ca.1 \
29 gnunet-identity.1 \ 46 gnunet-identity.1 \
30 gnunet-cadet.1 \ 47 gnunet-cadet.1 \
31 gnunet-namecache.1 \ 48 gnunet-namecache.1 \
@@ -34,6 +51,7 @@ man_MANS = \
34 gnunet-nat.1 \ 51 gnunet-nat.1 \
35 gnunet-nat-auto.1 \ 52 gnunet-nat-auto.1 \
36 gnunet-nat-server.1 \ 53 gnunet-nat-server.1 \
54 gnunet-nse.1 \
37 gnunet-peerinfo.1 \ 55 gnunet-peerinfo.1 \
38 gnunet-publish.1 \ 56 gnunet-publish.1 \
39 gnunet-qr.1 \ 57 gnunet-qr.1 \
@@ -53,10 +71,15 @@ man_MANS = \
53 gnunet-vpn.1 \ 71 gnunet-vpn.1 \
54 gnunet-zoneimport.1 72 gnunet-zoneimport.1
55 73
74if TEXI2MDOC_GENERATION
75man_MANS += gnunet-c-tutorial.7 gnunet-documentation.7
76endif
77
56EXTRA_DIST = ${man_MANS} \ 78EXTRA_DIST = ${man_MANS} \
57 gnunet.conf.5.in 79 gnunet.conf.5.in \
80 texi2mdoc-generation.sh \
81 README
58 82
59if TEXI2MDOC_GENERATION 83if TEXI2MDOC_GENERATION
60EXTRA_DIST += gnunet-documentation.7 \ 84EXTRA_DIST += gnunet-documentation.7 gnunet-c-tutorial.7
61 gnunet-c-tutorial.7
62endif 85endif
diff --git a/doc/man/README b/doc/man/README
new file mode 100644
index 000000000..fb95a11f2
--- /dev/null
+++ b/doc/man/README
@@ -0,0 +1,8 @@
1Please note that new edits in files which already are in mdoc format
2should only be done in mdoc format.
3
4TODO:
5
6* incomplete pages:
7 - gnunet-timeout
8 \ No newline at end of file
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
index b17e74a73..c25b10bb5 100644
--- a/doc/man/gnunet-arm.1
+++ b/doc/man/gnunet-arm.1
@@ -1,78 +1,134 @@
1.TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-arm \- control GNUnet services 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-arm 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.RI [ options ] 6.\" any later version published by the Free Software Foundation; with no
7.SH DESCRIPTION 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8\fBgnunet\-arm\fP can be used to start or stop GNUnet services, including 8.\" copy of the license is included in the file
9the ARM service itself. The ARM service is a supervisor for GNUnet's 9.\" ``FDL-1.3''.
10service processes. ARM starts services on-demand or as configured and 10.\"
11re-starts them if they crash. 11.\" A copy of the license is also available from the Free Software
12.SH OPTIONS 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.B 13.\"
14.IP "\-c FILENAME, \-\-config=FILENAME" 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 @url{http://www.gnu.org/licenses/gpl.html}.
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd January 4, 2012
25.Dt GNUNET-ARM 1
26.Os
27.Sh NAME
28.Nm gnunet-arm
29.Nd
30control GNUnet services
31.Sh SYNOPSIS
32.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl d | \-delete
35.Op Fl e | \-end
36.Op Fl E | \-no-stderr
37.Op Fl h | \-help
38.Op Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE
39.Op Fl I | \-info
40.Op Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE
41.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
42.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
43.Op Fl m | \-monitor
44.Op Fl O | \-no-stdout
45.Op Fl q | \-quiet
46.Op Fl r | \-restart
47.Op Fl s | \-start
48.Op Fl T DELAY | \-timeout= Ns Ar TIMEOUT
49.Op Fl v | \-version
50.Sh DESCRIPTION
51.Nm
52can be used to start or stop GNUnet services, including the ARM service itself.
53The ARM service is a supervisor for GNUnet's service processes.
54ARM starts services on-demand or as configured and restarts them if they crash.
55.Bl -tag -width Ds
56.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
15Use the configuration file FILENAME. 57Use the configuration file FILENAME.
16.B 58.It Fl d | \-delete
17.IP "\-e, \-\-end" 59Delete config file and directory on exit.
18Shutdown all GNUnet services (including ARM itself). Running 60.It Fl e | \-end
19"gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. 61Shutdown all GNUnet services (including ARM itself).
20.B 62Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer.
21.IP "\-h, \-\-help" 63.It Fl E | \-no-stderr
64Don't let gnunet-arm inherit standard error.
65.It Fl h | \-help
22Print short help on options. 66Print short help on options.
23.B 67.It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE
24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 68Starts the specified SERVICE if it is not already running.
25Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 69More specifically, this makes the service behave as if it were in the default services list.
26.B 70.It Fl I | \-info
27.IP "\-i SERVICE, \-\-init=SERVICE"
28Starts the specified SERVICE if it is not already running. More specifically,
29this makes the service behave as if it were in the default services list.
30.B
31.IP "\-k SERVICE, \-\-kill=SERVICE"
32Stop the specified SERVICE if it is running. While this will kill the service
33right now, the service may be restarted immediately if other services depend
34on it (service is then started 'on-demand'). If the service used to be a 'default'
35service, its default-service status will be revoked. If the
36service was not a default service, it will just be (temporarily) stopped,
37but could be re-started on-demand at any time.
38.B
39.IP "\-m, \-\-monitor"
40Monitor service activity of ARM. In this mode, the command will not terminate
41until the user presses CTRL-C.
42.B
43.IP "\-s, \-\-start"
44Start all GNUnet default services on this system (and also ARM). Naturally,
45if a service is demanded by a default service, it will then also be started.
46Running "gnunet-arm \-s" is the usual way to start a GNUnet peer.
47.B
48.IP "\-I, \-\-info"
49List all running services. 71List all running services.
50.B 72.It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE
51.IP "\-v, \-\-version" 73Stop the specified SERVICE if it is running.
74While this will kill the service right now, the service may be restarted immediately if other services depend on it (service is then started 'on-demand').
75If the service used to be a 'default' service, its default-service status will be revoked.
76If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time.
77.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
78Write logs to FILENAME.
79.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
80Use LOGLEVEL for logging.
81Valid values are DEBUG, INFO, WARNING and ERROR.
82.It Fl m | \-monitor
83Monitor service activity of ARM.
84In this mode, the command will not terminate until the user presses CTRL-C.
85.It Fl O | \-no-stdout
86Don't let gnunet-arm inherit standard output
87.It Fl q | \-quiet
88Don't print status messages.
89.It Fl r | \-restart
90Stop and start all GNUnet default services.
91.It Fl s | \-start
92Start all GNUnet default services on this system (and also ARM).
93Naturally, if a service is demanded by a default service, it will then also be started.
94Running "gnunet-arm \-s" is the usual way to start a GNUnet peer.
95.It Fl T DELAY | \-timeout= Ns Ar DELAY
96Exit with error status if operation does not finish after DELAY
97.It Fl v | \-version
52Print GNUnet version number. 98Print GNUnet version number.
53.SH BUGS 99.El
54Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 100.Sh EXAMPLES
55electronic mail to <gnunet\-developers@gnu.org> 101Start the gnunet-arm for the user:
56.SH SEE ALSO 102.Pp
57gnunet\-config(1), gnunet\-setup(1) 103.Dl gnunet-arm -s
58.PP 104.Pp
59The full documentation for 105Stop the gnunet-arm for the user:
60.B gnunet 106.Pp
61is maintained as a Texinfo manual. 107.Dl $ gnunet-arm -e
108.Sh SEE ALSO
109.Xr gnunet-config 1 ,
110.Xr gnunet-setup 1
111.sp
112The full documentation for gnunet is maintained as a Texinfo manual.
62If the 113If the
63.B info 114.Xr info 1
64and 115and gnunet programs are properly installed at your site, the command
65.B gnunet 116.Pp
66programs are properly installed at your site, the command 117.Dl info gnunet
67.IP 118.Pp
68.B info gnunet
69.PP
70should give you access to the complete handbook, 119should give you access to the complete handbook,
71.IP 120.Pp
72.B info gnunet-c-tutorial 121.Dl info gnunet-c-tutorial
73.PP 122.Pp
74will give you access to a tutorial for developers. 123will give you access to a tutorial for developers.
75.PP 124.sp
76Depending on your installation, this information is also 125Depending on your installation, this information is also available in
77available in 126.Xr gnunet 7 and
78\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 127.Xr gnunet-c-tutorial 7 .
128.\".Sh HISTORY
129.\".Sh AUTHORS
130.Sh BUGS
131Report bugs by using
132.Lk https://bugs.gnunet.org
133or by sending electronic mail to
134.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1
index c098ed576..1e7b7731c 100644
--- a/doc/man/gnunet-ats.1
+++ b/doc/man/gnunet-ats.1
@@ -1,85 +1,110 @@
1.TH GNUNET\-ATS 1 "October 16, 2015" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-ats \- display information about transport resource allocation 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-ats 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.RI [ options ] 6.\" any later version published by the Free Software Foundation; with no
7.br 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.SH DESCRIPTION 8.\" copy of the license is included in the file
9\fBgnunet\-ats\fP can be used to display information about the GNUnet's 9.\" ``FDL-1.3''.
10transport selection mechanism. It shows information about the 10.\"
11addresses and the assigned input and output bandwidth. 11.\" A copy of the license is also available from the Free Software
12.SH OPTIONS 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.B 13.\"
14.IP "\-a, \-\-aa" 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 @url{http://www.gnu.org/licenses/gpl.html}.
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd October 16, 2015
25.Dt GNUNET-ATS 1
26.Os
27.Sh NAME
28.Nm gnunet-ats
29.Nd
30display information about transport resource allocation
31.Sh SYNOPSIS
32.Nm
33.Op Fl a | \-all
34.Op Fl C Ar PEERID | Fl \-connect= Ns Ar PEERID
35.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
36.Op Fl h | \-help
37.Op Fl i Ar PEERID | Fl \-id= Ns Ar PEERID
38.Op Fl k Ar VALUE | Fl \-value= Ns Ar VALUE
39.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
40.Op Fl m | \-monitor
41.Op Fl n | \-numeric
42.Op Fl p Ar PREFERENCE | Fl \-preference= Ns Ar PREFERENCE
43.Op Fl q | \-quotas
44.Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE
45.Op Fl u | \-used
46.Op Fl V | \-verbose
47.Op Fl v | \-version
48.Sh DESCRIPTION
49.Nm
50can be used to display information about the GNUnet's transport selection mechanism.
51It shows information about the addresses and the assigned input and output bandwidth.
52.Sh OPTIONS
53.Bl -tag -width Ds
54.It Fl a | \-all
15List all addresses currently known to ats. 55List all addresses currently known to ats.
16.B 56.It Fl C Ar PEERID | Fl \-connect= Ns Ar PEERID
17.IP "\-c FILENAME, \-\-config=FILENAME" 57Ask ATS to suggest an address for PEERID to transport to establish a connection.
58Note that you can use the gnunet-transport commandline tool to force disconnects.
59.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
18Use the configuration file FILENAME. 60Use the configuration file FILENAME.
19.B 61.It Fl h | \-help
20.IP "\-C, \-\-connect=PEERID"
21Ask ATS to suggest an address for PEERID to transport to establish a
22connection.
23Note that you can use the gnunet\-transport command\-line tool to
24force disconnects.
25.B
26.IP "\-h, \-\-help"
27Print short help on options. 62Print short help on options.
28.B 63.It Fl i Ar PEERID | Fl \-id= Ns Ar PEERID
29.IP "\-i, \-\-id=PEERID" 64Print information for a specific peer identity only.
30Print information for a specific peer identity only 65.It Fl k Ar VALUE | Fl \-value= Ns Ar VALUE
31.B 66Value to set for when changing preference values.
32.IP "\-k, \-\-value=VALUE" 67.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
33Value to set for when changing preference values
34.B
35.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
36Use LOGLEVEL for logging. 68Use LOGLEVEL for logging.
37Valid values are DEBUG, INFO, WARNING and ERROR. 69Valid values are DEBUG, INFO, WARNING and ERROR.
38.B 70.It Fl m | \-monitor
39.IP "\-m, \-\-monitor" 71Monitor changes to the bandwidth assignments continuously.
40Monitor changes to the bandwidth assignments continuously 72.It Fl n | \-numeric
41.B 73Do not resolve IP addresses to hostnames.
42.IP "\-n, \-\-numeric" 74.It Fl p Ar PREFERENCE | Fl \-preference= Ns Ar PREFERENCE
43Do not resolve IP addresses to hostnames 75Set preference values, -i, -k and -t required.
44.B 76.It Fl q | \-quotas
45.IP "\-k, \-\-preference=E"
46Set preference values, \-i, \-k and \-t required
47.B
48.IP "\-q, \-\-quotas"
49Print quotas for all network types 77Print quotas for all network types
50.B 78.It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE
51.IP "\-t, \-\-type=VALUE"
52Preference type to change: latency | bandwidth 79Preference type to change: latency | bandwidth
53.B 80.It Fl u | \-used
54.IP "\-u, \-\-used"
55Print addresses actively used only 81Print addresses actively used only
56.B 82.It Fl V | \-verbose
57.IP "\-V, \-\-verbose"
58Print verbose output (include ATS address properties) 83Print verbose output (include ATS address properties)
59.B 84.It v | \-version
60.IP "\-v, \-\-version"
61Print GNUnet version number. 85Print GNUnet version number.
62.SH BUGS 86.El
63Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 87.Sh SEE ALSO
64electronic mail to <bug\-gnunet@gnu.org> 88.Xr gnunet-transport 1
65.SH SEE ALSO 89.sp
66gnunet\-transport(1) 90The full documentation for gnunet is maintained as a Texinfo manual.
67The full documentation for 91If the
68.B gnunet 92.Xr info 1
69is maintained as a Texinfo manual. If the 93and gnunet programs are properly installed at your site, the command
70.B info 94.Pp
71and 95.Dl info gnunet
72.B gnunet 96.Pp
73programs are properly installed at your site, the command
74.IP
75.B info gnunet
76.PP
77should give you access to the complete handbook, 97should give you access to the complete handbook,
78.IP 98.Pp
79.B info gnunet-c-tutorial 99.Dl info gnunet-c-tutorial
80.PP 100.Pp
81will give you access to a tutorial for developers. 101will give you access to a tutorial for developers.
82.PP 102.Pp
83Depending on your installation, this information is also 103Depending on your installation, this information is also available in
84available in 104.Xr gnunet 7 and
85\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 105.Xr gnunet-c-tutorial 7 .
106.Sh BUGS
107Report bugs by using
108.Lk https://bugs.gnunet.org
109or by sending electronic mail to
110.Aq Mt bug-gnunet@gnu.org .
diff --git a/doc/man/gnunet-bcd.1 b/doc/man/gnunet-bcd.1
index 02b4397de..9b37a097b 100644
--- a/doc/man/gnunet-bcd.1
+++ b/doc/man/gnunet-bcd.1
@@ -13,19 +13,14 @@ installed. If it does not work for you, try installing the full
13TeXLive distribution first, for example using the package\-manager 13TeXLive distribution first, for example using the package\-manager
14apt: "apt-get install texlive-full". 14apt: "apt-get install texlive-full".
15.SH OPTIONS 15.SH OPTIONS
16.B
17.IP "\-p PORT, \-\-port=PORT" 16.IP "\-p PORT, \-\-port=PORT"
18Run the HTTP server on port PORT. 17Run the HTTP server on port PORT.
19.B
20.IP "\-c FILENAME, \-\-config=FILENAME" 18.IP "\-c FILENAME, \-\-config=FILENAME"
21Use the configuration file FILENAME. 19Use the configuration file FILENAME.
22.B
23.IP "\-h, \-\-help" 20.IP "\-h, \-\-help"
24Print short help on options. 21Print short help on options.
25.B
26.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 22.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
27Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 23Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
28.B
29.IP "\-v, \-\-version" 24.IP "\-v, \-\-version"
30Print GNUnet version number. 25Print GNUnet version number.
31.SH BUGS 26.SH BUGS
diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1
index 8404f085c..44d7fffca 100644
--- a/doc/man/gnunet-cadet.1
+++ b/doc/man/gnunet-cadet.1
@@ -21,42 +21,30 @@ For one\-to\-many communication \fBgnunet\-social\fP may be better
21suited, however. 21suited, however.
22 22
23.SH SPECIFIC OPTIONS 23.SH SPECIFIC OPTIONS
24.B
25.IP "\-C CONNECTION_ID, \-\-connection=CONNECTION_ID" 24.IP "\-C CONNECTION_ID, \-\-connection=CONNECTION_ID"
26Provide information about a particular connection. 25Provide information about a particular connection.
27.B
28.IP "\-d, \-\-dump" 26.IP "\-d, \-\-dump"
29Dump debug information to STDERR. 27Dump debug information to STDERR.
30.B
31.IP "\-e, \-\-echo" 28.IP "\-e, \-\-echo"
32Activate echo mode. 29Activate echo mode.
33.B
34.IP "\-o SHARED_SECRET, \-\-open-port=SHARED_SECRET" 30.IP "\-o SHARED_SECRET, \-\-open-port=SHARED_SECRET"
35Listen for connections using a shared secret among sender and recipient. 31Listen for connections using a shared secret among sender and recipient.
36.B
37.IP "\-p PEER_ID, \-\-peer=PEER_ID" 32.IP "\-p PEER_ID, \-\-peer=PEER_ID"
38Provide information about a patricular peer. 33Provide information about a patricular peer.
39.B
40.IP "\-P, \-\-peers" 34.IP "\-P, \-\-peers"
41Provide information about all peers. 35Provide information about all peers.
42.B
43.IP "\-T, \-\-tunnels" 36.IP "\-T, \-\-tunnels"
44Provide information about all tunnels. 37Provide information about all tunnels.
45 38
46.SH STANDARD OPTIONS 39.SH STANDARD OPTIONS
47.B
48.IP "\-c FILENAME, \-\-config=FILENAME" 40.IP "\-c FILENAME, \-\-config=FILENAME"
49Use the configuration file FILENAME. 41Use the configuration file FILENAME.
50.B
51.IP "\-h, \-\-help" 42.IP "\-h, \-\-help"
52Print short help on options. 43Print short help on options.
53.B
54.IP "\-l LOGFILE, \-\-logfile=LOGFILE" 44.IP "\-l LOGFILE, \-\-logfile=LOGFILE"
55Configure logging to write logs to LOGFILE. 45Configure logging to write logs to LOGFILE.
56.B
57.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 46.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
58Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 47Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
59.B
60.IP "\-v, \-\-version" 48.IP "\-v, \-\-version"
61Print GNUnet version number. 49Print GNUnet version number.
62 50
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1
index f1443283f..8eca8de10 100644
--- a/doc/man/gnunet-config.1
+++ b/doc/man/gnunet-config.1
@@ -7,38 +7,28 @@ gnunet\-config \- manipulate GNUnet configuration files
7.SH DESCRIPTION 7.SH DESCRIPTION
8\fBgnunet\-config\fP can be used to read or modify GNUnet configuration files. 8\fBgnunet\-config\fP can be used to read or modify GNUnet configuration files.
9.SH OPTIONS 9.SH OPTIONS
10.B
11.IP "\-f, \-\-filename" 10.IP "\-f, \-\-filename"
12When accessing a specific option using \-s and \-o, perform expansions as if the 11Try to perform expansions as if the option values represent filenames (will
13value represents a filename. 12also be applied even if the option is not really a filename).
14.B
15.IP "\-s SECTION, \-\-section=SECTION" 13.IP "\-s SECTION, \-\-section=SECTION"
16Which configuration section should be accessed or edited. Required option. 14Which configuration section should be accessed or edited. Required option.
17.B
18.IP "\-S, \-\-list\-sections" 15.IP "\-S, \-\-list\-sections"
19List available configuration sections for use with \-\-section. 16List available configuration sections for use with \-\-section.
20.B
21.IP "\-W, \-\-rewrite" 17.IP "\-W, \-\-rewrite"
22Consider differences to defaults only. 18Consider differences to defaults only.
23.B
24.IP "\-o OPTION, \-\-option=OPTION" 19.IP "\-o OPTION, \-\-option=OPTION"
25Which configuration option should be accessed or edited. Required to set a value. 20Which configuration option should be accessed or edited. Required to set a value.
26If not given, all values of a given section will be printed in the 21If not given, all values of a given section will be printed in the
27format "OPTION = VALUE". 22format "OPTION = VALUE".
28.B
29.IP "\-V VALUE, \-\-value VALUE" 23.IP "\-V VALUE, \-\-value VALUE"
30Configuration value to store in the given section under the given option. 24Configuration value to store in the given section under the given option.
31Must only be given together with \-s and \-o options. 25Must only be given together with \-s and \-o options.
32.B
33.IP "\-c FILENAME, \-\-config=FILENAME" 26.IP "\-c FILENAME, \-\-config=FILENAME"
34Use the configuration file FILENAME. 27Use the configuration file FILENAME.
35.B
36.IP "\-h, \-\-help" 28.IP "\-h, \-\-help"
37Print short help on options. 29Print short help on options.
38.B
39.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 30.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
40Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 31Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
41.B
42.IP "\-v, \-\-version" 32.IP "\-v, \-\-version"
43Print GNUnet version number. 33Print GNUnet version number.
44.SH BUGS 34.SH BUGS
diff --git a/doc/man/gnunet-conversation-test.1 b/doc/man/gnunet-conversation-test.1
index 5c08d3dab..477da5042 100644
--- a/doc/man/gnunet-conversation-test.1
+++ b/doc/man/gnunet-conversation-test.1
@@ -17,17 +17,13 @@ known to your computer).
17You can use gnunet\-conversation\-test without having a peer running 17You can use gnunet\-conversation\-test without having a peer running
18on your computer. 18on your computer.
19.SH OPTIONS 19.SH OPTIONS
20.B
21.IP "\-c FILENAME, \-\-config=FILENAME" 20.IP "\-c FILENAME, \-\-config=FILENAME"
22Use the configuration file FILENAME. 21Use the configuration file FILENAME.
23.B
24.IP "\-h, \-\-help" 22.IP "\-h, \-\-help"
25Print short help on options. 23Print short help on options.
26.B
27.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
28Use LOGLEVEL for logging. 25Use LOGLEVEL for logging.
29Valid values are DEBUG, INFO, WARNING and ERROR. 26Valid values are DEBUG, INFO, WARNING and ERROR.
30.B
31.IP "\-v, \-\-version" 27.IP "\-v, \-\-version"
32Print GNUnet version number. 28Print GNUnet version number.
33.SH BUGS 29.SH BUGS
diff --git a/doc/man/gnunet-conversation.1 b/doc/man/gnunet-conversation.1
index 5925871da..3815b3887 100644
--- a/doc/man/gnunet-conversation.1
+++ b/doc/man/gnunet-conversation.1
@@ -15,25 +15,19 @@ your zone in the GNU Name System (using gnunet\-namestore).
15gnunet\-conversation has an interactive help system via the /help 15gnunet\-conversation has an interactive help system via the /help
16command. 16command.
17.SH OPTIONS 17.SH OPTIONS
18.B
19.IP "\-c FILENAME, \-\-config=FILENAME" 18.IP "\-c FILENAME, \-\-config=FILENAME"
20Use the configuration file FILENAME. 19Use the configuration file FILENAME.
21.B
22.IP "\-e NAME, \-\-ego=NAME" 20.IP "\-e NAME, \-\-ego=NAME"
23Specifies the NAME of the ego to use (for caller ID). 21Specifies the NAME of the ego to use (for caller ID).
24.B
25.IP "\-h, \-\-help" 22.IP "\-h, \-\-help"
26Print short help on options. 23Print short help on options.
27.B
28.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
29Use LOGLEVEL for logging. 25Use LOGLEVEL for logging.
30Valid values are DEBUG, INFO, WARNING and ERROR. 26Valid values are DEBUG, INFO, WARNING and ERROR.
31.B
32.IP "\-p LINE, \-\-phone=LINE" 27.IP "\-p LINE, \-\-phone=LINE"
33Optional argument that can be used to specify the phone LINE to be used with 28Optional argument that can be used to specify the phone LINE to be used with
34the conversation service. 29the conversation service.
35The default LINE is zero, which should be fine for most users. 30The default LINE is zero, which should be fine for most users.
36.B
37.IP "\-v, \-\-version" 31.IP "\-v, \-\-version"
38Print GNUnet version number. 32Print GNUnet version number.
39.SH BUGS 33.SH BUGS
diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1
index 552df25b6..f61a0a8b3 100644
--- a/doc/man/gnunet-dns2gns.1
+++ b/doc/man/gnunet-dns2gns.1
@@ -1,60 +1,60 @@
1.TH GNUNET\-DNS2GNS 1 "March 5, 2018" "GNUnet" 1.Dd March 5, 2018
2 2.Dt GNUNET-DNS2GNS 1
3.SH NAME 3.Os
4gnunet\-dns2gns \- run a DNS-to-GNS proxy 4.Sh NAME
5 5.Nm gnunet-dns2gns
6.SH SYNOPSIS 6.Nd
7.B gnunet\-dns2gns 7run a DNS-to-GNS proxy
8.RI [ options ] 8.Sh SYNOPSIS
9.br 9.Nm
10 10.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
11.SH DESCRIPTION 11.Op Fl d Ar IP | Fl \-dns= Ns Ar IP
12Most users will not want to run an DNS to GNS proxy/gateway and thus will not 12.Op Fl h | \-help
13need this program. 13.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
14 14.Op Fl v | \-version
15\fBgnunet\-dns2gns\fP runs a DNS resolver which delegates requests GNS if 15.Sh DESCRIPTION
16the TLD matches one configured for GNS. All other requests are forwarded 16.Nm
17to DNS. This DNS proxy is useful for enabling non-personalized 17runs a DNS resolver which delegates requests GNS if the TLD matches one configured for GNS.
18GNS\-resolution to an entire network or to offer GNS\-resolution to DNS users. 18All other requests are forwarded to DNS.
19 19This DNS proxy is useful for enabling non-personalized GNS\-resolution to an entire network or to offer GNS\-resolution to DNS users.
20.SH OPTIONS 20.Bl -tag -width Ds
21.B 21.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
22.IP "\-c FILENAME, \-\-config=FILENAME"
23Use the configuration file FILENAME. 22Use the configuration file FILENAME.
24.B 23.It Fl d Ar IP | Fl \-dns= Ns Ar IP
25.IP "\-d IP, \-\-dns=IP"
26IP address of a recursive DNS resolver that should be used for non-GADS hostnames. 24IP address of a recursive DNS resolver that should be used for non-GADS hostnames.
27.B 25.It Fl h | \-help
28.IP "\-h, \-\-help"
29Print short help on options. 26Print short help on options.
30.B 27.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
31.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 28Use LOGLEVEL for logging.
32Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 29Valid values are DEBUG, INFO, WARNING and ERROR.
33.B 30.It Fl v | \-version
34.IP "\-v, \-\-version"
35Print GNUnet version number. 31Print GNUnet version number.
36 32.El
37.SH BUGS 33.Sh SEE ALSO
38Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 34.Xr gnunet-gns-fcfs 1 ,
39electronic mail to <bug\-gnunet@gnu.org> 35.Xr gnunet-gns 1 ,
40.SH SEE ALSO 36.Xr gnunet-identity 1
41gnunet\-gns\-fcfs(1), gnunet\-gns(1), gnunet\-identity(1) 37.sp
42The full documentation for 38The full documentation for gnunet is maintained as a Texinfo manual.
43.B gnunet 39If the
44is maintained as a Texinfo manual. If the 40.Xr info 1
45.B info 41and gnunet programs are properly installed at your site, the command
46and 42.Pp
47.B gnunet 43.Dl info gnunet
48programs are properly installed at your site, the command 44.Pp
49.IP
50.B info gnunet
51.PP
52should give you access to the complete handbook, 45should give you access to the complete handbook,
53.IP 46.Pp
54.B info gnunet-c-tutorial 47.Dl info gnunet-c-tutorial
55.PP 48.Pp
56will give you access to a tutorial for developers. 49will give you access to a tutorial for developers.
57.PP 50.sp
58Depending on your installation, this information is also 51Depending on your installation, this information is also available in
59available in 52.Xr gnunet 7 and
60\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 53.Xr gnunet-c-tutorial 7 .
54.\".Sh HISTORY
55.\".Sh AUTHORS
56.Sh BUGS
57Report bugs by using
58.Lk https://bugs.gnunet.org
59or by sending electronic mail to
60.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-ecc.1 b/doc/man/gnunet-ecc.1
index aedc0bc49..2aa7743b2 100644
--- a/doc/man/gnunet-ecc.1
+++ b/doc/man/gnunet-ecc.1
@@ -17,33 +17,25 @@ take a while. If the option \-p is given, the corresponding public
17key will be printed to the console. 17key will be printed to the console.
18 18
19.SH OPTIONS 19.SH OPTIONS
20.B
21.IP "\-g COUNT, \-\-generate-keys=COUNT" 20.IP "\-g COUNT, \-\-generate-keys=COUNT"
22Create COUNT public-private key pairs and write them to FILENAME. 21Create COUNT public-private key pairs and write them to FILENAME.
23Used for creating a file for testing. 22Used for creating a file for testing.
24.B
25.IP "\-p, \-\-print-public-key" 23.IP "\-p, \-\-print-public-key"
26Print the corresponding public key to stdout. This is the value used 24Print the corresponding public key to stdout. This is the value used
27for PKEY records in GNS. 25for PKEY records in GNS.
28.B
29.IP "\-P, \-\-print-private-key" 26.IP "\-P, \-\-print-private-key"
30Print the corresponding private key to stdout. This is the value used 27Print the corresponding private key to stdout. This is the value used
31for PKEY records in GNS. 28for PKEY records in GNS.
32.B
33.IP "\-x, \-\-print-hex" 29.IP "\-x, \-\-print-hex"
34Print the corresponding public key to stdout in HEX format. Useful 30Print the corresponding public key to stdout in HEX format. Useful
35for comparing to Ed25519 keys in X.509 tools. 31for comparing to Ed25519 keys in X.509 tools.
36.B
37.IP "\-c FILENAME, \-\-config=FILENAME" 32.IP "\-c FILENAME, \-\-config=FILENAME"
38Use the configuration file FILENAME. 33Use the configuration file FILENAME.
39.B
40.IP "\-h, \-\-help" 34.IP "\-h, \-\-help"
41Print short help on options. 35Print short help on options.
42.B
43.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 36.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
44Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 37Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and
45ERROR. 38ERROR.
46.B
47.IP "\-v, \-\-version" 39.IP "\-v, \-\-version"
48Print GNUnet version number. 40Print GNUnet version number.
49 41
diff --git a/doc/man/gnunet-gns-proxy-setup-ca.1 b/doc/man/gnunet-gns-proxy-setup-ca.1
new file mode 100644
index 000000000..54df856eb
--- /dev/null
+++ b/doc/man/gnunet-gns-proxy-setup-ca.1
@@ -0,0 +1,64 @@
1.Dd March 6, 2019
2.Dt GNUNET-GNS-PROXY-SETUP-CA 1
3.Os
4.Sh NAME
5.Nm gnunet-gns-proxy-setup-ca
6.Nd generate an X509 certificate for gnunet-gns-proxy and install it
7.Sh SYNOPSIS
8.Nm
9.Op Fl c Ar FILE
10.\".Op Fl f Ar FILE
11.Op Fl h
12.Op Fl v
13.Op Fl V
14.Sh DESCRIPTION
15.Nm
16is a shell script to generate X509 certificates for your gnunet-gns-proxy and to install it for both GNUnet and your web browser.
17It currently supports Firefox and Chrome based browsers through the help of external helpers: certutil (nss) is used for the import into webbrowsers, openssl is used to generated the CA.
18.Bl -tag -width Ds
19.It Fl c Ar FILE
20Use the configuration file FILE.
21.\" .It Fl f
22.\" Perform expansions of the variables used in the config value of gns-proxy.
23.\" This will usually expand $GNUNET_DATA_HOME to represents its path.
24.It Fl h
25Print short help on options
26.It Fl v
27Print the version
28.It Fl V
29be verbose
30.El
31.Sh FILES
32.Pa gnunet.conf
33.Sh SEE ALSO
34.Xr gnunet-gns 1 ,
35.Xr gnunet-gns-proxy 1 ,
36.Xr gnunet.conf 5
37.sp
38The full documentation for gnunet is maintained as a Texinfo manual.
39If the
40.Xr info 1
41and gnunet programs are properly installed at your site, the command
42.Bd -literal -offset indent -compact
43 info gnunet
44.Ed
45should give you access to the complete handbook,
46.Bd -literal -offset indent -compact
47 info gnunet-c-tutorial
48.Ed
49will give you access to a tutorial for developers.
50.sp
51Depending on your installation, this information is also
52available in
53.Xr gnunet 7 and
54.Xr gnunet-c-tutorial 7 .
55.Sh HISTORY
56This man page first appeared in GNUnet 0.11.1.
57.Sh AUTHORS
58This page was written by
59.An ng0 Aq Mt ng0@gnunet.org .
60.Sh BUGS
61Report bugs by using
62.Lk https://bugs.gnunet.org
63or by sending electronic mail to
64.Aq Mt bug-gnunet@gnu.org .
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1
index 6c12e2c09..603c5a28c 100644
--- a/doc/man/gnunet-gns-proxy.1
+++ b/doc/man/gnunet-gns-proxy.1
@@ -15,26 +15,20 @@ CA certificate has to be generated that is used by the proxy. Thus
15of this proxy or the \-\-authority switch is used to specify an 15of this proxy or the \-\-authority switch is used to specify an
16appropriate CA certificate that is already trusted by the browser. 16appropriate CA certificate that is already trusted by the browser.
17.SH OPTIONS 17.SH OPTIONS
18.B
19.IP "\-c FILENAME, \-\-config=FILENAME" 18.IP "\-c FILENAME, \-\-config=FILENAME"
20Use the configuration file FILENAME. 19Use the configuration file FILENAME.
21.B
22.IP "\-a AUTHORITY, \-\-authority=AUTHORITY" 20.IP "\-a AUTHORITY, \-\-authority=AUTHORITY"
23Path to a PEM CA file that contains the certificate and private key of 21Path to a PEM CA file that contains the certificate and private key of
24the CA to use to assert the validity of GNS names. The default port is 22the CA to use to assert the validity of GNS names. The default port is
25specified in the configuration file for the gns service under 23specified in the configuration file for the gns service under
26"[gns-proxy]" PROXY_CACERT. 24"[gns-proxy]" PROXY_CACERT.
27.B
28.IP "\-p PORT, \-\-port=PORT" 25.IP "\-p PORT, \-\-port=PORT"
29The port this proxy should listen on. Default is 7777. 26The port this proxy should listen on. Default is 7777.
30.B
31.IP "\-h, \-\-help" 27.IP "\-h, \-\-help"
32Print short help on options. 28Print short help on options.
33.B
34.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 29.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
35Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 30Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and
36ERROR. 31ERROR.
37.B
38.IP "\-v, \-\-version" 32.IP "\-v, \-\-version"
39Print GNUnet version number. 33Print GNUnet version number.
40.SH BUGS 34.SH BUGS
diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1
index 597297629..750c72d95 100644
--- a/doc/man/gnunet-gns.1
+++ b/doc/man/gnunet-gns.1
@@ -8,33 +8,26 @@ gnunet\-gns \- Access to GNU Name System
8\fBgnunet\-gns\fP can be used to lookup and process GNU Name Service 8\fBgnunet\-gns\fP can be used to lookup and process GNU Name Service
9names. 9names.
10.SH OPTIONS 10.SH OPTIONS
11.B
12.IP "\-c FILENAME, \-\-config=FILENAME" 11.IP "\-c FILENAME, \-\-config=FILENAME"
13Use the configuration file FILENAME. 12Use the configuration file FILENAME.
14.B
15.IP "\-r, \-\-raw" 13.IP "\-r, \-\-raw"
16No unneeded output. 14No unneeded output.
17This is a quiet mode where only important information is displayed. 15This is a quiet mode where only important information is displayed.
18For example a lookup for an IP address will only yield the IP address, 16For example a lookup for an IP address will only yield the IP address,
19no descriptive text. 17no descriptive text.
20.B
21.IP "\-h, \-\-help" 18.IP "\-h, \-\-help"
22Print short help on options. 19Print short help on options.
23.B
24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 20.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
25Use LOGLEVEL for logging. 21Use LOGLEVEL for logging.
26Valid values are DEBUG, INFO, WARNING and ERROR. 22Valid values are DEBUG, INFO, WARNING and ERROR.
27.B
28.IP "\-u NAME, \-\-lookup=NAME" 23.IP "\-u NAME, \-\-lookup=NAME"
29Name to lookup. 24Name to lookup.
30Resolve the specified name using the GNU Name System. 25Resolve the specified name using the GNU Name System.
31.B
32.IP "\-t TYPE, \-\-type=TYPE" 26.IP "\-t TYPE, \-\-type=TYPE"
33Resource Record Type (TYPE) to look for. 27Resource Record Type (TYPE) to look for.
34Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, 28Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA,
35MX, LEHO, VPN, REV, PTR, TXT. 29MX, LEHO, VPN, REV, PTR, TXT.
36Defaults to "A". 30Defaults to "A".
37.B
38.IP "\-v, \-\-version" 31.IP "\-v, \-\-version"
39Print GNUnet version number. 32Print GNUnet version number.
40.SH RETURN VALUE 33.SH RETURN VALUE
diff --git a/doc/man/gnunet-namecache.1 b/doc/man/gnunet-namecache.1
index 78acb017b..06946e387 100644
--- a/doc/man/gnunet-namecache.1
+++ b/doc/man/gnunet-namecache.1
@@ -13,23 +13,17 @@ gnunet\-namecache \- inspect namecache
13namecache. 13namecache.
14 14
15.SH OPTIONS 15.SH OPTIONS
16.B
17.IP "\-c FILENAME, \-\-config=FILENAME" 16.IP "\-c FILENAME, \-\-config=FILENAME"
18Use the configuration file FILENAME. 17Use the configuration file FILENAME.
19.B
20.IP "\-h, \-\-help" 18.IP "\-h, \-\-help"
21Print short help on options. 19Print short help on options.
22.B
23.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 20.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
24Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 21Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and
25ERROR. 22ERROR.
26.B
27.IP "\-n NAME, \-\-name=NAME" 23.IP "\-n NAME, \-\-name=NAME"
28Name (label) of the record to display (mandatory option) 24Name (label) of the record to display (mandatory option)
29.B
30.IP "\-v, \-\-version" 25.IP "\-v, \-\-version"
31Print GNUnet version number. 26Print GNUnet version number.
32.B
33.IP "\-z PKEY, \-\-zone=PKEY" 27.IP "\-z PKEY, \-\-zone=PKEY"
34Specifies the public key of the zone to inspect (mandatory option) 28Specifies the public key of the zone to inspect (mandatory option)
35 29
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1
index a6c9d2b32..c1eca224f 100644
--- a/doc/man/gnunet-namestore-fcfsd.1
+++ b/doc/man/gnunet-namestore-fcfsd.1
@@ -27,20 +27,15 @@ pseudonym (using "gnunet\-identity \-C NAME"), and use it with the
27"-z" option. After that, you can start the FCFSD service (possibly using 27"-z" option. After that, you can start the FCFSD service (possibly using
28gnunet\-arm). 28gnunet\-arm).
29.SH OPTIONS 29.SH OPTIONS
30.B
31.IP "\-c FILENAME, \-\-config=FILENAME" 30.IP "\-c FILENAME, \-\-config=FILENAME"
32Use the configuration file FILENAME. 31Use the configuration file FILENAME.
33.B
34.IP "\-h, \-\-help" 32.IP "\-h, \-\-help"
35Print short help on options. 33Print short help on options.
36.B
37.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 34.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
38Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 35Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and
39ERROR. 36ERROR.
40.B
41.IP "\-v, \-\-version" 37.IP "\-v, \-\-version"
42Print GNUnet version number. 38Print GNUnet version number.
43.B
44.IP "\-z EGO, \-\-zone=EGO" 39.IP "\-z EGO, \-\-zone=EGO"
45Specifies for which EGO should FCFSD manage the zone. 40Specifies for which EGO should FCFSD manage the zone.
46.SH BUGS 41.SH BUGS
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index 7517a4f5e..6a824cc47 100644
--- a/doc/man/gnunet-namestore.1
+++ b/doc/man/gnunet-namestore.1
@@ -12,13 +12,10 @@ gnunet\-namestore \- manipulate GNU Name System (GNS) zone data
12\fBgnunet\-namestore\fP can be used to manipulate records in a GNS zone. 12\fBgnunet\-namestore\fP can be used to manipulate records in a GNS zone.
13 13
14.SH OPTIONS 14.SH OPTIONS
15.B
16.IP "\-a, \-\-add" 15.IP "\-a, \-\-add"
17Desired operation is adding a record 16Desired operation is adding a record
18.B
19.IP "\-c FILENAME, \-\-config=FILENAME" 17.IP "\-c FILENAME, \-\-config=FILENAME"
20Use the configuration file FILENAME. 18Use the configuration file FILENAME.
21.B
22.IP "\-d, \-\-delete" 19.IP "\-d, \-\-delete"
23Desired operation is deleting records under the given name that match 20Desired operation is deleting records under the given name that match
24the specified type (\-t) and value (\-V). If type or value are not 21the specified type (\-t) and value (\-V). If type or value are not
@@ -26,41 +23,31 @@ specified, it means that all types (or values) should be assumed to
26match (and possibly multiple or all values under the given label will 23match (and possibly multiple or all values under the given label will
27be deleted). Specifying a label (\-n) is mandatory. Note that 24be deleted). Specifying a label (\-n) is mandatory. Note that
28matching by expiration time or flags is (currently) not supported. 25matching by expiration time or flags is (currently) not supported.
29.B
30.IP "\-D, \-\-display" 26.IP "\-D, \-\-display"
31Desired operation is listing of matching records 27Desired operation is listing of matching records
32.B
33.IP "\-e TIME, \-\-expiration=TIME" 28.IP "\-e TIME, \-\-expiration=TIME"
34Specifies expiration time of record to add; format is relative time, 29Specifies expiration time of record to add; format is relative time,
35i.e "1 h" or "7 d 30 m". Supported units are "ms", "s", "min" or 30i.e "1 h" or "7 d 30 m". Supported units are "ms", "s", "min" or
36"minutes", "h" (hours), "d" (days) and "a" (years). 31"minutes", "h" (hours), "d" (days) and "a" (years).
37.B
38.IP "\-h, \-\-help" 32.IP "\-h, \-\-help"
39Print short help on options. 33Print short help on options.
40.B
41.IP "\-i NICKNAME, \-\-nick=NICKNAME" 34.IP "\-i NICKNAME, \-\-nick=NICKNAME"
42Set the desired NICKNAME for the zone. The nickname will be included 35Set the desired NICKNAME for the zone. The nickname will be included
43in all (public) records and used as the suggested name for this zone. 36in all (public) records and used as the suggested name for this zone.
44.B
45.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 37.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
46Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 38Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and
47ERROR. 39ERROR.
48.B
49.IP "\-m, \-\-monitor" 40.IP "\-m, \-\-monitor"
50Monitor changes to the zone on an ongoing basis (in contrast to \-D, 41Monitor changes to the zone on an ongoing basis (in contrast to \-D,
51which merely displays the current records) 42which merely displays the current records)
52.B
53.IP "\-n NAME, \-\-name=NAME" 43.IP "\-n NAME, \-\-name=NAME"
54Label or name of the record to add/delete/display 44Label or name of the record to add/delete/display
55.B
56.IP "\-p, \-\-public" 45.IP "\-p, \-\-public"
57Create a record that is public (shared with other users that know the 46Create a record that is public (shared with other users that know the
58label) 47label)
59.B
60.IP "\-r PKEY, \-\-reverse=PKEY" 48.IP "\-r PKEY, \-\-reverse=PKEY"
61Determine our GNS name for the given public key (reverse lookup of the 49Determine our GNS name for the given public key (reverse lookup of the
62PKEY) in the given zone. 50PKEY) in the given zone.
63.B
64.IP "\-R RECORDLINE, \-\-replace=RECORDLINE" 51.IP "\-R RECORDLINE, \-\-replace=RECORDLINE"
65Sets record set to values given in RECORDLINE. This option can be specified multiple 52Sets record set to values given in RECORDLINE. This option can be specified multiple
66times to provide multiple records for the record set. Existing records under the 53times to provide multiple records for the record set. Existing records under the
@@ -69,29 +56,23 @@ same label will be deleted. The format for the RECORDLINE is
69be given explicitly, seconds is always implied), TYPE is the 56be given explicitly, seconds is always implied), TYPE is the
70DNS/GNS record type, FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". The VALUE 57DNS/GNS record type, FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". The VALUE
71follows the usual human-readable value format(s) of DNS/GNS. 58follows the usual human-readable value format(s) of DNS/GNS.
72.B
73.IP "\-s, \-\-shadow" 59.IP "\-s, \-\-shadow"
74Create a record that is a shadow record. Shadow records are only used 60Create a record that is a shadow record. Shadow records are only used
75once all other records of the same type under the same label have 61once all other records of the same type under the same label have
76expired. 62expired.
77.B
78.IP "\-t TYPE, \-\-type=TYPE" 63.IP "\-t TYPE, \-\-type=TYPE"
79Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", 64Type of the record to add/delete/display (i.e. "A", "AAAA", "NS",
80"PKEY", "MX" etc.) 65"PKEY", "MX" etc.)
81.B
82.IP "\-u URI, \-\-uri=URI" 66.IP "\-u URI, \-\-uri=URI"
83Add PKEY record from gnunet://gns/-URI to our zone; the record type is 67Add PKEY record from gnunet://gns/-URI to our zone; the record type is
84always PKEY, if no expiration is given FOREVER is used 68always PKEY, if no expiration is given FOREVER is used
85.B
86.IP "\-v, \-\-version" 69.IP "\-v, \-\-version"
87Print GNUnet version number. 70Print GNUnet version number.
88.B
89.IP "\-V VALUE, \-\-value=VALUE" 71.IP "\-V VALUE, \-\-value=VALUE"
90Value to store or remove from the GNS zone. Specific format depends 72Value to store or remove from the GNS zone. Specific format depends
91on the record type. A records expect a dotted decimal IPv4 address, 73on the record type. A records expect a dotted decimal IPv4 address,
92AAAA records an IPv6 address, PKEY a public key in GNUnet's printable 74AAAA records an IPv6 address, PKEY a public key in GNUnet's printable
93format, and CNAME and NS records should be a domain name. 75format, and CNAME and NS records should be a domain name.
94.B
95.IP "\-z EGO, \-\-zone=EGO" 76.IP "\-z EGO, \-\-zone=EGO"
96Specifies the name of the ego controlling the private key for the zone 77Specifies the name of the ego controlling the private key for the zone
97(mandatory option) 78(mandatory option)
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1
index 8514a5c99..efd4b5df1 100644
--- a/doc/man/gnunet-nat-auto.1
+++ b/doc/man/gnunet-nat-auto.1
@@ -8,22 +8,17 @@ gnunet\-nat\-auto \- autoconfigure and test NAT traversal
8This tool allows testing various NAT traversal functions, as well 8This tool allows testing various NAT traversal functions, as well
9as attempting auto\-configuration. 9as attempting auto\-configuration.
10.SH OPTIONS 10.SH OPTIONS
11.B
12.IP "\-a, \-\-auto" 11.IP "\-a, \-\-auto"
13Attempt auto\-configuration for NAT traversal. 12Attempt auto\-configuration for NAT traversal.
14.B
15.IP "\-c FILENAME, \-\-config=FILENAME" 13.IP "\-c FILENAME, \-\-config=FILENAME"
16Use the configuration file FILENAME. 14Use the configuration file FILENAME.
17.B
18.IP "\-S NAME, \-\-section=NAME" 15.IP "\-S NAME, \-\-section=NAME"
19Name of the configuration section with details about the configuration 16Name of the configuration section with details about the configuration
20to test. For example "transport-tcp". 17to test. For example "transport-tcp".
21.IP "\-t, \-\-tcp" 18.IP "\-t, \-\-tcp"
22Use TCP. 19Use TCP.
23.B
24.IP "\-u, \-\-udp" 20.IP "\-u, \-\-udp"
25Use UDP. 21Use UDP.
26.B
27.IP "\-w, \-\-write" 22.IP "\-w, \-\-write"
28Write configuration to configuration file, useful in combination with 23Write configuration to configuration file, useful in combination with
29autoconfiguration (\-a). 24autoconfiguration (\-a).
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index f31e69b26..8cb995f7c 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -41,7 +41,6 @@ gnunet\-nat\-server is run on should be specified in the NATSERVER
41option in the [setup] section of the configuration file of hosts that 41option in the [setup] section of the configuration file of hosts that
42are supposed to autoconfigure with this server. 42are supposed to autoconfigure with this server.
43.SH OPTIONS 43.SH OPTIONS
44.B
45.IP "\-c FILENAME, \-\-config=FILENAME" 44.IP "\-c FILENAME, \-\-config=FILENAME"
46Use the configuration file FILENAME. 45Use the configuration file FILENAME.
47.SH BUGS 46.SH BUGS
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1
index 4a6a56e97..fe9272ea5 100644
--- a/doc/man/gnunet-nat.1
+++ b/doc/man/gnunet-nat.1
@@ -8,38 +8,28 @@ gnunet\-nat \- interact with the NAT service
8This tool allows testing various NAT traversal functions, as well as 8This tool allows testing various NAT traversal functions, as well as
9attempting auto\-configuration. 9attempting auto\-configuration.
10.SH OPTIONS 10.SH OPTIONS
11.B
12.IP "\-b ADDRESS, \-\-bind=ADDRESS" 11.IP "\-b ADDRESS, \-\-bind=ADDRESS"
13Assume that the service is (locally) bound to ADDRESS. 12Assume that the service is (locally) bound to ADDRESS.
14.B
15.IP "\-c FILENAME, \-\-config=FILENAME" 13.IP "\-c FILENAME, \-\-config=FILENAME"
16Use the configuration file FILENAME. 14Use the configuration file FILENAME.
17.B
18.IP "\-e ADDRESS, \-\-external=ADDRESS" 15.IP "\-e ADDRESS, \-\-external=ADDRESS"
19Assume that ADDRESS is the globally visible address of the peer. 16Assume that ADDRESS is the globally visible address of the peer.
20.B
21.IP "\-i ADDRESS, \-\-in=ADDRESS" 17.IP "\-i ADDRESS, \-\-in=ADDRESS"
22Assuming we are listening at ADDRESS for connection reversal requests. 18Assuming we are listening at ADDRESS for connection reversal requests.
23.B
24.IP "\-r ADDRESS, \-\-remote=ADDRESS" 19.IP "\-r ADDRESS, \-\-remote=ADDRESS"
25Ask the peer at ADDRESS for connection reversal, using the local 20Ask the peer at ADDRESS for connection reversal, using the local
26address for the target address of the reversal. 21address for the target address of the reversal.
27.B
28.IP "\-S NAME, \-\-section=NAME" 22.IP "\-S NAME, \-\-section=NAME"
29Name of section in configuration file to use for additional options. 23Name of section in configuration file to use for additional options.
30.B
31.IP "\-s, \-\-stun" 24.IP "\-s, \-\-stun"
32Enable processing of STUN requests. 25Enable processing of STUN requests.
33Will try to read UDP packets from the bind address and handle the 26Will try to read UDP packets from the bind address and handle the
34packets if they are STUN packets. 27packets if they are STUN packets.
35Will only work with UDP. 28Will only work with UDP.
36.B
37.IP "\-t, \-\-tcp" 29.IP "\-t, \-\-tcp"
38Use TCP. 30Use TCP.
39.B
40.IP "\-u, \-\-udp" 31.IP "\-u, \-\-udp"
41Use UDP. 32Use UDP.
42.B
43.IP "\-W, \-\-watch" 33.IP "\-W, \-\-watch"
44Watch for connection reversal requests. 34Watch for connection reversal requests.
45.SH EXAMPLES 35.SH EXAMPLES
diff --git a/doc/man/gnunet-nse.1 b/doc/man/gnunet-nse.1
new file mode 100644
index 000000000..151ba4957
--- /dev/null
+++ b/doc/man/gnunet-nse.1
@@ -0,0 +1,65 @@
1.Dd March 6, 2019
2.Dt GNUNET-NSE 1
3.Os
4.Sh NAME
5.Nm gnunet-nse
6.Nd show network size estimates from NSE service
7.Sh SYNOPSIS
8.Nm
9.Op Fl c Ar file | Fl -config Ns = Ns file
10.Op Fl h | \-help
11.Op Fl l file | Fl -logfile Ns = Ns file
12.Op Fl L Ar loglevel | Fl -loglevel Ns = Ns loglevel
13.Op Fl v | \-version
14.Sh DESCRIPTION
15.Nm
16is a command line tool to show network size estimates from the NSE service of GNUnet.
17.Bl -tag -width Ds
18.It Fl c Ar file | Fl -config Ns = Ns file
19Use the configuration file FILENAME.
20.It Fl h | \-help
21Print short help on options.
22.It Fl l file | Fl -logfile Ns = Ns file
23Configure logging to write logs to LOGFILE.
24.It Fl L Ar loglevel | Fl -loglevel Ns = Ns loglevel
25Use LOGLEVEL for logging.
26Valid values are DEBUG, INFO, WARNING and ERROR.
27.It Fl v | \-version
28Print GNUnet version number.
29.El
30.Sh FILES
31.Pa gnunet.conf
32Configuration file for gnunet.
33.Sh SEE ALSO
34.Xr gnunet.conf 5
35.sp
36The full documentation for gnunet is maintained as a Texinfo manual.
37If the
38.Xr info 1
39gnunet programs are properly installed at your site, the command
40.Bd -literal -offset indent -compact
41 info gnunet
42.Ed
43should give you access to the complete handbook,
44.Bd -literal -offset indent -compact
45 info gnunet-c-tutorial
46.Ed
47will give you access to a tutorial for developers.
48.sp
49Depending on your installation, this information is also
50available in
51.Xr gnunet 7 and
52.Xr gnunet-c-tutorial 7 .
53.Sh HISTORY
54This man page first appeared in GNUnet 0.11.1.
55.Sh AUTHORS
56This page was originally written by
57.An Bertrand Marc Aq Mt bmarc@debian.org
58for Debian's gnunet package (man page date: 2014).
59Further edits and conversion to mdoc were done by
60.An ng0 Aq Mt ng0@gnunet.org .
61.Sh BUGS
62Report bugs by using
63.Lk https://bugs.gnunet.org
64or by sending electronic mail to
65.Aq Mt bug-gnunet@gnu.org .
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1
index bd37fa635..88094fa10 100644
--- a/doc/man/gnunet-peerinfo.1
+++ b/doc/man/gnunet-peerinfo.1
@@ -8,39 +8,28 @@ gnunet\-peerinfo \- Display information about other peers.
8.PP 8.PP
9\fBgnunet\-peerinfo\fP display the known addresses and trust of known peers. 9\fBgnunet\-peerinfo\fP display the known addresses and trust of known peers.
10.SH OPTIONS 10.SH OPTIONS
11.B
12.IP "\-c FILENAME, \-\-config=FILENAME" 11.IP "\-c FILENAME, \-\-config=FILENAME"
13Load config file (default: ~/.config/gnunet.conf) 12Load config file (default: ~/.config/gnunet.conf)
14.B
15.IP "\-g, \-\-get\-hello" 13.IP "\-g, \-\-get\-hello"
16Output HELLO uri(s) 14Output HELLO uri(s)
17.B
18.IP "\-h, \-\-help" 15.IP "\-h, \-\-help"
19Print help page 16Print help page
20.B
21.IP "\-i, \-\-info" 17.IP "\-i, \-\-info"
22List all known peers (and their addresses) 18List all known peers (and their addresses)
23.B
24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 19.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
25Set the loglevel 20Set the loglevel
26.B
27.IP "\-l LOGFILE, \-\-logfile=LOGFILE" 21.IP "\-l LOGFILE, \-\-logfile=LOGFILE"
28Log messages to LOGFILE 22Log messages to LOGFILE
29.B
30.IP "\-n, \-\-numeric" 23.IP "\-n, \-\-numeric"
31Disable resolution of IPs to hostnames 24Disable resolution of IPs to hostnames
32.B
33.IP "\-p, \-\-put\-hello=HELLO" 25.IP "\-p, \-\-put\-hello=HELLO"
34Add given HELLO uri to the database 26Add given HELLO uri to the database
35.B
36.IP "\-q, \-\-quiet" 27.IP "\-q, \-\-quiet"
37Do not print anything but the peer identities 28Do not print anything but the peer identities
38.B
39.IP "\-s, \-\-self" 29.IP "\-s, \-\-self"
40Print only our own identity (together with "\-q", this is the exact 30Print only our own identity (together with "\-q", this is the exact
41line that other peers would have to put in to their friends file in 31line that other peers would have to put in to their friends file in
42order to consider this peer one of their friends in F2F mode). 32order to consider this peer one of their friends in F2F mode).
43.B
44.IP "\-v, \-\-version" 33.IP "\-v, \-\-version"
45Print the version number 34Print the version number
46.SH BUGS 35.SH BUGS
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index b07208732..5f774580b 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -112,9 +112,9 @@ default is ~/.config/gnunet.conf).
112Disable use of GNU libextractor for finding additional keywords and 112Disable use of GNU libextractor for finding additional keywords and
113metadata. 113metadata.
114.TP 114.TP
115\fB\-d\fR, \fB\-\-disable\-creation\-time\fR 115\fB\-E\fR, \fB\-\-enable\-creation\-time\fR
116Disable use of creation time timestamp in metadata. 116Enable use of creation time timestamp in metadata.
117Useful to make created directories deterministic and to avoid leaking 117Setting this information will leak
118information about the time at which a file was made available. 118information about the time at which a file was made available.
119.TP 119.TP
120\fB\-e\fR, \fB\-\-extract\fR 120\fB\-e\fR, \fB\-\-extract\fR
diff --git a/doc/man/gnunet-qr.1 b/doc/man/gnunet-qr.1
index 0145a3523..2aabe6b22 100644
--- a/doc/man/gnunet-qr.1
+++ b/doc/man/gnunet-qr.1
@@ -1,49 +1,53 @@
1.TH GNUNET\-QR 1 "September 13, 2014" "GNUnet" 1.Dd September 13, 2014
2.SH NAME 2.Dt GNUNET-QR 1
3gnunet\-qr \- Scan a QR code using a video device and import. 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-qr 5.Nm gnunet-qr
6.RI [ options ] 6.Nd
7.br 7scan a QR code using a video device and import
8.SH DESCRIPTION 8.Sh SYNOPSIS
9\fBgnunet\-qr\fP is a command line tool to scan a QR code using a 9.Nm
10video device and import. 10.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
11.SH OPTIONS 11.Op Fl d Ar DEVICE | Fl \-device= Ns Ar DEVICE
12.B 12.Op Fl h | \-help
13.IP "\-c FILENAME, \-\-config=FILENAME" 13.Op Fl s | \-silent
14.Op Fl v | \-verbose
15.Sh DESCRIPTION
16.Nm
17is a command line tool to scan a QR code using a video device and import.
18.Bl -tag -width Ds
19.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
14Use the configuration file FILENAME. 20Use the configuration file FILENAME.
15.B 21.It Fl d Ar DEVICE | Fl \-device= Ns Ar DEVICE
16.IP "\-d DEVICE, \-\-device=DEVICE"
17Use device DEVICE. 22Use device DEVICE.
18.B 23.It Fl h | \-help
19.IP "\-h, \-\-help"
20Print short help on options. 24Print short help on options.
21.B 25.It Fl s | \-silent
22.IP "\-s, \-\-silent"
23Do not show preview windows. 26Do not show preview windows.
24.B 27.It Fl v | \-verbose
25.IP "\-v, \-\-verbose"
26Be verbose. 28Be verbose.
27.SH BUGS 29.El
28Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 30.Sh SEE ALSO
29electronic mail to <gnunet\-developers@gnu.org> 31The full documentation for gnunet is maintained as a Texinfo manual.
30.SH SEE ALSO 32If the
31The full documentation for 33.Xr info 1
32.B gnunet 34and gnunet programs are properly installed at your site, the command
33is maintained as a Texinfo manual. If the 35.Pp
34.B info 36.Dl info gnunet
35and 37.Pp
36.B gnunet
37programs are properly installed at your site, the command
38.IP
39.B info gnunet
40.PP
41should give you access to the complete handbook, 38should give you access to the complete handbook,
42.IP 39.Pp
43.B info gnunet-c-tutorial 40.Dl info gnunet-c-tutorial
44.PP 41.Pp
45will give you access to a tutorial for developers. 42will give you access to a tutorial for developers.
46.PP 43.sp
47Depending on your installation, this information is also 44Depending on your installation, this information is also available in
48available in 45.Xr gnunet 7 and
49\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 46.Xr gnunet-c-tutorial 7 .
47.\".Sh HISTORY
48.\".Sh AUTHORS
49.Sh BUGS
50Report bugs by using
51.Lk https://bugs.gnunet.org
52or by sending electronic mail to
53.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-resolver.1
index 66f1ba9a8..494131d01 100644
--- a/doc/man/gnunet-resolver.1
+++ b/doc/man/gnunet-resolver.1
@@ -7,23 +7,17 @@ gnunet\-resolver \- build-in GNUnet stub resolver
7.SH DESCRIPTION 7.SH DESCRIPTION
8\fBgnunet\-resolver\fP uses build-in GNUnet stub resolver. 8\fBgnunet\-resolver\fP uses build-in GNUnet stub resolver.
9.SH OPTIONS 9.SH OPTIONS
10.B
11.IP "\-c FILENAME, \-\-config=FILENAME" 10.IP "\-c FILENAME, \-\-config=FILENAME"
12Use the configuration file FILENAME. 11Use the configuration file FILENAME.
13.B
14.IP "\-h, \-\-help" 12.IP "\-h, \-\-help"
15Print short help on options. 13Print short help on options.
16.B
17.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 14.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
18Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 15Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and
19ERROR. 16ERROR.
20.B
21.IP "\-l LOGFILE, \-\-logfile=LOGFILE" 17.IP "\-l LOGFILE, \-\-logfile=LOGFILE"
22Configure logging to write logs to LOGFILE. 18Configure logging to write logs to LOGFILE.
23.B
24.IP "\-r, \-\-reverse" 19.IP "\-r, \-\-reverse"
25Perform a reverse lookup. 20Perform a reverse lookup.
26.B
27.IP "\-v, \-\-version" 21.IP "\-v, \-\-version"
28Print GNUnet version number. 22Print GNUnet version number.
29.SH BUGS 23.SH BUGS
diff --git a/doc/man/gnunet-revocation.1 b/doc/man/gnunet-revocation.1
index f21f82612..6fae373e7 100644
--- a/doc/man/gnunet-revocation.1
+++ b/doc/man/gnunet-revocation.1
@@ -28,19 +28,15 @@ expensive. Depending on your CPU, the calculation can take days or
28weeks. 28weeks.
29 29
30.SH OPTIONS 30.SH OPTIONS
31.B
32.IP "\-t KEY, \-\-test=KEY" 31.IP "\-t KEY, \-\-test=KEY"
33Check if the given KEY (ASCII\-encoded public key required) has been 32Check if the given KEY (ASCII\-encoded public key required) has been
34revoked. 33revoked.
35.B
36.IP "\-R NAME, \-\-revoke=NAME" 34.IP "\-R NAME, \-\-revoke=NAME"
37Calculate or perform revocation for the ego with the given NAME. 35Calculate or perform revocation for the ego with the given NAME.
38.B
39.IP "\-p, \-\-perform" 36.IP "\-p, \-\-perform"
40Actually perform the revocation as soon as possible (do not just 37Actually perform the revocation as soon as possible (do not just
41generate a revocation certificate, use it). Must be supplied to 38generate a revocation certificate, use it). Must be supplied to
42actually perform the revocation. 39actually perform the revocation.
43.B
44.IP "\-f NAME, \-\-filename=NAME" 40.IP "\-f NAME, \-\-filename=NAME"
45Use NAME as the name of the file that is to contain the revocation 41Use NAME as the name of the file that is to contain the revocation
46certificate. Intermediate computation results will be stored here, as 42certificate. Intermediate computation results will be stored here, as
@@ -51,17 +47,13 @@ be performed instantly. If the given file contains anything (a valid
51certificate, with or without the completed proof-of-work) there is no 47certificate, with or without the completed proof-of-work) there is no
52need to supply the "\-R" option or to still have the private key of 48need to supply the "\-R" option or to still have the private key of
53the ego to perform the revocation. 49the ego to perform the revocation.
54.B
55.IP "\-c FILENAME, \-\-config=FILENAME" 50.IP "\-c FILENAME, \-\-config=FILENAME"
56Use the configuration file FILENAME. 51Use the configuration file FILENAME.
57.B
58.IP "\-h, \-\-help" 52.IP "\-h, \-\-help"
59Print short help on options. 53Print short help on options.
60.B
61.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 54.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
62Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 55Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and
63ERROR. 56ERROR.
64.B
65.IP "\-v, \-\-version" 57.IP "\-v, \-\-version"
66Print GNUnet version number. 58Print GNUnet version number.
67 59
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1
index 1c8938daf..34d5e4ef0 100644
--- a/doc/man/gnunet-scalarproduct.1
+++ b/doc/man/gnunet-scalarproduct.1
@@ -42,34 +42,26 @@ The protocol by definition relies on \fBAlice\fP and \fBBob\fP being
42benign, thus \fBBob\fP can arbitrarily falsify his information. Both 42benign, thus \fBBob\fP can arbitrarily falsify his information. Both
43peers collaborate to achieve a correct result. 43peers collaborate to achieve a correct result.
44.SH OPTIONS 44.SH OPTIONS
45.B
46.IP "\-e ELEMENTS, \-\-elements=ELEMENTS" 45.IP "\-e ELEMENTS, \-\-elements=ELEMENTS"
47The element-vector the vectorproduct should be computed over in signed 46The element-vector the vectorproduct should be computed over in signed
48decimal form, eg: \"42,1,-3,3,7\". Zero value elements will be automatically masked. 47decimal form, eg: \"42,1,-3,3,7\". Zero value elements will be automatically masked.
49.B
50.IP "\-m MASK, \-\-mask=MASK" 48.IP "\-m MASK, \-\-mask=MASK"
51Elements in the vector can be masked. There must be at least two 49Elements in the vector can be masked. There must be at least two
52elements left in the vector to compute a vectorproduct. Non-Zero 50elements left in the vector to compute a vectorproduct. Non-Zero
53values indicate an element is not maskes. 51values indicate an element is not maskes.
54.B
55.IP "\-k KEY, \-\-key=KEY" 52.IP "\-k KEY, \-\-key=KEY"
56The session key, a shared string of arbitrary length from which the 53The session key, a shared string of arbitrary length from which the
57SID will be generated 54SID will be generated
58.B
59.IP "\-c FILENAME, \-\-config=FILENAME" 55.IP "\-c FILENAME, \-\-config=FILENAME"
60Use the configuration file FILENAME. 56Use the configuration file FILENAME.
61.B
62.IP "\-p PEERID, \-\-peer=PEERID" 57.IP "\-p PEERID, \-\-peer=PEERID"
63The remote peer\'s ASCII-armored gnunet-peer ID as output by 58The remote peer\'s ASCII-armored gnunet-peer ID as output by
64gnunet-peerinfo. If this option is not given, the peer will take the 59gnunet-peerinfo. If this option is not given, the peer will take the
65\fBBob\fP\'s role. 60\fBBob\fP\'s role.
66.B
67.IP "\-h, \-\-help" 61.IP "\-h, \-\-help"
68Print short help on options. 62Print short help on options.
69.B
70.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 63.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
71Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 64Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
72.B
73.IP "\-v, \-\-version" 65.IP "\-v, \-\-version"
74Print GNUnet version number. 66Print GNUnet version number.
75.SH BUGS 67.SH BUGS
diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1
index 01ac4205a..545af37e9 100644
--- a/doc/man/gnunet-scrypt.1
+++ b/doc/man/gnunet-scrypt.1
@@ -5,34 +5,24 @@ gnunet\-scrypt \- Manipulate GNUnet proof of work files.
5.B gnunet\-scrypt 5.B gnunet\-scrypt
6.RI [ options ] 6.RI [ options ]
7.SH DESCRIPTION 7.SH DESCRIPTION
8\fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof 8\fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof of work files.
9of work files.
10.SH OPTIONS 9.SH OPTIONS
11.B
12.IP "\-b BITS, \-\-bits=BITS" 10.IP "\-b BITS, \-\-bits=BITS"
13Number of bits to require for the proof of work. 11Number of bits to require for the proof of work.
14.B
15.IP "\-c FILENAME, \-\-config=FILENAME" 12.IP "\-c FILENAME, \-\-config=FILENAME"
16Use the configuration file FILENAME. 13Use the configuration file FILENAME.
17.B
18.IP "\-h, \-\-help" 14.IP "\-h, \-\-help"
19Print short help on options. 15Print short help on options.
20.B
21.IP "\-k FILE, \-\-keyfile=FILE" 16.IP "\-k FILE, \-\-keyfile=FILE"
22File with private key, otherwise default is used. 17File with private key, otherwise default is used.
23.B
24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 18.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
25Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 19Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
26.B
27.IP "\-l LOGFILE, \-\-logfile=LOGFILE" 20.IP "\-l LOGFILE, \-\-logfile=LOGFILE"
28Configure logging to write logs to LOGFILE. 21Configure logging to write logs to LOGFILE.
29.B
30.IP "\-o FILE, \-\-outfile=FILE" 22.IP "\-o FILE, \-\-outfile=FILE"
31File with proof of work, otherwise default is used. 23File with proof of work, otherwise default is used.
32.B
33.IP "\-t TIME, \-\-timeout=TIME" 24.IP "\-t TIME, \-\-timeout=TIME"
34Time to wait between calculations. 25Time to wait between calculations.
35.B
36.IP "\-v, \-\-version" 26.IP "\-v, \-\-version"
37Print GNUnet version number. 27Print GNUnet version number.
38.SH BUGS 28.SH BUGS
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1
index e61a8493c..c0d5e8fe3 100644
--- a/doc/man/gnunet-statistics.1
+++ b/doc/man/gnunet-statistics.1
@@ -1,73 +1,91 @@
1.TH GNUNET-STATISTICS 1 "January 4, 2012" "GNUnet" 1.Dd January 4, 2012
2.SH NAME 2.Dt GNUNET-STATISTICS 1
3gnunet\-statistics \- Display statistics about your GNUnet system 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-statistics 5.Nm gnunet-statistics
6.RI [ options ] 6.Nd display statistics about your GNUnet system
7.RI [ VALUE ] 7.Sh SYNOPSIS
8.SH DESCRIPTION 8.Nm
9\fBgnunet\-statistics\fP is used to display detailed information about 9.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
10various aspect of GNUnet's operation. This tool only works if the 10.Op Fl h | \-help
11"statistics" service is available. 11.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
12gnunet\-statistics can be used to set a value by giving the options 12.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
13\-n, \-s and also a VALUE. 13.Op Fl n Ar NAME | Fl \-name= Ns Ar NAME
14.SH OPTIONS 14.Op Fl o Ar PORT | Fl \-port= Ns Ar PORT
15.B 15.Op Fl p | \-persistent
16.IP "\-c FILENAME, \-\-config=FILENAME" 16.Op Fl q | \-quiet
17.Op Fl r Ar REMOTE | Fl \-remote= Ns Ar REMOTE
18.Op Fl S Ar SEPARATOR | Fl \-csv-separator= Ns Ar SEPARATOR
19.Op Fl s Ar SUBSYSTEM | Fl \-subsystem= Ns Ar SUBSYSTEM
20.Op Fl t Ar PATH | Fl \-testbed= Ns Ar PATH
21.Op Fl v | \-version
22.Op Fl w | \-watch
23.Ao Ar VALUE Ac
24.Sh DESCRIPTION
25.Nm
26is used to display detailed information about various aspect of GNUnet's operation.
27This tool only works if the "statistics" service is available.
28gnunet-statistics can be used to set a value by giving the options \-n, \-s and also a VALUE.
29.Bl -tag -width Ds
30.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
17Use the configuration file FILENAME. 31Use the configuration file FILENAME.
18.B 32.It Fl h | \-help
19.IP "\-h, \-\-help"
20Print short help on options. 33Print short help on options.
21.B 34.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
22.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
23Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 35Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
24.B 36.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
25.IP "\-n NAME, \-\-name=NAME" 37Configure logging to write logs to FILENAME
26Each statistic has a name that is unique with in its subsystem. With 38.It Fl n Ar NAME | Fl \-name= Ns Ar NAME
27this option, the output can be restricted to statistics that have a 39Each statistic has a NAME that is unique with in its subsystem.
28particular name. 40With this option, the output can be restricted to statistics that have a particular NAME.
29.B 41.It Fl o Ar PORT | Fl \-port= Ns Ar PORT
30.IP "\-p, \-\-persistent" 42PORT for remote host
31When setting a value, make the value persistent. If the value used to 43.It Fl p | \-persistent
32be persistent and this flag is not given, it will be marked as 44When setting a value, make the value persistent.
33non\-persistent. 45If the value used to be persistent and this flag is not given, it will be marked as non-persistent.
34.B 46.It Fl q | \-quiet
35.IP "\-s SUBSYSTEM, \-\-subsystem=SUBSYSTEM" 47Just print the statistics value
36Statistics are kept for various subsystems. With this option, the 48.It Fl r Ar REMOTE | Fl \-remote= Ns Ar REMOTE
37output can be restricted to a particular subsystem only. 49Connect to a remote host given as REMOTE.
38.B 50.It Fl S Ar SEPARATOR | Fl \-csv-separator= Ns Ar SEPARATOR
39.IP "\-S SEPARATOR, \-\-csv-separator=SEPARATOR"
40Specify a separator for generating csv-output. 51Specify a separator for generating csv-output.
41.B 52.It Fl s Ar SUBSYSTEM | Fl \-subsystem= Ns Ar SUBSYSTEM
42.IP "\-t TESTBED_PATH, \-\-subsystem=TESTBED_PATH" 53Statistics are kept for various subsystems.
54With this option, the output can be restricted to a particular subsystem only.
55.It Fl t Ar PATH | Fl \-testbed= Ns Ar PATH
43When running testbed, you can get statistics of all peers with specefying the 56When running testbed, you can get statistics of all peers with specefying the
44folder containing the data of all testbed nodes like \fBgnunet\-statistics -t /tmp/testbedARtmQv\fP. 57folder containing the data of all testbed nodes like
45.B 58.Pp
46.IP "\-v, \-\-version" 59.Dl $ gnunet-statistics -t /tmp/testbedARtmQv
60.Pp
61.It Fl v | \-version
47Print GNUnet version number. 62Print GNUnet version number.
48.SH BUGS 63.It Fl w | \-watch
49Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending 64Watch value continuously.
50electronic mail to <gnunet\-developers@gnu.org> 65.El
51.SH SEE ALSO 66.Sh SEE ALSO
52gnunet\-service\-statistics(1) 67.Xr gnunet-service-statistics 1
53.PP 68.sp
54The full documentation for 69The full documentation for gnunet is maintained as a Texinfo manual.
55.B gnunet
56is maintained as a Texinfo manual.
57If the 70If the
58.B info 71.Xr info 1
59and 72and gnunet programs are properly installed at your site, the command
60.B gnunet 73.Pp
61programs are properly installed at your site, the command 74.Dl info gnunet
62.IP 75.Pp
63.B info gnunet
64.PP
65should give you access to the complete handbook, 76should give you access to the complete handbook,
66.IP 77.Pp
67.B info gnunet-c-tutorial 78.Dl info gnunet-c-tutorial
68.PP 79.Pp
69will give you access to a tutorial for developers. 80will give you access to a tutorial for developers.
70.PP 81.sp
71Depending on your installation, this information is also 82Depending on your installation, this information is also available in
72available in 83.Xr gnunet 7 and
73\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 84.Xr gnunet-c-tutorial 7 .
85.\".Sh HISTORY
86.\".Sh AUTHORS
87.Sh BUGS
88Report bugs by using
89.Lk https://bugs.gnunet.org
90or by sending electronic mail to
91.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-testbed-profiler.1
index b1dde99dd..fe9d713b3 100644
--- a/doc/man/gnunet-testbed-profiler.1
+++ b/doc/man/gnunet-testbed-profiler.1
@@ -1,61 +1,67 @@
1.TH GNUNET\-TESTBED\-PROFILER 1 "September 13, 2014" "GNUnet" 1.Dd September 13, 2014
2.SH NAME 2.Dt GNUNET-TESTBED-PROFILER 1
3gnunet\-testbed\-profiler \- Profiling driver for the testbed. 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-testbed\-profiler 5.Nm gnunet-testbed-profiler
6.RI [ options ] 6.Nd
7.br 7profiling driver for the testbed
8.SH DESCRIPTION 8.Sh SYNOPSIS
9\fBgnunet\-testbed\-profiler\fP is a command line profiling driver for the testbed. 9.Nm
10.SH OPTIONS 10.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
11.B 11.Op Fl e Ar COUNT | Fl \-num-errors= Ns Ar COUNT
12.IP "\-c FILENAME, \-\-config=FILENAME" 12.Op Fl H Ar FILENAME | Fl \-hosts= Ns Ar FILENAME
13.Op Fl h | \-help
14.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
15.Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE
16.Op Fl n | \-non-interactive
17.Op Fl p Ar COUNT | Fl \-num-peers= Ns Ar COUNT
18.Op Fl v | \-version
19.Sh DESCRIPTION
20.Nm
21is a command line profiling driver for the testbed.
22.Sh OPTIONS
23.Bl -tag -width Ds
24.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
13Use the configuration file FILENAME. 25Use the configuration file FILENAME.
14.B 26.It Fl e Ar COUNT | Fl \-num-errors= Ns Ar COUNT
15.IP "\-e COUNT, \-\-num\-errors=COUNT"
16Tolerate COUNT number of continious timeout failures. 27Tolerate COUNT number of continious timeout failures.
17.B 28.It Fl H Ar FILENAME | Fl \-hosts= Ns Ar FILENAME
18.IP "\-H FILENAME, \-\-hosts=FILENAME"
19Name of the file with the login information for the testbed. 29Name of the file with the login information for the testbed.
20.B 30.It Fl h | \-help
21.IP "\-h, \-\-help"
22Print short help on options. 31Print short help on options.
23.B 32.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 33Use LOGLEVEL for logging.
25Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 34Valid values are DEBUG, INFO, WARNING and ERROR.
26.B 35.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE
27.IP "\-l LOGFILE, \-\-logfile=LOGFILE"
28Configure logging to write logs to LOGFILE. 36Configure logging to write logs to LOGFILE.
29.B 37.It Fl n | \-non-interactive
30.IP "\-n, \-\-non\-interactive" 38Run profiler in non-interactive mode where upon testbed setup the profiler does not wait for a keystroke but continues to run until a termination signal is received.
31Run profiler in non-interactive mode where upon testbed setup the 39.It Fl p Ar COUNT | Fl \-num-peers= Ns Ar COUNT
32profiler does not wait for a keystroke but continues to run until a
33termination signal is received.
34.B
35.IP "\-p COUNT, \-\-num\-peers=COUNT"
36Create COUNT number of peers. 40Create COUNT number of peers.
37.B 41.It Fl v | \-version
38.IP "\-v, \-\-version"
39Print GNUnet version number. 42Print GNUnet version number.
40.SH BUGS 43.El
41Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org> 44.Sh SEE ALSO
42.SH "SEE ALSO" 45The full documentation for gnunet is maintained as a Texinfo manual.
43The full documentation for 46If the
44.B gnunet 47.Xr info 1
45is maintained as a Texinfo manual. If the 48and gnunet programs are properly installed at your site, the command
46.B info 49.Pp
47and 50.Dl info gnunet
48.B gnunet 51.Pp
49programs are properly installed at your site, the command
50.IP
51.B info gnunet
52.PP
53should give you access to the complete handbook, 52should give you access to the complete handbook,
54.IP 53.Pp
55.B info gnunet-c-tutorial 54.Dl info gnunet-c-tutorial
56.PP 55.Pp
57will give you access to a tutorial for developers. 56will give you access to a tutorial for developers.
58.PP 57.sp
59Depending on your installation, this information is also 58Depending on your installation, this information is also available in
60available in 59.Xr gnunet 7 and
61\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 60.Xr gnunet-c-tutorial 7 .
61.\".Sh HISTORY
62.\".Sh AUTHORS
63.Sh BUGS
64Report bugs by using
65.Lk https://bugs.gnunet.org
66or by sending electronic mail to
67.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-testing-run-service.1 b/doc/man/gnunet-testing-run-service.1
index 43fdb8ecf..903810c7f 100644
--- a/doc/man/gnunet-testing-run-service.1
+++ b/doc/man/gnunet-testing-run-service.1
@@ -1,52 +1,53 @@
1.TH GNUNET-TESTING-RUN-SERVICE 1 "August 25, 2013" "GNUnet" 1.Dd August 25, 2013
2.SH NAME 2.Dt GNUNET-TESTING-RUN-SERVICE 1
3gnunet\-testing\-run\-service \- Command line tool to start a service for testing. 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-testing\-run\-service 5.Nm gnunet-testing-run-service
6.RI [ options ] 6.Nd
7.SH DESCRIPTION 7command line tool to start a service for testing
8\fBgnunet\-testing\-run\-service\fP is a command line tool to start a 8.Sh SYNOPSIS
9service for testing. It starts a peer, running only the service 9.Nm
10specified on the command line, outputs the path to the temporary 10.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
11configuration file to stdout. 11.Op Fl h | \-help
12.PP 12.Op Fl s Ar SERVICE | Fl \-service= Ns Ar SERVICE
13The peer will run until this program is killed, or stdin is 13.Sh DESCRIPTION
14closed. When reading the character 'r' from stdin, the running service 14.Nm
15is restarted with the same configuration. 15is a command line tool to start a service for testing.
16.PP 16It starts a peer, running only the service specified on the command line, outputs the path to the temporary configuration file to stdout.
17This executable is intended to be used by gnunet-java, in order to 17.Pp
18reliably start and stop services for test cases. 18The peer will run until this program is killed, or stdin is closed.
19.SH OPTIONS 19When reading the character 'r' from stdin, the running service is restarted with the same configuration.
20.B 20.Pp
21.IP "\-c FILENAME, \-\-config=FILENAME" 21This executable is intended to be used by gnunet-java, in order to reliably start and stop services for test cases.
22.Bl -tag -width Ds
23.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
22Name of the template configuration file to use (optional). 24Name of the template configuration file to use (optional).
23.B 25.It Fl h | \-help
24.IP "\-h, \-\-help"
25Print short help on options. 26Print short help on options.
26.B 27.It Fl s Ar SERVICE | Fl \-service= Ns Ar SERVICE
27.IP "\-s SERVICE, \-\-service=SERVICE"
28Name of the service to run. 28Name of the service to run.
29.SH BUGS 29.El
30Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 30.Sh SEE ALSO
31electronic mail to <gnunet\-developers@gnu.org> 31The full documentation for gnunet is maintained as a Texinfo manual.
32.SH SEE ALSO
33The full documentation for
34.B gnunet
35is maintained as a Texinfo manual.
36If the 32If the
37.B info 33.Xr info 1
38and 34and gnunet programs are properly installed at your site, the command
39.B gnunet 35.Pp
40programs are properly installed at your site, the command 36.Dl info gnunet
41.IP 37.Pp
42.B info gnunet
43.PP
44should give you access to the complete handbook, 38should give you access to the complete handbook,
45.IP 39.Pp
46.B info gnunet-c-tutorial 40.Dl info gnunet-c-tutorial
47.PP 41.Pp
48will give you access to a tutorial for developers. 42will give you access to a tutorial for developers.
49.PP 43.sp
50Depending on your installation, this information is also 44Depending on your installation, this information is also available in
51available in 45.Xr gnunet 7 and
52\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 46.Xr gnunet-c-tutorial 7 .
47.\".Sh HISTORY
48.\".Sh AUTHORS
49.Sh BUGS
50Report bugs by using
51.Lk https://bugs.gnunet.org
52or by sending electronic mail to
53.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-testing.1 b/doc/man/gnunet-testing.1
index 357d0df44..182da613d 100644
--- a/doc/man/gnunet-testing.1
+++ b/doc/man/gnunet-testing.1
@@ -1,65 +1,69 @@
1.TH GNUNET\-TESTING 1 "January 4, 2012" "GNUnet" 1.Dd January 4, 2012
2.SH NAME 2.Dt GNUNET-TESTING 1
3gnunet\-testing \- Command line tool to access the testing library. 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-testing 5.Nm gnunet-testing
6.RI [ options ] 6.Nd
7.br 7command line tool to access the testing library
8.SH DESCRIPTION 8.Sh SYNOPSIS
9\fBgnunet\-testing\fP is a command line tool to access the testing 9.Nm
10library. 10.Op Fl C | \-cfg
11.SH OPTIONS 11.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
12.B 12.Op Fl H | \-hostkeys
13.IP "\-C, \-\-cfg" 13.Op Fl h | \-help
14.Op Fl k | \-key
15.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
16.Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOFILE
17.Op Fl n | \-number
18.Op Fl t | \-template
19.Op Fl v | \-version
20.Sh DESCRIPTION
21.Nm
22is a command line tool to access the testing library.
23.Sh OPTIONS
24.Bl -tag -width Ds
25.It Fl C | \-cfg
14Create unique configuration files. 26Create unique configuration files.
15.B 27.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
16.IP "\-c FILENAME, \-\-config=FILENAME"
17Use the configuration file FILENAME. 28Use the configuration file FILENAME.
18.B 29.It Fl H | \-hostkeys
19.IP "\-H, \-\-hostkeys"
20Host key file. 30Host key file.
21.B 31.It Fl h | \-help
22.IP "\-h, \-\-help"
23Print short help on options. 32Print short help on options.
24.B 33.It Fl k | \-key
25.IP "\-k, \-\-key"
26Create hostkey files from pre-computed hostkey list. 34Create hostkey files from pre-computed hostkey list.
27.B 35.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
28.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
29Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 36Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
30.B 37.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOFILE
31.IP "\-l LOGFILE, \-\-logfile=LOGFILE"
32Configure logging to write logs to LOGFILE. 38Configure logging to write logs to LOGFILE.
33.B 39.It Fl n | \-number
34.IP "\-n, \-\-number"
35Number of unique configuration files or hostkeys to create. 40Number of unique configuration files or hostkeys to create.
36.B 41.It Fl t | \-template
37.IP "\-t, \-\-template"
38Configuration template. 42Configuration template.
39.B 43.It Fl v | \-version
40.IP "\-v, \-\-version"
41Print GNUnet version number. 44Print GNUnet version number.
42.SH BUGS 45.El
43Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 46.Sh SEE ALSO
44electronic mail to <gnunet\-developers@gnu.org> 47The full documentation for gnunet is maintained as a Texinfo manual.
45.SH SEE ALSO
46The full documentation for
47.B gnunet
48is maintained as a Texinfo manual.
49If the 48If the
50.B info 49.Xr info 1
51and 50and gnunet programs are properly installed at your site, the command
52.B gnunet 51.Pp
53programs are properly installed at your site, the command 52.Dl info gnunet
54.IP 53.Pp
55.B info gnunet
56.PP
57should give you access to the complete handbook, 54should give you access to the complete handbook,
58.IP 55.Pp
59.B info gnunet-c-tutorial 56.Dl info gnunet-c-tutorial
60.PP 57.Pp
61will give you access to a tutorial for developers. 58will give you access to a tutorial for developers.
62.PP 59.sp
63Depending on your installation, this information is also 60Depending on your installation, this information is also available in
64available in 61.Xr gnunet 7 and
65\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 62.Xr gnunet-c-tutorial 7 .
63.\".Sh HISTORY
64.\".Sh AUTHORS
65.Sh BUGS
66Report bugs by using
67.Lk https://bugs.gnunet.org
68or by sending electronic mail to
69.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-timeout.1 b/doc/man/gnunet-timeout.1
index 653f211cd..15abfe351 100644
--- a/doc/man/gnunet-timeout.1
+++ b/doc/man/gnunet-timeout.1
@@ -1,36 +1,42 @@
1.TH GNUNET-TIMOUET 1 "June 5, 2018" "GNUnet" 1.Dd June 5, 2018
2.SH NAME 2.Dt GNUNET-TIMEOUT 1
3gnunet\-timeout \- run process with timeout 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-timeout 5.Nm gnunet-timeout
6.RI TIMEOUT PROGRAM ARGS 6.Nd
7.SH DESCRIPTION 7run process with timeout
8\fBgnunet\-timeout\fP can be used to run another process with a 8.Sh SYNOPSIS
9timeout. Provided as the standard "timout" utility may not be 9.Nm
10available on all platforms. 10.Ao Ar duration Ac
11.SH BUGS 11.Ao Ar command Ac
12Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 12.Ao args ... Ac
13electronic mail to <gnunet\-developers@gnu.org> 13.Sh DESCRIPTION
14.SH SEE ALSO 14.Nm
15timeout(1) 15can be used to run another process with a timeout.
16.PP 16It is provided because the standard "timout" utility may not be available on all platforms.
17The full documentation for 17.Sh SEE ALSO
18.B gnunet 18.Xr timeout 1
19is maintained as a Texinfo manual. 19.sp
20The full documentation for gnunet is maintained as a Texinfo manual.
20If the 21If the
21.B info 22.Xr info 1
22and 23and gnunet programs are properly installed at your site, the command
23.B gnunet 24.Pp
24programs are properly installed at your site, the command 25.Dl info gnunet
25.IP 26.Pp
26.B info gnunet
27.PP
28should give you access to the complete handbook, 27should give you access to the complete handbook,
29.IP 28.Pp
30.B info gnunet-c-tutorial 29.Dl info gnunet-c-tutorial
31.PP 30.Pp
32will give you access to a tutorial for developers. 31will give you access to a tutorial for developers.
33.PP 32.sp
34Depending on your installation, this information is also 33Depending on your installation, this information is also available in
35available in 34.Xr gnunet 7 and
36\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 35.Xr gnunet-c-tutorial 7 .
36.\".Sh HISTORY
37.\".Sh AUTHORS
38.Sh BUGS
39Report bugs by using
40.Lk https://bugs.gnunet.org
41or by sending electronic mail to
42.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-transport-certificate-creation.1 b/doc/man/gnunet-transport-certificate-creation.1
index 9dc572acf..e896363e4 100644
--- a/doc/man/gnunet-transport-certificate-creation.1
+++ b/doc/man/gnunet-transport-certificate-creation.1
@@ -1,35 +1,40 @@
1.TH GNUNET\-TRANSPORT-CERTIFICATE-CREATION 1 "January 31, 2014" "GNUnet" 1.Dd January 31, 2014
2.SH NAME 2.Dt GNUNET-TRANSPORT-CERTIFICATE-CREATION 1
3gnunet\-transport\-certificate\-creation \- create certificate for HTTPS transport 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-transport\-certificate\-creation 5.Nm gnunet-transport-certificate-creation
6.I privatekey certificate 6.Nd
7.SH DESCRIPTION 7create certificate for HTTPS transport
8\fBgnunet\-transport\-certificate\-creation\fP uses openssl to generate a RSA 8.Sh SYNOPSIS
9private key and then a self-signed certificate for HTTPS transport. 9.Nm
10.SH BUGS 10.Op privatekey
11Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 11.Op certificate
12electronic mail to <gnunet\-developers@gnu.org> 12.Sh DESCRIPTION
13.SH SEE ALSO 13.Nm
14gnunet\-transport(1) 14uses openssl to generate a RSA private key and then a self-signed certificate for HTTPS transport.
15.PP 15.Sh SEE ALSO
16The full documentation for 16.Xr gnunet-transport 1
17.B gnunet 17.sp
18is maintained as a Texinfo manual. 18The full documentation for gnunet is maintained as a Texinfo manual.
19If the 19If the
20.B info 20.Xr info 1
21and 21and gnunet programs are properly installed at your site, the command
22.B gnunet 22.Pp
23programs are properly installed at your site, the command 23.Dl info gnunet
24.IP 24.Pp
25.B info gnunet
26.PP
27should give you access to the complete handbook, 25should give you access to the complete handbook,
28.IP 26.Pp
29.B info gnunet-c-tutorial 27.Dl info gnunet-c-tutorial
30.PP 28.Pp
31will give you access to a tutorial for developers. 29will give you access to a tutorial for developers.
32.PP 30.sp
33Depending on your installation, this information is also 31Depending on your installation, this information is also available in
34available in 32.Xr gnunet 7 and
35\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 33.Xr gnunet-c-tutorial 7 .
34.\".Sh HISTORY
35.\".Sh AUTHORS
36.Sh BUGS
37Report bugs by using
38.Lk https://bugs.gnunet.org
39or by sending electronic mail to
40.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1
index eef762174..f5ed47ad1 100644
--- a/doc/man/gnunet-transport.1
+++ b/doc/man/gnunet-transport.1
@@ -1,84 +1,92 @@
1.TH GNUNET\-TRANSPORT "1" "October 17, 2015" "GNUnet" 1.Dd October 17, 2015
2.SH NAME 2.Dt GNUNET-TRANSPORT 1
3gnunet\-transport \- measure and control the transport subsystem 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-transport 5.Nm gnunet-transport
6[\fIOPTIONS\fR] 6.Nd
7.SH DESCRIPTION 7measure and control the transport subsystem
8.PP 8.Sh SYNOPSIS
9gnunet\-transport is a tool to access various functions of GNUnet's 9.Nm
10transport subsystem from the command\-line. Most of these are not 10.Op Fl b | \-benchmark
11expected to be useful for end-users. gnunet\-transport can be used to 11.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
12evaluate the performance of the transports, force a peer to connect to 12.Op Fl D | \-disconnect
13another peer (if possible). Other functions should be added in the 13.Op Fl e | \-events
14near future. 14.Op Fl h | \-help
15.TP 15.Op Fl i | \-information
16\fB\-b\fR, \fB\-\-benchmark\fR 16.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
17measure how fast we are receiving data (from all connections). On 17.Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE
18exit, the data rate will be reported. Runs until aborted with CTRL-C. 18.Op Fl m | \-monitor
19.TP 19.Op Fl p Ar PEER | Fl \-peer= Ns Ar PEER
20\fB\-D\fR, \fB\-\-disconnect\fR 20.Op Fl P | \-plugins
21force disconnection from a peer (used in conjunction with \-p). 21.Op Fl s | \-send
22Note that you can use the gnunet\-ats command\-line tool to suggest connects. 22.Op Fl v | \-version
23.TP 23.Op Fl V | \-verbose
24\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 24.Sh DESCRIPTION
25.Nm
26is a tool to access various functions of GNUnet's transport subsystem from the command-line.
27Most of these are not expected to be useful for end-users.
28gnunet-transport can be used to evaluate the performance of the transports, force a peer to connect to another peer (if possible).
29Other functions should be added in the near future.
30.Bl -tag -width Ds
31.It Fl b | \-benchmark
32measure how fast we are receiving data (from all connections).
33On exit, the data rate will be reported.
34Runs until aborted with CTRL-C.
35.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
25configuration file to use 36configuration file to use
26.TP 37.It Fl D | \-disconnect
27\fB\-e \fB\-\-events\fR 38force disconnection from a peer (used in conjunction with \-p).
39Note that you can use the gnunet-ats command-line tool to suggest connects.
40.It Fl e | \-events
28provide information about all connect and disconnect events (continuously) 41provide information about all connect and disconnect events (continuously)
29.TP 42.It Fl h | \-help
30\fB\-h\fR, \fB\-\-help\fR
31print help page 43print help page
32.TP 44.It Fl i | \-information
33\fB\-i\fR, \fB\-\-information\fR
34print information about our current connections (once) 45print information about our current connections (once)
35.TP 46.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
36\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
37Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 47Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
38.TP 48.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE
39\fB\-l \fILOGFILE\fR, \fB\-\-logfile=LOGFILE\fR
40configure logging to write logs to LOGFILE 49configure logging to write logs to LOGFILE
41.TP 50.It Fl m | \-monitor
42\fB\-m\fR, \fB\-\-monitor\fR
43print information about our current connections (continuously) 51print information about our current connections (continuously)
44.TP 52.It Fl p Ar PEER | Fl \-peer= Ns Ar PEER
45\fB\-p \fIPEER\fR, \fB\-\-peer=PEER\fR
46the peer identity to connect to or monitor 53the peer identity to connect to or monitor
47.TP 54.It Fl P | \-plugins
48\fB\-P, \fB\-\-plugins\fR
49monitor session state of transport plugins 55monitor session state of transport plugins
50.TP 56.It Fl s | \-send
51\fB\-s\fR, \fB\-\-send\fR
52transmit (dummy) traffic as quickly as possible to the peer specified 57transmit (dummy) traffic as quickly as possible to the peer specified
53with the \-p option. The rate will still be limited by the quota(s) 58with the \-p option. The rate will still be limited by the quota(s)
54determined by the peers (ATS subsystem). Will run until CTRL\-C is 59determined by the peers (ATS subsystem). Will run until CTRL\-C is
55pressed or until the connection to the other peer is disrupted. 60pressed or until the connection to the other peer is disrupted.
56.TP 61.It Fl v | \-version
57\fB\-v\fR, \fB\-\-version\fR
58print the version number 62print the version number
59.TP 63.It Fl V | \-verbose
60\fB\-V\fR, \fB\-\-verbose\fR
61be verbose 64be verbose
62.SH "REPORTING BUGS" 65.El
63Report bugs by using mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org> 66.Sh SEE ALSO
64.SH "SEE ALSO" 67.Xr gnunet-arm 1 ,
65\fBgnunet\-arm\fP(1), \fBgnunet\-ats\fP(1) 68.Xr gnunet-ats 1
66The full documentation for 69.sp
67.B gnunet 70The full documentation for gnunet is maintained as a Texinfo manual.
68is maintained as a Texinfo manual. If the 71If the
69.B info 72.Xr info 1
70and 73and gnunet programs are properly installed at your site, the command
71.B gnunet 74.Pp
72programs are properly installed at your site, the command 75.Dl info gnunet
73.IP 76.Pp
74.B info gnunet
75.PP
76should give you access to the complete handbook, 77should give you access to the complete handbook,
77.IP 78.Pp
78.B info gnunet-c-tutorial 79.Dl info gnunet-c-tutorial
79.PP 80.Pp
80will give you access to a tutorial for developers. 81will give you access to a tutorial for developers.
81.PP 82.sp
82Depending on your installation, this information is also 83Depending on your installation, this information is also available in
83available in 84.Xr gnunet 7 and
84\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 85.Xr gnunet-c-tutorial 7 .
86.\".Sh HISTORY
87.\".Sh AUTHORS
88.Sh BUGS
89Report bugs by using
90.Lk https://bugs.gnunet.org
91or by sending electronic mail to
92.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-unindex.1 b/doc/man/gnunet-unindex.1
index 6aee4f62e..e953ce23a 100644
--- a/doc/man/gnunet-unindex.1
+++ b/doc/man/gnunet-unindex.1
@@ -1,58 +1,67 @@
1.TH GNUNET-UNINDEX "1" "September 6, 2009" "GNUnet" 1.Dd September 6, 2009
2.SH NAME 2.Dt GNUNET-UNINDEX 1
3gnunet\-unindex \- a command line interface for deleting indexed files from GNUnet 3.Sh NAME
4.SH SYNOPSIS 4.Nm gnunet-unindex
5.B gnunet\-unindex 5.Nd
6[\fIOPTIONS\fR] FILENAME 6a command line interface for deleting indexed files from GNUnet
7.SH DESCRIPTION 7.Sh SYNOPSIS
8.PP 8.Nm
9gnunet\-unindex is used for deleting indexed files from GNUnet. 9.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
10.TP 10.Op Fl h | \-help
11\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 11.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
12use config file (defaults: ~/.config/gnunet.conf) 12.Op Fl v | \-version
13.TP 13.Op Fl V | \-verbose
14\fB\-h\fR, \fB\-\-help\fR 14FILENAME
15.Sh DESCRIPTION
16.Nm
17is used for deleting indexed files from GNUnet.
18.Bl -tag -width Ds
19.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
20Use config file FILENAME as config (default: ~/.config/gnunet.conf).
21.It Fl h | \-help
15print help page 22print help page
16.TP 23.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
17\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR 24Change the loglevel.
18Change the loglevel. Possible values for LOGLEVEL are NOTHING, 25Possible values for LOGLEVEL are NOTHING, ERROR, WARNING, INFO and DEBUG.
19ERROR, WARNING, INFO and DEBUG. 26.It Fl v | \-version
20.TP
21\fB\-v\fR, \fB\-\-version\fR
22print the version number 27print the version number
23.TP 28.It Fl V | \-verbose
24\fB\-V\fR, \fB\-\-verbose\fR
25be verbose 29be verbose
26.SH NOTES 30.El
27You can only unindex files that you indexed and that you still have 31.Sh NOTES
28available locally in full. You should use gnunet\-unindex on files 32You can only unindex files that you indexed and that you still have available locally in full.
29that you indexed (not inserted) and that you are going to delete or 33You should use gnunet-unindex on files that you indexed (not inserted) and that you are going to delete or move locally.
30move locally. 34.Sh FILES
31.TP
32.SH FILES
33.TP 35.TP
34~/.config/gnunet.conf 36~/.config/gnunet.conf
35GNUnet configuration file 37GNUnet configuration file
36.SH "REPORTING BUGS" 38.Sh SEE ALSO
37Report bugs to <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org> 39.Xr gnunet-fs-gtk 1 ,
38.SH "SEE ALSO" 40.Xr gnunet-publish 1 ,
39\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5) 41.Xr gnunet-search 1 ,
40The full documentation for 42.Xr gnunet-download 1 ,
41.B gnunet 43.Xr gnunet.conf 5
42is maintained as a Texinfo manual. If the 44.sp
43.B info 45The full documentation for gnunet is maintained as a Texinfo manual.
44and 46If the
45.B gnunet 47.Xr info 1
46programs are properly installed at your site, the command 48and gnunet programs are properly installed at your site, the command
47.IP 49.Pp
48.B info gnunet 50.Dl info gnunet
49.PP 51.Pp
50should give you access to the complete handbook, 52should give you access to the complete handbook,
51.IP 53.Pp
52.B info gnunet-c-tutorial 54.Dl info gnunet-c-tutorial
53.PP 55.Pp
54will give you access to a tutorial for developers. 56will give you access to a tutorial for developers.
55.PP 57.sp
56Depending on your installation, this information is also 58Depending on your installation, this information is also available in
57available in 59.Xr gnunet 7 and
58\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 60.Xr gnunet-c-tutorial 7 .
61.\".Sh HISTORY
62.\".Sh AUTHORS
63.Sh BUGS
64Report bugs by using
65.Lk https://bugs.gnunet.org
66or by sending electronic mail to
67.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-uri.1 b/doc/man/gnunet-uri.1
index 2fe1a05d2..bb525ef7f 100644
--- a/doc/man/gnunet-uri.1
+++ b/doc/man/gnunet-uri.1
@@ -1,49 +1,54 @@
1.TH GNUNET-URI 1 "June 26, 2012" "GNUnet" 1.Dd June 26, 2012
2.SH NAME 2.Dt GNUNET-URI 1
3gnunet\-uri \- invoke default handler for GNUnet URIs 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-uri 5.Nm gnunet-uri
6.RI URI 6.Nd
7.SH DESCRIPTION 7invoke default handler for GNUnet URIs
8\fBgnunet\-uri\fP can be used to invoke the correct tool to handle a 8.Sh SYNOPSIS
9GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" 9.Nm
10and thus the specific tool to handle the URI depends on the subsystem. 10.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
11gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM 11.Op Fl h | \-help
12in the configuration section "uri") and invoke it. 12.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
13.SH OPTIONS 13.Op Fl v | \-version
14.B 14URI
15.IP "\-c FILENAME, \-\-config=FILENAME" 15.Sh DESCRIPTION
16.Nm
17can be used to invoke the correct tool to handle a GNUnet URI.
18GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" and thus the specific tool to handle the URI depends on the subsystem.
19gnunet-uri will determine the correct tool (by looking for SUBSYSTEM in the configuration section "uri") and invoke it.
20.Bl -tag -width Ds
21.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
16Use the configuration file FILENAME. 22Use the configuration file FILENAME.
17.B 23.It Fl h | \-help
18.IP "\-h, \-\-help"
19Print short help on options. 24Print short help on options.
20.B 25.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
21.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 26Use LOGLEVEL for logging.
22Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 27Valid values are DEBUG, INFO, WARNING and ERROR.
23.B 28.It Fl v | \-version
24.IP "\-v, \-\-version"
25Print GNUnet version number. 29Print GNUnet version number.
26.SH BUGS 30.El
27Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 31.Sh SEE ALSO
28electronic mail to <gnunet\-developers@gnu.org> 32The full documentation for gnunet is maintained as a Texinfo manual.
29.SH SEE ALSO
30The full documentation for
31.B gnunet
32is maintained as a Texinfo manual.
33If the 33If the
34.B info 34.Xr info 1
35and 35and gnunet programs are properly installed at your site, the command
36.B gnunet 36.Pp
37programs are properly installed at your site, the command 37.Dl info gnunet
38.IP 38.Pp
39.B info gnunet
40.PP
41should give you access to the complete handbook, 39should give you access to the complete handbook,
42.IP 40.Pp
43.B info gnunet-c-tutorial 41.Dl info gnunet-c-tutorial
44.PP 42.Pp
45will give you access to a tutorial for developers. 43will give you access to a tutorial for developers.
46.PP 44.sp
47Depending on your installation, this information is also 45Depending on your installation, this information is also available in
48available in 46.Xr gnunet 7 and
49\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 47.Xr gnunet-c-tutorial 7 .
48.\".Sh HISTORY
49.\".Sh AUTHORS
50.Sh BUGS
51Report bugs by using
52.Lk https://bugs.gnunet.org
53or by sending electronic mail to
54.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1
index ddb53a7bd..e0fd2b78c 100644
--- a/doc/man/gnunet-vpn.1
+++ b/doc/man/gnunet-vpn.1
@@ -1,101 +1,98 @@
1.TH GNUNET\-VPN 1 "February 25, 2012" "GNUnet" 1.Dd February 25, 2012
2.SH NAME 2.Dt GNUNET-VPN 1
3gnunet\-vpn \- manually setup a GNUnet VPN tunnel 3.Sh NAME
4.SH SYNOPSIS 4.Nm gnunet-vpn
5.B gnunet\-vpn 5.Nd
6.RI [ options ] 6manually setup a GNUnet VPN tunnel
7.br 7.Sh SYNOPSIS
8.SH DESCRIPTION 8.Nm
9\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the 9.Op Fl 4 | \-ipv4
10GNUnet network. 10.Op Fl 6 | \-ipv6
11.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
12.Op Fl d Ar TIME | Fl \-duration Ar TIME
13.Op Fl h | \-help
14.Op Fl i Ar IP | Fl \-ip Ar IP
15.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
16.Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
17.Op Fl s Ar NAME | Fl \-service= Ns Ar NAME
18.Op Fl t | \-tcp
19.Op Fl u | \-udp
20.Op Fl V | \-verbose
21.Op Fl v | \-version
22.Sh DESCRIPTION
23.Nm
24can be used to manually setup a VPN tunnel via the GNUnet network.
11There are two main types of tunnels. 25There are two main types of tunnels.
12Tunnels to an exit node which routes the traffic to the global 26Tunnels to an exit node which routes the traffic to the global Internet, and tunnels to a node that runs a service only within GNUnet.
13Internet, and tunnels to a node that runs a service only within
14GNUnet.
15Depending on the type of tunnel, gnunet\-vpn takes different options. 27Depending on the type of tunnel, gnunet\-vpn takes different options.
16The "\-i" option is required for tunnels to an exit node, whereas the 28The "\-i" option is required for tunnels to an exit node, whereas the "\-p" and "\-s" options in conjunction with either "\-u" or "\-t" are required for tunnels to services.
17"\-p" and "\-s" options in conjunction with either "\-u" or "\-t" are
18required for tunnels to services.
19For exit tunnels, both UDP and TCP traffic will be redirected. 29For exit tunnels, both UDP and TCP traffic will be redirected.
20For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will 30For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will be redirected.
21be redirected.
22The tool will display the IP address for this end of the tunnel. 31The tool will display the IP address for this end of the tunnel.
23The address can be displayed as soon as it has been allocated, or only 32The address can be displayed as soon as it has been allocated, or only after ("\-a") the tunnel has been created.
24after ("\-a") the tunnel has been created. 33.Bl -tag -width Ds
25.SH OPTIONS 34.It Fl 4 | \-ipv4
26.B
27.IP "\-4, \-\-ipv4"
28Desired IP address on this end of the tunnel should be an IPv4 address. 35Desired IP address on this end of the tunnel should be an IPv4 address.
29.B 36.It Fl 6 | \-ipv6
30.IP "\-6, \-\-ipv6"
31Desired IP address on this end of the tunnel should be an IPv6 address. 37Desired IP address on this end of the tunnel should be an IPv6 address.
32.B 38.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
33.IP "\-c FILENAME, \-\-config=FILENAME"
34Use the configuration file FILENAME. 39Use the configuration file FILENAME.
35.B 40.It Fl d Ar TIME | Fl \-duration Ar TIME
36.IP "\-d TIME, \-\-duration TIME"
37The mapping should be established for TIME. 41The mapping should be established for TIME.
38The value given must be a number followed by a space and a time unit, 42The value given must be a number followed by a space and a time unit, for example "500 ms".
39for example "500 ms".
40Note that the quotes are required on the shell. 43Note that the quotes are required on the shell.
41Default is 5 minutes. 44Default is 5 minutes.
42.B 45.It Fl h | \-help
43.IP "\-h, \-\-help"
44Print short help on options. 46Print short help on options.
45.B 47.It Fl i Ar IP | Fl \-ip Ar IP
46.IP "\-i IP, \-\-ip IP"
47Tunnel should be to an exit node and connect to the given IPv4 or IPv6 48Tunnel should be to an exit node and connect to the given IPv4 or IPv6
48IP address. 49IP address.
49Note that you can specify an IPv6 address as the target here, even in 50Note that you can specify an IPv6 address as the target here, even in
50combination with "\-4" (4to6) and similarly you can specify an IPv4 51combination with "\-4" (4to6) and similarly you can specify an IPv4
51address in combination with "\-6" (6to4). 52address in combination with "\-6" (6to4).
52.B 53.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
53.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
54Use LOGLEVEL for logging. 54Use LOGLEVEL for logging.
55Valid values are DEBUG, INFO, WARNING and ERROR. 55Valid values are DEBUG, INFO, WARNING and ERROR.
56.B 56.It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
57.IP "\-p PEERID, \-\-peer=PEERID"
58Name of the peer offering the service to connect to. 57Name of the peer offering the service to connect to.
59Cannot be used in conjunction with "\-i", requires "\-s". 58Cannot be used in conjunction with "\-i", requires "\-s".
60.B 59.It Fl s Ar NAME | Fl \-service= Ns Ar NAME
61.IP "\-s NAME, \-\-service=NAME"
62Name of the service running on the target peer. 60Name of the service running on the target peer.
63Cannot be used in conjunction with "\-i", requires "\-p". 61Cannot be used in conjunction with "\-i", requires "\-p".
64.B 62.It Fl t | \-tcp
65.IP "\-t, \-\-tcp"
66Service runs TCP. 63Service runs TCP.
67Either "\-t" or "\-u" must be specified when using "\-s". 64Either "\-t" or "\-u" must be specified when using "\-s".
68.B 65.It Fl u | \-udp
69.IP "\-u, \-\-udp"
70Service runs UDP. 66Service runs UDP.
71Either "\-t" or "\-u" must be specified when using "\-s". 67Either "\-t" or "\-u" must be specified when using "\-s".
72.B 68.It Fl V | \-verbose
73.IP "\-V, \-\-verbose"
74Be verbose. 69Be verbose.
75.B 70.It Fl v | \-version
76.IP "\-v, \-\-version"
77Print GNUnet version number. 71Print GNUnet version number.
78.SH BUGS 72.El
79Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 73.Sh SEE ALSO
80electronic mail to <gnunet\-developers@gnu.org> 74.Xr gnunet-setup 1
81.SH SEE ALSO 75.sp
82gnunet\-setup(1) 76The full documentation for gnunet is maintained as a Texinfo manual.
83The full documentation for 77If the
84.B gnunet 78.Xr info 1
85is maintained as a Texinfo manual. If the 79and gnunet programs are properly installed at your site, the command
86.B info 80.Pp
87and 81.Dl info gnunet
88.B gnunet 82.Pp
89programs are properly installed at your site, the command
90.IP
91.B info gnunet
92.PP
93should give you access to the complete handbook, 83should give you access to the complete handbook,
94.IP 84.Pp
95.B info gnunet-c-tutorial 85.Dl info gnunet-c-tutorial
96.PP 86.Pp
97will give you access to a tutorial for developers. 87will give you access to a tutorial for developers.
98.PP 88.sp
99Depending on your installation, this information is also 89Depending on your installation, this information is also available in
100available in 90.Xr gnunet 7 and
101\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 91.Xr gnunet-c-tutorial 7 .
92.\".Sh HISTORY
93.\".Sh AUTHORS
94.Sh BUGS
95Report bugs by using
96.Lk https://bugs.gnunet.org
97or by sending electronic mail to
98.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1
index 2a67718f9..e99b235b8 100644
--- a/doc/man/gnunet-zoneimport.1
+++ b/doc/man/gnunet-zoneimport.1
@@ -1,90 +1,106 @@
1.TH GNUNET-ZONEIMPORT 1 "April 23, 2018" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2018, 2019 GNUnet e.V.
3gnunet\-zoneimport \- import DNS zone into GNS zone 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-zoneimport [IP]+ 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.SH DESCRIPTION 6.\" any later version published by the Free Software Foundation; with no
7\fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8stdin and issues DNS queries for each of the domain names given. It 8.\" copy of the license is included in the file
9then checks if a local ego with a name matching the domain 9.\" ``FDL-1.3''.
10exists. Specifically, if the domain name is "example.fr", it will 10.\"
11check if an ego "fr" exists, while for a domain "example.com.fr" it 11.\" A copy of the license is also available from the Free Software
12will look for an ego called "com.fr"). If so, it will convert the DNS 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13records into GNS records (in particular converting NS records and glue 13.\"
14records to GNS2DNS records) and add them to the namestore under the 14.\" Alternately, this document is also available under the General
15label ("example" in the examples above). 15.\" Public License, version 3 or later, as published by the Free Software
16.PP 16.\" Foundation. A copy of the license is included in the file
17The arguments given to gnunet\-zoneimport is a list of IP addresses of 17.\" ``GPL3''.
18DNS servers to query. 18.\"
19.PP 19.\" A copy of the license is also available from the Free Software
20gnunet\-zoneimport will usually never terminate: it will check when 20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21DNS records expire, and re-issue requests when the old DNS records 21.\"
22have expired so that GNS always has the latest data. 22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.PP 23.\"
24gnunet\-zoneimport will issue many DNS queries in parallel, but is 24.Dd April 23, 2018
25rate-limited in various ways, so most DNS servers should easily handle 25.Dt GNUNET-ZONEIMPORT 1
26the load. gnunet\-zoneimport will perform a limited number of retries 26.Os
27if queries fail. 27.Sh NAME
28.PP 28.Nm gnunet-zoneimport
29gnunet\-zoneimport operates incrementally. It will check if the 29.Nd
30namestore already has (non-expired) records stored for a given name in 30import DNS zone into GNS zone
31the respective zone and not issue those requests again. Thus, it is 31.Sh SYNOPSIS
32fine to restart gnunet\-zoneimport whenever the list of domain names 32.Nm
33changes. 33.Op Fl c Ar FILENAME | \-config= Ns Ar FILENAME
34.PP 34.Op Fl h | \-help
35Finally, gnunet\-zoneimport keeps information for each domain name in 35.Op Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME
36memory. This consumes about 200 bytes per domain name, or 1 GB for 5 36.Op Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE
37million labels. 37.Op Ar \IP
38.SH OPTIONS 38.Sh DESCRIPTION
39.B 39.Nm
40.IP "\-c FILENAME, \-\-config=FILENAME" 40reads a list of domain names (FQDN) from stdin and issues DNS queries for each of the domain names given.
41It then checks if a local ego with a name matching the domain exists.
42Specifically, if the domain name is "example.fr", it will check if an ego "fr" exists, while for a domain "example.com.fr" it will look for an ego called "com.fr").
43If so, it will convert the DNS records into GNS records (in particular converting NS records and glue records to GNS2DNS records) and add them to the namestore under the label ("example" in the examples above).
44.Pp
45The arguments given to gnunet-zoneimport is a list of IP addresses of DNS servers to query.
46.Pp
47gnunet-zoneimport will usually never terminate: it will check when DNS records expire, and re-issue requests when the old DNS records have expired so that GNS always has the latest data.
48.Pp
49gnunet-zoneimport will issue many DNS queries in parallel, but is rate-limited in various ways, so most DNS servers should easily handle the load.
50gnunet-zoneimport will perform a limited number of retries if queries fail.
51.Pp
52gnunet-zoneimport operates incrementally.
53It will check if the namestore already has (non-expired) records stored for a given name in the respective zone and not issue those requests again.
54Thus, it is fine to restart gnunet-zoneimport whenever the list of domain names changes.
55.Pp
56Finally, gnunet-zoneimport keeps information for each domain name in memory.
57This consumes about 200 bytes per domain name, or 1 GB for 5 million labels.
58.Bl -tag -width Ds
59.It Fl c Ar FILENAME | \-config= Ns Ar FILENAME
41Use the configuration file FILENAME. 60Use the configuration file FILENAME.
42.B 61.It Fl h | \-help
43.IP "\-h, \-\-help"
44Print short help on options. 62Print short help on options.
45.B 63.It Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME
46.IP "\-m RELATIVETIME, \-\-minimum-expiration=RELATIVETIME" 64Ensure that imported DNS records never have an expiration time that is less than RELATIVETIME into the future.
47.B 65RELATIVETIME is a time given like "1 week" or "1 h".
48Ensure that imported DNS records never have an expiration time that 66If DNS returns records with a shorter lifetime, gnunet\-zoneimport will simply bump the lifetime to the specified value (relative to the time of the import).
49is less than RELATIVETIME into the future. RELATIVETIME is a time 67Default is zero.
50given like "1 week" or "1 h". If DNS returns records with a shorter 68.It Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE
51lifetime, gnunet\-zoneimport will simply bump the lifetime to the 69Specifies the size (in number of entries) to use for the main hash map.
52specified value (relative to the time of the import). Default is zero. 70The value provided should be at least twice the number of domain names that will be given to the tool.
53.IP "\-s MAPSIZE, \-\-size=MAPSIZE" 71This option is required for very large zones where the number of records encountered is too large for the automatic growth mechanism to work (that one is limited to at most 16 MB allocations for security reasons).
54Specifies the size (in number of entries) to use for the main hash 72Do not worry about this unless you are importing millions of domain names from a zone.
55map. The value provided should be at least twice the number of domain 73.It Ar \IP
56names that will be given to the tool. This option is required for very 74IP Is the list of IPs given.
57large zones where the number of records encountered is too large for 75.El
58the automatic growth mechanism to work (that one is limited to at most 76.Sh EXAMPLES
5916 MB allocations for security reasons). Do not worry about this
60unless you are importing millions of domain names from a zone.
61.SH NOTES
62.TP
63Typical invocaton would be: 77Typical invocaton would be:
64$ gnunet\-zoneimport 1.2.3.4 < names.txt 78.Pp
65.SH BUGS 79.Dl $ gnunet\-zoneimport 1.2.3.4 < names.txt
66Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 80.Sh SEE ALSO
67electronic mail to <gnunet\-developers@gnu.org> 81.Xr gnunet-gns 1 ,
68.SH SEE ALSO 82.Xr gnunet-namestore 1
69gnunet\-gns(1), gnunet\-namestore(1) 83.sp
70.PP 84The full documentation for gnunet is maintained as a Texinfo manual.
71The full documentation for
72.B gnunet
73is maintained as a Texinfo manual.
74If the 85If the
75.B info 86.Xr info 1
76and 87and gnunet programs are properly installed at your site, the command
77.B gnunet 88.Pp
78programs are properly installed at your site, the command 89.Dl info gnunet
79.IP 90.Pp
80.B info gnunet
81.PP
82should give you access to the complete handbook, 91should give you access to the complete handbook,
83.IP 92.Pp
84.B info gnunet-c-tutorial 93.Dl info gnunet-c-tutorial
85.PP 94.Pp
86will give you access to a tutorial for developers. 95will give you access to a tutorial for developers.
87.PP 96.sp
88Depending on your installation, this information is also 97Depending on your installation, this information is also available in
89available in 98.Xr gnunet 7 and
90\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 99.Xr gnunet-c-tutorial 7 .
100.\".Sh HISTORY
101.\".Sh AUTHORS
102.Sh BUGS
103Report bugs by using
104.Lk https://bugs.gnunet.org
105or by sending electronic mail to
106.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet.conf.5.in b/doc/man/gnunet.conf.5.in
index 560704784..82340996a 100644
--- a/doc/man/gnunet.conf.5.in
+++ b/doc/man/gnunet.conf.5.in
@@ -1,4 +1,27 @@
1.\" -*- mode: nroff -*- 1.\" -*- mode: nroff -*-
2.\" This file is part of Ascension.
3.\" Copyright (C) 2012-2015,2018,2019 GNUnet e.V.
4.\"
5.\" Permission is granted to copy, distribute and/or modify this document
6.\" under the terms of the GNU Free Documentation License, Version 1.3 or
7.\" any later version published by the Free Software Foundation; with no
8.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
9.\" copy of the license is included in the file
10.\" ``FDL-1.3''.
11.\"
12.\" A copy of the license is also available from the Free Software
13.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
14.\"
15.\" Alternately, this document is also available under the General
16.\" Public License, version 3 or later, as published by the Free Software
17.\" Foundation. A copy of the license is included in the file
18.\" ``GPL3''.
19.\"
20.\" A copy of the license is also available from the Free Software
21.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
22.\"
23.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
24.\"
2.TH GNUNET.CONF "5" "October 26, 2018" "GNUnet" 25.TH GNUNET.CONF "5" "October 26, 2018" "GNUnet"
3.SH NAME 26.SH NAME
4gnunet.conf \- GNUnet configuration file 27gnunet.conf \- GNUnet configuration file
@@ -27,7 +50,7 @@ Default values for all of the options can be found in the files in the
27"$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will 50"$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will
28work out of the box with those. See the examples section below for 51work out of the box with those. See the examples section below for
29some common setups on top of that. 52some common setups on top of that.
30.SH General OPTIONS 53.SS GENERAL OPTIONS
31Many options will be common between sections. They can be repeated under 54Many options will be common between sections. They can be repeated under
32each section with different values. The "[PATHS]" section is special. 55each section with different values. The "[PATHS]" section is special.
33Here, it is possible to specify values for variables like "GNUNET_HOME". 56Here, it is possible to specify values for variables like "GNUNET_HOME".
@@ -85,7 +108,7 @@ The following options are generic and shared by all services:
85 Set to YES if this service should be run per-user, NO if this is a system 108 Set to YES if this service should be run per-user, NO if this is a system
86 service. End-users should never have to change the defaults GNUnet provides 109 service. End-users should never have to change the defaults GNUnet provides
87 for this option. 110 for this option.
88.SH ATS Options 111.SS ATS OPTIONS
89.IP UNSPECIFIED_QUOTA_IN 112.IP UNSPECIFIED_QUOTA_IN
90 quotes in KiB or MiB per seconds. Or use the word "unlimited" 113 quotes in KiB or MiB per seconds. Or use the word "unlimited"
91.IP UNSPECIFIED_QUOTA_OUT 114.IP UNSPECIFIED_QUOTA_OUT
@@ -109,12 +132,11 @@ The following options are generic and shared by all services:
109.SH EXAMPLES 132.SH EXAMPLES
110This example is a simple way to get started, using a server that has a known 133This example is a simple way to get started, using a server that has a known
111list of peers to get you started. Most users will be behind a firewall on 134list of peers to get you started. Most users will be behind a firewall on
112IPv4, as such NAT is enabled. Please rememeber to change your IP address 135IPv4, as such NAT is enabled. Please remember to change your IP address
113to the actual external address for your usage. 136to the actual external address for your usage.
114.PP 137.PP
115 [hostlist] 138 [hostlist]
116 OPTIONS = \-b 139 OPTIONS = \-b \-e
117 SERVERS = http://v9.gnunet.org:58080/
118 140
119 [nat] 141 [nat]
120 BEHIND_NAT = YES 142 BEHIND_NAT = YES
@@ -129,9 +151,6 @@ to the actual external address for your usage.
129.TP 151.TP
130~/.config/gnunet.conf 152~/.config/gnunet.conf
131GNUnet configuration file 153GNUnet configuration file
132.SH BUGS
133Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
134electronic mail to <bug-gnunet@gnu.org>
135.SH SEE ALSO 154.SH SEE ALSO
136\fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) 155\fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1)
137.PP 156.PP
@@ -155,3 +174,9 @@ will give you access to a tutorial for developers.
155Depending on your installation, this information is also 174Depending on your installation, this information is also
156available in 175available in
157\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 176\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
177.SH HISTORY
178.PP
179This man page first appeared in October 2012 in GNUnet.
180.SH BUGS
181Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
182electronic mail to <bug-gnunet@gnu.org>
diff --git a/doc/man/produce_html.sh b/doc/man/produce_html.sh
new file mode 100755
index 000000000..ce6dea304
--- /dev/null
+++ b/doc/man/produce_html.sh
@@ -0,0 +1,14 @@
1#!/bin/sh
2
3existence()
4{
5 command -v "$1" >/dev/null 2>&1
6}
7
8if existence mandoc;
9then
10 for f in `find . -name \*\.[1-9]`;
11 do
12 mandoc -T html $f > $f.html;
13 done
14fi
diff --git a/doc/man/texi2mdoc-generation.sh b/doc/man/texi2mdoc-generation.sh
new file mode 100755
index 000000000..b88987cda
--- /dev/null
+++ b/doc/man/texi2mdoc-generation.sh
@@ -0,0 +1,15 @@
1#!/bin/sh
2# This script is in the public-domain.
3# GNUnet e.V. 2019
4#
5# Commentary: generate texi2mdoc output. This would be easier with
6# bmake / BSDmake, oh well.
7#
8# Excercise for future readers: don't fix this.
9
10# echo $(pwd)
11cd ../tutorial
12texi2mdoc -I$(pwd):$(pwd)/chapters gnunet-tutorial.texi > ../man/gnunet-c-tutorial.7
13# echo $(pwd)
14cd ../handbook
15texi2mdoc -I$(pwd):$(pwd)/chapters gnunet.texi > ../man/gnunet-documentation.7