gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] r20026 - gnunet/doc/man


From: gnunet
Subject: [GNUnet-SVN] r20026 - gnunet/doc/man
Date: Sat, 25 Feb 2012 20:08:43 +0100

Author: grothoff
Date: 2012-02-25 20:08:43 +0100 (Sat, 25 Feb 2012)
New Revision: 20026

Modified:
   gnunet/doc/man/gnunet-directory.1
   gnunet/doc/man/gnunet-download.1
   gnunet/doc/man/gnunet-nat-server.1
   gnunet/doc/man/gnunet-pseudonym.1
   gnunet/doc/man/gnunet-publish.1
   gnunet/doc/man/gnunet-search.1
   gnunet/doc/man/gnunet-vpn.1
Log:
Igor/CG: various minor updates to man pages

Modified: gnunet/doc/man/gnunet-directory.1
===================================================================
--- gnunet/doc/man/gnunet-directory.1   2012-02-25 01:52:22 UTC (rev 20025)
+++ gnunet/doc/man/gnunet-directory.1   2012-02-25 19:08:43 UTC (rev 20026)
@@ -1,4 +1,4 @@
-.TH gnunet-directory "1" "26 Oct 2011" "GNUnet"
+.TH gnunet-directory "1" "25 Feb 2012" "GNUnet"
 .SH NAME
 gnunet\-directory \- display directories
 
@@ -25,9 +25,9 @@
 
 If a directory has missing blocks (for example, some blocks failed to 
download), GNUnet is typically able to retrieve information about other files 
in the directory.  Files in a GNUnet directory have no particular order; the 
GNUnet code that generates a directory can reorder the entries in order to 
better fit the information about files into blocks of 32k.  Respecting 32k 
boundaries where possible makes it easier for gnunet\-directory (and other 
tools) to recover information from partially downloaded directory files.
 
-At the moment, directories can be created by \fBgnunet\-gtk\fP and 
\fBgnunet\-publish\fP.  Just like ordinary files, a directory can be published 
in a namespace.
+At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP and 
\fBgnunet\-publish\fP.  Just like ordinary files, a directory can be published 
in a namespace.
 
-GNUnet directories use the (unregistered) mimetype 
\fBapplication/gnunet\-directory\fP.  They can show up among normal search 
results.  The directory file can be downloaded to disk by 
\fBgnunet\-download\fP(1) for later processing or be handled more directly by 
\fBgnunet\-gtk\fP(1).
+GNUnet directories use the (unregistered) mimetype 
\fBapplication/gnunet\-directory\fP.  They can show up among normal search 
results.  The directory file can be downloaded to disk by 
\fBgnunet\-download\fP(1) for later processing or be handled more directly by 
\fBgnunet\-fs\-gtk\fP(1).
 
 .SH "REPORTING BUGS"
 Report bugs by using mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>

Modified: gnunet/doc/man/gnunet-download.1
===================================================================
--- gnunet/doc/man/gnunet-download.1    2012-02-25 01:52:22 UTC (rev 20025)
+++ gnunet/doc/man/gnunet-download.1    2012-02-25 19:08:43 UTC (rev 20026)
@@ -1,4 +1,4 @@
-.TH GNUNET-DOWNLOAD "1" "28 Apr 2010" "GNUnet"
+.TH GNUNET-DOWNLOAD "1" "25 Feb 2012" "GNUnet"
 .SH NAME
 gnunet\-download \- a command line interface for downloading files from GNUnet
 .SH SYNOPSIS
@@ -39,7 +39,7 @@
 
 .TP
 \fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR
-set the maximum number of parallel downloads that is allowed.  More parallel 
downloads can, to some extent, improve the overall time to download content.  
However, parallel downloads also take more memory (see also option \-r which 
can be used to limit memory utilization) and more sockets.  GNUnet typically 
only supports 1024 sockets per process, and each parallel download requires a 
new socket.  Hence it is not possible to run more than about 1000 downloads in 
parallel.   This option is used to limit the number of files that are 
downloaded in parallel (\-r can be used to limit the number of blocks that are 
concurrently requested).  As a result, the value only matters for recursive 
downloads.  The default value is 32.  Note that the overall limit of 1000 
downloads applies to gnunet\-service\-fs as well and using multiple 
gnunet\-download processes hence does not increase this limit.
+set the maximum number of parallel downloads that is allowed.  More parallel 
downloads can, to some extent, improve the overall time to download content.  
However, parallel downloads also take more memory (see also option \-r which 
can be used to limit memory utilization) and more sockets.  This option is used 
to limit the number of files that are downloaded in parallel (\-r can be used 
to limit the number of blocks that are concurrently requested).  As a result, 
the value only matters for recursive downloads.  The default value is 32. 
 
 .TP
 \fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR
