doc/man/gnunet-auto-share.1

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