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.1232
1 files changed, 116 insertions, 116 deletions
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index a2965b19f..00b627d87 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -1,126 +1,126 @@
1.TH GNUNET\-AUTO\-SHARE "1" "June 18, 2012" "GNUnet" 1.Dd June 18, 2012
2.SH NAME 2.Dt GNUNET-AUTO-SHARE 1
3gnunet\-auto\-share \- a command line tool to automatically share an 3.Os
4entire directory with other users 4.Sh NAME
5.SH SYNOPSIS 5.Nm gnunet-auto-share
6.B gnunet\-auto\-share 6.Nd
7[\fIOPTIONS\fR] DIRNAME 7a command line tool to automatically share an entire directory with other users
8.SH DESCRIPTION 8.Sh SYNOPSIS
9In order to share files with other GNUnet users, the files must first be made 9.Nm
10available to GNUnet. This tool can be used to automatically share all files 10.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
11from a certain directory. The program will periodically scan the directory 11.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
12for changes and publish files that are new or that changed on GNUnet. 12.Op Fl D | \-disable-extractor
13Which files have already been shared is remembered in a ".auto-share" file 13.Op Fl d | \-disable-creation-time
14in the shared directory. You can run the tool by hand or automatically by 14.Op Fl h | \-help
15adding the respective options to your configuration. gnunet\-auto\-share 15.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
16has many options in common with gnunet\-publish, but can only be used to 16.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
17index files. 17.Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
18.PP 18.Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
19.Op Fl V | \-verbose
20.Op Fl v | \-version
21.Ao Ar DIRNAME Ac
22.Sh DESCRIPTION
23In order to share files with other GNUnet users, the files must first be made available to GNUnet.
24This tool can be used to automatically share all files from a certain directory.
25The program will periodically scan the directory for changes and publish files that are new or that changed on GNUnet.
26Which files have already been shared is remembered in a ".auto-share" file in the shared directory.
27You can run the tool by hand or automatically by adding the respective options to your configuration.
28gnunet\-auto\-share has many options in common with gnunet\-publish, but can only be used to index files.
29.Pp
19You can use automatic meta\-data extraction (based on libextractor). 30You can use automatic meta\-data extraction (based on libextractor).
20.TP 31.Bl -tag -width Ds
21\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 32.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
22Use alternate config file (if this option is not specified, the 33The \fB\-a\fR option can be used to specify additional anonymity constraints.
23default is ~/.config/gnunet.conf). 34If 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.
24.TP 35This will allow other users to download the file as fast as possible, including using non-anonymous methods (DHT, direct transfer).
25\fB\-D\fR, \fB\-\-disable\-extractor\fR 36If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
37However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity.
38You 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.
39Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
40.Pp
41The definition of the ANONYMITY LEVEL is the following.
420 means no anonymity is required.
43Otherwise 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.
44Thus, 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.
45The time\-period is twice the average delay that GNUnet defers forwarded queries.
46.Pp
47The default is 1 and this should be fine for most users.
48Also 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.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
50Use alternate config file (if this option is not specified, the default is ~/.config/gnunet.conf).
51.It Fl D | \-disable-extractor
26Disable use of GNU libextractor for finding additional keywords and metadata. 52Disable use of GNU libextractor for finding additional keywords and metadata.
27.TP 53.It Fl d | \-disable-creation-time
28\fB\-h\fR, \fB\-\-help\fR 54Disable adding the creation time to the metadata of the uploaded file.
55.It Fl h | \-help
29Print a brief help page with all the options. 56Print a brief help page with all the options.
30.TP 57.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
31\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR 58Change the loglevel.
32Change the loglevel. Possible values for LOGLEVEL are 59Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
33ERROR, WARNING, INFO and DEBUG. 60.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
34.TP 61Configure logging to write logs to FILENAME.
35\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR 62.It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
36Executive summary: You probably don't need it. 63Executive summary: You probably don't need it.
37Set the priority of the published content (default: 365). If the local 64Set the priority of the published content (default: 365).
38database is full, GNUnet will discard the content with the lowest ranking. 65If the local database is full, GNUnet will discard the content with the lowest ranking.
39Note that ranks change over time depending on popularity. The default 66Note that ranks change over time depending on popularity.
40should be high enough to preserve the locally published content in favor 67The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
41of content that migrates from other peers. 68.It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
42.TP 69Set the desired replication level.
43\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR 70If 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.
44Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet 71This option can be used to push some content out into the network harder.
45will push each block (for the file) LEVEL times to other peers before doing 72Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas.
46normal "random" replication of all content. This option can be used to push 73.It Fl V | \-verbose
47some content out into the network harder. Note that pushing content LEVEL 74Be verbose.
48times into the network does not guarantee that there will actually be LEVEL 75Using 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.
49replicas. 76.It Fl v | \-version
50.TP
51\fB\-v\fR, \fB\-\-version\fR
52Print the version number. 77Print the version number.
53.TP 78.El
54\fB\-V\fR, \fB\-\-verbose\fR 79.Sh EXAMPLES
55Be verbose. Using this option causes gnunet\-publish to print progress 80.Ss Basic example
56information and at the end the file identification that can be used to download 81$ gnunet-auto-share $HOME/gnunet-share/ &
57the file from GNUnet. 82.Pp
58.SH SETTING ANONYMITY LEVEL 83Share a directory "$HOME/gnunet-share/"
59The \fB\-a\fR option can be used to specify additional anonymity constraints. 84.Ss Basic configuration
60If set to 0, GNUnet will publish the file non-anonymously and in fact sign 85$ Share a directory "$HOME/gnunet-share/":
61the advertisement for the file using your peer's private key. This will 86.Pp
62allow other users to download the file as fast as possible, including using 87.Bd -literal -offset indent -compact
63non-anonymous methods (DHT, direct transfer). If you set it to 1 (default), 88[gnunet-auto-share]
64you use the standard anonymous routing algorithm (which does not explicitly 89OPTIONS = $HOME/gnunet-share
65leak your identity). However, a powerful adversary may still be able to 90IMMEDIATE_START = YES # start this service when the peer starts
66perform traffic analysis (statistics) to over time infer data about your 91.Ed
67identity. You can gain better privacy by specifying a higher level of 92.Sh FILES
68anonymity, which increases the amount of cover traffic your own traffic will
69get, at the expense of performance. Note that regardless of the anonymity
70level you choose, peers that cache content in the network always use anonymity
71level 1.
72.PP
73The definition of the ANONYMITY LEVEL is the following. 0 means no anonymity
74is required. Otherwise a value of 'v' means that 1 out of v bytes of "anonymous"
75traffic can be from the local user, leaving 'v-1' bytes of cover traffic per
76byte on the wire. Thus, if GNUnet routes n bytes of messages from foreign
77peers (using anonymous routing), it may originate n/(v-1) bytes of data in
78the same time\-period. The time\-period is twice the average delay that
79GNUnet defers forwarded queries.
80.PP
81The default is 1 and this should be fine for most users. Also notice that if
82you choose very large values, you may end up having no throughput at all,
83especially if many of your fellow GNUnet\-peers all do the same.
84.SH EXAMPLES
85\fBBasic example\fR
86.TP
87# gnunet\-auto\-share $HOME/gnunet\-share/ &
88Share a directory "$HOME/gnunet\-share/"
89.PP
90\fBBasic configuration\fR
91.PP
92Share a directory "$HOME/gnunet\-share/":
93
94 [gnunet-auto-share]
95 OPTIONS = $HOME/gnunet\-share
96 IMMEDIATE_START = YES # start this service when the peer starts
97.SH FILES
98.TP 93.TP
99~/.config/gnunet.conf 94~/.config/gnunet.conf
100GNUnet configuration file 95GNUnet configuration file
101.SH BUGS 96.Sh SEE ALSO
102Report bugs to <https://bugs.gnunet.org/> or by sending electronic 97.Xr gnunet-fs-gtk 1 ,
103mail to <gnunet\-developers@gnu.org> 98.Xr gnunet-publish 1 ,
104.SH SEE ALSO 99.Xr gnunet-search 1 ,
105\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), 100.Xr gnunet-download 1 ,
106\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), 101.Xr gnunet.conf 5 ,
107\fBgnunet.conf\fP(5), \fBextract\fP(1) 102.Xr extract 1
108The full documentation for 103.sp
109.B gnunet 104The full documentation for gnunet is maintained as a Texinfo manual.
110is maintained as a Texinfo manual. If the 105If the
111.B info 106.Xr info 1
112and 107and gnunet programs are properly installed at your site, the command
113.B gnunet 108.Pp
114programs are properly installed at your site, the command 109.Dl info gnunet
115.IP 110.Pp
116.B info gnunet
117.PP
118should give you access to the complete handbook, 111should give you access to the complete handbook,
119.IP 112.Pp
120.B info gnunet-c-tutorial 113.Dl info gnunet-c-tutorial
121.PP 114.Pp
122will give you access to a tutorial for developers. 115will give you access to a tutorial for developers.
123.PP 116.sp
124Depending on your installation, this information is also 117Depending on your installation, this information is also available in
125available in 118.Xr gnunet 7 and
126\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 119.Xr gnunet-c-tutorial 7 .
120.\".Sh HISTORY
121.\".Sh AUTHORS
122.Sh BUGS
123Report bugs by using
124.Lk https://bugs.gnunet.org
125or by sending electronic mail to
126.Aq Mt gnunet-developers@gnu.org .