@@ -58,18 +58,18 @@
 print progress information
 
 .SH NOTES
-The GNUNET_URI is typically obtained from gnunet\-search. gnunet\-gtk can also 
be used instead of gnunet\-download.
-If you ever have to abort a download, you can at any time continue it by 
re\-issuing gnunet\-download with the same filename. In that case GNUnet will 
not download blocks again that are already present. GNUnets file\-encoding will 
ensure file integrity, even if the existing file was not downloaded from GNUnet 
in the first place. Temporary information will be appended to the target file 
until the download is completed. 
+The GNUNET_URI is typically obtained from gnunet\-search. gnunet\-fs\-gtk can 
also be used instead of gnunet\-download.
+If you ever have to abort a download, you can at any time continue it by 
re\-issuing gnunet\-download with the same filename. In that case GNUnet will 
not download blocks again that are already present. GNUnet's file\-encoding 
will ensure file integrity, even if the existing file was not downloaded from 
GNUnet in the first place. Temporary information will be appended to the target 
file until the download is completed. 
 
 .SH SETTING ANONYMITY LEVEL
 
-The \fB\-a\fR option can be used to specify additional anonymity constraints. 
If set to 0, GNUnet will try to download the file as fast as possible without 
any additional slowdown by the anonymity code. Note that you will still have a 
fair degree of anonymity depending on the current network load and the power of 
the adversary. The download is still unlikely to be terribly fast since the 
sender may have requested sender\-anonymity and since in addition to that, 
GNUnet will still do the anonymous routing.
+The \fB\-a\fR option can be used to specify additional anonymity constraints. 
If set to 0, GNUnet will try to download the file as fast as possible, 
including using non-anonymous methods.  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.  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.  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.  Also, peers that cache content in 
 the network always use anonymity level 1.  
 
 This option can be used to limit requests further than that. In particular, 
you can require GNUnet to receive certain amounts of traffic from other peers 
before sending your queries. This way, you can gain very high levels of 
anonymity \- at the expense of much more traffic and much higher latency. So 
set it only if you really believe you need it.
 
-The definition of ANONYMITY\-RECEIVE is the following: If the value v is < 
1000, it means that if GNUnet routes n bytes of messages from foreign peers, it 
may originate n/v bytes of queries in the same time\-period. The time\-period 
is twice the average delay that GNUnet deferrs forwarded queries. If the value 
v is >= 1000, it means that if GNUnet routes n bytes of QUERIES from at least 
(v % 1000) peers, it may originate n/v/1000 bytes of queries in the same 
time\-period.
+The definition of ANONYMITY\-RECEIVE 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 
queries in the same time\-period. The time\-period is twice the average delay 
that GNUnet defers forwarded queries. 
 
-The default is 0 and this should be fine for most users. Also notice that if 
you choose values above 1000, you may end up having no throughput at all, 
especially if many of your fellow GNUnet\-peers do the same.
+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.
 
 .SH FILES
 .TP
@@ -78,4 +78,4 @@
 .SH "REPORTING BUGS"
 Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to 
<address@hidden>
 .SH "SEE ALSO"
-\fBgnunet\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-gtk\fP(1), 
\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), 
\fBgnunet\-service\-fs\fP(1)
+\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), 
\fBgnunet.conf\fP(5), \fBgnunet\-service\-fs\fP(1)

Modified: gnunet/doc/man/gnunet-nat-server.1
===================================================================
--- gnunet/doc/man/gnunet-nat-server.1  2012-02-25 01:52:22 UTC (rev 20025)
+++ gnunet/doc/man/gnunet-nat-server.1  2012-02-25 19:08:43 UTC (rev 20026)
@@ -1,4 +1,4 @@
-.TH GNUNET\-NAT\-SERVER 1 "Jan 4, 2012" "GNUnet"
+.TH GNUNET\-NAT\-SERVER 1 "25 Feb 2012" "GNUnet"
 
 .SH NAME
 gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
@@ -17,7 +17,7 @@
 
 The idea is that gnunet\-nat\-server will be run on some trusted hosts with 
