doc/man/gnunet-download.1

   1 .Dd January 31, 2016
   2 .Dt GNUNET-DOWNLOAD 1
   3 .Os
   4 .Sh NAME
   5 .Nm gnunet-download
   6 .Nd
   7 a command line interface for downloading files from GNUnet
   8 .Sh SYNOPSIS
   9 .Nm
  10 .Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
  11 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  12 .Op Fl D | \-delete\-incomplete
  13 .Op Fl h | \-help
  14 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  15 .Op Fl n | \-no-network
  16 .Op Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME
  17 .Op Fl p Ar DOWNLOADS | Fl \-parallelism= Ns Ar DOWNLOADS
  18 .Op Fl r Ar REQUESTS | Fl \-request-parallelism= Ns Ar REQUESTS
  19 .Op Fl R | \-recursive
  20 .Op Fl v | \-version
  21 .Op Fl V | \-verbose
  22 .Ao Ar GNUNET_URI Ac
  23 .Sh DESCRIPTION
  24 Download files from GNUnet.
  25 .Bl -tag -width Ds
  26 .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
  27 This option can be used to specify additional anonymity constraints. The default is 1.
  28 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.
  29 This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer).
  30 If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
  31 However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
  32 You can gain better privacy by specifying a higher level of anonymity (using values above 1).
  33 This tells FS that it must hide your own requests in equivalent\-looking cover traffic.
  34 This should confound an adversaries traffic analysis, increasing the time and effort it would
  35 take to discover your identity. However, it also can significantly reduce performance, as
  36 your requests will be delayed until sufficient cover traffic is available.  The specific
  37 numeric value (for anonymity levels above 1) is simple:
  38 Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent
  39 requests of cover traffic (traffic your peer routes for others) in the same time\-period.
  40 The time\-period is twice the average delay by which GNUnet artificially delays traffic.
  41 Note that regardless of the anonymity level you choose, peers that cache content in the
  42 network always use anonymity level 1.
  43 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  44 Use config file (default:
  45 .Pa ~/.config/gnunet.conf Ns )
  46 .It Fl D | \-delete\-incomplete
  47 Causes gnunet-download to delete incomplete downloads when aborted with CTRL-C.
  48 Note that complete files that are part of an incomplete recursive download will not be deleted even with this option.
  49 Without this option, terminating gnunet-download with a signal will cause incomplete downloads to stay on disk.
  50 If gnunet-download runs to (normal) completion finishing the download, this option has no effect.
  51 .It Fl h | \-help
  52 Print help page
  53 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  54 Change the loglevel.
  55 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
  56 .It Fl n | \-no-network
  57 Only search locally, do not forward requests to other peers.
  58 .It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME
  59 Write the file to FILENAME.
  60 Hint: when recursively downloading a directory, append a '/' to the end of the FILENAME to create a directory of that name.
  61 If no FILENAME is specified, gnunet-download constructs a temporary ID from the URI of the file.
  62 The final filename is constructed based on meta-data extracted using libextractor (if available).
  63 .It Fl p Ar DOWNLOADS | Fl \-parallelism= Ns Ar DOWNLOADS
  64 Set the maximum number of parallel downloads that is allowed.
  65 More parallel downloads can, to some extent, improve the overall time to download content.
  66 However, parallel downloads also take more memory (see also
  67 .Fl r
  68 which can be used to limit memory utilization) and more sockets.
  69 This option is used to limit the number of files that are downloaded in parallel.
  70 .Fl r
  71 can be used to limit the number of blocks that are concurrently requested.
  72 As a result, the value only matters for recursive downloads.
  73 The default value is 32.
  74 .It Fl r Ar REQUESTS | Fl \-request-parallelism= Ns Ar REQUESTS
  75 Set the maximum number of parallel requests that is allowed.
  76 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.
  77 This is useful since, for example, downloading dozens of multi-gigabyte files in parallel could exhaust memory resources and would hardly improve performance.
  78 Note that the limit only applies to this specific process and that other download activities by other processes are not included in this limit.
  79 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
  80 .Pq Fl p
  81 is not reached.
  82 This option also only matters for recursive downloads.
  83 The default value is 4092.
  84 .It Fl R | \-recursive
  85 Download directories recursively (and in parallel).
  86 Note that the URI must belong to a GNUnet directory and that the filename given to
  87 .Fl o
  88 must end in '.gnd' \(em otherwise, you will receive an error.
  89 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".
  90 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".
  91 .It Fl v | \-version
  92 print the version number
  93 .It Fl V | \-verbose
  94 print progress information
  95 .El
  96 .Ss NOTES
  97 The GNUNET_URI is typically obtained from
  98 .Xr gnunet-search 1 .
  99 .Xr gnunet-fs-gtk 1
 100 can also be used instead of gnunet-download.
 101 If you ever have to abort a download, you can at any time continue it by re-issuing gnunet-download with the same filename.
 102 In that case GNUnet will not download blocks again that are already present.
 103 GNUnet's file-encoding will ensure file integrity, even if the existing file was not downloaded from GNUnet in the first place.
 104 Temporary information will be appended to the target file until the download is completed.
 105 .Sh FILES
 106 .Pa ~/.config/gnunet.conf
 107 GNUnet configuration file
 108 .Sh SEE ALSO
 109 .Xr gnunet-fs-gtk 1 ,
 110 .Xr gnunet-publish 1 ,
 111 .Xr gnunet-search 1 ,
 112 .Xr gnunet-service-fs 1 ,
 113 .Xr gnunet.conf 5
 114 .sp
 115 The full documentation for gnunet is maintained as a Texinfo manual.
 116 If the
 117 .Xr info 1
 118 and gnunet programs are properly installed at your site, the command
 119 .Pp
 120 .Dl info gnunet
 121 .Pp
 122 should give you access to the complete handbook,
 123 .Pp
 124 .Dl info gnunet-c-tutorial
 125 .Pp
 126 will give you access to a tutorial for developers.
 127 .sp
 128 Depending on your installation, this information is also available in
 129 .Xr gnunet 7 and
 130 .Xr gnunet-c-tutorial 7 .
 131 .\".Sh HISTORY
 132 .\".Sh AUTHORS
 133 .Sh BUGS
 134 Report bugs by using
 135 .Lk https://bugs.gnunet.org
 136 or by sending electronic mail to
 137 .Aq Mt gnunet-developers@gnu.org .