diff options
Diffstat (limited to 'doc/man/gnunet-download.1')
-rw-r--r-- | doc/man/gnunet-download.1 | 51 |
1 files changed, 25 insertions, 26 deletions
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1 index 56f18e050..6244dbf6b 100644 --- a/doc/man/gnunet-download.1 +++ b/doc/man/gnunet-download.1 | |||
@@ -26,28 +26,27 @@ | |||
26 | .Os | 26 | .Os |
27 | .Sh NAME | 27 | .Sh NAME |
28 | .Nm gnunet-download | 28 | .Nm gnunet-download |
29 | .Nd | 29 | .Nd a command line interface for downloading files from GNUnet |
30 | a command line interface for downloading files from GNUnet | ||
31 | .Sh SYNOPSIS | 30 | .Sh SYNOPSIS |
32 | .Nm | 31 | .Nm |
33 | .Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL | 32 | .Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL |
34 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | 33 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
35 | .Op Fl D | \-delete\-incomplete | 34 | .Op Fl D | -delete-incomplete |
36 | .Op Fl h | \-help | 35 | .Op Fl h | -help |
37 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | 36 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
38 | .Op Fl n | \-no-network | 37 | .Op Fl n | -no-network |
39 | .Op Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME | 38 | .Op Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME |
40 | .Op Fl p Ar DOWNLOADS | Fl \-parallelism= Ns Ar DOWNLOADS | 39 | .Op Fl p Ar DOWNLOADS | Fl -parallelism= Ns Ar DOWNLOADS |
41 | .Op Fl r Ar REQUESTS | Fl \-request-parallelism= Ns Ar REQUESTS | 40 | .Op Fl r Ar REQUESTS | Fl -request-parallelism= Ns Ar REQUESTS |
42 | .Op Fl R | \-recursive | 41 | .Op Fl R | -recursive |
43 | .Op Fl v | \-version | 42 | .Op Fl v | -version |
44 | .Op Fl V | \-verbose | 43 | .Op Fl V | -verbose |
45 | .Ao Ar GNUNET_URI Ac | 44 | .Ao Ar GNUNET_URI Ac |
46 | .Sh DESCRIPTION | 45 | .Sh DESCRIPTION |
47 | Download files from GNUnet. | 46 | Download files from GNUnet. |
48 | The options are as follows: | 47 | The options are as follows: |
49 | .Bl -tag -width indent | 48 | .Bl -tag -width indent |
50 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL | 49 | .It Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL |
51 | This option can be used to specify additional anonymity constraints. | 50 | This option can be used to specify additional anonymity constraints. |
52 | The default is 1. | 51 | The default is 1. |
53 | If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key. | 52 | If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key. |
@@ -62,22 +61,22 @@ The specific numeric value (for anonymity levels above 1) is simple: | |||
62 | Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. | 61 | Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. |
63 | The time-period is twice the average delay by which GNUnet artificially delays traffic. | 62 | The time-period is twice the average delay by which GNUnet artificially delays traffic. |
64 | Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. | 63 | Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. |
65 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | 64 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
66 | Use config file (default: | 65 | Use config file (default: |
67 | .Pa ~/.config/gnunet.conf Ns ) | 66 | .Pa ~/.config/gnunet.conf Ns ) |
68 | .It Fl D | \-delete\-incomplete | 67 | .It Fl D | -delete-incomplete |
69 | Causes gnunet-download to delete incomplete downloads when aborted with CTRL-C. | 68 | Causes gnunet-download to delete incomplete downloads when aborted with CTRL-C. |
70 | Note that complete files that are part of an incomplete recursive download will not be deleted even with this option. | 69 | Note that complete files that are part of an incomplete recursive download will not be deleted even with this option. |
71 | Without this option, terminating gnunet-download with a signal will cause incomplete downloads to stay on disk. | 70 | Without this option, terminating gnunet-download with a signal will cause incomplete downloads to stay on disk. |
72 | If gnunet-download runs to (normal) completion finishing the download, this option has no effect. | 71 | If gnunet-download runs to (normal) completion finishing the download, this option has no effect. |
73 | .It Fl h | \-help | 72 | .It Fl h | -help |
74 | Print the help page. | 73 | Print the help page. |
75 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | 74 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
76 | Change the loglevel. | 75 | Change the loglevel. |
77 | Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. | 76 | Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. |
78 | .It Fl n | \-no-network | 77 | .It Fl n | -no-network |
79 | Only search locally, do not forward requests to other peers. | 78 | Only search locally, do not forward requests to other peers. |
80 | .It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME | 79 | .It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME |
81 | Write the file to | 80 | Write the file to |
82 | .Ar FILENAME . | 81 | .Ar FILENAME . |
83 | Hint: when recursively downloading a directory, append a '/' to the end of the FILENAME to create a directory of that name. | 82 | Hint: when recursively downloading a directory, append a '/' to the end of the FILENAME to create a directory of that name. |
@@ -85,7 +84,7 @@ If no FILENAME is specified, gnunet-download constructs a temporary ID from the | |||
85 | The final filename is constructed based on meta-data extracted using | 84 | The final filename is constructed based on meta-data extracted using |
86 | .Xr libextractor 1 | 85 | .Xr libextractor 1 |
87 | (if available). | 86 | (if available). |
88 | .It Fl p Ar DOWNLOADS | Fl \-parallelism= Ns Ar DOWNLOADS | 87 | .It Fl p Ar DOWNLOADS | Fl -parallelism= Ns Ar DOWNLOADS |
89 | Set the maximum number of allowed parallel downloads to | 88 | Set the maximum number of allowed parallel downloads to |
90 | .Ar DOWNLOADS . | 89 | .Ar DOWNLOADS . |
91 | More parallel downloads can, to some extent, improve the overall time to download content. | 90 | More parallel downloads can, to some extent, improve the overall time to download content. |
@@ -97,7 +96,7 @@ This option is used to limit the number of files that are downloaded in parallel | |||
97 | can be used to limit the number of blocks that are concurrently requested. | 96 | can be used to limit the number of blocks that are concurrently requested. |
98 | As a result, the value only matters for recursive downloads. | 97 | As a result, the value only matters for recursive downloads. |
99 | The default value is 32. | 98 | The default value is 32. |
100 | .It Fl r Ar REQUESTS | Fl \-request-parallelism= Ns Ar REQUESTS | 99 | .It Fl r Ar REQUESTS | Fl -request-parallelism= Ns Ar REQUESTS |
101 | Set the maximum number of parallel requests that is allowed. | 100 | Set the maximum number of parallel requests that is allowed. |
102 | 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. | 101 | 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. |
103 | This is useful since, for example, downloading dozens of multi-gigabyte files in parallel could exhaust memory resources and would hardly improve performance. | 102 | This is useful since, for example, downloading dozens of multi-gigabyte files in parallel could exhaust memory resources and would hardly improve performance. |
@@ -107,16 +106,16 @@ Consider raising this limit for large recursive downloads with many large files | |||
107 | is not reached. | 106 | is not reached. |
108 | This option also only matters for recursive downloads. | 107 | This option also only matters for recursive downloads. |
109 | The default value is 4092. | 108 | The default value is 4092. |
110 | .It Fl R | \-recursive | 109 | .It Fl R | -recursive |
111 | Download directories recursively (and in parallel). | 110 | Download directories recursively (and in parallel). |
112 | Note that the URI must belong to a GNUnet directory and that the filename given to | 111 | Note that the URI must belong to a GNUnet directory and that the filename given to |
113 | .Fl o | 112 | .Fl o |
114 | must end in '.gnd' \(em otherwise, you will receive an error. | 113 | must end in '.gnd' \(em otherwise, you will receive an error. |
115 | 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". | 114 | 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". |
116 | 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". | 115 | 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". |
117 | .It Fl v | \-version | 116 | .It Fl v | -version |
118 | Print the version number. | 117 | Print the version number. |
119 | .It Fl V | \-verbose | 118 | .It Fl V | -verbose |
120 | Print progress information. | 119 | Print progress information. |
121 | .El | 120 | .El |
122 | .Ss NOTES | 121 | .Ss NOTES |