unrestricted connectivity to allow GNUnet users to test their network 
configuration.  As written, the code allows any user on the Internet to cause 
the gnunet\-nat\-server to send 2-bytes of arbitrary data to any TCP or UDP 
port at any address.  We believe that this is generally harmless.
 
-When runnung gnunet\-nat\-server, make sure to use a configuration that 
disables most NAT options but enables 'enable_nat_client' and sets 
'internal_address' to the global IP address of your local host.  Also, the 
gnunet\-helper\-nat\-client should be installed locally and run with root 
priviledges (SUID), otherwise the gnunet\-nat\-server will not work properly.
+When running gnunet\-nat\-server, make sure to use a configuration that 
disables most NAT options but enables 'enable_nat_client' and sets 
'internal_address' to the global IP address of your local host.  Also, the 
gnunet\-helper\-nat\-client should be installed locally and run with root 
privileges (SUID), otherwise the gnunet\-nat\-server will not work properly.
 
 Note that gnunet\-nat\-server could be run via gnunet\-arm but typically is 
not.  Also, the name of the host and port that gnunet\-nat\-server is run on 
should be specified in the NATSERVER option in the [setup] section of the 
configuration file of hosts that are supposed to autoconfigure with this server.
 

Modified: gnunet/doc/man/gnunet-pseudonym.1
===================================================================
--- gnunet/doc/man/gnunet-pseudonym.1   2012-02-25 01:52:22 UTC (rev 20025)
+++ gnunet/doc/man/gnunet-pseudonym.1   2012-02-25 19:08:43 UTC (rev 20026)
@@ -1,4 +1,4 @@
-.TH GNUNET-PSEUDONYM "1" "30 Mar 2010" "GNUnet"
+.TH GNUNET-PSEUDONYM "1" "25 Feb 2012" "GNUnet"
 .SH NAME
 gnunet\-pseudonym \- create, delete or list pseudonyms
 .SH SYNOPSIS
@@ -12,7 +12,7 @@
 
 gnunet\-pseudonym can be used to list all of the pseudonyms that were created 
locally, to create new pseudonyms, to delete existing pseudonyms (the namespace 
will continue to exist, but it will be impossible to add additional data to it) 
and to list all of the namespaces (with their meta-data) known to the local 
user.  By default, gnunet\-pseudonym lists all pseudonyms that were discovered 
so far.
 
-Creating a new pseudonym requires using the \-C option together with a 
nickname that is to be used for the namespace.  Nicknames must be unique for 
each user, global uniqueness is desireable but not necessary.  If two 
namespaces in GNUnet use the same nickname all GNUnet tools will display the 
nickname together with a number which ensures that the name becomes locally 
unique to avoid ambiguity.  Additional options can be passed together with the 
\-C option to provide additional meta\-data that describes the namespace.  
Possible meta\-data includes the 'realname' of the person controlling the 
namespace, a description, the mime\-type for content in the namespace (useful 
if the namespace is dedicated to some specific type of content) and contact 
information.  One important piece of meta\-data that can be specified is the 
identifier of a document root, that is the name of a file in the namespace that 
is a portal to the rest of the content.  This is useful to help users find this
  root in the absence of conventions.  Note that all of this meta\-data is 
optional and should never be trusted blindly.
+Creating a new pseudonym requires using the \-C option together with a 
nickname that is to be used for the namespace.  Nicknames must be unique for 
each user, global uniqueness is desirable but not necessary.  If two namespaces 
in GNUnet use the same nickname all GNUnet tools will display the nickname 
together with a number which ensures that the name becomes locally unique to 
avoid ambiguity.  Additional options can be passed together with the \-C option 
to provide additional meta\-data that describes the namespace.  Possible 
meta\-data includes the 'realname' of the person controlling the namespace, a 
description, the mime\-type for content in the namespace (useful if the 
namespace is dedicated to some specific type of content) and contact 
information.  One important piece of meta\-data that can be specified is the 
identifier of a document root, that is the name of a file in the namespace that 
is a portal to the rest of the content.  This is useful to help users find this 
 root in the absence of conventions.  Note that all of this meta\-data is 
optional and should never be trusted blindly.
 
 As mentioned before, by default, gnunet\-pseudonym simply lists the meta\-data 
