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
  27 .Pa .auto-share
  28 file in the shared directory.
  29 You can run the tool by hand or automatically by adding the respective options to your configuration.
  30 gnunet-auto-share has many options in common with gnunet-publish, but can only be used to index files.
  31 .Pp
  32 You can use automatic meta-data extraction (based on libextractor).
  33 The options are as follows:
  34 .Bl -tag -width Ds
  35 .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
  36 This option can be used to specify additional anonymity constraints.
  37 The default is 1.
  38 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.
  39 This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer).
  40 If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
  41 However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
  42 You can gain better privacy by specifying a higher level of anonymity (using values above 1).
  43 This tells FS that it must hide your own requests in equivalent\-looking cover traffic.
  44 This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity.
  45 However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available.
  46 The specific numeric value (for anonymity levels above 1) is simple:
  47 Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period.
  48 The time-period is twice the average delay by which GNUnet artificially delays traffic.
  49 Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
  50 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  51 Use alternate config file (if this option is not specified, the default is
  52 .Pa ~/.config/gnunet.conf Ns ).
  53 .It Fl D | \-disable-extractor
  54 Disable use of GNU libextractor for finding additional keywords and metadata.
  55 .It Fl d | \-disable-creation-time
  56 Disable adding the creation time to the metadata of the uploaded file.
  57 .It Fl h | \-help
  58 Print a brief help page with all the options.
  59 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  60 Change the loglevel.
  61 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
  62 .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  63 Configure logging to write logs to FILENAME.
  64 .It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
  65 Executive summary: You probably don't need it.
  66 Set the priority of the published content (default: 365).
  67 If the local database is full, GNUnet will discard the content with the lowest ranking.
  68 Note that ranks change over time depending on popularity.
  69 The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
  70 .It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
  71 Set the desired replication level.
  72 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.
  73 This option can be used to push some content out into the network harder.
  74 Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas.
  75 .It Fl V | \-verbose
  76 Be verbose.
  77 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.
  78 .It Fl v | \-version
  79 Print the version number.
  80 .El
  81 .Sh EXAMPLES
  82 .Ss Basic example
  83 $ gnunet-auto-share $HOME/gnunet-share/ &
  84 .Pp
  85 Share a directory
  86 .Pa $HOME/gnunet-share/
  87 .Ss Basic configuration
  88 $ Share a directory
  89 .Pa $HOME/gnunet-share/
  90 .Pp
  91 .Bd -literal -offset indent -compact
  92 [gnunet-auto-share]
  93 OPTIONS = $HOME/gnunet-share
  94 IMMEDIATE_START = YES # start this service when the peer starts
  95 .Ed
  96 .Sh FILES
  97 .Pa ~/.config/gnunet.conf
  98 GNUnet configuration file
  99 .Sh SEE ALSO
 100 .Xr extract 1 ,
 101 .Xr gnunet-download 1 ,
 102 .Xr gnunet-fs-gtk 1 ,
 103 .Xr gnunet-publish 1 ,
 104 .Xr gnunet-search 1 ,
 105 .Xr gnunet.conf 5
 106 .sp
 107 The full documentation for gnunet is maintained as a Texinfo manual.
 108 If the
 109 .Xr info 1
 110 and gnunet programs are properly installed at your site, the command
 111 .Pp
 112 .Dl info gnunet
 113 .Pp
 114 should give you access to the complete handbook,
 115 .Pp
 116 .Dl info gnunet-c-tutorial
 117 .Pp
 118 will give you access to a tutorial for developers.
 119 .sp
 120 Depending on your installation, this information is also available in
 121 .Xr gnunet 7 and
 122 .Xr gnunet-c-tutorial 7 .
 123 .\".Sh HISTORY
 124 .\".Sh AUTHORS
 125 .Sh BUGS
 126 Report bugs by using
 127 .Lk https://bugs.gnunet.org
 128 or by sending electronic mail to
 129 .Aq Mt gnunet-developers@gnu.org .