aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-download.1
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
committerNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
commitd269419d23e8c4c062e21e5bd88cdee66a1680b0 (patch)
treec9661262fee4604bd83b0bc739e7223c8cddfb0a /doc/man/gnunet-download.1
parent4be442739c7f6745848a2f5544a59592f06a6cb3 (diff)
downloadgnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.tar.gz
gnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.zip
doc/man: More fixes.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc/man/gnunet-download.1')
-rw-r--r--doc/man/gnunet-download.129
1 files changed, 7 insertions, 22 deletions
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index aa1328c00..58e82e790 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -1,21 +1,17 @@
1.TH GNUNET-DOWNLOAD "1" "31 Jan 2016" "GNUnet" 1.TH GNUNET-DOWNLOAD "1" "January 31, 2016" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-download \- a command line interface for downloading files from GNUnet 3gnunet\-download \- a command line interface for downloading files from GNUnet
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B gnunet\-download 5.B gnunet\-download
6[\fIOPTIONS\fR] \-\- GNUNET_URI 6[\fIOPTIONS\fR] \-\- GNUNET_URI
7.SH DESCRIPTION 7.SH DESCRIPTION
8.PP
9Download files from GNUnet. 8Download files from GNUnet.
10
11.TP 9.TP
12\fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR 10\fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR
13set desired level of receiver anonymity. Default is 1. 11set desired level of receiver anonymity. Default is 1.
14
15.TP 12.TP
16\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 13\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
17use config file (defaults: ~/.config/gnunet.conf) 14use config file (defaults: ~/.config/gnunet.conf)
18
19.TP 15.TP
20\fB\-D, \fB\-\-delete\-incomplete\fR 16\fB\-D, \fB\-\-delete\-incomplete\fR
21causes gnunet\-download to delete incomplete downloads when aborted with 17causes gnunet\-download to delete incomplete downloads when aborted with
@@ -24,20 +20,16 @@ download will not be deleted even with this option. Without this option,
24terminating gnunet\-download with a signal will cause incomplete 20terminating gnunet\-download with a signal will cause incomplete
25downloads to stay on disk. If gnunet\-download runs to (normal) completion 21downloads to stay on disk. If gnunet\-download runs to (normal) completion
26finishing the download, this option has no effect. 22finishing the download, this option has no effect.
27
28.TP 23.TP
29\fB\-h\fR, \fB\-\-help\fR 24\fB\-h\fR, \fB\-\-help\fR
30print help page 25print help page
31
32.TP 26.TP
33\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR 27\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
34Change the loglevel. Possible values for LOGLEVEL are 28Change the loglevel. Possible values for LOGLEVEL are
35ERROR, WARNING, INFO and DEBUG. 29ERROR, WARNING, INFO and DEBUG.
36
37.TP 30.TP
38\fB\-n\fR, \fB\-\-no-network\fR 31\fB\-n\fR, \fB\-\-no-network\fR
39Only search locally, do not forward requests to other peers. 32Only search locally, do not forward requests to other peers.
40
41.TP 33.TP
42\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR 34\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR
43write the file to FILENAME. Hint: when recursively downloading a directory, 35write the file to FILENAME. Hint: when recursively downloading a directory,
@@ -45,7 +37,6 @@ append a '/' to the end of the FILENAME to create a directory of that name.
45If no FILENAME is specified, gnunet\-download constructs a temporary ID from 37If no FILENAME is specified, gnunet\-download constructs a temporary ID from
46the URI of the file. The final filename is constructed based on meta\-data 38the URI of the file. The final filename is constructed based on meta\-data
47extracted using libextractor (if available). 39extracted using libextractor (if available).
48
49.TP 40.TP
50\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR 41\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR
51set the maximum number of parallel downloads that is allowed. More parallel 42set the maximum number of parallel downloads that is allowed. More parallel
@@ -56,7 +47,6 @@ used to limit the number of files that are downloaded in parallel (\-r can
56be used to limit the number of blocks that are concurrently requested). 47be used to limit the number of blocks that are concurrently requested).
57As a result, the value only matters for recursive downloads. 48As a result, the value only matters for recursive downloads.
58The default value is 32. 49The default value is 32.
59
60.TP 50.TP
61\fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR 51\fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR
62set the maximum number of parallel requests that is allowed. If multiple 52set the maximum number of parallel requests that is allowed. If multiple
@@ -71,7 +61,6 @@ recursive downloads with many large files if memory and network
71bandwidth are not fully utilized and if the parallelism limit (\-p option) 61bandwidth are not fully utilized and if the parallelism limit (\-p option)
72is not reached. This option also only matters for recursive downloads. 62is not reached. This option also only matters for recursive downloads.
73The default value is 4092. 63The default value is 4092.
74
75.TP 64.TP
76\fB\-R\fR, \fB\-\-recursive\fR 65\fB\-R\fR, \fB\-\-recursive\fR
77download directories recursively (and in parallel). Note that the URI 66download directories recursively (and in parallel). Note that the URI
@@ -83,15 +72,12 @@ information will be stored in "DIRNAME/.gnd". However, it is also
83possible to specify "DIRNAME.gnd", in which case the files from the 72possible to specify "DIRNAME.gnd", in which case the files from the
84directory will end up in "DIRNAME/", while GNUnet's directory meta 73directory will end up in "DIRNAME/", while GNUnet's directory meta
85data will be in "DIRNAME.gnd". 74data will be in "DIRNAME.gnd".
86
87.TP 75.TP
88\fB\-v\fR, \fB\-\-version\fR 76\fB\-v\fR, \fB\-\-version\fR
89print the version number 77print the version number
90
91.TP 78.TP
92\fB\-V\fR, \fB\-\-verbose\fR 79\fB\-V\fR, \fB\-\-verbose\fR
93print progress information 80print progress information
94
95.SH NOTES 81.SH NOTES
96The GNUNET_URI is typically obtained from 82The GNUNET_URI is typically obtained from
97gnunet\-search. gnunet\-fs\-gtk can also be used instead of 83gnunet\-search. gnunet\-fs\-gtk can also be used instead of
@@ -102,9 +88,7 @@ already present. GNUnet's file\-encoding will ensure file integrity,
102even if the existing file was not downloaded from GNUnet in the first 88even if the existing file was not downloaded from GNUnet in the first
103place. Temporary information will be appended to the target file until 89place. Temporary information will be appended to the target file until
104the download is completed. 90the download is completed.
105
106.SH SETTING ANONYMITY LEVEL 91.SH SETTING ANONYMITY LEVEL
107
108The \fB\-a\fR option can be used to specify additional anonymity 92The \fB\-a\fR option can be used to specify additional anonymity
109constraints. If set to 0, GNUnet will try to download the file as fast 93constraints. If set to 0, GNUnet will try to download the file as fast
110as possible, including using non-anonymous methods. If you set it to 94as possible, including using non-anonymous methods. If you set it to
@@ -121,14 +105,14 @@ anonymity level 0, the peers publishing the data might be sharing with
121a higher anonymity level, which in this case will determine 105a higher anonymity level, which in this case will determine
122performance. Also, peers that cache content in the network always use 106performance. Also, peers that cache content in the network always use
123anonymity level 1. 107anonymity level 1.
124 108.PP
125This option can be used to limit requests further than that. In 109This option can be used to limit requests further than that. In
126particular, you can require GNUnet to receive certain amounts of 110particular, you can require GNUnet to receive certain amounts of
127traffic from other peers before sending your queries. This way, you 111traffic from other peers before sending your queries. This way, you
128can gain very high levels of anonymity \- at the expense of much more 112can gain very high levels of anonymity \- at the expense of much more
129traffic and much higher latency. So set it only if you really believe 113traffic and much higher latency. So set it only if you really believe
130you need it. 114you need it.
131 115.PP
132The definition of ANONYMITY\-RECEIVE is the following. 0 means no 116The definition of ANONYMITY\-RECEIVE is the following. 0 means no
133anonymity is required. Otherwise a value of 'v' means that 1 out of v 117anonymity is required. Otherwise a value of 'v' means that 1 out of v
134bytes of "anonymous" traffic can be from the local user, leaving 'v-1' 118bytes of "anonymous" traffic can be from the local user, leaving 'v-1'
@@ -137,12 +121,11 @@ bytes of messages from foreign peers (using anonymous routing), it may
137originate n/(v-1) bytes of queries in the same time\-period. The 121originate n/(v-1) bytes of queries in the same time\-period. The
138time\-period is twice the average delay that GNUnet defers forwarded 122time\-period is twice the average delay that GNUnet defers forwarded
139queries. 123queries.
140 124.PP
141The default is 1 and this should be fine for most users. Also notice 125The default is 1 and this should be fine for most users. Also notice
142that if you choose very large values, you may end up having no 126that if you choose very large values, you may end up having no
143throughput at all, especially if many of your fellow GNUnet\-peers all 127throughput at all, especially if many of your fellow GNUnet\-peers all
144do the same. 128do the same.
145
146.SH FILES 129.SH FILES
147.TP 130.TP
148~/.config/gnunet.conf 131~/.config/gnunet.conf
@@ -154,9 +137,11 @@ mail to <gnunet\-developers@gnu.org>
154\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), 137\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
155\fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5), 138\fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5),
156\fBgnunet\-service\-fs\fP(1) 139\fBgnunet\-service\-fs\fP(1)
140.PP
157The full documentation for 141The full documentation for
158.B gnunet 142.B gnunet
159is maintained as a Texinfo manual. If the 143is maintained as a Texinfo manual.
144If the
160.B info 145.B info
161and 146and
162.B gnunet 147.B gnunet