aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-download.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-download.1')
-rw-r--r--doc/man/gnunet-download.1100
1 files changed, 86 insertions, 14 deletions
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index 759b3a964..824c2414d 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -18,7 +18,12 @@ use config file (defaults: ~/.config/gnunet.conf)
18 18
19.TP 19.TP
20\fB\-D, \fB\-\-delete\-incomplete\fR 20\fB\-D, \fB\-\-delete\-incomplete\fR
21causes gnunet\-download to delete incomplete downloads when aborted with CTRL\-C. Note that complete files that are part of an incomplete recursive download will not be deleted even with this option. Without this option, terminating gnunet\-download with a signal will cause incomplete downloads to stay on disk. If gnunet\-download runs to (normal) completion finishing the download, this option has no effect. 21causes gnunet\-download to delete incomplete downloads when aborted with
22CTRL\-C. Note that complete files that are part of an incomplete recursive
23download will not be deleted even with this option. Without this option,
24terminating gnunet\-download with a signal will cause incomplete
25downloads to stay on disk. If gnunet\-download runs to (normal) completion
26finishing the download, this option has no effect.
22 27
23.TP 28.TP
24\fB\-h\fR, \fB\-\-help\fR 29\fB\-h\fR, \fB\-\-help\fR
@@ -35,19 +40,49 @@ Only search locally, do not forward requests to other peers.
35 40
36.TP 41.TP
37\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR 42\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR
38write the file to 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). 43write the file to FILENAME. Hint: when recursively downloading a directory,
44append 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
46the URI of the file. The final filename is constructed based on meta\-data
47extracted using libextractor (if available).
39 48
40.TP 49.TP
41\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR 50\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR
42set the maximum number of parallel downloads that is allowed. More parallel downloads can, to some extent, improve the overall time to download content. However, parallel downloads also take more memory (see also option \-r which can be used to limit memory utilization) and more sockets. This option is used to limit the number of files that are downloaded in parallel (\-r can be used to limit the number of blocks that are concurrently requested). As a result, the value only matters for recursive downloads. The default value is 32. 51set the maximum number of parallel downloads that is allowed. More parallel
52downloads can, to some extent, improve the overall time to download content.
53However, parallel downloads also take more memory (see also option \-r which
54can be used to limit memory utilization) and more sockets. This option is
55used 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).
57As a result, the value only matters for recursive downloads.
58The default value is 32.
43 59
44.TP 60.TP
45\fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR 61\fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR
46set the maximum number of parallel requests that is allowed. If multiple files are downloaded, gnunet\-download will not run them in parallel if this would cause the number of pending requests to possibly exceed the given value. This is useful since, for example, downloading dozens of multi\-gigabyte files in parallel could exhaust memory resources and would hardly improve performance. Note that the limit only applies to this specific process and that other download activities by other processes are not included in this limit. Consider raising this limit for large recursive downloads with many large files if memory and network bandwidth are not fully utilized and if the parallelism limit (\-p option) is not reached. This option also only matters for recursive downloads. The default value is 4092. 62set the maximum number of parallel requests that is allowed. If multiple
63files are downloaded, gnunet\-download will not run them in parallel if
64this would cause the number of pending requests to possibly exceed the
65given value. This is useful since, for example, downloading dozens of
66multi\-gigabyte files in parallel could exhaust memory resources and would
67hardly improve performance. Note that the limit only applies to this
68specific process and that other download activities by other processes
69are not included in this limit. Consider raising this limit for large
70recursive downloads with many large files if memory and network
71bandwidth are not fully utilized and if the parallelism limit (\-p option)
72is not reached. This option also only matters for recursive downloads.
73The default value is 4092.
47 74
48.TP 75.TP
49\fB\-R\fR, \fB\-\-recursive\fR 76\fB\-R\fR, \fB\-\-recursive\fR
50download directories recursively (and in parallel). Note that the URI must belong to a GNUnet directory and that the filename given to "\-o" must end in '.gnd' \-\- otherwise, you will receive an error. You may want to use "DIRNAME/.gnd" for the filename, this way a directory "DIRNAME/" will be created, and GNUnet's internal directory information will be stored in "DIRNAME/.gnd". However, it is also possible to specify "DIRNAME.gnd", in which case the files from the directory will end up in "DIRNAME/", while GNUnet's directory meta data will be in "DIRNAME.gnd". 77download directories recursively (and in parallel). Note that the URI
78must belong to a GNUnet directory and that the filename given to "\-o"
79must end in '.gnd' \-\- otherwise, you will receive an error. You may
80want to use "DIRNAME/.gnd" for the filename, this way a directory
81"DIRNAME/" will be created, and GNUnet's internal directory
82information will be stored in "DIRNAME/.gnd". However, it is also
83possible to specify "DIRNAME.gnd", in which case the files from the
84directory will end up in "DIRNAME/", while GNUnet's directory meta
85data will be in "DIRNAME.gnd".
51 86
52.TP 87.TP
53\fB\-v\fR, \fB\-\-version\fR 88\fB\-v\fR, \fB\-\-version\fR
@@ -58,18 +93,55 @@ print the version number
58print progress information 93print progress information
59 94
60.SH NOTES 95.SH NOTES
61The GNUNET_URI is typically obtained from gnunet\-search. gnunet\-fs\-gtk can also be used instead of gnunet\-download. 96The GNUNET_URI is typically obtained from
62If you ever have to abort a download, you can at any time continue it by re\-issuing gnunet\-download with the same filename. In that case GNUnet will not download blocks again that are already present. GNUnet's file\-encoding will ensure file integrity, even if the existing file was not downloaded from GNUnet in the first place. Temporary information will be appended to the target file until the download is completed. 97gnunet\-search. gnunet\-fs\-gtk can also be used instead of
98gnunet\-download. If you ever have to abort a download, you can at
99any time continue it by re\-issuing gnunet\-download with the same
100filename. In that case GNUnet will not download blocks again that are
101already present. GNUnet's file\-encoding will ensure file integrity,
102even if the existing file was not downloaded from GNUnet in the first
103place. Temporary information will be appended to the target file until
104the download is completed.
63 105
64.SH SETTING ANONYMITY LEVEL 106.SH SETTING ANONYMITY LEVEL
65 107
66The \fB\-a\fR option can be used to specify additional anonymity constraints. If set to 0, GNUnet will try to download the file as fast as possible, including using non-anonymous methods. If you set it to 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 your download performance is not only determined by your own anonymity level, but also by the anonymity level of the peers publishing the file. So even if you download with anonymity level 0, the peers publishing the data might be sharing with a higher anonymity level, which in this case will determine performance. Also, peers that cache content in the network always use anonymity level 1. 108The \fB\-a\fR option can be used to specify additional anonymity
67 109constraints. If set to 0, GNUnet will try to download the file as fast
68This option can be used to limit requests further than that. In particular, you can require GNUnet to receive certain amounts of traffic from other peers before sending your queries. This way, you can gain very high levels of anonymity \- at the expense of much more traffic and much higher latency. So set it only if you really believe you need it. 110as possible, including using non-anonymous methods. If you set it to
69 1111 (default), you use the standard anonymous routing algorithm (which
70The definition of ANONYMITY\-RECEIVE is the following. 0 means no anonymity is required. Otherwise a value of 'v' means that 1 out of v bytes of "anonymous" traffic can be from the local user, leaving 'v-1' 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 queries in the same time\-period. The time\-period is twice the average delay that GNUnet defers forwarded queries. 112does not explicitly leak your identity). However, a powerful
71 113adversary may still be able to perform traffic analysis (statistics)
72The 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. 114to over time infer data about your identity. You can gain better
115privacy by specifying a higher level of anonymity, which increases the
116amount of cover traffic your own traffic will get, at the expense of
117performance. Note that your download performance is not only
118determined by your own anonymity level, but also by the anonymity
119level of the peers publishing the file. So even if you download with
120anonymity level 0, the peers publishing the data might be sharing with
121a higher anonymity level, which in this case will determine
122performance. Also, peers that cache content in the network always use
123anonymity level 1.
124
125This option can be used to limit requests further than that. In
126particular, you can require GNUnet to receive certain amounts of
127traffic from other peers before sending your queries. This way, you
128can 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
130you need it.
131
132The definition of ANONYMITY\-RECEIVE is the following. 0 means no
133anonymity 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'
135bytes of cover traffic per byte on the wire. Thus, if GNUnet routes n
136bytes of messages from foreign peers (using anonymous routing), it may
137originate n/(v-1) bytes of queries in the same time\-period. The
138time\-period is twice the average delay that GNUnet defers forwarded
139queries.
140
141The 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
143throughput at all, especially if many of your fellow GNUnet\-peers all
144do the same.
73 145
74.SH FILES 146.SH FILES
75.TP 147.TP