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.152
1 files changed, 18 insertions, 34 deletions
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index 89c8bd6b3..3989b1351 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -1,11 +1,11 @@
1.TH GNUNET\-AUTO\-SHARE "1" "18 Jun 2012" "GNUnet" 1.TH GNUNET\-AUTO\-SHARE "1" "June 18, 2012" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-auto\-share \- a command line tool to automatically share an entire directory with other users 3gnunet\-auto\-share \- a command line tool to automatically share an
4entire directory with other users
4.SH SYNOPSIS 5.SH SYNOPSIS
5.B gnunet\-auto\-share 6.B gnunet\-auto\-share
6[\fIOPTIONS\fR] DIRNAME 7[\fIOPTIONS\fR] DIRNAME
7.SH DESCRIPTION 8.SH DESCRIPTION
8.PP
9In order to share files with other GNUnet users, the files must first be made 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 10available to GNUnet. This tool can be used to automatically share all files
11from a certain directory. The program will periodically scan the directory 11from a certain directory. The program will periodically scan the directory
@@ -17,35 +17,28 @@ has many options in common with gnunet\-publish, but can only be used to
17index files. 17index files.
18.PP 18.PP
19You can use automatic meta\-data extraction (based on libextractor). 19You can use automatic meta\-data extraction (based on libextractor).
20.PP 20.TP
21
22\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 21\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
23Use alternate config file (if this option is not specified, the 22Use alternate config file (if this option is not specified, the
24default is ~/.config/gnunet.conf). 23default is ~/.config/gnunet.conf).
25
26.TP 24.TP
27\fB\-D\fR, \fB\-\-disable\-extractor\fR 25\fB\-D\fR, \fB\-\-disable\-extractor\fR
28Disable use of GNU libextractor for finding additional keywords and metadata. 26Disable use of GNU libextractor for finding additional keywords and metadata.
29
30.TP 27.TP
31\fB\-h\fR, \fB\-\-help\fR 28\fB\-h\fR, \fB\-\-help\fR
32Print a brief help page with all the options. 29Print a brief help page with all the options.
33
34.TP 30.TP
35\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR 31\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
36Change the loglevel. Possible values for LOGLEVEL are 32Change the loglevel. Possible values for LOGLEVEL are
37ERROR, WARNING, INFO and DEBUG. 33ERROR, WARNING, INFO and DEBUG.
38
39.TP 34.TP
40\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR 35\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR
41Executive summary: You probably don't need it. 36Executive summary: You probably don't need it.
42
43Set the priority of the published content (default: 365). If the local 37Set the priority of the published content (default: 365). If the local
44database is full, GNUnet will discard the content with the lowest ranking. 38database is full, GNUnet will discard the content with the lowest ranking.
45Note that ranks change over time depending on popularity. The default 39Note that ranks change over time depending on popularity. The default
46should be high enough to preserve the locally published content in favor 40should be high enough to preserve the locally published content in favor
47of content that migrates from other peers. 41of content that migrates from other peers.
48
49.TP 42.TP
50\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR 43\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
51Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet 44Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet
@@ -54,20 +47,15 @@ normal "random" replication of all content. This option can be used to push
54some content out into the network harder. Note that pushing content LEVEL 47some content out into the network harder. Note that pushing content LEVEL
55times into the network does not guarantee that there will actually be LEVEL 48times into the network does not guarantee that there will actually be LEVEL
56replicas. 49replicas.
57
58.TP 50.TP
59\fB\-v\fR, \fB\-\-version\fR 51\fB\-v\fR, \fB\-\-version\fR
60Print the version number. 52Print the version number.
61
62.TP 53.TP
63\fB\-V\fR, \fB\-\-verbose\fR 54\fB\-V\fR, \fB\-\-verbose\fR
64Be verbose. Using this option causes gnunet\-publish to print progress 55Be verbose. Using this option causes gnunet\-publish to print progress
65information and at the end the file identification that can be used to download 56information and at the end the file identification that can be used to download
66the file from GNUnet. 57the file from GNUnet.
67
68
69.SH SETTING ANONYMITY LEVEL 58.SH SETTING ANONYMITY LEVEL
70
71The \fB\-a\fR option can be used to specify additional anonymity constraints. 59The \fB\-a\fR option can be used to specify additional anonymity constraints.
72If set to 0, GNUnet will publish the file non-anonymously and in fact sign 60If set to 0, GNUnet will publish the file non-anonymously and in fact sign
73the advertisement for the file using your peer's private key. This will 61the advertisement for the file using your peer's private key. This will
@@ -81,7 +69,7 @@ anonymity, which increases the amount of cover traffic your own traffic will
81get, at the expense of performance. Note that regardless of the anonymity 69get, at the expense of performance. Note that regardless of the anonymity
82level you choose, peers that cache content in the network always use anonymity 70level you choose, peers that cache content in the network always use anonymity
83level 1. 71level 1.
84 72.PP
85The definition of the ANONYMITY LEVEL is the following. 0 means no anonymity 73The 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" 74is 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 75traffic can be from the local user, leaving 'v-1' bytes of cover traffic per
@@ -89,38 +77,34 @@ byte 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 77peers (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 78the same time\-period. The time\-period is twice the average delay that
91GNUnet defers forwarded queries. 79GNUnet defers forwarded queries.
92 80.PP
93The default is 1 and this should be fine for most users. Also notice that if 81The 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, 82you 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. 83especially if many of your fellow GNUnet\-peers all do the same.
96
97
98.SH EXAMPLES 84.SH EXAMPLES
99.PP
100
101\fBBasic example\fR 85\fBBasic example\fR
102 86.TP
103Share a directory "$HOME/gnunet\-share/": 87# gnunet\-auto\-share $HOME/gnunet\-share/ &
104 88Share a directory "$HOME/gnunet\-share/"
105 # gnunet\-auto\-share $HOME/gnunet\-share/ & 89.PP
106
107
108\fBBasic configuration\fR 90\fBBasic configuration\fR
109 91.PP
110Share a directory "$HOME/gnunet\-share/": 92Share a directory "$HOME/gnunet\-share/":
111 93
112 [gnunet-auto-share] 94 [gnunet-auto-share]
113 OPTIONS = $HOME/gnunet\-share 95 OPTIONS = $HOME/gnunet\-share
114 IMMEDIATE_START = YES # start this service when the peer starts 96 IMMEDIATE_START = YES # start this service when the peer starts
115
116.SH FILES 97.SH FILES
117.TP 98.TP
118~/.config/gnunet.conf 99~/.config/gnunet.conf
119GNUnet configuration file 100GNUnet configuration file
120.SH "REPORTING BUGS" 101.SH BUGS
121Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 102Report bugs to <https://gnunet.org/bugs/> or by sending electronic
122.SH "SEE ALSO" 103mail to <gnunet\-developers@gnu.org>
123\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1) 104.SH SEE ALSO
105\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
106\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1),
107\fBgnunet.conf\fP(5), \fBextract\fP(1)
124The full documentation for 108The full documentation for
125.B gnunet 109.B gnunet
126is maintained as a Texinfo manual. If the 110is maintained as a Texinfo manual. If the