aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-auto-share.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-auto-share.1')
-rw-r--r--doc/man/gnunet-auto-share.160
1 files changed, 50 insertions, 10 deletions
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index dd3d93611..f655f6ccd 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -6,13 +6,22 @@ gnunet\-auto\-share \- a command line tool to automatically share an entire dire
6[\fIOPTIONS\fR] DIRNAME 6[\fIOPTIONS\fR] DIRNAME
7.SH DESCRIPTION 7.SH DESCRIPTION
8.PP 8.PP
9In 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. 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. 9In order to share files with other GNUnet users, the files must first be made
10available to GNUnet. This tool can be used to automatically share all files
11from a certain directory. The program will periodically scan the directory
12for changes and publish files that are new or that changed on GNUnet.
13Which files have already been shared is remembered in a ".auto-share" file
14in the shared directory. You can run the tool by hand or automatically by
15adding the respective options to your configuration. gnunet\-auto\-share
16has many options in common with gnunet\-publish, but can only be used to
17index files.
10.PP 18.PP
11You can use automatic meta\-data extraction (based on libextractor). 19You can use automatic meta\-data extraction (based on libextractor).
12.PP 20.PP
13 21
14\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 22\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
15Use alternate config file (if this option is not specified, the default is ~/.config/gnunet.conf). 23Use alternate config file (if this option is not specified, the
24default is ~/.config/gnunet.conf).
16 25
17.TP 26.TP
18\fB\-D\fR, \fB\-\-disable\-extractor\fR 27\fB\-D\fR, \fB\-\-disable\-extractor\fR
@@ -31,11 +40,20 @@ ERROR, WARNING, INFO and DEBUG.
31\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR 40\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR
32Executive summary: You probably don't need it. 41Executive summary: You probably don't need it.
33 42
34Set the priority of the published content (default: 365). If the local database is full, GNUnet will discard the content with the lowest ranking. Note that ranks change over time depending on popularity. The default should be high enough to preserve the locally published content in favor of content that migrates from other peers. 43Set the priority of the published content (default: 365). If the local
44database is full, GNUnet will discard the content with the lowest ranking.
45Note that ranks change over time depending on popularity. The default
46should be high enough to preserve the locally published content in favor
47of content that migrates from other peers.
35 48
36.TP 49.TP
37\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR 50\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
38Set 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. 51Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet
52will push each block (for the file) LEVEL times to other peers before doing
53normal "random" replication of all content. This option can be used to push
54some content out into the network harder. Note that pushing content LEVEL
55times into the network does not guarantee that there will actually be LEVEL
56replicas.
39 57
40.TP 58.TP
41\fB\-v\fR, \fB\-\-version\fR 59\fB\-v\fR, \fB\-\-version\fR
@@ -43,16 +61,38 @@ Print the version number.
43 61
44.TP 62.TP
45\fB\-V\fR, \fB\-\-verbose\fR 63\fB\-V\fR, \fB\-\-verbose\fR
46Be 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. 64Be verbose. Using this option causes gnunet\-publish to print progress
65information and at the end the file identification that can be used to download
66the file from GNUnet.
47 67
48 68
49.SH SETTING ANONYMITY LEVEL 69.SH SETTING ANONYMITY LEVEL
50 70
51The \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. 71The \fB\-a\fR option can be used to specify additional anonymity constraints.
52 72If set to 0, GNUnet will publish the file non-anonymously and in fact sign
53The 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. 73the advertisement for the file using your peer's private key. This will
54 74allow other users to download the file as fast as possible, including using
55The 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. 75non-anonymous methods (DHT, direct transfer). If you set it to 1 (default),
76you use the standard anonymous routing algorithm (which does not explicitly
77leak your identity). However, a powerful adversary may still be able to
78perform traffic analysis (statistics) to over time infer data about your
79identity. You can gain better privacy by specifying a higher level of
80anonymity, which increases the amount of cover traffic your own traffic will
81get, at the expense of performance. Note that regardless of the anonymity
82level you choose, peers that cache content in the network always use anonymity
83level 1.
84
85The definition of the ANONYMITY LEVEL is the following. 0 means no anonymity
86is required. Otherwise a value of 'v' means that 1 out of v bytes of "anonymous"
87traffic can be from the local user, leaving 'v-1' bytes of cover traffic per
88byte on the wire. Thus, if GNUnet routes n bytes of messages from foreign
89peers (using anonymous routing), it may originate n/(v-1) bytes of data in
90the same time\-period. The time\-period is twice the average delay that
91GNUnet defers forwarded queries.
92
93The default is 1 and this should be fine for most users. Also notice that if
94you choose very large values, you may end up having no throughput at all,
95especially if many of your fellow GNUnet\-peers all do the same.
56 96
57 97
58.SH EXAMPLES 98.SH EXAMPLES