1 files changed, 14 insertions, 5 deletions
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index f35234d13..a189c747e 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -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 @@ gnunet\-publish \- a command line interface for publishing new content into GNUn
 .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 @@ In addition to searching for files by keyword, GNUnet allows organizing files in
 .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 @@ For the main file (or directory), set the metadata of the given TYPE to the give
 \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 @@ For the top\-level directory or file, create an SBlock that places the file into
 .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 @@ Print the version number.
 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

diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1 index f35234d13..a189c747e 100644 --- a/doc/man/gnunet-publish.1 +++ b/doc/man/gnunet-publish.1
@@ -1,4 +1,4 @@
1	.TH GNUNET-PUBLISH "1" "27 Aug 2009" "GNUnet"	1	.TH GNUNET-PUBLISH "1" "25 Feb 2012" "GNUnet"
2	.SH NAME	2	.SH NAME
3	gnunet\-publish \- a command line interface for publishing new content into GNUnet	3	gnunet\-publish \- a command line interface for publishing new content into GNUnet
4	.SH SYNOPSIS	4	.SH SYNOPSIS
@@ -8,7 +8,7 @@ gnunet\-publish \- a command line interface for publishing new content into GNUn
8	.PP	8	.PP
9	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.	9	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.
10	.PP	10	.PP
11	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.	11	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.
12	.PP	12	.PP
13	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.	13	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.
14	.PP	14	.PP
@@ -18,7 +18,7 @@ In addition to searching for files by keyword, GNUnet allows organizing files in
18	.PP	18	.PP
19	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.	19	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.
20	.PP	20	.PP
21	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.	21	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.
22	.PP	22	.PP
23	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.	23	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.
24	.PP	24	.PP
@@ -58,7 +58,7 @@ For the main file (or directory), set the metadata of the given TYPE to the give
58	\fB\-n\fR, \fB\-\-noindex\fR	58	\fB\-n\fR, \fB\-\-noindex\fR
59	Executive summary: You probably don't need it.	59	Executive summary: You probably don't need it.
60		60
61	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.	61	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.
62		62
63	.TP	63	.TP
64	\fB\-N \fIID\fR, \fB\-\-next=\fIID\fR	64	\fB\-N \fIID\fR, \fB\-\-next=\fIID\fR
@@ -76,7 +76,7 @@ For the top\-level directory or file, create an SBlock that places the file into
76		76
77	.TP	77	.TP
78	\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR	78	\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
79	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.	79	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.
80		80
81	.TP	81	.TP
82	\fB\-s\fR, \fB\-\-simulate-only\fR	82	\fB\-s\fR, \fB\-\-simulate-only\fR
@@ -99,6 +99,15 @@ Print the version number.
99	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.	99	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.
100		100
101		101
		102	.SH SETTING ANONYMITY LEVEL
		103
		104	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.
		105
		106	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.
		107
		108	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.
		109
		110
102	.SH EXAMPLES	111	.SH EXAMPLES
103	.PP	112	.PP
104		113