available for other namespaces.  Namespaces can be discovered whenever the peer 
obtains the namespace advertisement.  Namespace advertisements can be found 
using ordinary keyword\-based searches (by default gnunet\-pseudonym publishes 
the namespace advertisement under the keyword 'namespace', but the \-k option 
can be used to specify other keywords) and under the 'empty' identifier of the 
respective namespace (using a namespace\-search if the namespace ID is already 
known).
 

Modified: gnunet/doc/man/gnunet-publish.1
===================================================================
--- gnunet/doc/man/gnunet-publish.1     2012-02-25 01:52:22 UTC (rev 20025)
+++ gnunet/doc/man/gnunet-publish.1     2012-02-25 19:08:43 UTC (rev 20026)
@@ -1,4 +1,4 @@
-.TH GNUNET-PUBLISH "1" "27 Aug 2009" "GNUnet"
+.TH GNUNET-PUBLISH "1" "25 Feb 2012" "GNUnet"
 .SH NAME
 gnunet\-publish \- a command line interface for publishing new content into 
GNUnet
 .SH SYNOPSIS
@@ -8,7 +8,7 @@
 .PP
 In order to share files with other GNUnet users, the files must first be made 
available to GNUnet.  GNUnet does not automatically share all files from a 
certain directory.  In fact, even files that are downloaded are not 
automatically shared.
 .PP
-In order to start sharing files, the files must be added either using 
gnunet\-publish or a graphical interface such as gnunet\-gtk.  The command line 
tool gnunet\-publish is more useful if many files are supposed to be added.  
gnunet\-publish can automatically publish batches of files, recursively publish 
directories, create directories that can be browsed within GNUnet and publish 
file lists in a namespace.  When run on a directory, gnunet\-publish will 
always recursively publish all of the files in the directory.
+In order to start sharing files, the files must be added either using 
gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk.  The command 
line tool gnunet\-publish is more useful if many files are supposed to be 
added.  gnunet\-publish can automatically publish batches of files, recursively 
publish directories, create directories that can be browsed within GNUnet and 
publish file lists in a namespace.  When run on a directory, gnunet\-publish 
will always recursively publish all of the files in the directory.
 .PP
 gnunet\-publish can automatically extract keywords from the files that are 
shared.  Users that want to download files from GNUnet use keywords to search 
for the appropriate content.  You can disable keyword extraction with the \-D 
option.  You can manually add keywords using the \-k option. The keywords are 
case\-sensitive.
 .PP
@@ -18,7 +18,7 @@
 .PP
 With gnunet\-publish, it is easy to create new directories simultaneously when 
adding the files.  Simply pass the name of a directory instead of a file.
 .PP
-Since keywords can be spammed (any user can add any content under any 
keyword), GNUnet supports namespaces.  A namespace is a subset of the 
searchspace into which only the holder of a certain pseudonym can add content.  
Any GNUnet user can create any number of pseudonyms using 
\fBgnunet\-pseudonym\fR. Pseudonyms are stored in the user's GNUnet directory. 
While pseudonyms are locally identified with an arbitrary string that the user 
selects when the pseudonym is created, the namespace is globally known only 
under the hash of the public key of the pseudonym. Since only the owner of the 
pseudonym can add content to the namespace, it is impossible for other users to 
pollute the namespace. gnunet\-publish automatically publishs the 
top\-directory (or the only file if only one file is specified) into the 
namespace if a pseudonym is specified.
+Since keywords can be spammed (any user can add any content under any 
keyword), GNUnet supports namespaces.  A namespace is a subset of the 
searchspace into which only the holder of a certain pseudonym can add content.  
Any GNUnet user can create any number of pseudonyms using 
\fBgnunet\-pseudonym\fR. Pseudonyms are stored in the user's GNUnet directory. 
While pseudonyms are locally identified with an arbitrary string that the user 
selects when the pseudonym is created, the namespace is globally known only 
under the hash of the public key of the pseudonym. Since only the owner of the 
pseudonym can add content to the namespace, it is impossible for other users to 
pollute the namespace. gnunet\-publish automatically publishes the 
top\-directory (or the only file if only one file is specified) into the 
namespace if a pseudonym is specified.
 .PP
 It is possible to update content in GNUnet if that content was placed and 
