doc/man/gnunet-auto-share.1

   1 .\" This file is part of GNUnet.
   2 .\" Copyright (C) 2001-2019 GNUnet e.V.
   3 .\"
   4 .\" Permission is granted to copy, distribute and/or modify this document
   5 .\" under the terms of the GNU Free Documentation License, Version 1.3 or
   6 .\" any later version published by the Free Software Foundation; with no
   7 .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
   8 .\" copy of the license is included in the file
   9 .\" FDL-1.3.
  10 .\"
  11 .\" A copy of the license is also available from the Free Software
  12 .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
  13 .\"
  14 .\" Alternately, this document is also available under the General
  15 .\" Public License, version 3 or later, as published by the Free Software
  16 .\" Foundation.  A copy of the license is included in the file
  17 .\" GPL3.
  18 .\"
  19 .\" A copy of the license is also available from the Free Software
  20 .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
  21 .\"
  22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23 .\"
  24 .Dd June 18, 2012
  25 .Dt GNUNET-AUTO-SHARE 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-auto-share
  29 .Nd
  30 a command line tool to automatically share an entire directory with other users
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
  34 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  35 .Op Fl D | \-disable-extractor
  36 .Op Fl d | \-disable-creation-time
  37 .Op Fl h | \-help
  38 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  39 .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  40 .Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
  41 .Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
  42 .Op Fl V | \-verbose
  43 .Op Fl v | \-version
  44 .Ao Ar DIRNAME Ac
  45 .Sh DESCRIPTION
  46 In order to share files with other GNUnet users, the files must first be made available to GNUnet.
  47 This tool can be used to automatically share all files from a certain directory.
  48 The program will periodically scan the directory for changes and publish files that are new or that changed on GNUnet.
  49 Which files have already been shared is remembered in a
  50 .Pa .auto-share
  51 file in the shared directory.
  52 You can run the tool by hand or automatically by adding the respective options to your configuration.
  53 gnunet-auto-share has many options in common with gnunet-publish, but can only be used to index files.
  54 .Pp
  55 You can use automatic meta-data extraction (based on libextractor).
  56 The options are as follows:
  57 .Bl -tag -width indent
  58 .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
  59 This option can be used to specify additional anonymity constraints.
  60 The default is 1.
  61 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.
  62 This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer).
  63 If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
  64 However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
  65 You can gain better privacy by specifying a higher level of anonymity (using values above 1).
  66 This tells FS that it must hide your own requests in equivalent\-looking cover traffic.
  67 This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity.
  68 However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available.
  69 The specific numeric value (for anonymity levels above 1) is simple:
  70 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.
  71 The time-period is twice the average delay by which GNUnet artificially delays traffic.
  72 Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
  73 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  74 Use alternate config file (if this option is not specified, the default is
  75 .Pa ~/.config/gnunet.conf Ns ).
  76 .It Fl D | \-disable-extractor
  77 Disable use of GNU libextractor for finding additional keywords and metadata.
  78 .It Fl d | \-disable-creation-time
  79 Disable adding the creation time to the metadata of the uploaded file.
  80 .It Fl h | \-help
  81 Print a brief help page with all the options.
  82 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  83 Change the loglevel.
  84 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
  85 .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  86 Configure logging to write logs to FILENAME.
  87 .It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
  88 Executive summary: You probably don't need it.
  89 Set the priority of the published content (default: 365).
  90 If the local database is full, GNUnet will discard the content with the lowest ranking.
  91 Note that ranks change over time depending on popularity.
  92 The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
  93 .It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
  94 Set the desired replication level.
  95 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.
  96 This option can be used to push some content out into the network harder.
  97 Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas.
  98 .It Fl V | \-verbose
  99 Be verbose.
 100 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.
 101 .It Fl v | \-version
 102 Print the version number.
 103 .El
 104 .Sh EXAMPLES
 105 .Ss Basic example
 106 $ gnunet-auto-share $HOME/gnunet-share/ &
 107 .Pp
 108 Share a directory
 109 .Pa $HOME/gnunet-share/
 110 .Ss Basic configuration
 111 $ Share a directory
 112 .Pa $HOME/gnunet-share/
 113 .Pp
 114 .Bd -literal -offset indent -compact
 115 [gnunet-auto-share]
 116 OPTIONS = $HOME/gnunet-share
 117 IMMEDIATE_START = YES # start this service when the peer starts
 118 .Ed
 119 .Sh FILES
 120 .Pa ~/.config/gnunet.conf
 121 GNUnet configuration file
 122 .Sh SEE ALSO
 123 .Xr extract 1 ,
 124 .Xr gnunet-download 1 ,
 125 .Xr gnunet-fs-gtk 1 ,
 126 .Xr gnunet-publish 1 ,
 127 .Xr gnunet-search 1 ,
 128 .Xr gnunet.conf 5
 129 .sp
 130 The full documentation for gnunet is maintained as a Texinfo manual.
 131 If the
 132 .Xr info 1
 133 and gnunet programs are properly installed at your site, the command
 134 .Pp
 135 .Dl info gnunet
 136 .Pp
 137 should give you access to the complete handbook,
 138 .Pp
 139 .Dl info gnunet-c-tutorial
 140 .Pp
 141 will give you access to a tutorial for developers.
 142 .sp
 143 Depending on your installation, this information is also available in
 144 .Xr gnunet 7 and
 145 .Xr gnunet-c-tutorial 7 .
 146 .\".Sh HISTORY
 147 .\".Sh AUTHORS
 148 .Sh BUGS
 149 Report bugs by using
 150 .Lk https://bugs.gnunet.org
 151 or by sending electronic mail to
 152 .Aq Mt gnunet-developers@gnu.org .