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