obtained from a particular namespace.  Updates are only possible for content in 
namespaces since this is the only way to assure that a malicious party can not 
supply counterfeited updates.  Note that an update with GNUnet does not make 
the old content unavailable, GNUnet merely allows the publisher to point users 
to more recent versions. You can use the \-N option to specify the future 
identifier of an update.  When using this option, a GNUnet client that finds 
the current (\-t) identifier will automatically begin a search for the update 
(\-N) identifier.  If you later publish an update under the (\-N) identifier, 
both results will be given to the user. 
 .PP
@@ -58,7 +58,7 @@
 \fB\-n\fR, \fB\-\-noindex\fR
 Executive summary: You probably don't need it.
 
-Do not index, full publishion.  Note that directories, RBlocks, SBlocks and 
IBlocks are always published (even without this option).  With this option, 
every block of the actual files is stored in encrypted form in the block 
database of the local peer.  While this adds security if the local node is 
compromised (the adversary snags your machine), it is significantly less 
efficient compared to on\-demand encryption and is definitely not recommended 
for large files.
+Do not index, full publishing.  Note that directories, RBlocks, SBlocks and 
IBlocks are always published (even without this option).  With this option, 
every block of the actual files is stored in encrypted form in the block 
database of the local peer.  While this adds security if the local node is 
compromised (the adversary snags your machine), it is significantly less 
efficient compared to on\-demand encryption and is definitely not recommended 
for large files.
 
 .TP
 \fB\-N \fIID\fR, \fB\-\-next=\fIID\fR
@@ -76,7 +76,7 @@
 
 .TP
 \fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
-Set the desired replication level.  If CONTENT_PUSHING is set to YES, GNUnet 
will push each block (for the file) LEVEL times to other peers before doing 
nomral "random" replication of all content.  This option can be used to push 
some content out into the network harder. Note that pushing content LEVEL times 
into the network does not guarantee that there will actually be LEVEL replicas.
+Set the desired replication level.  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.  This option can be used to push 
some content out into the network harder. Note that pushing content LEVEL times 
into the network does not guarantee that there will actually be LEVEL replicas.
 
 .TP
 \fB\-s\fR, \fB\-\-simulate-only\fR
@@ -99,6 +99,15 @@
 Be verbose.  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.
 
 
+.SH SETTING ANONYMITY LEVEL
+
+The \fB\-a\fR option can be used to specify additional anonymity constraints. 
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).  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.  Note that regardless of the anonymity 
level you choose, peers that cache content in the network always use anonymity 
level 1.  
+
+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. 
+
+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.
+
+
 .SH EXAMPLES
 .PP
 

Modified: gnunet/doc/man/gnunet-search.1
===================================================================
--- gnunet/doc/man/gnunet-search.1      2012-02-25 01:52:22 UTC (rev 20025)
+++ gnunet/doc/man/gnunet-search.1      2012-02-25 19:08:43 UTC (rev 20026)
@@ -1,4 +1,4 @@
-.TH GNUNET-SEARCH "1" "28 Apr 2010" "GNUnet"
+.TH GNUNET-SEARCH "1" "25 Feb 2012" "GNUnet"
 .SH NAME
 gnunet\-search \- a command line interface to search for content on GNUnet
 .SH SYNOPSIS
@@ -12,14 +12,15 @@
 Search for content on GNUnet. The keywords are case\-sensitive.  
gnunet\-search can be used both for a search in the global namespace as well as 
for searching a private subspace.
 .TP
 \fB\-a \fILEVEL\fR, \fB\-\-anonymity=\fILEVEL\fR
-The \fB-a\fR option can be used to specify additional anonymity constraints.  
If set to 0, GNUnet will try to download the file as fast as possible without 
any additional slowdown for anonymous routing.  Note that you may still have 
some amount of anonymity depending on the current network load and the power of 
the adversary.  Use at least 1 to force GNUnet to use anonymous routing.
 
-This option can be used to limit requests further than that. In particular, 
you can require GNUnet to have a certain amount of cover traffic from other 
peers before sending your queries. This way, you can gain very high levels of 
anonymity \- at the expense of much more traffic and much higher latency. So 
set this option to values beyond 1 only if you really believe you need it.
+The \fB\-a\fR option can be used to specify additional anonymity constraints. 
If set to 0, GNUnet will try to download the file as fast as possible, 
including using non-anonymous methods.  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.  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.  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.  Also, peers that cache content in 
 the network always use anonymity level 1.  
 
