summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-04-23 14:50:06 +0000
committerng0 <ng0@n0.is>2019-04-23 14:50:06 +0000
commit050f5f3f5d783bd080d838d04eb8837672627afb (patch)
tree9f4f67a567ddf413387290b5455f7ff8fcc9d413 /doc
parentf679160f2a6689ace17e2624405148da03c795bf (diff)
doc/man: bunch of fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-cadet.143
-rw-r--r--doc/man/gnunet-datastore.12
-rw-r--r--doc/man/gnunet-download.135
-rw-r--r--doc/man/gnunet-fs.16
-rw-r--r--doc/man/gnunet-peerinfo.12
-rw-r--r--doc/man/gnunet-publish.12
-rw-r--r--doc/man/gnunet-search.140
-rw-r--r--doc/man/gnunet-transport.12
8 files changed, 93 insertions, 39 deletions
diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1
index 272f04232..081b50572 100644
--- a/doc/man/gnunet-cadet.1
+++ b/doc/man/gnunet-cadet.1
@@ -19,41 +19,58 @@ create or obtain information about CADET tunnels and peers
.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
.Op Fl v | \-version
-.Ao Ar PEER_ID SHARED_SECRET Ac
+.Ao Ar PEER_ID Ac
+.Ao Ar SHARED_SECRET Ac
.Sh DESCRIPTION
.Nm
prints information about CADET tunnels and peers.
-It can also be used for command-line based CADET tunnels using the \fI-o SHARED_SECRET\fR option to open a port on a receiving PEER_ID and using "\fBgnunet\-cadet\fP \fIPEER_ID SHARED_SECRET\fR" to establish one circuit to that peer from any other peer.
-The receiving process will only accept one incoming circuit, but several commands using the same \fI-o\fR can be issued to satisfy multiple requests.
-For one\-to\-many communication
+It can also be used for command-line based CADET tunnels using the
+.Fl o Ar SHARED_SECRET
+option to open a port on a receiving
+.Ar PEER_ID
+and using
+.Nm
+.Ao Ar PEER_ID Ac
+.Ao Ar SHARED_SECRET Ac
+to establish one circuit to that peer from any other peer.
+The receiving process will only accept one incoming circuit, but several commands using the same
+.Fl o
+can be issued to satisfy multiple requests.
+For one-to-many communication
.Xr gnunet-social 1
may be better suited, however.
.Bl -tag -width Ds
.It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID
-Provide information about a particular connection.
+Provide information about the connection
+.Ar CONNECTION_ID .
.It Fl d | \-dump
-Dump debug information to STDERR.
+Dump debug information to stderr.
.It Fl e | \-echo
Activate echo mode.
.It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET
-Listen for connections using a shared secret among sender and recipient.
+Listen for connections using a shared secret, provided as
+.Ar SHARED_SECRET ,
+among sender and recipient.
.It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID
-Provide information about a patricular peer.
+Provide information about the peer
+.Ar PEER_ID .
.It Fl P | \-peers
-Provide information about all peers.
+Provide information about all (known) peers.
.It Fl T | \-tunnels
Provide information about all tunnels.
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
-Use the configuration file FILENAME.
+Use the configuration file
+.Ar FILENAME .
.It Fl h | \-help
-Print short help on options.
+Print the help page.
.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
-Configure logging to write logs to FILENAME.
+Configure logging to write logs to
+.Ar FILENAME .
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
.It Fl v | \-version
-Print GNUnet version number.
+Print the GNUnet version number.
.El
.Sh SEE ALSO
The full documentation for gnunet is maintained as a Texinfo manual.
diff --git a/doc/man/gnunet-datastore.1 b/doc/man/gnunet-datastore.1
index 0f43cc016..aeb7cc751 100644
--- a/doc/man/gnunet-datastore.1
+++ b/doc/man/gnunet-datastore.1
@@ -29,7 +29,7 @@ Dump all records to a file
File to dump to or insert from.
Otherwise stdin/stdout are used.
.It Fl h | \-help
-print help page
+Print the help page.
.It Fl i | \-insert
Insert from dump file.
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index 1c7776ff1..51bb1473b 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -1,3 +1,26 @@
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
+.\" copy of the license is included in the file
+.\" ``FDL-1.3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation. A copy of the license is included in the file
+.\" ``GPL3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
.Dd January 31, 2016
.Dt GNUNET-DOWNLOAD 1
.Os
@@ -48,19 +71,23 @@ Note that complete files that are part of an incomplete recursive download will
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.
.It Fl h | \-help
-Print help page
+Print the help page.
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
Change the loglevel.
Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
.It Fl n | \-no-network
Only search locally, do not forward requests to other peers.
.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME
-Write the file to FILENAME.
+Write the file to
+.Ar FILENAME .
Hint: when recursively downloading a directory, 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).
+The final filename is constructed based on meta-data extracted using
+.Xr libextractor 1
+(if available).
.It Fl p Ar DOWNLOADS | Fl \-parallelism= Ns Ar DOWNLOADS
-Set the maximum number of parallel downloads that is allowed.
+Set the maximum number of allowed parallel downloads to
+.Ar DOWNLOADS .
More parallel downloads can, to some extent, improve the overall time to download content.
However, parallel downloads also take more memory (see also
.Fl r
diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1
index ea0bb8cb0..556452425 100644
--- a/doc/man/gnunet-fs.1
+++ b/doc/man/gnunet-fs.1
@@ -38,15 +38,15 @@ measure and control the fs subsystem
.Op Fl V | \-verbose
.Sh DESCRIPTION
.Nm
-is a tool to access various functions of GNUnet's FS subsystem from the command\-line.
+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.
+gnunet-fs can currently only be used to obtain a list of indexed files.
Other functions should be added in the near future.
.Bl -tag -width Ds
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
Configuration file to use.
.It Fl h | \-help
-Print help page.
+Print the help page.
.It Fl i | \-list-indexed
Print information about files that are currently indexed by file-sharing.
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1
index c2a43b9c2..240f8b1b8 100644
--- a/doc/man/gnunet-peerinfo.1
+++ b/doc/man/gnunet-peerinfo.1
@@ -28,7 +28,7 @@ Load config file, default FILENAME of the config is
.It Fl g | \-get\-hello
Output HELLO uri(s)
.It Fl h | \-help
-Print help page
+Print the help page.
.It Fl i | \-info
List all known peers (and their addresses).
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index c41e34a8c..0cd3c6036 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -156,7 +156,7 @@ Setting this information will leak information about the time at which a file wa
Print the list of keywords that will be used for each file given the current options.
Do not perform any indexing or publishing.
.It Fl h | \-help
-Print a brief help page with all the options.
+Print the help page.
.It Fl k Ar KEYWORD | Fl \-key= Ns Ar KEYWORD
Additional key to index the content with (to add multiple keys, specify multiple times).
Each additional key is case\-sensitive.
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 484bfca24..801efbe3f 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -65,23 +65,30 @@ Given an anonymity level L (above 1), each request FS makes on your behalf must
The time-period is twice the average delay by which GNUnet artificially delays traffic.
Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
-Use the configuration file FILENAME (default:
+Use the configuration file
+.Ar FILENAME
+(default:
.Pa ~/.config/gnunet.conf )
.It Fl h | \-help
-print help page
+Print the help page.
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
Change the loglevel.
Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
-Write logs to FILENAME.
+Write logs to
+.Ar FILENAME .
.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME
-Writes a GNUnet directory containing all of the search results to FILENAME.
+Writes a GNUnet directory containing all of the search results to
+.Ar FILENAME .
.It Fl n | \-no-network
Only search locally, do not forward requests to other peers.
.It Fl N Ar VALUE | Fl \-results= Ns Ar VALUE
-Automatically terminate the search after receiving VALUE results.
+Automatically terminate the search after receiving
+.Ar VALUE
+results.
.It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY
-Automatically timeout search after DELAY.
+Automatically timeout search after
+.Ar DELAY .
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.
Otherwise the search runs until gnunet-search is aborted with CTRL\-C.
@@ -102,25 +109,24 @@ For a keyword search, use
.Pp
If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly.
.sp
-If multiple keywords are passed, gnunet-search will look for content
-matching any of the keywords.
+If multiple keywords are passed, gnunet-search will look for content matching any of the keywords.
The prefix "+" makes a keyword mandatory.
.Sh FILES
.Pa ~/.config/gnunet.conf
GNUnet configuration file; specifies the default value for the timeout
.Sh EXAMPLES
-.Dl $ gnunet\-search "Das Kapital"
+.Dl $ gnunet-search "Das Kapital"
.Pp
Searches for content matching the keyword "Das Kapital".
.Pp
-.Dl $ gnunet\-search +Das +Kapital
+.Dl $ gnunet-search +Das +Kapital
.Pp
Searches for content matching both mandatory keywords "Das" and "Kapital".
.sp
-Search results are printed by gnunet\-search like this:
+Search results are printed by gnunet-search like this:
.Pp
.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
@@ -130,11 +136,15 @@ Search results are printed by gnunet\-search like this:
The first line contains the command to run to download the file.
The suggested filename in the example is COPYING.
The GNUnet URI consists of the key and query hash of the file and finally the size of the file.
-After the command to download the file GNUnet will print meta\-data about the file as advertised in the search result, here "The GNU General Public License" and the mime\-type (see the options for gnunet-publish on how to supply meta-data by hand).
+After the command to download the file, GNUnet will print meta-data about the file as advertised in the search result.
+The meta-data here is the description ("The GNU General Public License") and the mime-type ("text-plain").
+See the options for
+.Xr gnunet-publish 1
+on how to supply meta-data by hand.
.Sh SEE ALSO
+.Xr gnunet-download 1 ,
.Xr gnunet-fs-gtk 1 ,
-.Xr gnunet\-publish 1 ,
-.Xr gnunet\-download 1 ,
+.Xr gnunet-publish 1 ,
.Xr gnunet.conf 5
.sp
The full documentation for gnunet is maintained as a Texinfo manual.
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1
index 217491bc8..ceab37ec3 100644
--- a/doc/man/gnunet-transport.1
+++ b/doc/man/gnunet-transport.1
@@ -40,7 +40,7 @@ Note that you can use the gnunet-ats command-line tool to suggest connects.
.It Fl e | \-events
provide information about all connect and disconnect events (continuously)
.It Fl h | \-help
-print help page
+Print the help page.
.It Fl i | \-information
print information about our current connections (once)
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL