summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
committerNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
commitd269419d23e8c4c062e21e5bd88cdee66a1680b0 (patch)
treec9661262fee4604bd83b0bc739e7223c8cddfb0a
parent4be442739c7f6745848a2f5544a59592f06a6cb3 (diff)
doc/man: More fixes.
Signed-off-by: Nils Gillmann <ng0@n0.is>
-rw-r--r--doc/man/gnunet-arm.114
-rw-r--r--doc/man/gnunet-config.112
-rw-r--r--doc/man/gnunet-core.114
-rw-r--r--doc/man/gnunet-datastore.14
-rw-r--r--doc/man/gnunet-directory.112
-rw-r--r--doc/man/gnunet-download.129
-rw-r--r--doc/man/gnunet-gns-proxy.115
-rw-r--r--doc/man/gnunet-namestore-fcfsd.120
-rw-r--r--doc/man/gnunet-nat-auto.152
-rw-r--r--doc/man/gnunet-nat-server.122
-rw-r--r--doc/man/gnunet-peerinfo.117
-rw-r--r--doc/man/gnunet-resolver.116
-rw-r--r--doc/man/gnunet-scalarproduct.126
-rw-r--r--doc/man/gnunet-scrypt.116
-rw-r--r--doc/man/gnunet-statistics.117
-rw-r--r--doc/man/gnunet-testing-run-service.120
-rw-r--r--doc/man/gnunet-timeout.117
-rw-r--r--doc/man/gnunet-transport-certificate-creation.115
-rw-r--r--doc/man/gnunet-uri.117
-rw-r--r--doc/man/gnunet-zoneimport.130
-rw-r--r--doc/man/gnunet.conf.526
21 files changed, 141 insertions, 270 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
index fdcc7d820..0e7486d28 100644
--- a/doc/man/gnunet-arm.1
+++ b/doc/man/gnunet-arm.1
@@ -1,19 +1,14 @@
-.TH GNUNET\-ARM 1 "Jan 4, 2012" "GNUnet"
-
+.TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet"
.SH NAME
gnunet\-arm \- control GNUnet services
-
.SH SYNOPSIS
.B gnunet\-arm
.RI [ options ]
-.br
-
.SH DESCRIPTION
\fBgnunet\-arm\fP can be used to start or stop GNUnet services, including
the ARM service itself. The ARM service is a supervisor for GNUnet's
service processes. ARM starts services on-demand or as configured and
re-starts them if they crash.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -55,17 +50,16 @@ List all running services.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-
-
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <gnunet\-developers@gnu.org>
-
.SH SEE ALSO
gnunet\-config(1), gnunet\-setup(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1
index 43e7a011b..c4f979fb0 100644
--- a/doc/man/gnunet-config.1
+++ b/doc/man/gnunet-config.1
@@ -1,16 +1,11 @@
-.TH GNUNET\-CONFIG 1 "Jul 15, 2012" "GNUnet"
-
+.TH GNUNET-CONFIG 1 "July 15, 2012" "GNUnet"
.SH NAME
gnunet\-config \- manipulate GNUnet configuration files
-
.SH SYNOPSIS
.B gnunet\-config
.RI [ options ]
-.br
-
.SH DESCRIPTION
\fBgnunet\-config\fP can be used to read or modify GNUnet configuration files.
-
.SH OPTIONS
.B
.IP "\-f, \-\-filename"
@@ -46,15 +41,14 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-
-
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-core.1 b/doc/man/gnunet-core.1
index 12d936f7a..dd2b566f9 100644
--- a/doc/man/gnunet-core.1
+++ b/doc/man/gnunet-core.1
@@ -1,17 +1,13 @@
-.TH gnunet\-core "1" "11 Apr 2014" "GNUnet"
+.TH GNUNET-CORE "1" "April 11, 2014" "GNUnet"
.SH NAME
gnunet\-core \- monitor CORE subsystem
-
.SH SYNOPSIS
.B gnunet\-core
[\fIOPTIONS\fR]
.SH DESCRIPTION
-.PP
-
gnunet\-core is a tool to access various functions of GNUnet's core subsystem
from the command\-line. The only function right now is to monitor the status
of peers known to the CORE service.
-
.TP
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
configuration file to use
@@ -31,18 +27,16 @@ print the version number
.TP
\fB\-V\fR, \fB\-\-verbose\fR
be verbose
-
-.SH NOTES
-
-
.SH BUGS
Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
\fBgnunet\-transport\fP(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-datastore.1 b/doc/man/gnunet-datastore.1
index 535aedbf5..4cb536f51 100644
--- a/doc/man/gnunet-datastore.1
+++ b/doc/man/gnunet-datastore.1
@@ -1,11 +1,10 @@
-.TH gnunet\-datastore "1" "April 13, 2017" "GNUnet"
+.TH GNUNET-DATASTORE "1" "April 13, 2017" "GNUnet"
.SH NAME
gnunet\-datastore \- dump or insert (restore) GNUnet datastore databases
.SH SYNOPSIS
.B gnunet\-datastore
[\fIOPTIONS\fR]
.SH DESCRIPTION
-.PP
gnunet\-datastore can be used to backup and restore or merge GNUnet
datastores.
This is useful if a datastore is to be migrated between SQL databases,
@@ -41,6 +40,7 @@ Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
\fBgnunet\-publish\fP(1)
+.PP
The full documentation for
.B gnunet
is maintained as a Texinfo manual.
diff --git a/doc/man/gnunet-directory.1 b/doc/man/gnunet-directory.1
index a8aa515e4..109b2fc6c 100644
--- a/doc/man/gnunet-directory.1
+++ b/doc/man/gnunet-directory.1
@@ -1,7 +1,6 @@
-.TH gnunet-directory "1" "25 Feb 2012" "GNUnet"
+.TH GNUNET-DIRECTORY "1" "February 25, 2012" "GNUnet"
.SH NAME
gnunet\-directory \- display directories
-
.SH SYNOPSIS
.B gnunet\-directory
[\fIOPTIONS\fR] (FILENAME)*
@@ -37,7 +36,7 @@ availability but does not produce useless duplicates (for example, it is a
better idea to publish a collection of pictures or compressed sound files
using a GNUnet directory instead of processing them with archivers such as
tar or zip first). Directories can contain arbitrary meta data for each file.
-
+.PP
If a directory has missing blocks (for example, some blocks failed to download),
GNUnet is typically able to retrieve information about other files in the
directory. Files in a GNUnet directory have no particular order; the GNUnet
@@ -45,11 +44,11 @@ code that generates a directory can reorder the entries in order to better
fit the information about files into blocks of 32k. Respecting 32k boundaries
where possible makes it easier for gnunet\-directory (and other tools) to
recover information from partially downloaded directory files.
-
+.PP
At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP
and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be
published in a namespace.
-
+.PP
GNUnet directories use the (unregistered)
mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal
search results. The directory file can be downloaded to disk
@@ -64,7 +63,8 @@ electronic mail to <gnunet\-developers@gnu.org>
\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1)
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index aa1328c00..58e82e790 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -1,21 +1,17 @@
-.TH GNUNET-DOWNLOAD "1" "31 Jan 2016" "GNUnet"
+.TH GNUNET-DOWNLOAD "1" "January 31, 2016" "GNUnet"
.SH NAME
gnunet\-download \- a command line interface for downloading files from GNUnet
.SH SYNOPSIS
.B gnunet\-download
[\fIOPTIONS\fR] \-\- GNUNET_URI
.SH DESCRIPTION
-.PP
Download files from GNUnet.
-
.TP
\fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR
set desired level of receiver anonymity. Default is 1.
-
.TP
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
use config file (defaults: ~/.config/gnunet.conf)
-
.TP
\fB\-D, \fB\-\-delete\-incomplete\fR
causes gnunet\-download to delete incomplete downloads when aborted with
@@ -24,20 +20,16 @@ download will not be deleted even with this option. Without this option,
terminating gnunet\-download with a signal will cause incomplete
downloads to stay on disk. If gnunet\-download runs to (normal) completion
finishing the download, this option has no effect.
-
.TP
\fB\-h\fR, \fB\-\-help\fR
print help page
-
.TP
\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
Change the loglevel. Possible values for LOGLEVEL are
ERROR, WARNING, INFO and DEBUG.
-
.TP
\fB\-n\fR, \fB\-\-no-network\fR
Only search locally, do not forward requests to other peers.
-
.TP
\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR
write the file to FILENAME. Hint: when recursively downloading a directory,
@@ -45,7 +37,6 @@ append a '/' to the end of the FILENAME to create a directory of that name.
If no FILENAME is specified, gnunet\-download constructs a temporary ID from
the URI of the file. The final filename is constructed based on meta\-data
extracted using libextractor (if available).
-
.TP
\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR
set the maximum number of parallel downloads that is allowed. More parallel
@@ -56,7 +47,6 @@ used to limit the number of files that are downloaded in parallel (\-r can
be used to limit the number of blocks that are concurrently requested).
As a result, the value only matters for recursive downloads.
The default value is 32.
-
.TP
\fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR
set the maximum number of parallel requests that is allowed. If multiple
@@ -71,7 +61,6 @@ recursive downloads with many large files if memory and network
bandwidth are not fully utilized and if the parallelism limit (\-p option)
is not reached. This option also only matters for recursive downloads.
The default value is 4092.
-
.TP
\fB\-R\fR, \fB\-\-recursive\fR
download directories recursively (and in parallel). Note that the URI
@@ -83,15 +72,12 @@ information will be stored in "DIRNAME/.gnd". However, it is also
possible to specify "DIRNAME.gnd", in which case the files from the
directory will end up in "DIRNAME/", while GNUnet's directory meta
data will be in "DIRNAME.gnd".
-
.TP
\fB\-v\fR, \fB\-\-version\fR
print the version number
-
.TP
\fB\-V\fR, \fB\-\-verbose\fR
print progress information
-
.SH NOTES
The GNUNET_URI is typically obtained from
gnunet\-search. gnunet\-fs\-gtk can also be used instead of
@@ -102,9 +88,7 @@ already present. GNUnet's file\-encoding will ensure file integrity,
even if the existing file was not downloaded from GNUnet in the first
place. Temporary information will be appended to the target file until
the download is completed.
-
.SH SETTING ANONYMITY LEVEL
-
The \fB\-a\fR option can be used to specify additional anonymity
constraints. If set to 0, GNUnet will try to download the file as fast
as possible, including using non-anonymous methods. If you set it to
@@ -121,14 +105,14 @@ anonymity level 0, the peers publishing the data might be sharing with
a higher anonymity level, which in this case will determine
performance. Also, peers that cache content in the network always use
anonymity level 1.
-
+.PP
This option can be used to limit requests further than that. In
particular, you can require GNUnet to receive certain amounts of
traffic from other peers before sending your queries. This way, you
can gain very high levels of anonymity \- at the expense of much more
traffic and much higher latency. So set it only if you really believe
you need it.
-
+.PP
The definition of ANONYMITY\-RECEIVE is the following. 0 means no
anonymity is required. Otherwise a value of 'v' means that 1 out of v
bytes of "anonymous" traffic can be from the local user, leaving 'v-1'
@@ -137,12 +121,11 @@ bytes of messages from foreign peers (using anonymous routing), it may
originate n/(v-1) bytes of queries in the same time\-period. The
time\-period is twice the average delay that GNUnet defers forwarded
queries.
-
+.PP
The default is 1 and this should be fine for most users. Also notice
that if you choose very large values, you may end up having no
throughput at all, especially if many of your fellow GNUnet\-peers all
do the same.
-
.SH FILES
.TP
~/.config/gnunet.conf
@@ -154,9 +137,11 @@ mail to <gnunet\-developers@gnu.org>
\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
\fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5),
\fBgnunet\-service\-fs\fP(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1
index ccb0f7206..f99be5104 100644
--- a/doc/man/gnunet-gns-proxy.1
+++ b/doc/man/gnunet-gns-proxy.1
@@ -1,24 +1,19 @@
-.TH GNUNET\-GNS\-PROXY 1 "Oct 25, 2012" "GNUnet"
-
+.TH GNUNET-GNS-PROXY 1 "October 25, 2012" "GNUnet"
.SH NAME
gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy
-
.SH SYNOPSIS
.B gnunet\-gns\-proxy
.RI [ options ]
-.br
-
.SH DESCRIPTION
Most users will want to run this SOCKS proxy. It can be used in
combination with browsers that support the SOCKS 4a protocol.
-
+.PP
The proxy will perform SSL authentication of GNS names and rewrite GNS
enabled HTML content. To assert the validity of GNS names a local root
CA certificate has to be generated that is used by the proxy. Thus
"gnunet-gns-proxy-setup-ca" should be executed before the first launch
of this proxy or the \-\-authority switch is used to specify an
appropriate CA certificate that is already trusted by the browser.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -42,16 +37,16 @@ ERROR.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-
-
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <bug\-gnunet@gnu.org>
.SH SEE ALSO
gnunet\-gns(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1
index fc0f40eef..3f22145e2 100644
--- a/doc/man/gnunet-namestore-fcfsd.1
+++ b/doc/man/gnunet-namestore-fcfsd.1
@@ -1,36 +1,31 @@
-.TH GNUNET\-NAMESTORE-FCFSD 1 "5 Sep 2013" "GNUnet"
-
+.TH GNUNET-NAMESTORE-FCFSD 1 "September 5, 2013" "GNUnet"
.SH NAME
gnunet\-namestore-fcfsd \- HTTP server for GNU Name System First-Come-First-Served name registration
-
.SH SYNOPSIS
.B gnunet\-namestore-fcfsd
.RI [ options ]
-.br
-
.SH DESCRIPTION
Most users will not want to run an FCFS\-zone and thus will not need
this program.
-
+.PP
\fBgnunet\-gns-fcfsd\fP runs a web server where users can register
names to be mapped to their GNS zone. Names are made available on a
First Come First Served basis (hence fcfs). Registered names do not
expire. The HTTP server is run on the port that is specified in the
configuration file in section "[fcfsd]" under the name "HTTPPORT".
-
+.PP
It is possible to manage gnunet\-gns\-fcfsd using
gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i
fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your
configuration and the "-z ZONE" in as the "OPTION".
-
+.PP
An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are
encouraged to register their zone with the gnunet.org FCFS authority.
-
+.PP
If you want to run your own FCFS registrar, you need to first create a
pseudonym (using "gnunet\-identity \-C NAME"), and use it with the
"-z" option. After that, you can start the FCFSD service (possibly using
gnunet\-arm).
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -48,15 +43,16 @@ Print GNUnet version number.
.B
.IP "\-z EGO, \-\-zone=EGO"
Specifies for which EGO should FCFSD manage the zone.
-
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <bug\-gnunet@gnu.org>
.SH SEE ALSO
gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1
index ca50d76fc..bc95972c4 100644
--- a/doc/man/gnunet-nat-auto.1
+++ b/doc/man/gnunet-nat-auto.1
@@ -1,77 +1,59 @@
-.TH GNUNET\-NAT\-AUTO 1 "6 Jan 2017" "GNUnet"
-
+.TH GNUNET-NAT-AUTO 1 "January 6, 2017" "GNUnet"
.SH NAME
gnunet\-nat\-auto \- autoconfigure and test NAT traversal
-
.SH SYNOPSIS
.B gnunet\-nat\-auto
.RI [ options ]
-.br
-
.SH DESCRIPTION
-
This tool allows testing various NAT traversal functions, as well
as attempting auto\-configuration.
-
.SH OPTIONS
.B
.IP "\-a, \-\-auto"
Attempt auto\-configuration for NAT traversal.
-
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
Use the configuration file FILENAME.
-
.B
.IP "\-S NAME, \-\-section=NAME"
Name of the configuration section with details about the configuration
to test. For example "transport-tcp".
-
.IP "\-t, \-\-tcp"
Use TCP.
-
.B
.IP "\-u, \-\-udp"
Use UDP.
-
.B
.IP "\-w, \-\-write"
Write configuration to configuration file, useful in combination with
autoconfiguration (\-a).
-
.SH EXAMPLES
.PP
-
\fBAutomatic configuration:\fR
-
-Probe and write result to configuration:
-
- # gnunet\-nat\-auto \-aw
-
-
+.TP
+# gnunet\-nat\-auto \-aw
+Probe and write result to configuration
+.PP
\fBTest configuration:\fR
-
-Test TCP configuration:
-
- # gnunet\-nat\-auto -t \-S transport-tcp
-
-Test HTTP configuration:
-
- # gnunet\-nat\-auto -t \-S transport-http
-
-Test UDP configuration:
-
- # gnunet\-nat\-auto -u \-S transport-udp
-
-
+.TP
+# gnunet\-nat\-auto -t \-S transport-tcp
+Test TCP configuration
+.TP
+# gnunet\-nat\-auto -t \-S transport-http
+Test HTTP configuration
+.TP
+# gnunet\-nat\-auto -u \-S transport-udp
+Test UDP configuration
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
gnunet\-transport(1) gnunet\-nat(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index a97768340..1fdf1e265 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -1,23 +1,18 @@
-.TH GNUNET\-NAT\-SERVER 1 "25 Feb 2012" "GNUnet"
-
+.TH GNUNET-NAT-SERVER 1 "February 25, 2012" "GNUnet"
.SH NAME
gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
-
.SH SYNOPSIS
.B gnunet\-nat\-server
.RI [ options ]
.RI PORT
-.br
-
.SH DESCRIPTION
-
Normal GNUnet end-users should not concern themselves with
gnunet\-nat\-server. In fact, distributions are encouraged to
consider not shipping it at all. Running gnunet\-nat\-server's is
similar to running hostlist servers: it is a special service to the
community with special requirements and no benefit to those running
the service.
-
+.PP
This program will listen on the specified PORT for incoming requests
to test a peer's network connectivity. Incoming requests can ask it
to connect to a given IPv4 address (and port) using TCP or UDP and to
@@ -25,41 +20,40 @@ send a 2-byte test message using the specified address. The program
can also be asked to send a "fake" ICMP response message to a given
IPv4 address (for autonomous NAT traversal \-\-\- see the description
in the respective research paper).
-
+.PP
The idea is that gnunet\-nat\-server will be run on some trusted hosts
with unrestricted connectivity to allow GNUnet users to test their
network configuration. As written, the code allows any user on the
Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary
data to any TCP or UDP port at any address. We believe that this is
generally harmless.
-
+.PP
When running gnunet\-nat\-server, make sure to use a configuration
that disables most NAT options but enables 'enable_nat_client' and
sets 'internal_address' to the global IP address of your local host.
Also, the gnunet\-helper\-nat\-client should be installed locally and
run with root privileges (SUID), otherwise the gnunet\-nat\-server
will not work properly.
-
+.PP
Note that gnunet\-nat\-server could be run via gnunet\-arm but
typically is not. Also, the name of the host and port that
gnunet\-nat\-server is run on should be specified in the NATSERVER
option in the [setup] section of the configuration file of hosts that
are supposed to autoconfigure with this server.
-
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
Use the configuration file FILENAME.
-
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
gnunet\-transport(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1
index 5c610b59f..03246d968 100644
--- a/doc/man/gnunet-peerinfo.1
+++ b/doc/man/gnunet-peerinfo.1
@@ -1,23 +1,18 @@
-.TH GNUNET\-PEERINFO 1 "Mar 4, 2013" "GNUnet"
-
+.TH GNUNET-PEERINFO 1 "March 4, 2013" "GNUnet"
.SH NAME
gnunet\-peerinfo \- Display information about other peers.
-
.SH SYNOPSIS
.B gnunet\-peerinfo
.RI [ options ]
-.br
-
.SH DESCRIPTION
.PP
\fBgnunet\-peerinfo\fP display the known addresses and trust of known peers.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
Load config file (default: ~/.config/gnunet.conf)
.B
-.IP "\-g, \-\-get\-hello
+.IP "\-g, \-\-get\-hello"
Output HELLO uri(s)
.B
.IP "\-h, \-\-help"
@@ -35,7 +30,7 @@ Log messages to LOGFILE
.IP "\-n, \-\-numeric"
Disable resolution of IPs to hostnames
.B
-.IP "\-p, \-\-put\-hello=HELLO
+.IP "\-p, \-\-put\-hello=HELLO"
Add given HELLO uri to the database
.B
.IP "\-q, \-\-quiet"
@@ -48,16 +43,16 @@ order to consider this peer one of their friends in F2F mode).
.B
.IP "\-v, \-\-version"
Print the version number
-
-
.SH BUGS
Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
gnunet.conf(5)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-resolver.1
index 743731fc4..56eef560d 100644
--- a/doc/man/gnunet-resolver.1
+++ b/doc/man/gnunet-resolver.1
@@ -1,16 +1,11 @@
-.TH GNUNET\-RESOLVER 1 "Jan 4, 2012" "GNUnet"
-
+.TH GNUNET-RESOLVER 1 "January 4, 2012" "GNUnet"
.SH NAME
gnunet\-resolver \- build-in GNUnet stub resolver
-
.SH SYNOPSIS
.B gnunet\-resolver
.RI [ options ] [ hostname ]
-.br
-
.SH DESCRIPTION
\fBgnunet\-resolver\fP uses build-in GNUnet stub resolver.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -31,13 +26,14 @@ Perform a reverse lookup.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
+electronic mail to <gnunet\-developers@gnu.org>
+.SH SEE ALSO
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1
index 548a03943..4ccb2a740 100644
--- a/doc/man/gnunet-scalarproduct.1
+++ b/doc/man/gnunet-scalarproduct.1
@@ -1,17 +1,13 @@
-.TH GNUNET\-VECTORPRODUCT 1 "8 Aug 2013" "GNUnet"
-
+.TH GNUNET-VECTORPRODUCT 1 "August 8, 2013" "GNUnet"
.SH NAME
gnunet\-vectorproduct \- compute a vectorproduct
-
.SH SYNOPSIS
.B gnunet\-vectorproduct
.RI [ options ]
-.br
-
.SH DESCRIPTION
\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct
across two peers \fBAlice\fP and \fBBob\fP.
-
+.PP
A client can issue one of two messages to its service:
.TS
tab (@);
@@ -23,17 +19,16 @@ T}
Elements to support a peer in computing a vectorproduct (\fBBob\fP)
T}
.TE
-
Both requests must share the same SID, which can be an arbitrary
string identifying the session. SIDs should be unique, however it is
sufficient to guarantee the uniqueness of the tupel element count and
session ID.
-
+.PP
\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s
service, it will internally be checked by the client for
validity. Invalid values here result in the client or the service
failing the session.
-
+.PP
Elements are handed over as signed decimal integers, the element count
supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also
supply a mask for these values to her service, which allows partial
@@ -42,11 +37,10 @@ masked by setting their the corresponding mask element to zero, any
other value means the element will not be masked. \fBAlice\fP\'s
client will also mask all 0-values to avoid information leakage to
\fBBob\fP.
-
+.PP
The protocol by definition relies on \fBAlice\fP and \fBBob\fP being
benign, thus \fBBob\fP can arbitrarily falsify his information. Both
peers collaborate to achieve a correct result.
-
.SH OPTIONS
.B
.IP "\-e ELEMENTS, \-\-elements=ELEMENTS"
@@ -78,16 +72,16 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-
-
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
+electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
gnunet\-peerinfo(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1
index a05888dcd..d156e17e8 100644
--- a/doc/man/gnunet-scrypt.1
+++ b/doc/man/gnunet-scrypt.1
@@ -1,17 +1,12 @@
-.TH GNUNET\-SCRYPT 1 "Sep 13, 2014" "GNUnet"
-
+.TH GNUNET-SCRYPT 1 "September 13, 2014" "GNUnet"
.SH NAME
gnunet\-scrypt \- Manipulate GNUnet proof of work files.
-
.SH SYNOPSIS
.B gnunet\-scrypt
.RI [ options ]
-.br
-
.SH DESCRIPTION
\fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof
of work files.
-
.SH OPTIONS
.B
.IP "\-b BITS, \-\-bits=BITS"
@@ -40,13 +35,14 @@ Time to wait between calculations.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
+electronic mail to <gnunet\-developers@gnu.org>
+.SH SEE ALSO
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1
index 6b3d06f59..e61a8493c 100644
--- a/doc/man/gnunet-statistics.1
+++ b/doc/man/gnunet-statistics.1
@@ -1,21 +1,16 @@
-.TH GNUNET\-STATISTICS 1 "Jan 4, 2012" "GNUnet"
-
+.TH GNUNET-STATISTICS 1 "January 4, 2012" "GNUnet"
.SH NAME
gnunet\-statistics \- Display statistics about your GNUnet system
-
.SH SYNOPSIS
.B gnunet\-statistics
.RI [ options ]
.RI [ VALUE ]
-.br
-
.SH DESCRIPTION
\fBgnunet\-statistics\fP is used to display detailed information about
various aspect of GNUnet's operation. This tool only works if the
"statistics" service is available.
gnunet\-statistics can be used to set a value by giving the options
\-n, \-s and also a VALUE.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -50,16 +45,16 @@ folder containing the data of all testbed nodes like \fBgnunet\-statistics -t /t
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-
-
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-
+Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending
+electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
gnunet\-service\-statistics(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-testing-run-service.1 b/doc/man/gnunet-testing-run-service.1
index ec7cdcdfa..60c40bf7f 100644
--- a/doc/man/gnunet-testing-run-service.1
+++ b/doc/man/gnunet-testing-run-service.1
@@ -1,26 +1,21 @@
-.TH GNUNET\-TESTING\-RUN\-SERVICE 1 "Aug 25, 2013" "GNUnet"
-
+.TH GNUNET-TESTING-RUN-SERVICE 1 "August 25, 2013" "GNUnet"
.SH NAME
gnunet\-testing\-run\-service \- Command line tool to start a service for testing.
-
.SH SYNOPSIS
.B gnunet\-testing\-run\-service
.RI [ options ]
-.br
-
.SH DESCRIPTION
\fBgnunet\-testing\-run\-service\fP is a command line tool to start a
service for testing. It starts a peer, running only the service
specified on the command line, outputs the path to the temporary
configuration file to stdout.
-
+.PP
The peer will run until this program is killed, or stdin is
closed. When reading the character 'r' from stdin, the running service
is restarted with the same configuration.
-
+.PP
This executable is intended to be used by gnunet-java, in order to
reliably start and stop services for test cases.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -31,13 +26,14 @@ Print short help on options.
.B
.IP "\-s SERVICE, \-\-service=SERVICE"
Name of the service to run.
-
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
+electronic mail to <gnunet\-developers@gnu.org>
+.SH SEE ALSO
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-timeout.1 b/doc/man/gnunet-timeout.1
index d23389523..8adb85571 100644
--- a/doc/man/gnunet-timeout.1
+++ b/doc/man/gnunet-timeout.1
@@ -1,26 +1,23 @@
-.TH GNUNET\-TIMOUET 1 "Jun 5, 2018" "GNUnet"
-
+.TH GNUNET-TIMOUET 1 "June 5, 2018" "GNUnet"
.SH NAME
gnunet\-timeout \- run process with timeout
-
.SH SYNOPSIS
.B gnunet\-timeout
.RI TIMEOUT PROGRAM ARGS
-.br
-
.SH DESCRIPTION
\fBgnunet\-timeout\fP can be used to run another process with a
timeout. Provided as the standard "timout" utility may not be
available on all platforms.
-
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-
-.SH SEE
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
+electronic mail to <gnunet\-developers@gnu.org>
+.SH SEE ALSO
timeout(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-transport-certificate-creation.1 b/doc/man/gnunet-transport-certificate-creation.1
index 894ed2de8..0e1e681f8 100644
--- a/doc/man/gnunet-transport-certificate-creation.1
+++ b/doc/man/gnunet-transport-certificate-creation.1
@@ -1,25 +1,22 @@
-.TH GNUNET\-TRANSPORT\-CERTIFICATE\-CREATION 1 "Jan 31, 2014" "GNUnet"
-
+.TH GNUNET\-TRANSPORT-CERTIFICATE-CREATION 1 "January 31, 2014" "GNUnet"
.SH NAME
gnunet\-transport\-certificate\-creation \- create certificate for HTTPS transport
-
.SH SYNOPSIS
.B gnunet\-transport\-certificate\-creation
.I privatekey certificate
-.br
-
.SH DESCRIPTION
\fBgnunet\-transport\-certificate\-creation\fP uses openssl to generate a RSA
private key and then a self-signed certificate for HTTPS transport.
-
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
+electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
gnunet\-transport(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-uri.1 b/doc/man/gnunet-uri.1
index bfb8fa0f8..72105c4c8 100644
--- a/doc/man/gnunet-uri.1
+++ b/doc/man/gnunet-uri.1
@@ -1,20 +1,15 @@
-.TH GNUNET\-URI 1 "Jun 26, 2012" "GNUnet"
-
+.TH GNUNET-URI 1 "June 26, 2012" "GNUnet"
.SH NAME
gnunet\-uri \- invoke default handler for GNUnet URIs
-
.SH SYNOPSIS
.B gnunet\-uri
.RI URI
-.br
-
.SH DESCRIPTION
\fBgnunet\-uri\fP can be used to invoke the correct tool to handle a
GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS"
and thus the specific tool to handle the URI depends on the subsystem.
gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM
in the configuration section "uri") and invoke it.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -28,14 +23,14 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-
-
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
+electronic mail to <gnunet\-developers@gnu.org>
+.SH SEE ALSO
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1
index 0b3f44fff..97d784136 100644
--- a/doc/man/gnunet-zoneimport.1
+++ b/doc/man/gnunet-zoneimport.1
@@ -1,12 +1,8 @@
-.TH GNUNET\-ZONEIMPORT 1 "Apr 23, 2018" "GNUnet"
-
+.TH GNUNET-ZONEIMPORT 1 "April 23, 2018" "GNUnet"
.SH NAME
gnunet\-zoneimport \- import DNS zone into GNS zone
-
.SH SYNOPSIS
.B gnunet\-zoneimport [IP]+
-.br
-
.SH DESCRIPTION
\fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from
stdin and issues DNS queries for each of the domain names given. It
@@ -17,29 +13,28 @@ will look for an ego called "com.fr"). If 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).
-
+.PP
The arguments given to gnunet\-zoneimport is a list of IP addresses of
DNS servers to query.
-
+.PP
gnunet\-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.
-
+.PP
gnunet\-zoneimport will issue many DNS queries in parallel, but is
rate-limited in various ways, so most DNS servers should easily handle
the load. gnunet\-zoneimport will perform a limited number of retries
if queries fail.
-
+.PP
gnunet\-zoneimport operates incrementally. It 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. Thus, it is
fine to restart gnunet\-zoneimport whenever the list of domain names
changes.
-
+.PP
Finally, gnunet\-zoneimport keeps information for each domain name in
memory. This consumes about 200 bytes per domain name, or 1 GB for 5
million labels.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -55,7 +50,6 @@ is less than RELATIVETIME into the future. RELATIVETIME is a time
given like "1 week" or "1 h". If 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). Default is zero.
-
.IP "\-s MAPSIZE, \-\-size=MAPSIZE"
Specifies the size (in number of entries) to use for the main hash
map. The value provided should be at least twice the number of domain
@@ -64,24 +58,20 @@ 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). Do not worry about this
unless you are importing millions of domain names from a zone.
-
.SH NOTES
-
+.TP
Typical invocaton would be:
-
$ gnunet\-zoneimport 1.2.3.4 < names.txt
-
-
-
-
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
gnunet\-gns(1), gnunet\-namestore(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5
index 3aee4ed71..3c88305ba 100644
--- a/doc/man/gnunet.conf.5
+++ b/doc/man/gnunet.conf.5
@@ -1,12 +1,10 @@
.\" -*- mode: nroff -*-
-.TH GNUNET.CONF "5" "26 October 2018" "GNUnet"
+.TH GNUNET.CONF "5" "October 26, 2018" "GNUnet"
.SH NAME
gnunet.conf \- GNUnet configuration file
.SH SYNOPSIS
~/.config/gnunet.conf
.SH DESCRIPTION
-.PP
-
A GNUnet setup typically consists of a set of service processes run by a user
"gnunet" and a set of user-interface processes run by a standard account.
The default location for the configuration file for the services is
@@ -17,8 +15,7 @@ gnunet\-setup (part of the GNUnet GTK package) can be used to edit this
configuration. The parts of GNUnet that are run as a normal user may have
config options too and they read from "$HOME/.config/gnunet.conf".
The latter config file can skip any options for the services.
-
-.TP
+.PP
The basic structure of the configuration file is the following. The file is
split into sections. Every section begins with "[SECTIONNAME]" and contains
a number of options of the form "OPTION=VALUE".
@@ -30,9 +27,7 @@ Default values for all of the options can be found in the files in the
"$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will
work out of the box with those. See the examples section below for
some common setups on top of that.
-
.SH General OPTIONS
-.PP
Many options will be common between sections. They can be repeated under
each section with different values. The "[PATHS]" section is special.
Here, it is possible to specify values for variables like "GNUNET_HOME".
@@ -46,11 +41,8 @@ place of the absolute definition of "/tmp".
So instead of "/tmp/foo" you would write "$GNUNET_TMP/foo".
The usage of "$GNUNET_TMP/foo", will result in "$TMPDIR/gnunet/foo", or
"$TMP/gnunet/foo" and finally, if "TMPDIR" is undefined, "/tmp/gnunet/foo".
-
.PP
-
The following options are generic and shared by all services:
-
.IP HOSTNAME
The hostname specifies the machine on which the service is running.
This is usually "localhost".
@@ -93,12 +85,7 @@ The following options are generic and shared by all services:
Set to YES if this service should be run per-user, NO if this is a system
service. End-users should never have to change the defaults GNUnet provides
for this option.
-
-
-
-.B
.SH ATS Options
-
.IP UNSPECIFIED_QUOTA_IN
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP UNSPECIFIED_QUOTA_OUT
@@ -119,9 +106,7 @@ The following options are generic and shared by all services:
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP WLAN_QUOTA_OUT
quotes in KiB or MiB per seconds. Or use the word "unlimited"
-
.SH EXAMPLES
-
This example is a simple way to get started, using a server that has a known
list of peers to get you started. Most users will be behind a firewall on
IPv4, as such NAT is enabled. Please rememeber to change your IP address
@@ -140,7 +125,6 @@ to the actual external address for your usage.
[arm]
START_SYSTEM_SERVICES = YES
START_USER_SERVICES = NO
-
.SH FILES
.TP
~/.config/gnunet.conf
@@ -150,9 +134,11 @@ Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <bug-gnunet@gnu.org>
.SH SEE ALSO
\fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1)
+.PP
The full documentation for
.B gnunet
-is maintained as a Texinfo manual. If the
+is maintained as a Texinfo manual.
+If the
.B info
and
.B gnunet
@@ -168,4 +154,4 @@ will give you access to a tutorial for developers.
.PP
Depending on your installation, this information is also
available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). \ No newline at end of file
+\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).