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.151
1 files changed, 25 insertions, 26 deletions
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index 0a0e8f702..939a75888 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -26,21 +26,20 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-auto-share 28.Nm gnunet-auto-share
29.Nd 29.Nd a command line tool to automatically share an entire directory with other users
30a command line tool to automatically share an entire directory with other users
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 32.Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL
34.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 33.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl D | \-disable-extractor 34.Op Fl D | -disable-extractor
36.Op Fl d | \-disable-creation-time 35.Op Fl d | -disable-creation-time
37.Op Fl h | \-help 36.Op Fl h | -help
38.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 37.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
39.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 38.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
40.Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY 39.Op Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY
41.Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL 40.Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
42.Op Fl V | \-verbose 41.Op Fl V | -verbose
43.Op Fl v | \-version 42.Op Fl v | -version
44.Ao Ar DIRNAME Ac 43.Ao Ar DIRNAME Ac
45.Sh DESCRIPTION 44.Sh DESCRIPTION
46In order to share files with other GNUnet users, the files must first be made available to GNUnet. 45In order to share files with other GNUnet users, the files must first be made available to GNUnet.
@@ -55,7 +54,7 @@ gnunet-auto-share has many options in common with gnunet-publish, but can only b
55You can use automatic meta-data extraction (based on libextractor). 54You can use automatic meta-data extraction (based on libextractor).
56The options are as follows: 55The options are as follows:
57.Bl -tag -width indent 56.Bl -tag -width indent
58.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 57.It Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL
59This option can be used to specify additional anonymity constraints. 58This option can be used to specify additional anonymity constraints.
60The default is 1. 59The default is 1.
61If 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. 60If 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.
@@ -63,42 +62,42 @@ This will allow other users to download the file as fast as possible, including
63If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). 62If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
64However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. 63However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
65You can gain better privacy by specifying a higher level of anonymity (using values above 1). 64You can gain better privacy by specifying a higher level of anonymity (using values above 1).
66This tells FS that it must hide your own requests in equivalent\-looking cover traffic. 65This tells FS that it must hide your own requests in equivalent-looking cover traffic.
67This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity. 66This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity.
68However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available. 67However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available.
69The specific numeric value (for anonymity levels above 1) is simple: 68The specific numeric value (for anonymity levels above 1) is simple:
70Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. 69Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period.
71The time-period is twice the average delay by which GNUnet artificially delays traffic. 70The time-period is twice the average delay by which GNUnet artificially delays traffic.
72Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. 71Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
73.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 72.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
74Use alternate config file (if this option is not specified, the default is 73Use alternate config file (if this option is not specified, the default is
75.Pa ~/.config/gnunet.conf Ns ). 74.Pa ~/.config/gnunet.conf Ns ).
76.It Fl D | \-disable-extractor 75.It Fl D | -disable-extractor
77Disable use of GNU libextractor for finding additional keywords and metadata. 76Disable use of GNU libextractor for finding additional keywords and metadata.
78.It Fl d | \-disable-creation-time 77.It Fl d | -disable-creation-time
79Disable adding the creation time to the metadata of the uploaded file. 78Disable adding the creation time to the metadata of the uploaded file.
80.It Fl h | \-help 79.It Fl h | -help
81Print a brief help page with all the options. 80Print a brief help page with all the options.
82.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 81.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
83Change the loglevel. 82Change the loglevel.
84Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 83Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
85.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 84.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
86Configure logging to write logs to FILENAME. 85Configure logging to write logs to FILENAME.
87.It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY 86.It Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY
88Executive summary: You probably don't need it. 87Executive summary: You probably don't need it.
89Set the priority of the published content (default: 365). 88Set the priority of the published content (default: 365).
90If the local database is full, GNUnet will discard the content with the lowest ranking. 89If the local database is full, GNUnet will discard the content with the lowest ranking.
91Note that ranks change over time depending on popularity. 90Note that ranks change over time depending on popularity.
92The default should be high enough to preserve the locally published content in favor of content that migrates from other peers. 91The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
93.It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL 92.It Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
94Set the desired replication level. 93Set the desired replication level.
95If 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. 94If 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.
96This option can be used to push some content out into the network harder. 95This option can be used to push some content out into the network harder.
97Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas. 96Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas.
98.It Fl V | \-verbose 97.It Fl V | -verbose
99Be verbose. 98Be verbose.
100Using 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. 99Using 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.
101.It Fl v | \-version 100.It Fl v | -version
102Print the version number. 101Print the version number.
103.El 102.El
104.Sh EXAMPLES 103.Sh EXAMPLES