-The definition of ANONYMITY\-RECEIVE is the following: If the value v is 0, 
anonymous routing is not required.  For 1, anonymous routing is required, but 
there is no lower bound on how much cover traffic must be present.  For values 
> 1 and < 1000, it means that if GNUnet routes n bytes of messages from foreign 
peers, it may originate n/v bytes of queries in the same time\-period. The 
time\-period is twice the average delay that GNUnet deferrs forwarded queries. 
If the value v is >= 1000, it means that if GNUnet routes n bytes of QUERIES 
from at least (v % 1000) peers, it may originate n/v/1000 bytes of queries in 
the same time\-period.
+This option can be used to limit requests further than that. In particular, 
you can require GNUnet to receive certain amounts of traffic from other peers 
before sending your queries. This way, you can gain very high levels of 
anonymity \- at the expense of much more traffic and much higher latency. So 
set it only if you really believe you need it.
 
-The default is 1 and this should be fine for most users.  Also notice that if 
you choose values above 1000, you may end up having no throughput at all, 
especially if many of your fellow GNUnet\-peers do the same.
+The definition of ANONYMITY\-RECEIVE 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 
queries in the same time\-period. The time\-period is twice the average delay 
that GNUnet defers forwarded queries. 
 
+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.
+
 .TP
 \fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR
 use config file (defaults: ~/.gnunet/gnunet.conf)
@@ -42,7 +43,7 @@
 Only search locally, do not forward requests to other peers.
 
 .TP
-\fB\-N \fIVALUE\fR, \fB\-\-results=\fVALUE\fR
+\fB\-N \fIVALUE\fR, \fB\-\-results=\fIVALUE\fR
 automatically terminate the search after receiving VALUE results.
 
 .TP

Modified: gnunet/doc/man/gnunet-vpn.1
===================================================================
--- gnunet/doc/man/gnunet-vpn.1 2012-02-25 01:52:22 UTC (rev 20025)
+++ gnunet/doc/man/gnunet-vpn.1 2012-02-25 19:08:43 UTC (rev 20026)
@@ -1,4 +1,4 @@
-.TH GNUNET\-VPN 1 "Jan 7, 2012" "GNUnet"
+.TH GNUNET\-VPN 1 "25 Feb 2012" "GNUnet"
 
 .SH NAME
 gnunet\-vpn \- manually setup a GNUnet VPN tunnel
@@ -9,7 +9,7 @@
 .br
 
 .SH DESCRIPTION
-\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the GNUnet 
network.  There are two main types of tunnels.  Tunnels to an exit node which 
routes the traffic to the global Internet, and tunnels to a node that runs a 
service only within GNUnet.  Depending on the type of tunnel, gnunet\-vpn takes 
different options.  The "\-i" option is required for tunnels to an exit node, 
whereas the "\-p" and "\-s" options in conjuction with either "\-u" or "\-t" 
are required for tunnels to services.  For exit tunnels, both UDP and TCP 
traffic will be redirected.  For service tunnels, either UDP ("\-u") or TCP 
("\-t") traffic will be redirected.
+\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the GNUnet 
network.  There are two main types of tunnels.  Tunnels to an exit node which 
routes the traffic to the global Internet, and tunnels to a node that runs a 
service only within GNUnet.  Depending on the type of tunnel, gnunet\-vpn takes 
different options.  The "\-i" option is required for tunnels to an exit node, 
whereas the "\-p" and "\-s" options in conjunction with either "\-u" or "\-t" 
are required for tunnels to services.  For exit tunnels, both UDP and TCP 
traffic will be redirected.  For service tunnels, either UDP ("\-u") or TCP 
("\-t") traffic will be redirected.
 
 The tool will display the IP address for this end of the tunnel.  The address 
can be displayed as soon as it has been allocated, or only after ("\-a") the 
tunnel has been created.
 
@@ -46,10 +46,10 @@
 Name of the service running on the target peer.  Cannot be used in conjunction 
with "\-i", requires "\-p".
 .B
 .IP "\-t, \-\-tcp"
-Service runs TCP.  Either "\-t" or \"-u" must be specified when using "\-s".
+Service runs TCP.  Either "\-t" or "\-u" must be specified when using "\-s".
 .B
 .IP "\-u, \-\-udp"
-Service runs UDP.  Either "\-t" or \"-u" must be specified when using "\-s".
+Service runs UDP.  Either "\-t" or "\-u" must be specified when using "\-s".
 .B
 .IP "\-V, \-\-verbose"
 Be verbose.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]