doc/man/gnunet-auto-share.1

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