diff options
Diffstat (limited to 'doc/man/gnunet-download.1')
-rw-r--r-- | doc/man/gnunet-download.1 | 57 |
1 files changed, 32 insertions, 25 deletions
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1 index 824c2414d..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 |
3 | gnunet\-download \- a command line interface for downloading files from GNUnet | 3 | gnunet\-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 | ||
9 | Download files from GNUnet. | 8 | Download 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 |
13 | set desired level of receiver anonymity. Default is 1. | 11 | set 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 |
17 | use config file (defaults: ~/.config/gnunet.conf) | 14 | use 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 |
21 | causes gnunet\-download to delete incomplete downloads when aborted with | 17 | causes 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, | |||
24 | terminating gnunet\-download with a signal will cause incomplete | 20 | terminating gnunet\-download with a signal will cause incomplete |
25 | downloads to stay on disk. If gnunet\-download runs to (normal) completion | 21 | downloads to stay on disk. If gnunet\-download runs to (normal) completion |
26 | finishing the download, this option has no effect. | 22 | finishing 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 |
30 | print help page | 25 | print 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 |
34 | Change the loglevel. Possible values for LOGLEVEL are | 28 | Change the loglevel. Possible values for LOGLEVEL are |
35 | ERROR, WARNING, INFO and DEBUG. | 29 | ERROR, 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 |
39 | Only search locally, do not forward requests to other peers. | 32 | Only 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 |
43 | write the file to FILENAME. Hint: when recursively downloading a directory, | 35 | write 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. | |||
45 | If no FILENAME is specified, gnunet\-download constructs a temporary ID from | 37 | If no FILENAME is specified, gnunet\-download constructs a temporary ID from |
46 | the URI of the file. The final filename is constructed based on meta\-data | 38 | the URI of the file. The final filename is constructed based on meta\-data |
47 | extracted using libextractor (if available). | 39 | extracted 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 |
51 | set the maximum number of parallel downloads that is allowed. More parallel | 42 | set 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 | |||
56 | be used to limit the number of blocks that are concurrently requested). | 47 | be used to limit the number of blocks that are concurrently requested). |
57 | As a result, the value only matters for recursive downloads. | 48 | As a result, the value only matters for recursive downloads. |
58 | The default value is 32. | 49 | The 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 |
62 | set the maximum number of parallel requests that is allowed. If multiple | 52 | set 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 | |||
71 | bandwidth are not fully utilized and if the parallelism limit (\-p option) | 61 | bandwidth are not fully utilized and if the parallelism limit (\-p option) |
72 | is not reached. This option also only matters for recursive downloads. | 62 | is not reached. This option also only matters for recursive downloads. |
73 | The default value is 4092. | 63 | The default value is 4092. |
74 | |||
75 | .TP | 64 | .TP |
76 | \fB\-R\fR, \fB\-\-recursive\fR | 65 | \fB\-R\fR, \fB\-\-recursive\fR |
77 | download directories recursively (and in parallel). Note that the URI | 66 | download directories recursively (and in parallel). Note that the URI |
@@ -83,15 +72,12 @@ information will be stored in "DIRNAME/.gnd". However, it is also | |||
83 | possible to specify "DIRNAME.gnd", in which case the files from the | 72 | possible to specify "DIRNAME.gnd", in which case the files from the |
84 | directory will end up in "DIRNAME/", while GNUnet's directory meta | 73 | directory will end up in "DIRNAME/", while GNUnet's directory meta |
85 | data will be in "DIRNAME.gnd". | 74 | data will be in "DIRNAME.gnd". |
86 | |||
87 | .TP | 75 | .TP |
88 | \fB\-v\fR, \fB\-\-version\fR | 76 | \fB\-v\fR, \fB\-\-version\fR |
89 | print the version number | 77 | print the version number |
90 | |||
91 | .TP | 78 | .TP |
92 | \fB\-V\fR, \fB\-\-verbose\fR | 79 | \fB\-V\fR, \fB\-\-verbose\fR |
93 | print progress information | 80 | print progress information |
94 | |||
95 | .SH NOTES | 81 | .SH NOTES |
96 | The GNUNET_URI is typically obtained from | 82 | The GNUNET_URI is typically obtained from |
97 | gnunet\-search. gnunet\-fs\-gtk can also be used instead of | 83 | gnunet\-search. gnunet\-fs\-gtk can also be used instead of |
@@ -102,9 +88,7 @@ already present. GNUnet's file\-encoding will ensure file integrity, | |||
102 | even if the existing file was not downloaded from GNUnet in the first | 88 | even if the existing file was not downloaded from GNUnet in the first |
103 | place. Temporary information will be appended to the target file until | 89 | place. Temporary information will be appended to the target file until |
104 | the download is completed. | 90 | the download is completed. |
105 | |||
106 | .SH SETTING ANONYMITY LEVEL | 91 | .SH SETTING ANONYMITY LEVEL |
107 | |||
108 | The \fB\-a\fR option can be used to specify additional anonymity | 92 | The \fB\-a\fR option can be used to specify additional anonymity |
109 | constraints. If set to 0, GNUnet will try to download the file as fast | 93 | constraints. If set to 0, GNUnet will try to download the file as fast |
110 | as possible, including using non-anonymous methods. If you set it to | 94 | as 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 | |||
121 | a higher anonymity level, which in this case will determine | 105 | a higher anonymity level, which in this case will determine |
122 | performance. Also, peers that cache content in the network always use | 106 | performance. Also, peers that cache content in the network always use |
123 | anonymity level 1. | 107 | anonymity level 1. |
124 | 108 | .PP | |
125 | This option can be used to limit requests further than that. In | 109 | This option can be used to limit requests further than that. In |
126 | particular, you can require GNUnet to receive certain amounts of | 110 | particular, you can require GNUnet to receive certain amounts of |
127 | traffic from other peers before sending your queries. This way, you | 111 | traffic from other peers before sending your queries. This way, you |
128 | can gain very high levels of anonymity \- at the expense of much more | 112 | can gain very high levels of anonymity \- at the expense of much more |
129 | traffic and much higher latency. So set it only if you really believe | 113 | traffic and much higher latency. So set it only if you really believe |
130 | you need it. | 114 | you need it. |
131 | 115 | .PP | |
132 | The definition of ANONYMITY\-RECEIVE is the following. 0 means no | 116 | The definition of ANONYMITY\-RECEIVE is the following. 0 means no |
133 | anonymity is required. Otherwise a value of 'v' means that 1 out of v | 117 | anonymity is required. Otherwise a value of 'v' means that 1 out of v |
134 | bytes of "anonymous" traffic can be from the local user, leaving 'v-1' | 118 | bytes of "anonymous" traffic can be from the local user, leaving 'v-1' |
@@ -137,17 +121,40 @@ bytes of messages from foreign peers (using anonymous routing), it may | |||
137 | originate n/(v-1) bytes of queries in the same time\-period. The | 121 | originate n/(v-1) bytes of queries in the same time\-period. The |
138 | time\-period is twice the average delay that GNUnet defers forwarded | 122 | time\-period is twice the average delay that GNUnet defers forwarded |
139 | queries. | 123 | queries. |
140 | 124 | .PP | |
141 | The default is 1 and this should be fine for most users. Also notice | 125 | The default is 1 and this should be fine for most users. Also notice |
142 | that if you choose very large values, you may end up having no | 126 | that if you choose very large values, you may end up having no |
143 | throughput at all, especially if many of your fellow GNUnet\-peers all | 127 | throughput at all, especially if many of your fellow GNUnet\-peers all |
144 | do the same. | 128 | do the same. |
145 | |||
146 | .SH FILES | 129 | .SH FILES |
147 | .TP | 130 | .TP |
148 | ~/.config/gnunet.conf | 131 | ~/.config/gnunet.conf |
149 | GNUnet configuration file | 132 | GNUnet configuration file |
150 | .SH "REPORTING BUGS" | 133 | .SH BUGS |
151 | Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 134 | Report bugs to <https://gnunet.org/bugs/> or by sending electronic |
152 | .SH "SEE ALSO" | 135 | mail to <gnunet\-developers@gnu.org> |
153 | \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5), \fBgnunet\-service\-fs\fP(1) | 136 | .SH SEE ALSO |
137 | \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), | ||
138 | \fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5), | ||
139 | \fBgnunet\-service\-fs\fP(1) | ||
140 | .PP | ||
141 | The full documentation for | ||
142 | .B gnunet | ||
143 | is maintained as a Texinfo manual. | ||
144 | If the | ||
145 | .B info | ||
146 | and | ||
147 | .B gnunet | ||
148 | programs are properly installed at your site, the command | ||
149 | .IP | ||
150 | .B info gnunet | ||
151 | .PP | ||
152 | should give you access to the complete handbook, | ||
153 | .IP | ||
154 | .B info gnunet-c-tutorial | ||
155 | .PP | ||
156 | will give you access to a tutorial for developers. | ||
157 | .PP | ||
158 | Depending on your installation, this information is also | ||
159 | available in | ||
160 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | ||