diff options
author | Christian Grothoff <christian@grothoff.org> | 2019-04-20 21:45:25 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2019-04-20 21:45:25 +0200 |
commit | 32485c3b58983ada1943b3fa27eac3b0cff2a9da (patch) | |
tree | 1e439c5054194faef2f52a86f16a7c13f5f5aa20 /doc/man | |
parent | 5fab02b10baef639121723aacf3b1351e5db8003 (diff) | |
download | gnunet-32485c3b58983ada1943b3fa27eac3b0cff2a9da.tar.gz gnunet-32485c3b58983ada1943b3fa27eac3b0cff2a9da.zip |
try to address #5660:
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/gnunet-auto-share.1 | 29 | ||||
-rw-r--r-- | doc/man/gnunet-download.1 | 43 | ||||
-rw-r--r-- | doc/man/gnunet-publish.1 | 39 | ||||
-rw-r--r-- | doc/man/gnunet-search.1 | 37 |
4 files changed, 65 insertions, 83 deletions
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1 index 19cb998fa..e68ecdc08 100644 --- a/doc/man/gnunet-auto-share.1 +++ b/doc/man/gnunet-auto-share.1 | |||
@@ -28,24 +28,25 @@ You can run the tool by hand or automatically by adding the respective options t | |||
28 | gnunet-auto-share has many options in common with gnunet-publish, but can only be used to index files. | 28 | gnunet-auto-share has many options in common with gnunet-publish, but can only be used to index files. |
29 | .Pp | 29 | .Pp |
30 | You can use automatic meta-data extraction (based on libextractor). | 30 | You can use automatic meta-data extraction (based on libextractor). |
31 | .Sh OPTIONS | ||
31 | .Bl -tag -width Ds | 32 | .Bl -tag -width Ds |
32 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL | 33 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL |
33 | This option can be used to specify additional anonymity constraints. | 34 | This option can be used to specify additional anonymity constraints. The default is 1. |
34 | 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. | 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. |
35 | This will allow other users to download the file as fast as possible, including using non-anonymous methods (DHT, direct transfer). | 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). |
36 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). | 37 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). |
37 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity. | 38 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. |
38 | 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. | 39 | You can gain better privacy by specifying a higher level of anonymity (using values above 1). |
39 | Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. | 40 | This tells FS that it must hide your own requests in equivalent\-looking cover traffic. |
40 | .Pp | 41 | This should confound an adversaries traffic analysis, increasing the time and effort it would |
41 | The definition of the ANONYMITY LEVEL is the following. | 42 | take to discover your identity. However, it also can significantly reduce performance, as |
42 | 0 means no anonymity is required. | 43 | your requests will be delayed until sufficient cover traffic is available. The specific |
43 | 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. | 44 | numeric value (for anonymity levels above 1) is simple: |
44 | 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. | 45 | Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent |
45 | The time-period is twice the average delay that GNUnet defers forwarded queries. | 46 | requests of cover traffic (traffic your peer routes for others) in the same time\-period. |
46 | .Pp | 47 | The time\-period is twice the average delay by which GNUnet artificially delays traffic. |
47 | The default is 1 and this should be fine for most users. | 48 | Note that regardless of the anonymity level you choose, peers that cache content in the |
48 | 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. | 49 | network always use anonymity level 1. |
49 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | 50 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
50 | 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 |
51 | .Pa ~/.config/gnunet.conf Ns ). | 52 | .Pa ~/.config/gnunet.conf Ns ). |
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1 index e2c4ab365..f278694c3 100644 --- a/doc/man/gnunet-download.1 +++ b/doc/man/gnunet-download.1 | |||
@@ -24,8 +24,22 @@ a command line interface for downloading files from GNUnet | |||
24 | Download files from GNUnet. | 24 | Download files from GNUnet. |
25 | .Bl -tag -width Ds | 25 | .Bl -tag -width Ds |
26 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL | 26 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL |
27 | Set desired level of receiver anonymity. | 27 | This option can be used to specify additional anonymity constraints. The default is 1. |
28 | Default is 1. | 28 | 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. |
29 | This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer). | ||
30 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). | ||
31 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. | ||
32 | You can gain better privacy by specifying a higher level of anonymity (using values above 1). | ||
33 | This tells FS that it must hide your own requests in equivalent\-looking cover traffic. | ||
34 | This should confound an adversaries traffic analysis, increasing the time and effort it would | ||
35 | take to discover your identity. However, it also can significantly reduce performance, as | ||
36 | your requests will be delayed until sufficient cover traffic is available. The specific | ||
37 | numeric value (for anonymity levels above 1) is simple: | ||
38 | Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent | ||
39 | requests of cover traffic (traffic your peer routes for others) in the same time\-period. | ||
40 | The time\-period is twice the average delay by which GNUnet artificially delays traffic. | ||
41 | Note that regardless of the anonymity level you choose, peers that cache content in the | ||
42 | network always use anonymity level 1. | ||
29 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | 43 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
30 | Use config file (default: | 44 | Use config file (default: |
31 | .Pa ~/.config/gnunet.conf Ns ) | 45 | .Pa ~/.config/gnunet.conf Ns ) |
@@ -88,31 +102,6 @@ If you ever have to abort a download, you can at any time continue it by re-issu | |||
88 | In that case GNUnet will not download blocks again that are already present. | 102 | In that case GNUnet will not download blocks again that are already present. |
89 | GNUnet's file-encoding will ensure file integrity, even if the existing file was not downloaded from GNUnet in the first place. | 103 | GNUnet's file-encoding will ensure file integrity, even if the existing file was not downloaded from GNUnet in the first place. |
90 | Temporary information will be appended to the target file until the download is completed. | 104 | Temporary information will be appended to the target file until the download is completed. |
91 | .Ss SETTING ANONYMITY LEVEL | ||
92 | The | ||
93 | .Fl a | ||
94 | option can be used to specify additional anonymity constraints. | ||
95 | If set to 0, GNUnet will try to download the file as fast as possible, including using non-anonymous methods. | ||
96 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). | ||
97 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity. | ||
98 | 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. | ||
99 | Note that your download performance is not only determined by your own anonymity level, but also by the anonymity level of the peers publishing the file. | ||
100 | So even if you download with anonymity level 0, the peers publishing the data might be sharing with a higher anonymity level, which in this case will determine performance. | ||
101 | Also, peers that cache content in the network always use anonymity level 1. | ||
102 | .Pp | ||
103 | This option can be used to limit requests further than that. | ||
104 | In particular, you can require GNUnet to receive certain amounts of traffic from other peers before sending your queries. | ||
105 | This way, you can gain very high levels of anonymity - at the expense of much more traffic and much higher latency. | ||
106 | So set it only if you really believe you need it. | ||
107 | .Pp | ||
108 | The definition of ANONYMITY\-RECEIVE is the following. | ||
109 | 0 means no anonymity is required. | ||
110 | 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. | ||
111 | Thus, if GNUnet routes n bytes of messages from foreign peers (using anonymous routing), it may originate n/(v-1) bytes of queries in the same time\-period. | ||
112 | The time\-period is twice the average delay that GNUnet defers forwarded queries. | ||
113 | .Pp | ||
114 | The default is 1 and this should be fine for most users. | ||
115 | 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. | ||
116 | .Sh FILES | 105 | .Sh FILES |
117 | .Pa ~/.config/gnunet.conf | 106 | .Pa ~/.config/gnunet.conf |
118 | GNUnet configuration file | 107 | GNUnet configuration file |
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1 index 0cfad4c78..b003f27e0 100644 --- a/doc/man/gnunet-publish.1 +++ b/doc/man/gnunet-publish.1 | |||
@@ -125,7 +125,25 @@ However, indexing only works if the indexed file can be read (using the same abs | |||
125 | If this is not the case, indexing will fail (and gnunet-publish will automatically revert to publishing instead). | 125 | If this is not the case, indexing will fail (and gnunet-publish will automatically revert to publishing instead). |
126 | Regardless of which method is used to publish the file, the file will be slowly (depending on how often it is requested and on how much bandwidth is available) dispersed into the network. | 126 | Regardless of which method is used to publish the file, the file will be slowly (depending on how often it is requested and on how much bandwidth is available) dispersed into the network. |
127 | If you publish or index a file and then leave the network, it will almost always NOT be available anymore. | 127 | If you publish or index a file and then leave the network, it will almost always NOT be available anymore. |
128 | .Sh OPTIONS | ||
128 | .Bl -tag -width Ds | 129 | .Bl -tag -width Ds |
130 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL | ||
131 | This option can be used to specify additional anonymity constraints. The default is 1. | ||
132 | 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. | ||
133 | This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer). | ||
134 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). | ||
135 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. | ||
136 | You can gain better privacy by specifying a higher level of anonymity (using values above 1). | ||
137 | This tells FS that it must hide your own requests in equivalent\-looking cover traffic. | ||
138 | This should confound an adversaries traffic analysis, increasing the time and effort it would | ||
139 | take to discover your identity. However, it also can significantly reduce performance, as | ||
140 | your requests will be delayed until sufficient cover traffic is available. The specific | ||
141 | numeric value (for anonymity levels above 1) is simple: | ||
142 | Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent | ||
143 | requests of cover traffic (traffic your peer routes for others) in the same time\-period. | ||
144 | The time\-period is twice the average delay by which GNUnet artificially delays traffic. | ||
145 | Note that regardless of the anonymity level you choose, peers that cache content in the | ||
146 | network always use anonymity level 1. | ||
129 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | 147 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
130 | Use alternate config file FILENAME. | 148 | Use alternate config file FILENAME. |
131 | If this option is not specified, the default is | 149 | If this option is not specified, the default is |
@@ -192,27 +210,6 @@ Print the version number. | |||
192 | Be verbose. | 210 | Be verbose. |
193 | 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. | 211 | 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. |
194 | .El | 212 | .El |
195 | .Ss SETTING ANONYMITY LEVEL | ||
196 | .Bl -tag -width Ds | ||
197 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL | ||
198 | .El | ||
199 | .sp | ||
200 | The \fB\-a\fR option can be used to specify additional anonymity constraints. | ||
201 | 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. | ||
202 | This will allow other users to download the file as fast as possible, including using non-anonymous methods (DHT, direct transfer). | ||
203 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). | ||
204 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity. | ||
205 | 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. | ||
206 | Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. | ||
207 | .Pp | ||
208 | The definition of the ANONYMITY LEVEL is the following. | ||
209 | 0 means no anonymity is required. | ||
210 | 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. | ||
211 | 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. | ||
212 | The time\-period is twice the average delay that GNUnet defers forwarded queries. | ||
213 | .Pp | ||
214 | The default is 1 and this should be fine for most users. | ||
215 | 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. | ||
216 | .Sh EXAMPLES | 213 | .Sh EXAMPLES |
217 | .Ss BASIC EXAMPLES | 214 | .Ss BASIC EXAMPLES |
218 | Index a file COPYING: | 215 | Index a file COPYING: |
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1 index d4ad4b516..58e16ea7b 100644 --- a/doc/man/gnunet-search.1 +++ b/doc/man/gnunet-search.1 | |||
@@ -24,30 +24,25 @@ Search for content on GNUnet. | |||
24 | The keywords are case-sensitive. | 24 | The keywords are case-sensitive. |
25 | .Nm | 25 | .Nm |
26 | can be used both for a search in the global namespace as well as for searching a private subspace. | 26 | can be used both for a search in the global namespace as well as for searching a private subspace. |
27 | .Sh OPTIONS | ||
27 | .Bl -tag -width Ds | 28 | .Bl -tag -width Ds |
28 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL | 29 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL |
29 | The \fB\-a\fR option can be used to specify additional anonymity constraints. | 30 | This option can be used to specify additional anonymity constraints. The default is 1. |
30 | If set to 0, GNUnet will try to download the file as fast as possible, including using non-anonymous methods. | 31 | 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. |
32 | This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer). | ||
31 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). | 33 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). |
32 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity. | 34 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. |
33 | 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. | 35 | You can gain better privacy by specifying a higher level of anonymity (using values above 1). |
34 | Note that your download performance is not only determined by your own anonymity level, but also by the anonymity level of the peers publishing the file. | 36 | This tells FS that it must hide your own requests in equivalent\-looking cover traffic. |
35 | So even if you download with anonymity level 0, the peers publishing the data might be sharing with a higher anonymity level, which in this case will determine performance. | 37 | This should confound an adversaries traffic analysis, increasing the time and effort it would |
36 | Also, peers that cache content in the network always use anonymity level 1. | 38 | take to discover your identity. However, it also can significantly reduce performance, as |
37 | .sp | 39 | your requests will be delayed until sufficient cover traffic is available. The specific |
38 | This option can be used to limit requests further than that. | 40 | numeric value (for anonymity levels above 1) is simple: |
39 | In particular, you can require GNUnet to receive certain amounts of traffic from other peers before sending your queries. | 41 | Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent |
40 | This way, you can gain very high levels of anonymity \- at the expense of much more traffic and much higher latency. | 42 | requests of cover traffic (traffic your peer routes for others) in the same time\-period. |
41 | So set it only if you really believe you need it. | 43 | The time\-period is twice the average delay by which GNUnet artificially delays traffic. |
42 | .sp | 44 | Note that regardless of the anonymity level you choose, peers that cache content in the |
43 | The definition of ANONYMITY\-RECEIVE is the following. | 45 | network always use anonymity level 1. |
44 | 0 means no anonymity is required. | ||
45 | 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. | ||
46 | Thus, if GNUnet routes n bytes of messages from foreign peers (using anonymous routing), it may originate n/(v-1) bytes of queries in the same time\-period. | ||
47 | The time\-period is twice the average delay that GNUnet defers forwarded queries. | ||
48 | .sp | ||
49 | The default is 1 and this should be fine for most users. | ||
50 | 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. | ||
51 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | 46 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
52 | use config file (defaults: ~/.config/gnunet.conf) | 47 | use config file (defaults: ~/.config/gnunet.conf) |
53 | .It Fl h | \-help | 48 | .It Fl h | \-help |