diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/gnunet-auto-share.1 | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1 index e68ecdc08..598d8961d 100644 --- a/doc/man/gnunet-auto-share.1 +++ b/doc/man/gnunet-auto-share.1 | |||
@@ -23,30 +23,30 @@ a command line tool to automatically share an entire directory with other users | |||
23 | In order to share files with other GNUnet users, the files must first be made available to GNUnet. | 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. | 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. | 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 ".auto-share" file in the shared directory. | 26 | Which files have already been shared is remembered in a |
27 | .Pa .auto-share | ||
28 | file in the shared directory. | ||
27 | You can run the tool by hand or automatically by adding the respective options to your configuration. | 29 | You can run the tool by hand or automatically by adding the respective options to your configuration. |
28 | gnunet-auto-share has many options in common with gnunet-publish, but can only be used to index files. | 30 | gnunet-auto-share has many options in common with gnunet-publish, but can only be used to index files. |
29 | .Pp | 31 | .Pp |
30 | You can use automatic meta-data extraction (based on libextractor). | 32 | You can use automatic meta-data extraction (based on libextractor). |
31 | .Sh OPTIONS | 33 | The options are as follows: |
32 | .Bl -tag -width Ds | 34 | .Bl -tag -width Ds |
33 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL | 35 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL |
34 | This option can be used to specify additional anonymity constraints. The default is 1. | 36 | This option can be used to specify additional anonymity constraints. |
37 | The default is 1. | ||
35 | 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. | 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. |
36 | This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer). | 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). |
37 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). | 40 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). |
38 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. | 41 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. |
39 | You can gain better privacy by specifying a higher level of anonymity (using values above 1). | 42 | You can gain better privacy by specifying a higher level of anonymity (using values above 1). |
40 | This tells FS that it must hide your own requests in equivalent\-looking cover traffic. | 43 | This tells FS that it must hide your own requests in equivalent\-looking cover traffic. |
41 | This should confound an adversaries traffic analysis, increasing the time and effort it would | 44 | This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity. |
42 | take to discover your identity. However, it also can significantly reduce performance, as | 45 | However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available. |
43 | your requests will be delayed until sufficient cover traffic is available. The specific | 46 | The specific numeric value (for anonymity levels above 1) is simple: |
44 | 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. |
45 | Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent | 48 | The time-period is twice the average delay by which GNUnet artificially delays traffic. |
46 | requests of cover traffic (traffic your peer routes for others) in the same time\-period. | 49 | Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. |
47 | The time\-period is twice the average delay by which GNUnet artificially delays traffic. | ||
48 | Note that regardless of the anonymity level you choose, peers that cache content in the | ||
49 | network always use anonymity level 1. | ||
50 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | 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 | 51 | Use alternate config file (if this option is not specified, the default is |
52 | .Pa ~/.config/gnunet.conf Ns ). | 52 | .Pa ~/.config/gnunet.conf Ns ). |
@@ -82,9 +82,11 @@ Print the version number. | |||
82 | .Ss Basic example | 82 | .Ss Basic example |
83 | $ gnunet-auto-share $HOME/gnunet-share/ & | 83 | $ gnunet-auto-share $HOME/gnunet-share/ & |
84 | .Pp | 84 | .Pp |
85 | Share a directory "$HOME/gnunet-share/" | 85 | Share a directory |
86 | .Pa $HOME/gnunet-share/ | ||
86 | .Ss Basic configuration | 87 | .Ss Basic configuration |
87 | $ Share a directory "$HOME/gnunet-share/": | 88 | $ Share a directory |
89 | .Pa $HOME/gnunet-share/ | ||
88 | .Pp | 90 | .Pp |
89 | .Bd -literal -offset indent -compact | 91 | .Bd -literal -offset indent -compact |
90 | [gnunet-auto-share] | 92 | [gnunet-auto-share] |