Merge branch 'master' into cadet_option
[oweals/gnunet.git] / doc / man / gnunet-auto-share.1
index 9d0e159c529224a342189b975d2eb015c5f2e592..0a0e8f70221d3950b2f17f349985623c95539617 100644 (file)
@@ -1,3 +1,26 @@
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+.\" copy of the license is included in the file
+.\" FDL-1.3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation.  A copy of the license is included in the file
+.\" GPL3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
 .Dd June 18, 2012
 .Dt GNUNET-AUTO-SHARE 1
 .Os
@@ -23,29 +46,30 @@ a command line tool to automatically share an entire directory with other users
 In order to share files with other GNUnet users, the files must first be made available to GNUnet.
 This tool can be used to automatically share all files from a certain directory.
 The program will periodically scan the directory for changes and publish files that are new or that changed on GNUnet.
-Which files have already been shared is remembered in a ".auto-share" file in the shared directory.
+Which files have already been shared is remembered in a
+.Pa .auto-share
+file in the shared directory.
 You can run the tool by hand or automatically by adding the respective options to your configuration.
-gnunet\-auto\-share has many options in common with gnunet\-publish, but can only be used to index files.
+gnunet-auto-share has many options in common with gnunet-publish, but can only be used to index files.
 .Pp
-You can use automatic meta\-data extraction (based on libextractor).
-.Bl -tag -width Ds
+You can use automatic meta-data extraction (based on libextractor).
+The options are as follows:
+.Bl -tag -width indent
 .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
 This option can be used to specify additional anonymity constraints.
+The default is 1.
 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.
-This will allow other users to download the file as fast as possible, including using non-anonymous methods (DHT, direct transfer).
+This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer).
 If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
-However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity.
-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.
+However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
+You can gain better privacy by specifying a higher level of anonymity (using values above 1).
+This tells FS that it must hide your own requests in equivalent\-looking cover traffic.
+This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity.
+However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available.
+The specific numeric value (for anonymity levels above 1) is simple:
+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.
+The time-period is twice the average delay by which GNUnet artificially delays traffic.
 Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
-.Pp
-The definition of the ANONYMITY LEVEL is the following.
-0 means no anonymity is required.
-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.
-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.
-The time-period is twice the average delay that GNUnet defers forwarded queries.
-.Pp
-The default is 1 and this should be fine for most users.
-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.
 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
 Use alternate config file (if this option is not specified, the default is
 .Pa ~/.config/gnunet.conf Ns ).
@@ -81,9 +105,11 @@ Print the version number.
 .Ss Basic example
 $ gnunet-auto-share $HOME/gnunet-share/ &
 .Pp
-Share a directory "$HOME/gnunet-share/"
+Share a directory
+.Pa $HOME/gnunet-share/
 .Ss Basic configuration
-$ Share a directory "$HOME/gnunet-share/":
+$ Share a directory
+.Pa $HOME/gnunet-share/
 .Pp
 .Bd -literal -offset indent -compact
 [gnunet-auto-share]
@@ -94,12 +120,12 @@ IMMEDIATE_START = YES # start this service when the peer starts
 .Pa ~/.config/gnunet.conf
 GNUnet configuration file
 .Sh SEE ALSO
+.Xr extract 1 ,
+.Xr gnunet-download 1 ,
 .Xr gnunet-fs-gtk 1 ,
 .Xr gnunet-publish 1 ,
 .Xr gnunet-search 1 ,
-.Xr gnunet-download 1 ,
-.Xr gnunet.conf 5 ,
-.Xr extract 1
+.Xr gnunet.conf 5
 .sp
 The full documentation for gnunet is maintained as a Texinfo manual.
 If the