aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
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
19.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 19.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
20.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 20.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
21.Op Fl v | \-version 21.Op Fl v | \-version
22.Ao Ar PEER_ID SHARED_SECRET Ac 22.Ao Ar PEER_ID Ac
23.Ao Ar SHARED_SECRET Ac
23.Sh DESCRIPTION 24.Sh DESCRIPTION
24.Nm 25.Nm
25prints information about CADET tunnels and peers. 26prints information about CADET tunnels and peers.
26It 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. 27It can also be used for command-line based CADET tunnels using the
27The receiving process will only accept one incoming circuit, but several commands using the same \fI-o\fR can be issued to satisfy multiple requests. 28.Fl o Ar SHARED_SECRET
28For one\-to\-many communication 29option to open a port on a receiving
30.Ar PEER_ID
31and using
32.Nm
33.Ao Ar PEER_ID Ac
34.Ao Ar SHARED_SECRET Ac
35to establish one circuit to that peer from any other peer.
36The receiving process will only accept one incoming circuit, but several commands using the same
37.Fl o
38can be issued to satisfy multiple requests.
39For one-to-many communication
29.Xr gnunet-social 1 40.Xr gnunet-social 1
30may be better suited, however. 41may be better suited, however.
31.Bl -tag -width Ds 42.Bl -tag -width Ds
32.It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID 43.It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID
33Provide information about a particular connection. 44Provide information about the connection
45.Ar CONNECTION_ID .
34.It Fl d | \-dump 46.It Fl d | \-dump
35Dump debug information to STDERR. 47Dump debug information to stderr.
36.It Fl e | \-echo 48.It Fl e | \-echo
37Activate echo mode. 49Activate echo mode.
38.It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET 50.It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET
39Listen for connections using a shared secret among sender and recipient. 51Listen for connections using a shared secret, provided as
52.Ar SHARED_SECRET ,
53among sender and recipient.
40.It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID 54.It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID
41Provide information about a patricular peer. 55Provide information about the peer
56.Ar PEER_ID .
42.It Fl P | \-peers 57.It Fl P | \-peers
43Provide information about all peers. 58Provide information about all (known) peers.
44.It Fl T | \-tunnels 59.It Fl T | \-tunnels
45Provide information about all tunnels. 60Provide information about all tunnels.
46.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 61.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
47Use the configuration file FILENAME. 62Use the configuration file
63.Ar FILENAME .
48.It Fl h | \-help 64.It Fl h | \-help
49Print short help on options. 65Print the help page.
50.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 66.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
51Configure logging to write logs to FILENAME. 67Configure logging to write logs to
68.Ar FILENAME .
52.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 69.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
53Use LOGLEVEL for logging. 70Use LOGLEVEL for logging.
54Valid values are DEBUG, INFO, WARNING and ERROR. 71Valid values are DEBUG, INFO, WARNING and ERROR.
55.It Fl v | \-version 72.It Fl v | \-version
56Print GNUnet version number. 73Print the GNUnet version number.
57.El 74.El
58.Sh SEE ALSO 75.Sh SEE ALSO
59The full documentation for gnunet is maintained as a Texinfo manual. 76The 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
29File to dump to or insert from. 29File to dump to or insert from.
30Otherwise stdin/stdout are used. 30Otherwise stdin/stdout are used.
31.It Fl h | \-help 31.It Fl h | \-help
32print help page 32Print the help page.
33.It Fl i | \-insert 33.It Fl i | \-insert
34Insert from dump file. 34Insert from dump file.
35.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 35.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 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2019 GNUnet e.V.
3.\"
4.\" Permission is granted to copy, distribute and/or modify this document
5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" ``FDL-1.3''.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" ``GPL3''.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
1.Dd January 31, 2016 24.Dd January 31, 2016
2.Dt GNUNET-DOWNLOAD 1 25.Dt GNUNET-DOWNLOAD 1
3.Os 26.Os
@@ -48,19 +71,23 @@ Note that complete files that are part of an incomplete recursive download will
48Without this option, terminating gnunet-download with a signal will cause incomplete downloads to stay on disk. 71Without this option, terminating gnunet-download with a signal will cause incomplete downloads to stay on disk.
49If gnunet-download runs to (normal) completion finishing the download, this option has no effect. 72If gnunet-download runs to (normal) completion finishing the download, this option has no effect.
50.It Fl h | \-help 73.It Fl h | \-help
51Print help page 74Print the help page.
52.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 75.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
53Change the loglevel. 76Change the loglevel.
54Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 77Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
55.It Fl n | \-no-network 78.It Fl n | \-no-network
56Only search locally, do not forward requests to other peers. 79Only search locally, do not forward requests to other peers.
57.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME 80.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME
58Write the file to FILENAME. 81Write the file to
82.Ar FILENAME .
59Hint: when recursively downloading a directory, append a '/' to the end of the FILENAME to create a directory of that name. 83Hint: when recursively downloading a directory, append a '/' to the end of the FILENAME to create a directory of that name.
60If no FILENAME is specified, gnunet-download constructs a temporary ID from the URI of the file. 84If no FILENAME is specified, gnunet-download constructs a temporary ID from the URI of the file.
61The final filename is constructed based on meta-data extracted using libextractor (if available). 85The final filename is constructed based on meta-data extracted using
86.Xr libextractor 1
87(if available).
62.It Fl p Ar DOWNLOADS | Fl \-parallelism= Ns Ar DOWNLOADS 88.It Fl p Ar DOWNLOADS | Fl \-parallelism= Ns Ar DOWNLOADS
63Set the maximum number of parallel downloads that is allowed. 89Set the maximum number of allowed parallel downloads to
90.Ar DOWNLOADS .
64More parallel downloads can, to some extent, improve the overall time to download content. 91More parallel downloads can, to some extent, improve the overall time to download content.
65However, parallel downloads also take more memory (see also 92However, parallel downloads also take more memory (see also
66.Fl r 93.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
38.Op Fl V | \-verbose 38.Op Fl V | \-verbose
39.Sh DESCRIPTION 39.Sh DESCRIPTION
40.Nm 40.Nm
41is a tool to access various functions of GNUnet's FS subsystem from the command\-line. 41is a tool to access various functions of GNUnet's FS subsystem from the command-line.
42Most of these are not expected to be useful for end-users. 42Most of these are not expected to be useful for end-users.
43gnunet\-fs can currently only be used to obtain a list of indexed files. 43gnunet-fs can currently only be used to obtain a list of indexed files.
44Other functions should be added in the near future. 44Other functions should be added in the near future.
45.Bl -tag -width Ds 45.Bl -tag -width Ds
46.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 46.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
47Configuration file to use. 47Configuration file to use.
48.It Fl h | \-help 48.It Fl h | \-help
49Print help page. 49Print the help page.
50.It Fl i | \-list-indexed 50.It Fl i | \-list-indexed
51Print information about files that are currently indexed by file-sharing. 51Print information about files that are currently indexed by file-sharing.
52.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 52.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
28.It Fl g | \-get\-hello 28.It Fl g | \-get\-hello
29Output HELLO uri(s) 29Output HELLO uri(s)
30.It Fl h | \-help 30.It Fl h | \-help
31Print help page 31Print the help page.
32.It Fl i | \-info 32.It Fl i | \-info
33List all known peers (and their addresses). 33List all known peers (and their addresses).
34.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 34.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
156Print the list of keywords that will be used for each file given the current options. 156Print the list of keywords that will be used for each file given the current options.
157Do not perform any indexing or publishing. 157Do not perform any indexing or publishing.
158.It Fl h | \-help 158.It Fl h | \-help
159Print a brief help page with all the options. 159Print the help page.
160.It Fl k Ar KEYWORD | Fl \-key= Ns Ar KEYWORD 160.It Fl k Ar KEYWORD | Fl \-key= Ns Ar KEYWORD
161Additional key to index the content with (to add multiple keys, specify multiple times). 161Additional key to index the content with (to add multiple keys, specify multiple times).
162Each additional key is case\-sensitive. 162Each 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
65The time-period is twice the average delay by which GNUnet artificially delays traffic. 65The time-period is twice the average delay by which GNUnet artificially delays traffic.
66Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. 66Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
67.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 67.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
68Use the configuration file FILENAME (default: 68Use the configuration file
69.Ar FILENAME
70(default:
69.Pa ~/.config/gnunet.conf ) 71.Pa ~/.config/gnunet.conf )
70.It Fl h | \-help 72.It Fl h | \-help
71print help page 73Print the help page.
72.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 74.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
73Change the loglevel. 75Change the loglevel.
74Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 76Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
75.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 77.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
76Write logs to FILENAME. 78Write logs to
79.Ar FILENAME .
77.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME 80.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME
78Writes a GNUnet directory containing all of the search results to FILENAME. 81Writes a GNUnet directory containing all of the search results to
82.Ar FILENAME .
79.It Fl n | \-no-network 83.It Fl n | \-no-network
80Only search locally, do not forward requests to other peers. 84Only search locally, do not forward requests to other peers.
81.It Fl N Ar VALUE | Fl \-results= Ns Ar VALUE 85.It Fl N Ar VALUE | Fl \-results= Ns Ar VALUE
82Automatically terminate the search after receiving VALUE results. 86Automatically terminate the search after receiving
87.Ar VALUE
88results.
83.It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY 89.It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY
84Automatically timeout search after DELAY. 90Automatically timeout search after
91.Ar DELAY .
85The value given must be a number followed by a space and a time unit, for example "500 ms". 92The value given must be a number followed by a space and a time unit, for example "500 ms".
86Note that the quotes are required on the shell. 93Note that the quotes are required on the shell.
87Otherwise the search runs until gnunet-search is aborted with CTRL\-C. 94Otherwise the search runs until gnunet-search is aborted with CTRL\-C.
@@ -102,25 +109,24 @@ For a keyword search, use
102.Pp 109.Pp
103If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly. 110If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly.
104.sp 111.sp
105If multiple keywords are passed, gnunet-search will look for content 112If multiple keywords are passed, gnunet-search will look for content matching any of the keywords.
106matching any of the keywords.
107The prefix "+" makes a keyword mandatory. 113The prefix "+" makes a keyword mandatory.
108.Sh FILES 114.Sh FILES
109.Pa ~/.config/gnunet.conf 115.Pa ~/.config/gnunet.conf
110GNUnet configuration file; specifies the default value for the timeout 116GNUnet configuration file; specifies the default value for the timeout
111.Sh EXAMPLES 117.Sh EXAMPLES
112.Dl $ gnunet\-search "Das Kapital" 118.Dl $ gnunet-search "Das Kapital"
113.Pp 119.Pp
114Searches for content matching the keyword "Das Kapital". 120Searches for content matching the keyword "Das Kapital".
115.Pp 121.Pp
116.Dl $ gnunet\-search +Das +Kapital 122.Dl $ gnunet-search +Das +Kapital
117.Pp 123.Pp
118Searches for content matching both mandatory keywords "Das" and "Kapital". 124Searches for content matching both mandatory keywords "Das" and "Kapital".
119.sp 125.sp
120Search results are printed by gnunet\-search like this: 126Search results are printed by gnunet-search like this:
121.Pp 127.Pp
122.ad l 128.ad l
123 gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE 129 gnunet-download -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
124 130
125 Description: The GNU General Public License 131 Description: The GNU General Public License
126 132
@@ -130,11 +136,15 @@ Search results are printed by gnunet\-search like this:
130The first line contains the command to run to download the file. 136The first line contains the command to run to download the file.
131The suggested filename in the example is COPYING. 137The suggested filename in the example is COPYING.
132The GNUnet URI consists of the key and query hash of the file and finally the size of the file. 138The GNUnet URI consists of the key and query hash of the file and finally the size of the file.
133After 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). 139After the command to download the file, GNUnet will print meta-data about the file as advertised in the search result.
140The meta-data here is the description ("The GNU General Public License") and the mime-type ("text-plain").
141See the options for
142.Xr gnunet-publish 1
143on how to supply meta-data by hand.
134.Sh SEE ALSO 144.Sh SEE ALSO
145.Xr gnunet-download 1 ,
135.Xr gnunet-fs-gtk 1 , 146.Xr gnunet-fs-gtk 1 ,
136.Xr gnunet\-publish 1 , 147.Xr gnunet-publish 1 ,
137.Xr gnunet\-download 1 ,
138.Xr gnunet.conf 5 148.Xr gnunet.conf 5
139.sp 149.sp
140The full documentation for gnunet is maintained as a Texinfo manual. 150The 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.
40.It Fl e | \-events 40.It Fl e | \-events
41provide information about all connect and disconnect events (continuously) 41provide information about all connect and disconnect events (continuously)
42.It Fl h | \-help 42.It Fl h | \-help
43print help page 43Print the help page.
44.It Fl i | \-information 44.It Fl i | \-information
45print information about our current connections (once) 45print information about our current connections (once)
46.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 46.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL