summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-10-26 16:08:14 +0000
committerNils Gillmann <ng0@n0.is>2018-10-26 16:08:14 +0000
commit4be442739c7f6745848a2f5544a59592f06a6cb3 (patch)
treef8ef204dd70d64d4fc8349551f584fb75323abd9 /doc
parent19fe19822004e33b89d2f71c154c28f8eff1c936 (diff)
Start fixing the man pages via linting and style.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-ats.117
-rw-r--r--doc/man/gnunet-auto-share.152
-rw-r--r--doc/man/gnunet-bcd.113
-rw-r--r--doc/man/gnunet-cadet.16
-rw-r--r--doc/man/gnunet-config.16
-rw-r--r--doc/man/gnunet-conversation-test.138
-rw-r--r--doc/man/gnunet-conversation.134
-rw-r--r--doc/man/gnunet-core.18
-rw-r--r--doc/man/gnunet-datastore.126
-rw-r--r--doc/man/gnunet-directory.110
-rw-r--r--doc/man/gnunet-dns2gns.13
-rw-r--r--doc/man/gnunet-download-manager.169
-rw-r--r--doc/man/gnunet-download.111
-rw-r--r--doc/man/gnunet-ecc.16
-rw-r--r--doc/man/gnunet-fs.137
-rw-r--r--doc/man/gnunet-gns-proxy.14
-rw-r--r--doc/man/gnunet-gns.139
-rw-r--r--doc/man/gnunet-identity.178
-rw-r--r--doc/man/gnunet-namecache.17
-rw-r--r--doc/man/gnunet-namestore-fcfsd.13
-rw-r--r--doc/man/gnunet-namestore.17
-rw-r--r--doc/man/gnunet-nat-auto.14
-rw-r--r--doc/man/gnunet-nat-server.14
-rw-r--r--doc/man/gnunet-nat.189
-rw-r--r--doc/man/gnunet-peerinfo.14
-rw-r--r--doc/man/gnunet-publish.1507
-rw-r--r--doc/man/gnunet-qr.112
-rw-r--r--doc/man/gnunet-revocation.12
-rw-r--r--doc/man/gnunet-search.18
-rw-r--r--doc/man/gnunet-testbed-profiler.17
-rw-r--r--doc/man/gnunet-testing.118
-rw-r--r--doc/man/gnunet-transport.19
-rw-r--r--doc/man/gnunet-unindex.13
-rw-r--r--doc/man/gnunet-vpn.170
-rw-r--r--doc/man/gnunet-zoneimport.14
-rw-r--r--doc/man/gnunet.conf.59
36 files changed, 596 insertions, 628 deletions
diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1
index 5f933d621..895c71942 100644
--- a/doc/man/gnunet-ats.1
+++ b/doc/man/gnunet-ats.1
@@ -1,18 +1,14 @@
-.TH GNUNET\-ATS 1 "Oct 16, 2015" "GNUnet"
-
+.TH GNUNET\-ATS 1 "October 16, 2015" "GNUnet"
.SH NAME
gnunet\-ats \- display information about transport resource allocation
-
.SH SYNOPSIS
.B gnunet\-ats
.RI [ options ]
.br
-
.SH DESCRIPTION
\fBgnunet\-ats\fP can be used to display information about the GNUnet's
transport selection mechanism. It shows information about the
addresses and the assigned input and output bandwidth.
-
.SH OPTIONS
.B
.IP "\-a, \-\-aa"
@@ -22,8 +18,10 @@ List all addresses currently known to ats.
Use the configuration file FILENAME.
.B
.IP "\-C, \-\-connect=PEERID"
-Ask ATS to suggest an address for PEERID to transport to establish a connection.
-Note that you can use the gnunet\-transport command\-line tool to force disconnects.
+Ask ATS to suggest an address for PEERID to transport to establish a
+connection.
+Note that you can use the gnunet\-transport command\-line tool to
+force disconnects.
.B
.IP "\-h, \-\-help"
Print short help on options.
@@ -35,7 +33,8 @@ Print information for a specific peer identity only
Value to set for when changing preference values
.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-m, \-\-monitor"
Monitor changes to the bandwidth assignments continuously
@@ -60,11 +59,9 @@ Print verbose output (include ATS address properties)
.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\-transport(1)
The full documentation for
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index 89c8bd6b3..3989b1351 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -1,11 +1,11 @@
-.TH GNUNET\-AUTO\-SHARE "1" "18 Jun 2012" "GNUnet"
+.TH GNUNET\-AUTO\-SHARE "1" "June 18, 2012" "GNUnet"
.SH NAME
-gnunet\-auto\-share \- a command line tool to automatically share an entire directory with other users
+gnunet\-auto\-share \- a command line tool to automatically share an
+entire directory with other users
.SH SYNOPSIS
.B gnunet\-auto\-share
[\fIOPTIONS\fR] DIRNAME
.SH DESCRIPTION
-.PP
In order to share files with other GNUnet users, the files must first be made
available to GNUnet. This tool can be used to automatically share all files
from a certain directory. The program will periodically scan the directory
@@ -17,35 +17,28 @@ has many options in common with gnunet\-publish, but can only be used to
index files.
.PP
You can use automatic meta\-data extraction (based on libextractor).
-.PP
-
+.TP
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
Use alternate config file (if this option is not specified, the
default is ~/.config/gnunet.conf).
-
.TP
\fB\-D\fR, \fB\-\-disable\-extractor\fR
Disable use of GNU libextractor for finding additional keywords and metadata.
-
.TP
\fB\-h\fR, \fB\-\-help\fR
Print a brief help page with all the options.
-
.TP
\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
Change the loglevel. Possible values for LOGLEVEL are
ERROR, WARNING, INFO and DEBUG.
-
.TP
\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR
Executive summary: You probably don't need it.
-
Set the priority of the published content (default: 365). If the local
database is full, GNUnet will discard the content with the lowest ranking.
Note that ranks change over time depending on popularity. The default
should be high enough to preserve the locally published content in favor
of content that migrates from other peers.
-
.TP
\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet
@@ -54,20 +47,15 @@ normal "random" replication of all content. This option can be used to push
some content out into the network harder. Note that pushing content LEVEL
times into the network does not guarantee that there will actually be LEVEL
replicas.
-
.TP
\fB\-v\fR, \fB\-\-version\fR
Print the version number.
-
.TP
\fB\-V\fR, \fB\-\-verbose\fR
Be verbose. Using this option causes gnunet\-publish to print progress
information and at the end the file identification that can be used to download
the file from GNUnet.
-
-
.SH SETTING ANONYMITY LEVEL
-
The \fB\-a\fR option can be used to specify additional anonymity constraints.
If set to 0, GNUnet will publish the file non-anonymously and in fact sign
the advertisement for the file using your peer's private key. This will
@@ -81,7 +69,7 @@ anonymity, which increases the amount of cover traffic your own traffic will
get, at the expense of performance. Note that regardless of the anonymity
level you choose, peers that cache content in the network always use anonymity
level 1.
-
+.PP
The definition of the ANONYMITY LEVEL 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' bytes of cover traffic per
@@ -89,38 +77,34 @@ byte on the wire. Thus, if GNUnet routes n bytes of messages from foreign
peers (using anonymous routing), it may originate n/(v-1) bytes of data 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 EXAMPLES
-.PP
-
\fBBasic example\fR
-
-Share a directory "$HOME/gnunet\-share/":
-
- # gnunet\-auto\-share $HOME/gnunet\-share/ &
-
-
+.TP
+# gnunet\-auto\-share $HOME/gnunet\-share/ &
+Share a directory "$HOME/gnunet\-share/"
+.PP
\fBBasic configuration\fR
-
+.PP
Share a directory "$HOME/gnunet\-share/":
[gnunet-auto-share]
OPTIONS = $HOME/gnunet\-share
IMMEDIATE_START = YES # start this service when the peer starts
-
.SH FILES
.TP
~/.config/gnunet.conf
GNUnet configuration file
-.SH "REPORTING BUGS"
-Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
-\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1)
+.SH BUGS
+Report bugs to <https://gnunet.org/bugs/> or by sending electronic
+mail to <gnunet\-developers@gnu.org>
+.SH SEE ALSO
+\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
+\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1),
+\fBgnunet.conf\fP(5), \fBextract\fP(1)
The full documentation for
.B gnunet
is maintained as a Texinfo manual. If the
diff --git a/doc/man/gnunet-bcd.1 b/doc/man/gnunet-bcd.1
index 4a9fe08f6..f10e6f891 100644
--- a/doc/man/gnunet-bcd.1
+++ b/doc/man/gnunet-bcd.1
@@ -1,13 +1,10 @@
-.TH GNUNET\-BCD 1 "Dec 5, 2013" "GNUnet"
-
+.TH GNUNET\-BCD 1 "December 5, 2013" "GNUnet"
.SH NAME
gnunet\-bcd \- run HTTP server to create GNS business cards
-
.SH SYNOPSIS
.B gnunet\-bcd
.RI [ options ]
.br
-
.SH DESCRIPTION
\fBgnunet\-bcd\fP can be used to create an business card with a QR code
containing the public key of a zone from the GNU Name System.
@@ -15,7 +12,6 @@ gnunet\-bcd requires LaTeX (pdflatex) with various packages to be
installed. If it does not work for you, try installing the full
TeXLive distribution first, for example using the package\-manager
apt: "apt-get install texlive-full".
-
.SH OPTIONS
.B
.IP "\-p PORT, \-\-port=PORT"
@@ -32,11 +28,10 @@ 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
diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1
index 9414c14eb..3551a335d 100644
--- a/doc/man/gnunet-cadet.1
+++ b/doc/man/gnunet-cadet.1
@@ -64,9 +64,9 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
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
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1
index d0fc50ecd..43e7a011b 100644
--- a/doc/man/gnunet-config.1
+++ b/doc/man/gnunet-config.1
@@ -49,9 +49,9 @@ 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
diff --git a/doc/man/gnunet-conversation-test.1 b/doc/man/gnunet-conversation-test.1
index 6ceca61e2..046091752 100644
--- a/doc/man/gnunet-conversation-test.1
+++ b/doc/man/gnunet-conversation-test.1
@@ -1,23 +1,21 @@
-.TH GNUNET\-CONVERSATION\-TEST 1 "Oct 30, 2013" "GNUnet"
-
+.TH GNUNET\-CONVERSATION\-TEST 1 "October 30, 2013" "GNUnet"
.SH NAME
gnunet\-conversation\-test \- check your speaker and microphone settings
-
.SH SYNOPSIS
.B gnunet\-conversation\-test [OPTIONS]
.RI URI
.br
-
.SH DESCRIPTION
-\fBgnunet\-conversation\-test\fP can be used to check your speaker and microphone
-settings. It will record you for five seconds and then play the recording back
-to you. If this fails, you might want to use the \fBpavucontrol\fP tool to
-check which microphone or speaker were assigned to GNUnet by PulseAudio (you
-may have more than one set of microphones or speakers known to your computer).
-
-You can use gnunet\-conversation\-test without having a peer running on your
-computer.
-
+\fBgnunet\-conversation\-test\fP can be used to check your speaker and
+microphone settings.
+It will record you for five seconds and then play the recording back
+to you.
+If this fails, you might want to use the \fBpavucontrol\fP tool to
+check which microphone or speaker were assigned to GNUnet by
+PulseAudio (you may have more than one set of microphones or speakers
+known to your computer).
+You can use gnunet\-conversation\-test without having a peer running
+on your computer.
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -27,20 +25,20 @@ Use the configuration file FILENAME.
Print short help on options.
.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
+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
\fBgnunet\-conversation\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-conversation.1 b/doc/man/gnunet-conversation.1
index 2440c48a7..fb0596e19 100644
--- a/doc/man/gnunet-conversation.1
+++ b/doc/man/gnunet-conversation.1
@@ -1,20 +1,19 @@
-.TH GNUNET\-CONVERSATION 1 "Oct 5, 2013" "GNUnet"
-
+.TH GNUNET\-CONVERSATION 1 "October 5, 2013" "GNUnet"
.SH NAME
gnunet\-conversation \- have a conversation with your peers
-
.SH SYNOPSIS
.B gnunet\-conversation \-e NAME [OPTIONS]
.RI URI
.br
-
.SH DESCRIPTION
-\fBgnunet\-conversation\fP can be used to have a conversation with other GNUnet
-users. You can make calls and receive incoming calls. You need to setup an
-ego using gnunet\-identity first. For others to be able to call you, you must
-add a PHONE record to your zone in the GNU Name System (using gnunet\-namestore).
-gnunet\-conversation has an interactive help system via the /help command.
-
+\fBgnunet\-conversation\fP can be used to have a conversation with
+other GNUnet users.
+You can make calls and receive incoming calls.
+You need to setup an ego using gnunet\-identity first.
+For others to be able to call you, you must add a PHONE record to
+your zone in the GNU Name System (using gnunet\-namestore).
+gnunet\-conversation has an interactive help system via the /help
+command.
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -27,21 +26,20 @@ Specifies the NAME of the ego to use (for caller ID).
Print short help on options.
.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-p LINE, \-\-phone=LINE"
Optional argument that can be used to specify the phone LINE to be used with
-the conversation service. The default LINE is zero, which should be fine
-for most users.
+the conversation service.
+The default LINE is zero, which should be fine for most users.
.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
\fBgnunet\-identity\fP(1), \fBgnunet\-namestore\fP(1), \fBgnunet\-gns\fP(1)
The full documentation for
.B gnunet
diff --git a/doc/man/gnunet-core.1 b/doc/man/gnunet-core.1
index 382d1b152..12d936f7a 100644
--- a/doc/man/gnunet-core.1
+++ b/doc/man/gnunet-core.1
@@ -35,10 +35,10 @@ be verbose
.SH NOTES
-.SH "REPORTING BUGS"
-Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-
-.SH "SEE ALSO"
+.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)
The full documentation for
.B gnunet
diff --git a/doc/man/gnunet-datastore.1 b/doc/man/gnunet-datastore.1
index f97363e64..535aedbf5 100644
--- a/doc/man/gnunet-datastore.1
+++ b/doc/man/gnunet-datastore.1
@@ -1,18 +1,17 @@
-.TH gnunet\-datastore "1" "13 April 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, i.e.
-from sqlite to postgres or vice versa. gnunet\-datastore will dump the
-entire contents of the database or insert a dump file into the database.
-
+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,
+i.e. from sqlite to postgres or vice versa.
+gnunet\-datastore will dump the entire contents of the database or
+insert a dump file into the database.
.TP
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
configuration file to use
@@ -37,14 +36,15 @@ configure logging to write logs to FILENAME
.TP
\fB\-v\fR, \fB\-\-version\fR
print the version number
-
-.SH "REPORTING BUGS"
-Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
+.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\-publish\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-directory.1 b/doc/man/gnunet-directory.1
index 7bed13f4d..a8aa515e4 100644
--- a/doc/man/gnunet-directory.1
+++ b/doc/man/gnunet-directory.1
@@ -56,10 +56,12 @@ search results. The directory file can be downloaded to disk
by \fBgnunet\-download\fP(1) for later processing or be handled more directly
by \fBgnunet\-fs\-gtk\fP(1).
-.SH "REPORTING BUGS"
-Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
-\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1)
+.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\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
+\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1)
The full documentation for
.B gnunet
is maintained as a Texinfo manual. If the
diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1
index 8a3c83218..6ecad3c42 100644
--- a/doc/man/gnunet-dns2gns.1
+++ b/doc/man/gnunet-dns2gns.1
@@ -35,7 +35,8 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
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>
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
+electronic mail to <bug\-gnunet@gnu.org>
.SH SEE ALSO
gnunet\-gns\-fcfs(1), gnunet\-gns(1), gnunet\-identity(1)
The full documentation for
diff --git a/doc/man/gnunet-download-manager.1 b/doc/man/gnunet-download-manager.1
index 797afa8c0..7cc6dbffb 100644
--- a/doc/man/gnunet-download-manager.1
+++ b/doc/man/gnunet-download-manager.1
@@ -1,36 +1,64 @@
-.TH GNUNET-DOWNLOAD-MANAGER 1 "15 Jan, 2011" "GNUnet"
-
+.TH GNUNET-DOWNLOAD-MANAGER 1 "October 26, 2018" "GNUnet"
.SH NAME
gnunet-download-manager \- manage downloads across sessions
-
.SH SYNOPSIS
.B gnunet\-download\-manager
.RI [ options ]
.br
-
.SH DESCRIPTION
\fBgnunet\-download\-manager\fP is a script that can be used to track
-download sessions. It makes the process of resuming downloads after a
-system reboot easier. A typical use is to define an alias (depending
-on your shell) of the form
-
+download sessions.
+It makes the process of resuming downloads after a system reboot
+easier.
+A typical use is to define an alias (depending on your shell) of the
+form:
+.TP
$ alias gnunet\-download='gnunet\-download\-manager.scm download'
-
-Other commands for the download manager include resume (resumes all
-downloads), status (show status of pending downloads), killall (abort
-all downloads), settings (for configuration) and help (print help text).
-
-gnunet\-download\-manager is a scheme script and will only work if Guile
-is available.
-
+.PP
+The options for the download manager include:
+.TP
+.B download
+download
+.TP
+.B resume
+resumes all downloads
+.TP
+.B status
+show status of pending downloads
+.TP
+.B killall
+abort all downloads
+.TP
+.B settings
+for configuration
+.TP
+.B help
+print help text
+.PP
+gnunet\-download\-manager is a Scheme script and will only work if GNU
+Guile is available.
+.SH EXAMPLES
+(add-hook! *completed-download-hook* completed-download-notification-hook)
+.TP
+Add this to the configuration file to be notified of completed
+downloads.
+.SH FILES
+.TP
+~/.gnunet-download-manager.scm
+Configuration file.
.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>.
+.PP
+Furthermore it is assumed that gnunet-download-manager is no longer
+working correctly with Guile 2.2 series or current GNUnet, bugfixes
+are welcome.
.SH SEE ALSO
gnunet\-download(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
@@ -47,3 +75,6 @@ will give you access to a tutorial for developers.
Depending on your installation, this information is also
available in
\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.SH HISTORY
+.SH AUTHORS
+gnunet\-download\-manager was contributed by Ludovic Courtes in 2004.
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index d787a7aba..aa1328c00 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -147,10 +147,13 @@ do the same.
.TP
~/.config/gnunet.conf
GNUnet configuration file
-.SH "REPORTING BUGS"
-Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
-\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5), \fBgnunet\-service\-fs\fP(1)
+.SH BUGS
+Report bugs to <https://gnunet.org/bugs/> or by sending electronic
+mail to <gnunet\-developers@gnu.org>
+.SH SEE ALSO
+\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
+\fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5),
+\fBgnunet\-service\-fs\fP(1)
The full documentation for
.B gnunet
is maintained as a Texinfo manual. If the
diff --git a/doc/man/gnunet-ecc.1 b/doc/man/gnunet-ecc.1
index f0de83865..e3db11eab 100644
--- a/doc/man/gnunet-ecc.1
+++ b/doc/man/gnunet-ecc.1
@@ -1,4 +1,4 @@
-.TH GNUNET\-ECC 1 "Jun 5, 2017" "GNUnet"
+.TH GNUNET\-ECC 1 "June 5, 2017" "GNUnet"
.SH NAME
gnunet\-ecc \- manipulate GNUnet ECC key files
@@ -49,7 +49,9 @@ 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
The full documentation for
.B gnunet
is maintained as a Texinfo manual. If the
diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1
index e3837cb9d..8a9f0838c 100644
--- a/doc/man/gnunet-fs.1
+++ b/doc/man/gnunet-fs.1
@@ -1,19 +1,17 @@
-.TH gnunet\-fs "1" "2 Nov 2011" "GNUnet"
+.TH GNUNET\-FS "1" "November 2, 2011" "GNUnet"
.SH NAME
gnunet\-fs \- measure and control the fs subsystem
-
.SH SYNOPSIS
.B gnunet\-fs
[\fIOPTIONS\fR]
.SH DESCRIPTION
.PP
-
gnunet\-fs is a tool to access various functions of GNUnet's fs
-subsystem from the command\-line. Most of these are not expected to
-be useful for end-users. gnunet\-fs can currently only be used to
-obtain a list of indexed files. Other functions should be added in
-the near future.
-
+subsystem from the command\-line.
+Most of these are not expected to be useful for end-users.
+gnunet\-fs can currently only be used to obtain a list of indexed
+files.
+Other functions should be added in the near future.
.TP
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
configuration file to use
@@ -21,21 +19,22 @@ configuration file to use
\fB\-h\fR, \fB\-\-help\fR
print help page
.TP
-\fB\-i\fR, \fB\-\-list-indexed\fR print information about files that
-are currently indexed by file-sharing
+\fB\-i\fR, \fB\-\-list-indexed\fR
+print information about files that are currently indexed by
+file-sharing
.TP
-\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR Change the
-loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and
-DEBUG.
+\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
+Change the loglevel.
+Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
.TP
-\fB\-v\fR, \fB\-\-version\fR print the version number
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
.TP
-\fB\-V\fR, \fB\-\-verbose\fR be verbose
-
-
+\fB\-V\fR, \fB\-\-verbose\fR
+be verbose
.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
\fBgnunet\-publish\fP(1)
The full documentation for
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1
index 3a6cc004f..ccb0f7206 100644
--- a/doc/man/gnunet-gns-proxy.1
+++ b/doc/man/gnunet-gns-proxy.1
@@ -45,8 +45,8 @@ 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>
-
+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)
The full documentation for
diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1
index f19c4fc4d..9f7a651a7 100644
--- a/doc/man/gnunet-gns.1
+++ b/doc/man/gnunet-gns.1
@@ -1,58 +1,51 @@
-.TH GNUNET\-GNS 1 "Mar 23, 2018" "GNUnet"
-
+.TH GNUNET\-GNS 1 "March 23, 2018" "GNUnet"
.SH NAME
gnunet\-gns \- Access to GNU Name System
-
.SH SYNOPSIS
.B gnunet\-gns
.RI [ options ]
-.br
-
.SH DESCRIPTION
\fBgnunet\-gns\fP can be used to lookup and process GNU Name Service
names.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
Use the configuration file FILENAME.
.B
.IP "\-r, \-\-raw"
-No unneeded output. This is a quiet mode where only important
-information is displayed. For example a lookup for an IP address will
-only yield the IP address, no descriptive text.
+No unneeded output.
+This is a quiet mode where only important information is displayed.
+For example a lookup for an IP address will only yield the IP address,
+no descriptive text.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and
-ERROR.
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-u NAME, \-\-lookup=NAME"
-Name to lookup. Resolve the specified name using the GNU Name System.
+Name to lookup.
+Resolve the specified name using the GNU Name System.
.B
.IP "\-t TYPE, \-\-type=TYPE"
-Resource Record Type (TYPE) to look for. Supported TYPE's are: A,
-AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, MX, LEHO, VPN, REV, PTR,
-TXT
-
+Resource Record Type (TYPE) to look for.
+Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA,
+MX, LEHO, VPN, REV, PTR, TXT.
Defaults to "A".
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-.B
-
.SH RETURN VALUE
-
gnunet\-gns will return 0 on success, 1 on internal failures, 2 on
launch failures, 4 if the given name is not configured to use GNS.
-
-
.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
\fBgnunet\-namestore\fP(1), \fBgnunet\-identity\fP(1)
+.PP
The full documentation for
.B gnunet
is maintained as a Texinfo manual. If the
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1
index d20c3a0fa..8d009d07b 100644
--- a/doc/man/gnunet-identity.1
+++ b/doc/man/gnunet-identity.1
@@ -1,4 +1,4 @@
-.TH GNUNET-IDENTITY "1" "5 Sep 2013" "GNUnet"
+.TH GNUNET-IDENTITY "1" "September 5, 2013" "GNUnet"
.SH NAME
gnunet\-identity \- create, delete or list egos
.SH SYNOPSIS
@@ -6,64 +6,62 @@ gnunet\-identity \- create, delete or list egos
[options]
.SH DESCRIPTION
.PP
-gnunet\-identity is a tool for managing egos. An ego is the persona
-that controls a namespace. It is identical to a public\-private ECC
-key pair.
-
+gnunet\-identity is a tool for managing egos.
+An ego is the persona that controls a namespace.
+It is identical to a public\-private ECC key pair.
+.PP
gnunet\-identity can be used to list all of the egos that were created
locally, to create new egos, and to delete existing egos (the
namespace will continue to exist, but it will be impossible to add
additional data to it).
-
+.PP
Creating a new ego requires using the \-C option together with an
-identifier (name) that is to be used for the new ego. This identifier
-is only used locally for this peer and not shared with other peers.
-
+identifier (name) that is to be used for the new ego.
+This identifier is only used locally for this peer and not shared with
+other peers.
.TP
-\fB\-C NAME\fR, \fB\-\-create=NAME\fR Creates a new ego with the given
-NAME.
-
+\fB\-C NAME\fR, \fB\-\-create=NAME\fR
+Creates a new ego with the given NAME.
.TP
-\fB\-D NAME\fR, \fB\-\-delete=NAME\fR Delete the ego with the given
-NAME.
-
+\fB\-D NAME\fR, \fB\-\-delete=NAME\fR
+Delete the ego with the given NAME.
.TP
-\fB\-e NAME\fR, \fB\-\-ego=NAME\fR Perform "set" operation with the
-respective ego. Needs to be used together with option \-s.
-
+\fB\-e NAME\fR, \fB\-\-ego=NAME\fR
+Perform "set" operation with the respective ego.
+Needs to be used together with option \-s.
.TP
-\fB\-h\fR, \fB\-\-help\fR Print help page.
-
+\fB\-h\fR, \fB\-\-help\fR
+Print help page.
.TP
-\fB\-d\fR, \fB\-\-display\fR display all of our egos
-
+\fB\-d\fR, \fB\-\-display\fR
+display all of our egos
.TP
-\fB\-m\fR, \fB\-\-monitor\fR run in monitor mode, listing all ouf our
-egos until CTRL-C is pressed. Each ego is listed together with a
-unique pointer value; if egos are renamed, that pointer value remains
-the same; if egos are deleted, they are listed one more time with a
-name of "<null>".
-
+\fB\-m\fR, \fB\-\-monitor\fR
+Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
+Each ego is listed together with a unique pointer value; if egos are
+renamed, that pointer value remains the same; if egos are deleted,
+they are listed one more time with a name of "<null>".
.TP
-\fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR Perform "set" operation
-for the specified SUBSYSTEM with the respective ego. Needs to be used
-together with option \-e. After this, the given SUBSYSTEM will use
-the ego with the specified NAME. This will fail if NAME does not yet
-exist.
-
-
+\fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR
+Perform "set" operation for the specified SUBSYSTEM with the
+respective ego.
+Needs to be used together with option \-e.
+After this, the given SUBSYSTEM will use the ego with the specified
+NAME.
+This will fail if NAME does not yet exist.
.SH FILES
.TP
~/.local/share/gnunet/identity/egos
Directory where the egos are stored (by default)
-
-.SH "REPORTING BUGS"
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
+.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\-gns\fP(1), \fBgnunet\-namestore\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-namecache.1 b/doc/man/gnunet-namecache.1
index 8b610d119..528656218 100644
--- a/doc/man/gnunet-namecache.1
+++ b/doc/man/gnunet-namecache.1
@@ -1,4 +1,4 @@
-.TH GNUNET\-NAMECACHE 1 "Oct 16, 2013" "GNUnet"
+.TH GNUNET\-NAMECACHE 1 "October 16, 2013" "GNUnet"
.SH NAME
gnunet\-namecache \- inspect namecache
@@ -35,8 +35,9 @@ Specifies the public key of the zone to inspect (mandatory option)
.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
\fBgnunet\-gns\fP(1)
The full documentation for
.B gnunet
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1
index 2c2960d86..fc0f40eef 100644
--- a/doc/man/gnunet-namestore-fcfsd.1
+++ b/doc/man/gnunet-namestore-fcfsd.1
@@ -50,7 +50,8 @@ Print GNUnet version number.
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>
+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)
The full documentation for
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index 7b06b7fce..10577a0d9 100644
--- a/doc/man/gnunet-namestore.1
+++ b/doc/man/gnunet-namestore.1
@@ -1,4 +1,4 @@
-.TH GNUNET\-NAMESTORE 1 "Apr 15, 2014" "GNUnet"
+.TH GNUNET\-NAMESTORE 1 "April 15, 2014" "GNUnet"
.SH NAME
gnunet\-namestore \- manipulate GNU Name System (GNS) zone data
@@ -89,8 +89,9 @@ Specifies the name of the ego controlling the private key for the zone
.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
\fBgnunet\-gns\fP(1), \fBgnunet\-namestore\-gtk\fP(1)
The full documentation for
.B gnunet
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1
index 17de488ce..ca50d76fc 100644
--- a/doc/man/gnunet-nat-auto.1
+++ b/doc/man/gnunet-nat-auto.1
@@ -65,8 +65,8 @@ Test UDP configuration:
.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) gnunet\-nat(1)
The full documentation for
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index 68cbefe5d..a97768340 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -53,8 +53,8 @@ are supposed to autoconfigure with this server.
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>
-
+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)
The full documentation for
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1
index a7f8526b4..cf48e1dc6 100644
--- a/doc/man/gnunet-nat.1
+++ b/doc/man/gnunet-nat.1
@@ -1,118 +1,91 @@
-.TH GNUNET\-NAT 1 "27 Nov 2016" "GNUnet"
-
+.TH GNUNET\-NAT 1 "October 26, 2018" "GNUnet"
.SH NAME
gnunet\-nat \- interact with the NAT service
-
.SH SYNOPSIS
.B gnunet\-nat
.RI [ options ]
-.br
-
.SH DESCRIPTION
-
-This tool allows testing various NAT traversal functions, as well
-as attempting auto\-configuration.
-
+This tool allows testing various NAT traversal functions, as well as
+attempting auto\-configuration.
.SH OPTIONS
-
.B
.IP "\-b ADDRESS, \-\-bind=ADDRESS"
Assume that the service is (locally) bound to ADDRESS.
-
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
Use the configuration file FILENAME.
-
.B
.IP "\-e ADDRESS, \-\-external=ADDRESS"
Assume that ADDRESS is the globally visible address of the peer.
-
.B
.IP "\-i ADDRESS, \-\-in=ADDRESS"
Assuming we are listening at ADDRESS for connection reversal requests.
-
.B
.IP "\-r ADDRESS, \-\-remote=ADDRESS"
Ask the peer at ADDRESS for connection reversal, using the local
address for the target address of the reversal.
-
.B
.IP "\-S NAME, \-\-section=NAME"
Name of section in configuration file to use for additional options.
-
.B
.IP "\-s, \-\-stun"
-Enable processing of STUN requests. Will try to read UDP packets from
-the bind address and handle the packets if they are STUN packets. Will
-only work with UDP.
-
+Enable processing of STUN requests.
+Will try to read UDP packets from the bind address and handle the
+packets if they are STUN packets.
+Will only work with UDP.
.B
.IP "\-t, \-\-tcp"
Use TCP.
-
.B
.IP "\-u, \-\-udp"
Use UDP.
-
.B
.IP "\-W, \-\-watch"
Watch for connection reversal requests.
-
.SH EXAMPLES
.PP
-
\fBBasic examples\fR
-
+.TP
+# gnunet-nat -i 0.0.0.0:8080 -u
We are bound to "0.0.0.0:8080" on UDP and want to obtain all
-applicable IP addresses:
-
- # gnunet-nat -i 0.0.0.0:8080 -u
-
+applicable IP addresses.
+.TP
+# gnunet-nat -i '[::0]':8080 -t
We are bound to "::0" on port 8080 on TCP and want to obtain all
-applicable IP addresses:
-
- # gnunet-nat -i '[::0]':8080 -t
-
+applicable IP addresses.
+.TP
+# gnunet-nat -i 127.0.0.1:8080 -u
We are bound to "127.0.0.1:8080" on UDP and want to obtain all
applicable IP addresses:
-
- # gnunet-nat -i 127.0.0.1:8080 -u
-
+.PP
\fBICMP-based NAT traversal:\fR
-
+.TP
+# gnunet-nat -Wt -i 192.168.178.12:8080
Watch for connection reversal request (you must be bound to NAT range
or to wildcard, 0.0.0.0), only works for IPv4:
-
- # gnunet-nat -Wt -i 192.168.178.12:8080
-
+.TP
+# gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080
Initiate connection reversal request from peer at external IPv4
address 1.2.3.4, while we are running ourselves at 2.3.4.5:8080 (must
use IPv4 addresses):
-
- # gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080
-
+.TP
+# gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080
Initiate connection reversal request from peer at external IPv4
address 1.2.3.4, and let the kernel fill in whatever IPv4 address we
happen to have:
-
- # gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080
-
+.PP
\fBManual hole punching:\fR
-
+.TP
+# gnunet-nat -t -p AUTO:8080
Assume manually punched NAT, but determine external IP automatically:
-
- # gnunet-nat -t -p AUTO:8080
-
+.PP
\fBSTUN-based XXX:\fR
-
-XXX:
-
- # gnunet-nat FIXME -s
-
-
+.TP
+# gnunet-nat FIXME -s
+XXX
.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)
The full documentation for
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1
index a0226f25b..5c610b59f 100644
--- a/doc/man/gnunet-peerinfo.1
+++ b/doc/man/gnunet-peerinfo.1
@@ -51,8 +51,8 @@ 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>
-
+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)
The full documentation for
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index 8811ad6e2..5bc2eec76 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -1,4 +1,4 @@
-.TH GNUNET-PUBLISH "1" "16 Nov 2015" "GNUnet"
+.TH GNUNET-PUBLISH "1" "November 16, 2015" "GNUnet"
.SH NAME
gnunet\-publish \- a command line interface for publishing new content into GNUnet
.SH SYNOPSIS
@@ -7,321 +7,328 @@ gnunet\-publish \- a command line interface for publishing new content into GNUn
.SH DESCRIPTION
.PP
In order to share files with other GNUnet users, the files must first
-be made available to GNUnet. GNUnet does not automatically share all
-files from a certain directory (however, you can do this with the
-gnunet\-auto\-share tool). In fact, even files that are downloaded
-are not automatically shared.
+be made available to GNUnet.
+GNUnet does not automatically share all files from a certain directory
+(however, you can do this with the gnunet\-auto\-share tool).
+In fact, even files that are downloaded are not automatically shared.
.PP
In order to start sharing files, the files must be added either using
-gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk. The
-command line tool gnunet\-publish is more useful if many files are
-supposed to be added. gnunet\-publish can automatically publish
-batches of files, recursively publish directories, create directories
-that can be browsed within GNUnet and publish file lists in a
-namespace. When run on a directory, gnunet\-publish will always
-recursively publish all of the files in the directory.
+gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk.
+The command line tool gnunet\-publish is more useful if many files are
+supposed to be added.
+gnunet\-publish can automatically publish batches of files,
+recursively publish directories, create directories that can be
+browsed within GNUnet and publish file lists in a namespace.
+When run on a directory, gnunet\-publish will always recursively
+publish all of the files in the directory.
.PP
gnunet\-publish can automatically extract keywords from the files that
-are shared. Users that want to download files from GNUnet use
-keywords to search for the appropriate content. You can disable
-keyword extraction with the \-D option. You can manually add keywords
-using the \-k option. The keywords are case\-sensitive.
+are shared.
+Users that want to download files from GNUnet use keywords to search
+for the appropriate content.
+You can disable keyword extraction with the \-D option.
+You can manually add keywords using the \-k option.
+The keywords are case\-sensitive.
.PP
In addition to searching for files by keyword, GNUnet allows
-organizing files into directories. With directories, the user only
-needs to find the directory in order to be able to download any of the
-files listed in the directory. Directories can contain pointers to
-other directories.
+organizing files into directories.
+With directories, the user only needs to find the directory in order
+to be able to download any of the files listed in the directory.
+Directories can contain pointers to other directories.
.PP
With gnunet\-publish, it is easy to create new directories
-simultaneously when adding the files. Simply pass the name of a
-directory instead of a file.
+simultaneously when adding the files.
+Simply pass the name of a directory instead of a file.
.PP
Since keywords can be spammed (any user can add any content under any
-keyword), GNUnet supports namespaces. A namespace is a subset of the
-searchspace into which only the holder of a certain pseudonym can add
-content. Any GNUnet user can create any number of pseudonyms using
-\fBgnunet\-pseudonym\fR. Pseudonyms are stored in the user's GNUnet
-directory. While pseudonyms are locally identified with an arbitrary
-string that the user selects when the pseudonym is created, the
-namespace is globally known only under the hash of the public key of
-the pseudonym. Since only the owner of the pseudonym can add content
-to the namespace, it is impossible for other users to pollute the
-namespace. gnunet\-publish automatically publishes the top\-directory
-(or the only file if only one file is specified) into the namespace if
-a pseudonym is specified.
+keyword), GNUnet supports namespaces.
+A namespace is a subset of the searchspace into which only the holder
+of a certain pseudonym can add content.
+Any GNUnet user can create any number of pseudonyms using
+\fBgnunet\-pseudonym\fR. Pseudonyms are stored in the user's GNUnet
+directory.
+While pseudonyms are locally identified with an arbitrary string that
+the user selects when the pseudonym is created, the namespace is
+globally known only under the hash of the public key of the pseudonym.
+Since only the owner of the pseudonym can add content to the
+namespace, it is impossible for other users to pollute the namespace.
+gnunet\-publish automatically publishes the top\-directory (or the
+only file if only one file is specified) into the namespace if a
+pseudonym is specified.
.PP
It is possible to update content in GNUnet if that content was placed
-and obtained from a particular namespace. Updates are only possible
-for content in namespaces since this is the only way to assure that a
-malicious party can not supply counterfeited updates. Note that an
-update with GNUnet does not make the old content unavailable, GNUnet
-merely allows the publisher to point users to more recent
-versions. You can use the \-N option to specify the future identifier
-of an update. When using this option, a GNUnet client that finds the
-current (\-t) identifier will automatically begin a search for the
-update (\-N) identifier. If you later publish an update under the
-(\-N) identifier, both results will be given to the user.
+and obtained from a particular namespace.
+Updates are only possible for content in namespaces since this is the
+only way to assure that a malicious party can not supply counterfeited
+updates.
+Note that an update with GNUnet does not make the old content
+unavailable, GNUnet merely allows the publisher to point users to more
+recent versions.
+You can use the \-N option to specify the future identifier of an
+update.
+When using this option, a GNUnet client that finds the current (\-t)
+identifier will automatically begin a search for the update (\-N)
+identifier.
+If you later publish an update under the (\-N) identifier, both
+results will be given to the user.
.PP
You can use automatic meta\-data extraction (based on libextractor) or
-the command\-line option \-m to specify meta-data. For the \-m option
-you need to use the form keyword\-type:value. For example, use "\-m
-os:Linux" to specify that the operating system is Linux. Common
-meta\-data types are "author", "title" , "mimetype", "filename",
-"language", "subject" and "keywords". A full list can be obtained
-from the extract tool using the option \-\-list. The meta\-data is
-used to help users in searching for files on the network. The
-keywords are case\-sensitive.
+the command\-line option \-m to specify meta-data.
+For the \-m option you need to use the form keyword\-type:value.
+For example, use "\-m os:Linux" to specify that the operating system
+is Linux.
+Common meta\-data types are "author", "title" , "mimetype",
+"filename", "language", "subject" and "keywords".
+A full list can be obtained from the extract tool using the option
+\-\-list.
+The meta\-data is used to help users in searching for files on the
+network.
+The keywords are case\-sensitive.
.PP
-GNUnet supports two styles of publishing files on the
-network. Publishing a file means that a copy of the file is made in
-the local (!) database of the node. Indexing a file means that an
-index is added to the local (!) database with symbolic links to the
-file itself. The links will use the SHA-512 hash of the entire file
-as the filename. Indexing is generally significantly more efficient
-and the default choice. However, indexing only works if the indexed
-file can be read (using the same absolute path) by gnunet-service-fs.
+GNUnet supports two styles of publishing files on the network.
+Publishing a file means that a copy of the file is made in the local
+(!) database of the node.
+Indexing a file means that an index is added to the local (!)
+database with symbolic links to the file itself.
+The links will use the SHA-512 hash of the entire file as the
+filename.
+Indexing is generally significantly more efficient and the default
+choice.
+However, indexing only works if the indexed file can be read (using
+the same absolute path) by gnunet-service-fs.
If this is not the case, indexing will fail (and gnunet\-publish will
-automatically revert to publishing instead). Regardless of which
-method is used to publish the file, the file will be slowly (depending
-on how often it is requested and on how much bandwidth is available)
-dispersed into the network. If you publish or index a file and then
-leave the network, it will almost always NOT be available anymore.
-
-\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR Use alternate config
-file (if this option is not specified, the default is
-~/.config/gnunet.conf).
-
+automatically revert to publishing instead).
+Regardless of which method is used to publish the file, the file will
+be slowly (depending on how often it is requested and on how much
+bandwidth is available) dispersed into the network.
+If you publish or index a file and then leave the network, it will
+almost always NOT be available anymore.
+.PP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
+Use alternate config file (if this option is not specified, the
+default is ~/.config/gnunet.conf).
.TP
-\fB\-D\fR, \fB\-\-disable\-extractor\fR Disable use of GNU
-libextractor for finding additional keywords and metadata.
-
+\fB\-D\fR, \fB\-\-disable\-extractor\fR
+Disable use of GNU libextractor for finding additional keywords and
+metadata.
.TP
-\fB\-d\fR, \fB\-\-disable\-creation\-time\fR Disable use of creation
-time timestamp in metadata. Useful to make created directories
-deterministic and to avoid leaking information about the time at which
-a file was made available.
-
+\fB\-d\fR, \fB\-\-disable\-creation\-time\fR
+Disable use of creation time timestamp in metadata.
+Useful to make created directories deterministic and to avoid leaking
+information about the time at which a file was made available.
.TP
-\fB\-e\fR, \fB\-\-extract\fR Print the list of keywords that will be
-used for each file given the current options. Do not perform any
-indexing or publishing.
-
+\fB\-e\fR, \fB\-\-extract\fR
+Print the list of keywords that will be used for each file given the
+current options.
+Do not perform any indexing or publishing.
.TP
-\fB\-h\fR, \fB\-\-help\fR Print a brief help page with all the
-options.
-
+\fB\-h\fR, \fB\-\-help\fR
+Print a brief help page with all the options.
.TP
-\fB\-k \fIKEYWORD\fR, \fB\-\-key=KEYWORD\fR additional key to index
-the content with (to add multiple keys, specify multiple times). Each
-additional key is case\-sensitive. Can be specified multiple times.
+\fB\-k \fIKEYWORD\fR, \fB\-\-key=KEYWORD\fR
+Additional key to index the content with (to add multiple keys,
+specify multiple times).
+Each additional key is case\-sensitive.
+Can be specified multiple times.
The keyword is only applied to the top\-level file or directory.
-
.TP
-\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR Change the
-loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and
-DEBUG.
-
+\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
+Change the loglevel.
+Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
.TP
-\fB\-m \fITYPE:VALUE\fR, \fB\-\-meta=\fITYPE:VALUE\fR For the main
-file (or directory), set the metadata of the given TYPE to the given
-VALUE. Note that this will not add the respective VALUE to the set of
+\fB\-m \fITYPE:VALUE\fR, \fB\-\-meta=\fITYPE:VALUE\fR
+For the main file (or directory), set the metadata of the given TYPE
+to the given VALUE.
+Note that this will not add the respective VALUE to the set of
keywords under which the file can be found.
-
.TP
-\fB\-n\fR, \fB\-\-noindex\fR Executive summary: You probably don't
-need it.
-
-Do not index, full publishing. Note that directories, information for
-keyword search, namespace search and indexing data are always
-published (even without this option). With this option, every block
-of the actual files is stored in encrypted form in the block database
-of the local peer. While this adds security if the local node is
-compromised (the adversary snags your machine), it is significantly
-less efficient compared to on\-demand encryption and is definitely not
-recommended for large files.
-
+\fB\-n\fR, \fB\-\-noindex\fR
+Executive summary: You probably don't need it.
+Do not index, full publishing.
+Note that directories, information for keyword search, namespace
+search and indexing data are always published (even without this
+option).
+With this option, every block of the actual files is stored in
+encrypted form in the block database of the local peer.
+While this adds security if the local node is compromised (the
+adversary snags your machine), it is significantly less efficient
+compared to on\-demand encryption and is definitely not recommended
+for large files.
.TP
-\fB\-N \fIID\fR, \fB\-\-next=\fIID\fR Specifies the next identifier of
-a future version of the file to be published under the same pseudonym.
-This option is only valid together with the \-P option. This option
-can be used to specify what the identifier of an updated version will
-look like. Note that specifying \-i and \-N without \-t is not
-allowed.
-
+\fB\-N \fIID\fR, \fB\-\-next=\fIID\fR
+Specifies the next identifier of a future version of the file to be
+published under the same pseudonym.
+This option is only valid together with the \-P option.
+This option can be used to specify what the identifier of an updated
+version will look like.
+Note that specifying \-i and \-N without \-t is not allowed.
.TP
-\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR Executive summary:
-You probably don't need it.
-
-Set the priority of the published content (default: 365). If the
-local database is full, GNUnet will discard the content with the
-lowest ranking. Note that ranks change over time depending on
-popularity. The default should be high enough to preserve the locally
-published content in favor of content that migrates from other peers.
-
+\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR
+Executive summary: You probably don't need it.
+Set the priority of the published content (default: 365).
+If the local database is full, GNUnet will discard the content with
+the lowest ranking.
+Note that ranks change over time depending on popularity.
+The default should be high enough to preserve the locally published
+content in favor of content that migrates from other peers.
.TP
-\fB\-P \fINAME\fR, \fB\-\-pseudonym=\fINAME\fR For the top\-level
-directory or file, places the file into the namespace identified by
-the pseudonym NAME. NAME must be a valid pseudonym managed by
-gnunet\-identity.
-
+\fB\-P \fINAME\fR, \fB\-\-pseudonym=\fINAME\fR
+For the top\-level directory or file, places the file into the
+namespace identified by the pseudonym NAME.
+NAME must be a valid pseudonym managed by gnunet\-identity.
.TP
-\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR Set the desired
-replication level. If CONTENT_PUSHING is set to YES, GNUnet will push
-each block (for the file) LEVEL times to other peers before doing
-normal "random" replication of all content. This option can be used
-to push some content out into the network harder. Note that pushing
-content LEVEL times into the network does not guarantee that there
-will actually be LEVEL replicas.
-
+\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
+Set the desired replication level.
+If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the
+file) LEVEL times to other peers before doing normal "random"
+replication of all content.
+This option can be used to push some content out into the network
+harder.
+Note that pushing content LEVEL times into the network does not
+guarantee that there will actually be LEVEL replicas.
.TP
-\fB\-s\fR, \fB\-\-simulate-only\fR When this option is used,
-gnunet\-publish will not actually publish the file but just simulate
-what would be done. This can be used to compute the GNUnet URI for a
-file without actually sharing it.
-
+\fB\-s\fR, \fB\-\-simulate-only\fR
+When this option is used, gnunet\-publish will not actually publish
+the file but just simulate what would be done.
+This can be used to compute the GNUnet URI for a file without actually
+sharing it.
.TP
-\fB\-t \fIID\fR, \fB\-\-this=\fIID\fR Specifies the identifier under
-which the file is to be published under a pseudonym. This option is
-only valid together with the\ \-P option.
-
+\fB\-t \fIID\fR, \fB\-\-this=\fIID\fR
+Specifies the identifier under which the file is to be published under
+a pseudonym.
+This option is only valid together with the\ \-P option.
.TP
-\fB\-u \fIURI\fR, \fB\-\-uri=\fIURI\fR This option can be used to
-specify the URI of a file instead of a filename (this is the only case
-where the otherwise mandatory filename argument must be omitted).
+\fB\-u \fIURI\fR, \fB\-\-uri=\fIURI\fR
+This option can be used to specify the URI of a file instead of a
+filename (this is the only case where the otherwise mandatory filename
+argument must be omitted).
Instead of publishing a file or directory and using the corresponding
URI, gnunet\-publish will use this URI and perform the selected
-namespace or keyword operations. This can be used to add additional
-keywords to a file that has already been shared or to add files to a
-namespace for which the URI is known but the content is not locally
-available.
-
+namespace or keyword operations.
+This can be used to add additional keywords to a file that has already
+been shared or to add files to a namespace for which the URI is known
+but the content is not locally available.
.TP
-\fB\-v\fR, \fB\-\-version\fR Print the version number.
-
+\fB\-v\fR, \fB\-\-version\fR
+Print the version number.
.TP
-\fB\-V\fR, \fB\-\-verbose\fR Be verbose. Using this option causes
-gnunet\-publish to print progress information and at the end the file
-identification that can be used to download the file from GNUnet.
-
-
+\fB\-V\fR, \fB\-\-verbose\fR
+Be verbose.
+Using this option causes gnunet\-publish to print progress information
+and at the end the file identification that can be used to download
+the file from GNUnet.
.SH SETTING ANONYMITY LEVEL
-
The \fB\-a\fR option can be used to specify additional anonymity
-constraints. If set to 0, GNUnet will publish the file non-anonymously
-and in fact sign the advertisement for the file using your peer's
-private key. This will allow other users to download the file as fast
-as possible, including using non-anonymous methods (DHT, direct
-transfer). If you set it to 1 (default), you use the standard
-anonymous routing algorithm (which does not explicitly leak your
-identity). However, a powerful adversary may still be able to perform
-traffic analysis (statistics) to over time infer data about your
-identity. You can gain better privacy by specifying a higher level of
-anonymity, which increases the amount of cover traffic your own
-traffic will get, at the expense of performance. Note that regardless
-of the anonymity level you choose, peers that cache content in the
-network always use anonymity level 1.
-
-The definition of the ANONYMITY LEVEL 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'
-bytes of cover traffic per byte on the wire. Thus, if GNUnet routes n
-bytes of messages from foreign peers (using anonymous routing), it may
-originate n/(v-1) bytes of data in the same time\-period. The
-time\-period is twice the average delay that GNUnet defers forwarded
-queries.
-
-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.
-
-
+constraints.
+If set to 0, GNUnet will publish the file non-anonymously and in fact
+sign the advertisement for the file using your peer's private key.
+This will allow other users to download the file as fast as possible,
+including using non-anonymous methods (DHT, direct transfer).
+If you set it to 1 (default), you use the standard anonymous routing
+algorithm (which does not explicitly leak your identity).
+However, a powerful adversary may still be able to perform traffic
+analysis (statistics) to over time infer data about your identity.
+You can gain better privacy by specifying a higher level of anonymity,
+which increases the amount of cover traffic your own traffic will get,
+at the expense of performance.
+Note that regardless of the anonymity level you choose, peers that
+cache content in the network always use anonymity level 1.
+.PP
+The definition of the ANONYMITY LEVEL 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' bytes of cover
+traffic per byte on the wire.
+Thus, if GNUnet routes n bytes of messages from foreign peers (using
+anonymous routing), it may originate n/(v-1) bytes of data 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 EXAMPLES
.PP
-
\fBBasic examples\fR
-
-Index a file COPYING:
-
- # gnunet\-publish COPYING
-
-Publish a file COPYING:
-
- # gnunet\-publish \-n COPYING
-
-Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR:
-
- # gnunet\-publish \-k gpl \-k test COPYING
-
+.TP
+gnunet\-publish COPYING
+Index a file COPYING
+.TP
+gnunet\-publish \-n COPYING
+Publish a file COPYING
+.TP
+gnunet\-publish \-k gpl \-k test COPYING
+Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR
+.TP
+gnunet\-publish \-m "description:GNU License" \-k gpl \-k test \-m "mimetype:text/plain" COPYING
Index a file COPYING with description "GNU License", mime-type
-"text/plain" and keywords \fBgpl\fR and \fBtest\fR:
-
- # gnunet\-publish \-m "description:GNU License" \-k gpl \-k test \-m
- "mimetype:text/plain" COPYING
-
+"text/plain" and keywords \fBgpl\fR and \fBtest\fR
+.PP
\fBUsing directories\fR
-
+.TP
+mkdir gnu ; mv COPYING AUTHORS gnu/ ; gnunet\-publish \-k test \-k gnu \-D gnu/
Index the files COPYING and AUTHORS with keyword \fBtest\fR and build
a directory containing the two files. Make the directory itself
available under keyword \fBgnu\fR and disable keyword extraction using
-libextractor:
-
- # mkdir gnu mv COPYING AUTHORS gnu/ gnunet\-publish \-k test \-k gnu
- # \-D gnu/
-
+libextractor
+.TP
+gnunet\-publish \-n \-m "description:Kitten collection" \-k kittens kittendir/
Neatly publish an image gallery in \fBkittendir/\fR and its subdirs
with keyword \fBkittens\fR for the directory but no keywords for the
-individual files or subdirs (\-n). Force description for all files:
-
- # gnunet\-publish \-n \-m "description:Kitten collection" \-k kittens
- kittendir/
-
+individual files or subdirs (\-n).
+Force description for all files.
+.PP
\fBSecure publishing with namespaces\fR
-
+.TP
+gnunet\-publish \-P RIAA-2 \-t gpl COPYING
Publish file COPYING with pseudonym RIAA-2 (\-P) and with identifier
-\fBgpl\fR (\-t) and no updates:
-
- # gnunet\-publish \-P RIAA-2 \-t gpl COPYING
-
+\fBgpl\fR (\-t) and no updates
+.TP
+gnunet\-publish \-P RIAA-2 \-t MUSIC \-N VIDEOS /home/ogg
Recursively index /home/ogg and build a matching directory
structure. Publish the top\-level directory into the namespace under
the pseudonym RIAA\-2 (\-P) under identifier 'MUSIC' (\-t) and promise
to provide an update with identifier 'VIDEOS' (\-N):
-
- # gnunet\-publish \-P RIAA-2 \-t MUSIC \-N VIDEOS /home/ogg
-
+.TP
+gnunet\-publish \-nV /var/lib/mysql
Recursively publish (\-n) /var/lib/mysql and build a matching
directory structure, but disable the use of libextractor to extract
-keywords (\-n). Print the file identifiers (\-V) that can be used to
-retrieve the files. This will store a copy of the MySQL database in
-GNUnet but without adding any keywords to search for it. Thus only
-people that have been told the secret file identifiers printed with
-the \-V option can retrieve the (secret?) files:
-
- # gnunet\-publish \-nV /var/lib/mysql
-
+keywords (\-n).
+Print the file identifiers (\-V) that can be used to retrieve the
+files.
+This will store a copy of the MySQL database in GNUnet but without
+adding any keywords to search for it.
+Thus only people that have been told the secret file identifiers
+printed with the \-V option can retrieve the (secret?) files:
+.TP
+gnunet\-publish \-P MPAA-1 \-t root \-N next noise.mp3
Create a namespace entry 'root' in namespace MPAA-1 and announce that
the next update will be called 'next':
-
- # gnunet\-publish \-P MPAA-1 \-t root \-N next noise.mp3
-
+.TP
+gnunet\-publish \-P MPAA-1 \-t next noise_updated.mp3
Update the previous entry, do not allow any future updates:
-
- # gnunet\-publish \-P MPAA-1 \-t next noise_updated.mp3
-
-
.SH FILES
.TP
~/.config/gnunet.conf
GNUnet configuration file
-.SH "REPORTING BUGS"
-Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
-.SH "SEE ALSO"
-\fBgnunet\-auto\-share\fP(1), \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1), \fBgnunet\-identity\fP(1)
+.SH BUGS
+Report bugs to <https://gnunet.org/bugs/> or by sending electronic
+mail to <gnunet\-developers@gnu.org>
+.SH SEE ALSO
+\fBgnunet\-auto\-share\fP(1)
+\fBgnunet\-fs\-gtk\fP(1)
+\fBgnunet\-search\fP(1)
+\fBgnunet\-download\fP(1)
+\fBgnunet.conf\fP(5)
+\fBextract\fP(1)
+\fBgnunet\-identity\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-qr.1 b/doc/man/gnunet-qr.1
index 01c05084c..b80f18bb3 100644
--- a/doc/man/gnunet-qr.1
+++ b/doc/man/gnunet-qr.1
@@ -1,17 +1,13 @@
-.TH GNUNET\-QR 1 "Sep 13, 2014" "GNUnet"
-
+.TH GNUNET\-QR 1 "September 13, 2014" "GNUnet"
.SH NAME
gnunet\-qr \- Scan a QR code using a video device and import.
-
.SH SYNOPSIS
.B gnunet\-qr
.RI [ options ]
.br
-
.SH DESCRIPTION
\fBgnunet\-qr\fP is a command line tool to scan a QR code using a
video device and import.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -28,10 +24,10 @@ Do not show preview windows.
.B
.IP "\-v, \-\-verbose"
Be verbose.
-
.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
diff --git a/doc/man/gnunet-revocation.1 b/doc/man/gnunet-revocation.1
index 467eb4bcf..1afda399c 100644
--- a/doc/man/gnunet-revocation.1
+++ b/doc/man/gnunet-revocation.1
@@ -1,4 +1,4 @@
-.TH GNUNET\-REVOCATION 1 "Mar 15, 2012" "GNUnet"
+.TH GNUNET\-REVOCATION 1 "March 15, 2012" "GNUnet"
.SH NAME
gnunet\-revocation \- revoke private keys (of egos) in GNUnet
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index d79dd620c..79991e375 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -1,4 +1,4 @@
-.TH GNUNET-SEARCH "1" "25 Feb 2012" "0.9.6" "GNUnet"
+.TH GNUNET-SEARCH "1" "February 25, 2012" "0.9.6" "GNUnet"
.SH NAME
gnunet\-search \- a command line interface to search for content on GNUnet
.SH SYNOPSIS
@@ -117,11 +117,11 @@ Searches for content matching both mandatory keywords "Das" and "Kapital".
Search results are printed by gnunet\-search like this:
.P
.ad l
- gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
+ gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
- Description: The GNU General Public License
+ Description: The GNU General Public License
- Mime-type: text/plain
+ Mime-type: text/plain
.ad b
The first line contains the command to run to download the file. The
diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-testbed-profiler.1
index a5f7ea70d..cac6e9af7 100644
--- a/doc/man/gnunet-testbed-profiler.1
+++ b/doc/man/gnunet-testbed-profiler.1
@@ -1,16 +1,12 @@
-.TH GNUNET\-TESTBED\-PROFILER 1 "Sep 13, 2014" "GNUnet"
-
+.TH GNUNET\-TESTBED\-PROFILER 1 "September 13, 2014" "GNUnet"
.SH NAME
gnunet\-testbed\-profiler \- Profiling driver for the testbed.
-
.SH SYNOPSIS
.B gnunet\-testbed\-profiler
.RI [ options ]
.br
-
.SH DESCRIPTION
\fBgnunet\-testbed\-profiler\fP is a command line profiling driver for the testbed.
-
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -41,7 +37,6 @@ Create COUNT number of peers.
.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"
diff --git a/doc/man/gnunet-testing.1 b/doc/man/gnunet-testing.1
index 47aa4a411..ff1af50ef 100644
--- a/doc/man/gnunet-testing.1
+++ b/doc/man/gnunet-testing.1
@@ -1,16 +1,13 @@
-.TH GNUNET\-TESTING 1 "Jan 4, 2012" "GNUnet"
-
+.TH GNUNET\-TESTING 1 "January 4, 2012" "GNUnet"
.SH NAME
gnunet\-testing \- Command line tool to access the testing library.
-
.SH SYNOPSIS
.B gnunet\-testing
.RI [ options ]
.br
-
.SH DESCRIPTION
-\fBgnunet\-testing\fP is a command line tool to access the testing library.
-
+\fBgnunet\-testing\fP is a command line tool to access the testing
+library.
.SH OPTIONS
.B
.IP "\-C, \-\-cfg"
@@ -42,13 +39,14 @@ Configuration template.
.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-transport.1 b/doc/man/gnunet-transport.1
index e05f451b5..2aafbb9ab 100644
--- a/doc/man/gnunet-transport.1
+++ b/doc/man/gnunet-transport.1
@@ -1,20 +1,17 @@
-.TH gnunet\-transport "1" "17 Oct 2015" "GNUnet"
+.TH GNUNET\-TRANSPORT "1" "October 17, 2015" "GNUnet"
.SH NAME
gnunet\-transport \- measure and control the transport subsystem
-
.SH SYNOPSIS
.B gnunet\-transport
[\fIOPTIONS\fR]
.SH DESCRIPTION
.PP
-
gnunet\-transport is a tool to access various functions of GNUnet's
transport subsystem from the command\-line. Most of these are not
expected to be useful for end-users. gnunet\-transport can be used to
evaluate the performance of the transports, force a peer to connect to
another peer (if possible). Other functions should be added in the
near future.
-
.TP
\fB\-b\fR, \fB\-\-benchmark\fR
measure how fast we are receiving data (from all connections). On
@@ -62,10 +59,6 @@ print the version number
.TP
\fB\-V\fR, \fB\-\-verbose\fR
be verbose
-
-.SH NOTES
-
-
.SH "REPORTING BUGS"
Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
.SH "SEE ALSO"
diff --git a/doc/man/gnunet-unindex.1 b/doc/man/gnunet-unindex.1
index bc6a23f6a..1c9d1a58c 100644
--- a/doc/man/gnunet-unindex.1
+++ b/doc/man/gnunet-unindex.1
@@ -1,4 +1,4 @@
-.TH GNUNET-UNINDEX "1" "6 Sep 2009" "GNUnet"
+.TH GNUNET-UNINDEX "1" "September 6, 2009" "GNUnet"
.SH NAME
gnunet\-unindex \- a command line interface for deleting indexed files from GNUnet
.SH SYNOPSIS
@@ -17,7 +17,6 @@ print help page
\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
Change the loglevel. Possible values for LOGLEVEL are NOTHING,
ERROR, WARNING, INFO and DEBUG.
-
.TP
\fB\-v\fR, \fB\-\-version\fR
print the version number
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1
index f4e445c21..838624d98 100644
--- a/doc/man/gnunet-vpn.1
+++ b/doc/man/gnunet-vpn.1
@@ -1,29 +1,27 @@
-.TH GNUNET\-VPN 1 "25 Feb 2012" "GNUnet"
-
+.TH GNUNET\-VPN 1 "February 25, 2012" "GNUnet"
.SH NAME
gnunet\-vpn \- manually setup a GNUnet VPN tunnel
-
.SH SYNOPSIS
.B gnunet\-vpn
.RI [ options ]
.br
-
.SH DESCRIPTION
\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the
-GNUnet network. There are two main types of tunnels. Tunnels to an
-exit node which routes the traffic to the global Internet, and tunnels
-to a node that runs a service only within GNUnet. Depending on the
-type of tunnel, gnunet\-vpn takes different options. The "\-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. For exit tunnels, both UDP and TCP traffic will
-be redirected. For service tunnels, either UDP ("\-u") or TCP ("\-t")
-traffic will be redirected.
-
-The tool will display the IP address for this end of the tunnel. The
-address can be displayed as soon as it has been allocated, or only
+GNUnet network.
+There are two main types of tunnels.
+Tunnels to an exit node which routes the traffic to the global
+Internet, and tunnels to a node that runs a service only within
+GNUnet.
+Depending on the type of tunnel, gnunet\-vpn takes different options.
+The "\-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.
+For exit tunnels, both UDP and TCP traffic will be redirected.
+For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will
+be redirected.
+The tool will display the IP address for this end of the tunnel.
+The address can be displayed as soon as it has been allocated, or only
after ("\-a") the tunnel has been created.
-
.SH OPTIONS
.B
.IP "\-4, \-\-ipv4"
@@ -36,46 +34,50 @@ Desired IP address on this end of the tunnel should be an IPv6 address.
Use the configuration file FILENAME.
.B
.IP "\-d TIME, \-\-duration TIME"
-The mapping should be established for TIME. The value given must be a
-number followed by a space and a time unit, for example "500 ms".
-Note that the quotes are required on the shell. Default is 5 minutes.
+The mapping should be established for TIME.
+The value given must be a number followed by a space and a time unit,
+for example "500 ms".
+Note that the quotes are required on the shell.
+Default is 5 minutes.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-i IP, \-\-ip IP"
Tunnel should be to an exit node and connect to the given IPv4 or IPv6
-IP address. Note that you can specify an IPv6 address as the target
-here, even in combination with "\-4" (4to6) and similarly you can
-specify an IPv4 address in combination with "\-6" (6to4).
+IP address.
+Note that you can specify an IPv6 address as the target here, even in
+combination with "\-4" (4to6) and similarly you can specify an IPv4
+address in combination with "\-6" (6to4).
.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-p PEERID, \-\-peer=PEERID"
-Name of the peer offering the service to connect to. Cannot be used
-in conjunction with "\-i", requires "\-s".
+Name of the peer offering the service to connect to.
+Cannot be used in conjunction with "\-i", requires "\-s".
.B
.IP "\-s NAME, \-\-service=NAME"
-Name of the service running on the target peer. Cannot be used in
-conjunction with "\-i", requires "\-p".
+Name of the service running on the target peer.
+Cannot be used in conjunction with "\-i", requires "\-p".
.B
.IP "\-t, \-\-tcp"
-Service runs TCP. Either "\-t" or "\-u" must be specified when using "\-s".
+Service runs TCP.
+Either "\-t" or "\-u" must be specified when using "\-s".
.B
.IP "\-u, \-\-udp"
-Service runs UDP. Either "\-t" or "\-u" must be specified when using "\-s".
+Service runs UDP.
+Either "\-t" or "\-u" must be specified when using "\-s".
.B
.IP "\-V, \-\-verbose"
Be verbose.
.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\-setup(1)
The full documentation for
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1
index 57f5e70e2..0b3f44fff 100644
--- a/doc/man/gnunet-zoneimport.1
+++ b/doc/man/gnunet-zoneimport.1
@@ -75,8 +75,8 @@ $ 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>
-
+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)
The full documentation for
diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5
index ec6a089d7..3aee4ed71 100644
--- a/doc/man/gnunet.conf.5
+++ b/doc/man/gnunet.conf.5
@@ -1,3 +1,4 @@
+.\" -*- mode: nroff -*-
.TH GNUNET.CONF "5" "26 October 2018" "GNUnet"
.SH NAME
gnunet.conf \- GNUnet configuration file
@@ -144,10 +145,10 @@ to the actual external address for your usage.
.TP
~/.config/gnunet.conf
GNUnet configuration file
-.SH "REPORTING BUGS"
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic
-mail to <bug-gnunet@gnu.org>
-.SH "SEE ALSO"
+.SH BUGS
+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)
The full documentation for
.B gnunet