doc/man/gnunet-auto-share.1

   1 .Dd June 18, 2012
   2 .Dt GNUNET-AUTO-SHARE 1
   3 .Os
   4 .Sh NAME
   5 .Nm gnunet-auto-share
   6 .Nd
   7 a command line tool to automatically share an entire directory with other users
   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 | \-disable-extractor
  13 .Op Fl d | \-disable-creation-time
  14 .Op Fl h | \-help
  15 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  16 .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  17 .Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
  18 .Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
  19 .Op Fl V | \-verbose
  20 .Op Fl v | \-version
  21 .Ao Ar DIRNAME Ac
  22 .Sh DESCRIPTION
  23 In order to share files with other GNUnet users, the files must first be made available to GNUnet.
  24 This tool can be used to automatically share all files from a certain directory.
  25 The program will periodically scan the directory for changes and publish files that are new or that changed on GNUnet.
  26 Which files have already been shared is remembered in a ".auto-share" file in the shared directory.
  27 You can run the tool by hand or automatically by adding the respective options to your configuration.
  28 gnunet\-auto\-share has many options in common with gnunet\-publish, but can only be used to index files.
  29 .Pp
  30 You can use automatic meta\-data extraction (based on libextractor).
  31 .Bl -tag -width Ds
  32 .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
  33 This option can be used to specify additional anonymity constraints.
  34 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.
  35 This will allow other users to download the file as fast as possible, including using non-anonymous methods (DHT, direct transfer).
  36 If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
  37 However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity.
  38 You can gain better privacy by specifying a higher level of anonymity, which increases the amount of cover traffic your own traffic will get, at the expense of performance.
  39 Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
  40 .Pp
  41 The definition of the ANONYMITY LEVEL is the following.
  42 0 means no anonymity is required.
  43 Otherwise a value of 'v' means that 1 out of v bytes of "anonymous" traffic can be from the local user, leaving 'v-1' bytes of cover traffic per byte on the wire.
  44 Thus, if GNUnet routes n bytes of messages from foreign peers (using anonymous routing), it may originate n/(v-1) bytes of data in the same time-period.
  45 The time-period is twice the average delay that GNUnet defers forwarded queries.
  46 .Pp
  47 The default is 1 and this should be fine for most users.
  48 Also notice that if you choose very large values, you may end up having no throughput at all, especially if many of your fellow GNUnet-peers all do the same.
  49 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  50 Use alternate config file (if this option is not specified, the default is
  51 .Pa ~/.config/gnunet.conf Ns ).
  52 .It Fl D | \-disable-extractor
  53 Disable use of GNU libextractor for finding additional keywords and metadata.
  54 .It Fl d | \-disable-creation-time
  55 Disable adding the creation time to the metadata of the uploaded file.
  56 .It Fl h | \-help
  57 Print a brief help page with all the options.
  58 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  59 Change the loglevel.
  60 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
  61 .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  62 Configure logging to write logs to FILENAME.
  63 .It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
  64 Executive summary: You probably don't need it.
  65 Set the priority of the published content (default: 365).
  66 If the local database is full, GNUnet will discard the content with the lowest ranking.
  67 Note that ranks change over time depending on popularity.
  68 The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
  69 .It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
  70 Set the desired replication level.
  71 If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the file) LEVEL times to other peers before doing normal "random" replication of all content.
  72 This option can be used to push some content out into the network harder.
  73 Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas.
  74 .It Fl V | \-verbose
  75 Be verbose.
  76 Using this option causes gnunet-publish to print progress information and at the end the file identification that can be used to download the file from GNUnet.
  77 .It Fl v | \-version
  78 Print the version number.
  79 .El
  80 .Sh EXAMPLES
  81 .Ss Basic example
  82 $ gnunet-auto-share $HOME/gnunet-share/ &
  83 .Pp
  84 Share a directory "$HOME/gnunet-share/"
  85 .Ss Basic configuration
  86 $ Share a directory "$HOME/gnunet-share/":
  87 .Pp
  88 .Bd -literal -offset indent -compact
  89 [gnunet-auto-share]
  90 OPTIONS = $HOME/gnunet-share
  91 IMMEDIATE_START = YES # start this service when the peer starts
  92 .Ed
  93 .Sh FILES
  94 .Pa ~/.config/gnunet.conf
  95 GNUnet configuration file
  96 .Sh SEE ALSO
  97 .Xr gnunet-fs-gtk 1 ,
  98 .Xr gnunet-publish 1 ,
  99 .Xr gnunet-search 1 ,
 100 .Xr gnunet-download 1 ,
 101 .Xr gnunet.conf 5 ,
 102 .Xr extract 1
 103 .sp
 104 The full documentation for gnunet is maintained as a Texinfo manual.
 105 If the
 106 .Xr info 1
 107 and gnunet programs are properly installed at your site, the command
 108 .Pp
 109 .Dl info gnunet
 110 .Pp
 111 should give you access to the complete handbook,
 112 .Pp
 113 .Dl info gnunet-c-tutorial
 114 .Pp
 115 will give you access to a tutorial for developers.
 116 .sp
 117 Depending on your installation, this information is also available in
 118 .Xr gnunet 7 and
 119 .Xr gnunet-c-tutorial 7 .
 120 .\".Sh HISTORY
 121 .\".Sh AUTHORS
 122 .Sh BUGS
 123 Report bugs by using
 124 .Lk https://bugs.gnunet.org
 125 or by sending electronic mail to
 126 .Aq Mt gnunet-developers@gnu.org .