doc/man/gnunet-download.1

   1 .TH GNUNET-DOWNLOAD "1" "31 Jan 2016" "GNUnet"
   2 .SH NAME
   3 gnunet\-download \- a command line interface for downloading files from GNUnet
   4 .SH SYNOPSIS
   5 .B gnunet\-download
   6 [\fIOPTIONS\fR] \-\- GNUNET_URI
   7 .SH DESCRIPTION
   8 .PP
   9 Download files from GNUnet.
  10
  11 .TP
  12 \fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR
  13 set desired level of receiver anonymity.  Default is 1.
  14
  15 .TP
  16 \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
  17 use config file (defaults: ~/.config/gnunet.conf)
  18
  19 .TP
  20 \fB\-D, \fB\-\-delete\-incomplete\fR
  21 causes gnunet\-download to delete incomplete downloads when aborted with
  22 CTRL\-C.  Note that complete files that are part of an incomplete recursive
  23 download will not be deleted even with this option.  Without this option,
  24 terminating gnunet\-download with a signal will cause incomplete
  25 downloads to stay on disk.  If gnunet\-download runs to (normal) completion
  26 finishing the download, this option has no effect.
  27
  28 .TP
  29 \fB\-h\fR, \fB\-\-help\fR
  30 print help page
  31
  32 .TP
  33 \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
  34 Change the loglevel.  Possible values for LOGLEVEL are
  35 ERROR, WARNING, INFO and DEBUG.
  36
  37 .TP
  38 \fB\-n\fR, \fB\-\-no-network\fR
  39 Only search locally, do not forward requests to other peers.
  40
  41 .TP
  42 \fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR
  43 write the file to FILENAME.  Hint: when recursively downloading a directory,
  44 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
  46 the URI of the file.  The final filename is constructed based on meta\-data
  47 extracted using libextractor (if available).
  48
  49 .TP
  50 \fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR
  51 set the maximum number of parallel downloads that is allowed.  More parallel
  52 downloads can, to some extent, improve the overall time to download content.
  53 However, parallel downloads also take more memory (see also option \-r which
  54 can be used to limit memory utilization) and more sockets.  This option is
  55 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).
  57 As a result, the value only matters for recursive downloads.
  58 The default value is 32.
  59
  60 .TP
  61 \fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR
  62 set the maximum number of parallel requests that is allowed.  If multiple
  63 files are downloaded, gnunet\-download will not run them in parallel if
  64 this would cause the number of pending requests to possibly exceed the
  65 given value.  This is useful since, for example, downloading dozens of
  66 multi\-gigabyte files in parallel could exhaust memory resources and would
  67 hardly improve performance.   Note that the limit only applies to this
  68 specific process and that other download activities by other processes
  69 are not included in this limit.  Consider raising this limit for large
  70 recursive downloads with many large files if memory and network
  71 bandwidth are not fully utilized and if the parallelism limit (\-p option)
  72 is not reached.  This option also only matters for recursive downloads.
  73 The default value is 4092.
  74
  75 .TP
  76 \fB\-R\fR, \fB\-\-recursive\fR
  77 download directories recursively (and in parallel). Note that the URI
  78 must belong to a GNUnet directory and that the filename given to "\-o"
  79 must end in '.gnd' \-\- otherwise, you will receive an error.  You may
  80 want to use "DIRNAME/.gnd" for the filename, this way a directory
  81 "DIRNAME/" will be created, and GNUnet's internal directory
  82 information will be stored in "DIRNAME/.gnd". However, it is also
  83 possible to specify "DIRNAME.gnd", in which case the files from the
  84 directory will end up in "DIRNAME/", while GNUnet's directory meta
  85 data will be in "DIRNAME.gnd".
  86
  87 .TP
  88 \fB\-v\fR, \fB\-\-version\fR
  89 print the version number
  90
  91 .TP
  92 \fB\-V\fR, \fB\-\-verbose\fR
  93 print progress information
  94
  95 .SH NOTES
  96 The GNUNET_URI is typically obtained from
  97 gnunet\-search. gnunet\-fs\-gtk can also be used instead of
  98 gnunet\-download.  If you ever have to abort a download, you can at
  99 any time continue it by re\-issuing gnunet\-download with the same
 100 filename. In that case GNUnet will not download blocks again that are
 101 already present. GNUnet's file\-encoding will ensure file integrity,
 102 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
 104 the download is completed.
 105
 106 .SH SETTING ANONYMITY LEVEL
 107
 108 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
 110 as possible, including using non-anonymous methods.  If you set it to
 111 1 (default), you use the standard anonymous routing algorithm (which
 112 does not explicitly leak your identity).  However, a powerful
 113 adversary may still be able to perform traffic analysis (statistics)
 114 to over time infer data about your identity.  You can gain better
 115 privacy by specifying a higher level of anonymity, which increases the
 116 amount of cover traffic your own traffic will get, at the expense of
 117 performance.  Note that your download performance is not only
 118 determined by your own anonymity level, but also by the anonymity
 119 level of the peers publishing the file.  So even if you download with
 120 anonymity level 0, the peers publishing the data might be sharing with
 121 a higher anonymity level, which in this case will determine
 122 performance.  Also, peers that cache content in the network always use
 123 anonymity level 1.
 124
 125 This option can be used to limit requests further than that. In
 126 particular, you can require GNUnet to receive certain amounts of
 127 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
 129 traffic and much higher latency. So set it only if you really believe
 130 you need it.
 131
 132 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
 134 bytes of "anonymous" traffic can be from the local user, leaving 'v-1'
 135 bytes of cover traffic per byte on the wire.  Thus, if GNUnet routes n
 136 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
 138 time\-period is twice the average delay that GNUnet defers forwarded
 139 queries.
 140
 141 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
 143 throughput at all, especially if many of your fellow GNUnet\-peers all
 144 do the same.
 145
 146 .SH FILES
 147 .TP
 148 ~/.config/gnunet.conf
 149 GNUnet configuration file
 150 .SH "REPORTING BUGS"
 151 Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
 152 .SH "SEE ALSO"
 153 \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5), \fBgnunet\-service\-fs\fP(1)