aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-publish.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-publish.1')
-rw-r--r--doc/man/gnunet-publish.186
1 files changed, 43 insertions, 43 deletions
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index 04293102c..a54a1717f 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -30,25 +30,25 @@
30a command line interface for publishing new content into GNUnet 30a command line interface for publishing new content into GNUnet
31.Sh SYNOPSIS 31.Sh SYNOPSIS
32.Nm 32.Nm
33.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 33.Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL
34.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 34.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl D | \-disable\-extractor 35.Op Fl D | -disable-extractor
36.Op Fl E | \-enable\-creation\-time 36.Op Fl E | -enable-creation-time
37.Op Fl e | \-extract 37.Op Fl e | -extract
38.Op Fl h | \-help 38.Op Fl h | -help
39.Op Fl k Ar KEYWORD | Fl \-key= Ns Ar KEYWORD 39.Op Fl k Ar KEYWORD | Fl -key= Ns Ar KEYWORD
40.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 40.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
41.Op Fl m Ar TYPE:VALUE | Fl \-meta= Ns Ar TYPE:VALUE 41.Op Fl m Ar TYPE:VALUE | Fl -meta= Ns Ar TYPE:VALUE
42.Op Fl n | \-noindex 42.Op Fl n | -noindex
43.Op Fl N Ar ID | Fl \-next= Ns Ar ID 43.Op Fl N Ar ID | Fl -next= Ns Ar ID
44.Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY 44.Op Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY
45.Op Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME 45.Op Fl P Ar NAME | Fl -pseudonym= Ns Ar NAME
46.Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL 46.Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
47.Op Fl s | \-simulate-only 47.Op Fl s | -simulate-only
48.Op Fl t Ar ID | Fl \-this= Ns Ar ID 48.Op Fl t Ar ID | Fl -this= Ns Ar ID
49.Op Fl u Ar URI | Fl \-uri= Ns Ar URI 49.Op Fl u Ar URI | Fl -uri= Ns Ar URI
50.Op Fl v | \-version 50.Op Fl v | -version
51.Op Fl V | \-verbose 51.Op Fl V | -verbose
52.Ao Ar FILENAME Ac 52.Ao Ar FILENAME Ac
53.Sh DESCRIPTION 53.Sh DESCRIPTION
54In order to share files with other GNUnet users, the files must first be made available to GNUnet. 54In order to share files with other GNUnet users, the files must first be made available to GNUnet.
@@ -109,10 +109,10 @@ to specify meta-data.
109For the 109For the
110.Fl m 110.Fl m
111option you need to use the form keyword-type:value. 111option you need to use the form keyword-type:value.
112For example, use "\-m os:Linux" to specify that the operating system is Linux. 112For example, use "-m os:Linux" to specify that the operating system is Linux.
113Common meta-data types are "author", "title", "mimetype", "filename", "language", "subject" and "keywords". 113Common meta-data types are "author", "title", "mimetype", "filename", "language", "subject" and "keywords".
114A full list can be obtained from the extract tool using the option 114A full list can be obtained from the extract tool using the option
115.Fl \-list . 115.Fl -list .
116The meta-data is used to help users in searching for files on the network. 116The meta-data is used to help users in searching for files on the network.
117The keywords are case-sensitive. 117The keywords are case-sensitive.
118.Pp 118.Pp
@@ -128,7 +128,7 @@ If you publish or index a file and then leave the network, it will almost always
128.Pp 128.Pp
129The options are as follows: 129The options are as follows:
130.Bl -tag -width indent 130.Bl -tag -width indent
131.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 131.It Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL
132This option can be used to specify additional anonymity constraints. 132This option can be used to specify additional anonymity constraints.
133The default is 1. 133The default is 1.
134If 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. 134If 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.
@@ -143,38 +143,38 @@ The specific numeric value (for anonymity levels above 1) is simple:
143Given 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. 143Given 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.
144The time-period is twice the average delay by which GNUnet artificially delays traffic. 144The time-period is twice the average delay by which GNUnet artificially delays traffic.
145Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. 145Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
146.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 146.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
147Use alternate config file FILENAME. 147Use alternate config file FILENAME.
148If this option is not specified, the default is 148If this option is not specified, the default is
149.Pa ~/.config/gnunet.conf . 149.Pa ~/.config/gnunet.conf .
150.It Fl D | \-disable\-extractor 150.It Fl D | -disable-extractor
151Disable use of GNU libextractor for finding additional keywords and metadata. 151Disable use of GNU libextractor for finding additional keywords and metadata.
152.It Fl E | \-enable\-creation\-time 152.It Fl E | -enable-creation-time
153Enable use of creation time timestamp in metadata. 153Enable use of creation time timestamp in metadata.
154Setting this information will leak information about the time at which a file was made available. 154Setting this information will leak information about the time at which a file was made available.
155.It Fl e | \-extract 155.It Fl e | -extract
156Print the list of keywords that will be used for each file given the current options. 156Print the list of keywords that will be used for each file given the current options.
157Do not perform any indexing or publishing. 157Do not perform any indexing or publishing.
158.It Fl h | \-help 158.It Fl h | -help
159Print the help page. 159Print the help page.
160.It Fl k Ar KEYWORD | Fl \-key= Ns Ar KEYWORD 160.It Fl k Ar KEYWORD | Fl -key= Ns Ar KEYWORD
161Additional key to index the content with (to add multiple keys, specify multiple times). 161Additional key to index the content with (to add multiple keys, specify multiple times).
162Each additional key is case\-sensitive. 162Each additional key is case-sensitive.
163Can be specified multiple times. 163Can be specified multiple times.
164The keyword is only applied to the top\-level file or directory. 164The keyword is only applied to the top-level file or directory.
165.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 165.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
166Change the loglevel. 166Change the loglevel.
167Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 167Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
168.It Fl m Ar TYPE:VALUE | Fl \-meta= Ns Ar TYPE:VALUE 168.It Fl m Ar TYPE:VALUE | Fl -meta= Ns Ar TYPE:VALUE
169For the main file (or directory), set the metadata of the given TYPE to the given VALUE. 169For the main file (or directory), set the metadata of the given TYPE to the given VALUE.
170Note that this will not add the respective VALUE to the set of keywords under which the file can be found. 170Note that this will not add the respective VALUE to the set of keywords under which the file can be found.
171.It Fl n | \-noindex 171.It Fl n | -noindex
172Executive summary: You probably don't need it. 172Executive summary: You probably don't need it.
173Do not index, full publishing. 173Do not index, full publishing.
174Note that directories, information for keyword search, namespace search and indexing data are always published (even without this option). 174Note that directories, information for keyword search, namespace search and indexing data are always published (even without this option).
175With this option, every block of the actual files is stored in encrypted form in the block database of the local peer. 175With this option, every block of the actual files is stored in encrypted form in the block database of the local peer.
176While 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. 176While 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.
177.It Fl N Ar ID | Fl \-next= Ns Ar ID 177.It Fl N Ar ID | Fl -next= Ns Ar ID
178Specifies the next identifier of a future version of the file to be published under the same pseudonym. 178Specifies the next identifier of a future version of the file to be published under the same pseudonym.
179This option is only valid together with the 179This option is only valid together with the
180.Fl P 180.Fl P
@@ -187,36 +187,36 @@ and
187without 187without
188.Fl t 188.Fl t
189is not allowed. 189is not allowed.
190.It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY 190.It Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY
191Executive summary: You probably don't need it. 191Executive summary: You probably don't need it.
192Set the priority of the published content (default: 365). 192Set the priority of the published content (default: 365).
193If the local database is full, GNUnet will discard the content with the lowest ranking. 193If the local database is full, GNUnet will discard the content with the lowest ranking.
194Note that ranks change over time depending on popularity. 194Note that ranks change over time depending on popularity.
195The default should be high enough to preserve the locally published content in favor of content that migrates from other peers. 195The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
196.It Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME 196.It Fl P Ar NAME | Fl -pseudonym= Ns Ar NAME
197For the top-level directory or file, places the file into the namespace identified by the pseudonym NAME. 197For the top-level directory or file, places the file into the namespace identified by the pseudonym NAME.
198NAME must be a valid pseudonym managed by 198NAME must be a valid pseudonym managed by
199.Xr gnunet-identity 1 . 199.Xr gnunet-identity 1 .
200.It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL 200.It Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
201Set the desired replication level. 201Set the desired replication level.
202If 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. 202If 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.
203This option can be used to push some content out into the network harder. 203This option can be used to push some content out into the network harder.
204Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas. 204Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas.
205.It Fl s | \-simulate-only 205.It Fl s | -simulate-only
206When this option is used, gnunet\-publish will not actually publish the file but just simulate what would be done. 206When this option is used, gnunet-publish will not actually publish the file but just simulate what would be done.
207This can be used to compute the GNUnet URI for a file without actually sharing it. 207This can be used to compute the GNUnet URI for a file without actually sharing it.
208.It Fl t Ar ID | Fl \-this= Ns Ar ID 208.It Fl t Ar ID | Fl -this= Ns Ar ID
209Specifies the identifier under which the file is to be published under a pseudonym. 209Specifies the identifier under which the file is to be published under a pseudonym.
210This option is only valid together with the 210This option is only valid together with the
211.Fl P 211.Fl P
212option. 212option.
213.It Fl u Ar URI | Fl \-uri= Ns Ar URI 213.It Fl u Ar URI | Fl -uri= Ns Ar URI
214This option can be used to specify the URI of a file instead of a filename (this is the only case where the otherwise mandatory filename argument must be omitted). 214This option can be used to specify the URI of a file instead of a filename (this is the only case where the otherwise mandatory filename argument must be omitted).
215Instead of publishing a file or directory and using the corresponding URI, gnunet-publish will use this URI and perform the selected namespace or keyword operations. 215Instead of publishing a file or directory and using the corresponding URI, gnunet-publish will use this URI and perform the selected namespace or keyword operations.
216This can be used to add additional keywords to a file that has already been shared or to add files to a namespace for which the URI is known but the content is not locally available. 216This can be used to add additional keywords to a file that has already been shared or to add files to a namespace for which the URI is known but the content is not locally available.
217.It Fl v | \-version 217.It Fl v | -version
218Print the version number. 218Print the version number.
219.It Fl V | \-verbose 219.It Fl V | -verbose
220Be verbose. 220Be verbose.
221Using 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. 221Using 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.
222.El 222.El