diff options
Diffstat (limited to 'doc/man/gnunet-publish.1')
-rw-r--r-- | doc/man/gnunet-publish.1 | 507 |
1 files changed, 257 insertions, 250 deletions
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1 index 8811ad6e2..5bc2eec76 100644 --- a/doc/man/gnunet-publish.1 +++ b/doc/man/gnunet-publish.1 | |||
@@ -1,4 +1,4 @@ | |||
1 | .TH GNUNET-PUBLISH "1" "16 Nov 2015" "GNUnet" | 1 | .TH GNUNET-PUBLISH "1" "November 16, 2015" "GNUnet" |
2 | .SH NAME | 2 | .SH NAME |
3 | gnunet\-publish \- a command line interface for publishing new content into GNUnet | 3 | gnunet\-publish \- a command line interface for publishing new content into GNUnet |
4 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
@@ -7,321 +7,328 @@ gnunet\-publish \- a command line interface for publishing new content into GNUn | |||
7 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
8 | .PP | 8 | .PP |
9 | In order to share files with other GNUnet users, the files must first | 9 | In order to share files with other GNUnet users, the files must first |
10 | be made available to GNUnet. GNUnet does not automatically share all | 10 | be made available to GNUnet. |
11 | files from a certain directory (however, you can do this with the | 11 | GNUnet does not automatically share all files from a certain directory |
12 | gnunet\-auto\-share tool). In fact, even files that are downloaded | 12 | (however, you can do this with the gnunet\-auto\-share tool). |
13 | are not automatically shared. | 13 | In fact, even files that are downloaded are not automatically shared. |
14 | .PP | 14 | .PP |
15 | In order to start sharing files, the files must be added either using | 15 | In order to start sharing files, the files must be added either using |
16 | gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk. The | 16 | gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk. |
17 | command line tool gnunet\-publish is more useful if many files are | 17 | The command line tool gnunet\-publish is more useful if many files are |
18 | supposed to be added. gnunet\-publish can automatically publish | 18 | supposed to be added. |
19 | batches of files, recursively publish directories, create directories | 19 | gnunet\-publish can automatically publish batches of files, |
20 | that can be browsed within GNUnet and publish file lists in a | 20 | recursively publish directories, create directories that can be |
21 | namespace. When run on a directory, gnunet\-publish will always | 21 | browsed within GNUnet and publish file lists in a namespace. |
22 | recursively publish all of the files in the directory. | 22 | When run on a directory, gnunet\-publish will always recursively |
23 | publish all of the files in the directory. | ||
23 | .PP | 24 | .PP |
24 | gnunet\-publish can automatically extract keywords from the files that | 25 | gnunet\-publish can automatically extract keywords from the files that |
25 | are shared. Users that want to download files from GNUnet use | 26 | are shared. |
26 | keywords to search for the appropriate content. You can disable | 27 | Users that want to download files from GNUnet use keywords to search |
27 | keyword extraction with the \-D option. You can manually add keywords | 28 | for the appropriate content. |
28 | using the \-k option. The keywords are case\-sensitive. | 29 | You can disable keyword extraction with the \-D option. |
30 | You can manually add keywords using the \-k option. | ||
31 | The keywords are case\-sensitive. | ||
29 | .PP | 32 | .PP |
30 | In addition to searching for files by keyword, GNUnet allows | 33 | In addition to searching for files by keyword, GNUnet allows |
31 | organizing files into directories. With directories, the user only | 34 | organizing files into directories. |
32 | needs to find the directory in order to be able to download any of the | 35 | With directories, the user only needs to find the directory in order |
33 | files listed in the directory. Directories can contain pointers to | 36 | to be able to download any of the files listed in the directory. |
34 | other directories. | 37 | Directories can contain pointers to other directories. |
35 | .PP | 38 | .PP |
36 | With gnunet\-publish, it is easy to create new directories | 39 | With gnunet\-publish, it is easy to create new directories |
37 | simultaneously when adding the files. Simply pass the name of a | 40 | simultaneously when adding the files. |
38 | directory instead of a file. | 41 | Simply pass the name of a directory instead of a file. |
39 | .PP | 42 | .PP |
40 | Since keywords can be spammed (any user can add any content under any | 43 | Since keywords can be spammed (any user can add any content under any |
41 | keyword), GNUnet supports namespaces. A namespace is a subset of the | 44 | keyword), GNUnet supports namespaces. |
42 | searchspace into which only the holder of a certain pseudonym can add | 45 | A namespace is a subset of the searchspace into which only the holder |
43 | content. Any GNUnet user can create any number of pseudonyms using | 46 | of a certain pseudonym can add content. |
44 | \fBgnunet\-pseudonym\fR. Pseudonyms are stored in the user's GNUnet | 47 | Any GNUnet user can create any number of pseudonyms using |
45 | directory. While pseudonyms are locally identified with an arbitrary | 48 | \fBgnunet\-pseudonym\fR. Pseudonyms are stored in the user's GNUnet |
46 | string that the user selects when the pseudonym is created, the | 49 | directory. |
47 | namespace is globally known only under the hash of the public key of | 50 | While pseudonyms are locally identified with an arbitrary string that |
48 | the pseudonym. Since only the owner of the pseudonym can add content | 51 | the user selects when the pseudonym is created, the namespace is |
49 | to the namespace, it is impossible for other users to pollute the | 52 | globally known only under the hash of the public key of the pseudonym. |
50 | namespace. gnunet\-publish automatically publishes the top\-directory | 53 | Since only the owner of the pseudonym can add content to the |
51 | (or the only file if only one file is specified) into the namespace if | 54 | namespace, it is impossible for other users to pollute the namespace. |
52 | a pseudonym is specified. | 55 | gnunet\-publish automatically publishes the top\-directory (or the |
56 | only file if only one file is specified) into the namespace if a | ||
57 | pseudonym is specified. | ||
53 | .PP | 58 | .PP |
54 | It is possible to update content in GNUnet if that content was placed | 59 | It is possible to update content in GNUnet if that content was placed |
55 | and obtained from a particular namespace. Updates are only possible | 60 | and obtained from a particular namespace. |
56 | for content in namespaces since this is the only way to assure that a | 61 | Updates are only possible for content in namespaces since this is the |
57 | malicious party can not supply counterfeited updates. Note that an | 62 | only way to assure that a malicious party can not supply counterfeited |
58 | update with GNUnet does not make the old content unavailable, GNUnet | 63 | updates. |
59 | merely allows the publisher to point users to more recent | 64 | Note that an update with GNUnet does not make the old content |
60 | versions. You can use the \-N option to specify the future identifier | 65 | unavailable, GNUnet merely allows the publisher to point users to more |
61 | of an update. When using this option, a GNUnet client that finds the | 66 | recent versions. |
62 | current (\-t) identifier will automatically begin a search for the | 67 | You can use the \-N option to specify the future identifier of an |
63 | update (\-N) identifier. If you later publish an update under the | 68 | update. |
64 | (\-N) identifier, both results will be given to the user. | 69 | When using this option, a GNUnet client that finds the current (\-t) |
70 | identifier will automatically begin a search for the update (\-N) | ||
71 | identifier. | ||
72 | If you later publish an update under the (\-N) identifier, both | ||
73 | results will be given to the user. | ||
65 | .PP | 74 | .PP |
66 | You can use automatic meta\-data extraction (based on libextractor) or | 75 | You can use automatic meta\-data extraction (based on libextractor) or |
67 | the command\-line option \-m to specify meta-data. For the \-m option | 76 | the command\-line option \-m to specify meta-data. |
68 | you need to use the form keyword\-type:value. For example, use "\-m | 77 | For the \-m option you need to use the form keyword\-type:value. |
69 | os:Linux" to specify that the operating system is Linux. Common | 78 | For example, use "\-m os:Linux" to specify that the operating system |
70 | meta\-data types are "author", "title" , "mimetype", "filename", | 79 | is Linux. |
71 | "language", "subject" and "keywords". A full list can be obtained | 80 | Common meta\-data types are "author", "title" , "mimetype", |
72 | from the extract tool using the option \-\-list. The meta\-data is | 81 | "filename", "language", "subject" and "keywords". |
73 | used to help users in searching for files on the network. The | 82 | A full list can be obtained from the extract tool using the option |
74 | keywords are case\-sensitive. | 83 | \-\-list. |
84 | The meta\-data is used to help users in searching for files on the | ||
85 | network. | ||
86 | The keywords are case\-sensitive. | ||
75 | .PP | 87 | .PP |
76 | GNUnet supports two styles of publishing files on the | 88 | GNUnet supports two styles of publishing files on the network. |
77 | network. Publishing a file means that a copy of the file is made in | 89 | Publishing a file means that a copy of the file is made in the local |
78 | the local (!) database of the node. Indexing a file means that an | 90 | (!) database of the node. |
79 | index is added to the local (!) database with symbolic links to the | 91 | Indexing a file means that an index is added to the local (!) |
80 | file itself. The links will use the SHA-512 hash of the entire file | 92 | database with symbolic links to the file itself. |
81 | as the filename. Indexing is generally significantly more efficient | 93 | The links will use the SHA-512 hash of the entire file as the |
82 | and the default choice. However, indexing only works if the indexed | 94 | filename. |
83 | file can be read (using the same absolute path) by gnunet-service-fs. | 95 | Indexing is generally significantly more efficient and the default |
96 | choice. | ||
97 | However, indexing only works if the indexed file can be read (using | ||
98 | the same absolute path) by gnunet-service-fs. | ||
84 | If this is not the case, indexing will fail (and gnunet\-publish will | 99 | If this is not the case, indexing will fail (and gnunet\-publish will |
85 | automatically revert to publishing instead). Regardless of which | 100 | automatically revert to publishing instead). |
86 | method is used to publish the file, the file will be slowly (depending | 101 | Regardless of which method is used to publish the file, the file will |
87 | on how often it is requested and on how much bandwidth is available) | 102 | be slowly (depending on how often it is requested and on how much |
88 | dispersed into the network. If you publish or index a file and then | 103 | bandwidth is available) dispersed into the network. |
89 | leave the network, it will almost always NOT be available anymore. | 104 | If you publish or index a file and then leave the network, it will |
90 | 105 | almost always NOT be available anymore. | |
91 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR Use alternate config | 106 | .PP |
92 | file (if this option is not specified, the default is | 107 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR |
93 | ~/.config/gnunet.conf). | 108 | Use alternate config file (if this option is not specified, the |
94 | 109 | default is ~/.config/gnunet.conf). | |
95 | .TP | 110 | .TP |
96 | \fB\-D\fR, \fB\-\-disable\-extractor\fR Disable use of GNU | 111 | \fB\-D\fR, \fB\-\-disable\-extractor\fR |
97 | libextractor for finding additional keywords and metadata. | 112 | Disable use of GNU libextractor for finding additional keywords and |
98 | 113 | metadata. | |
99 | .TP | 114 | .TP |
100 | \fB\-d\fR, \fB\-\-disable\-creation\-time\fR Disable use of creation | 115 | \fB\-d\fR, \fB\-\-disable\-creation\-time\fR |
101 | time timestamp in metadata. Useful to make created directories | 116 | Disable use of creation time timestamp in metadata. |
102 | deterministic and to avoid leaking information about the time at which | 117 | Useful to make created directories deterministic and to avoid leaking |
103 | a file was made available. | 118 | information about the time at which a file was made available. |
104 | |||
105 | .TP | 119 | .TP |
106 | \fB\-e\fR, \fB\-\-extract\fR Print the list of keywords that will be | 120 | \fB\-e\fR, \fB\-\-extract\fR |
107 | used for each file given the current options. Do not perform any | 121 | Print the list of keywords that will be used for each file given the |
108 | indexing or publishing. | 122 | current options. |
109 | 123 | Do not perform any indexing or publishing. | |
110 | .TP | 124 | .TP |
111 | \fB\-h\fR, \fB\-\-help\fR Print a brief help page with all the | 125 | \fB\-h\fR, \fB\-\-help\fR |
112 | options. | 126 | Print a brief help page with all the options. |
113 | |||
114 | .TP | 127 | .TP |
115 | \fB\-k \fIKEYWORD\fR, \fB\-\-key=KEYWORD\fR additional key to index | 128 | \fB\-k \fIKEYWORD\fR, \fB\-\-key=KEYWORD\fR |
116 | the content with (to add multiple keys, specify multiple times). Each | 129 | Additional key to index the content with (to add multiple keys, |
117 | additional key is case\-sensitive. Can be specified multiple times. | 130 | specify multiple times). |
131 | Each additional key is case\-sensitive. | ||
132 | Can be specified multiple times. | ||
118 | The keyword is only applied to the top\-level file or directory. | 133 | The keyword is only applied to the top\-level file or directory. |
119 | |||
120 | .TP | 134 | .TP |
121 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR Change the | 135 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR |
122 | loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and | 136 | Change the loglevel. |
123 | DEBUG. | 137 | Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. |
124 | |||
125 | .TP | 138 | .TP |
126 | \fB\-m \fITYPE:VALUE\fR, \fB\-\-meta=\fITYPE:VALUE\fR For the main | 139 | \fB\-m \fITYPE:VALUE\fR, \fB\-\-meta=\fITYPE:VALUE\fR |
127 | file (or directory), set the metadata of the given TYPE to the given | 140 | For the main file (or directory), set the metadata of the given TYPE |
128 | VALUE. Note that this will not add the respective VALUE to the set of | 141 | to the given VALUE. |
142 | Note that this will not add the respective VALUE to the set of | ||
129 | keywords under which the file can be found. | 143 | keywords under which the file can be found. |
130 | |||
131 | .TP | 144 | .TP |
132 | \fB\-n\fR, \fB\-\-noindex\fR Executive summary: You probably don't | 145 | \fB\-n\fR, \fB\-\-noindex\fR |
133 | need it. | 146 | Executive summary: You probably don't need it. |
134 | 147 | Do not index, full publishing. | |
135 | Do not index, full publishing. Note that directories, information for | 148 | Note that directories, information for keyword search, namespace |
136 | keyword search, namespace search and indexing data are always | 149 | search and indexing data are always published (even without this |
137 | published (even without this option). With this option, every block | 150 | option). |
138 | of the actual files is stored in encrypted form in the block database | 151 | With this option, every block of the actual files is stored in |
139 | of the local peer. While this adds security if the local node is | 152 | encrypted form in the block database of the local peer. |
140 | compromised (the adversary snags your machine), it is significantly | 153 | While this adds security if the local node is compromised (the |
141 | less efficient compared to on\-demand encryption and is definitely not | 154 | adversary snags your machine), it is significantly less efficient |
142 | recommended for large files. | 155 | compared to on\-demand encryption and is definitely not recommended |
143 | 156 | for large files. | |
144 | .TP | 157 | .TP |
145 | \fB\-N \fIID\fR, \fB\-\-next=\fIID\fR Specifies the next identifier of | 158 | \fB\-N \fIID\fR, \fB\-\-next=\fIID\fR |
146 | a future version of the file to be published under the same pseudonym. | 159 | Specifies the next identifier of a future version of the file to be |
147 | This option is only valid together with the \-P option. This option | 160 | published under the same pseudonym. |
148 | can be used to specify what the identifier of an updated version will | 161 | This option is only valid together with the \-P option. |
149 | look like. Note that specifying \-i and \-N without \-t is not | 162 | This option can be used to specify what the identifier of an updated |
150 | allowed. | 163 | version will look like. |
151 | 164 | Note that specifying \-i and \-N without \-t is not allowed. | |
152 | .TP | 165 | .TP |
153 | \fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR Executive summary: | 166 | \fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR |
154 | You probably don't need it. | 167 | Executive summary: You probably don't need it. |
155 | 168 | Set the priority of the published content (default: 365). | |
156 | Set the priority of the published content (default: 365). If the | 169 | If the local database is full, GNUnet will discard the content with |
157 | local database is full, GNUnet will discard the content with the | 170 | the lowest ranking. |
158 | lowest ranking. Note that ranks change over time depending on | 171 | Note that ranks change over time depending on popularity. |
159 | popularity. The default should be high enough to preserve the locally | 172 | The default should be high enough to preserve the locally published |
160 | published content in favor of content that migrates from other peers. | 173 | content in favor of content that migrates from other peers. |
161 | |||
162 | .TP | 174 | .TP |
163 | \fB\-P \fINAME\fR, \fB\-\-pseudonym=\fINAME\fR For the top\-level | 175 | \fB\-P \fINAME\fR, \fB\-\-pseudonym=\fINAME\fR |
164 | directory or file, places the file into the namespace identified by | 176 | For the top\-level directory or file, places the file into the |
165 | the pseudonym NAME. NAME must be a valid pseudonym managed by | 177 | namespace identified by the pseudonym NAME. |
166 | gnunet\-identity. | 178 | NAME must be a valid pseudonym managed by gnunet\-identity. |
167 | |||
168 | .TP | 179 | .TP |
169 | \fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR Set the desired | 180 | \fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR |
170 | replication level. If CONTENT_PUSHING is set to YES, GNUnet will push | 181 | Set the desired replication level. |
171 | each block (for the file) LEVEL times to other peers before doing | 182 | If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the |
172 | normal "random" replication of all content. This option can be used | 183 | file) LEVEL times to other peers before doing normal "random" |
173 | to push some content out into the network harder. Note that pushing | 184 | replication of all content. |
174 | content LEVEL times into the network does not guarantee that there | 185 | This option can be used to push some content out into the network |
175 | will actually be LEVEL replicas. | 186 | harder. |
176 | 187 | Note that pushing content LEVEL times into the network does not | |
188 | guarantee that there will actually be LEVEL replicas. | ||
177 | .TP | 189 | .TP |
178 | \fB\-s\fR, \fB\-\-simulate-only\fR When this option is used, | 190 | \fB\-s\fR, \fB\-\-simulate-only\fR |
179 | gnunet\-publish will not actually publish the file but just simulate | 191 | When this option is used, gnunet\-publish will not actually publish |
180 | what would be done. This can be used to compute the GNUnet URI for a | 192 | the file but just simulate what would be done. |
181 | file without actually sharing it. | 193 | This can be used to compute the GNUnet URI for a file without actually |
182 | 194 | sharing it. | |
183 | .TP | 195 | .TP |
184 | \fB\-t \fIID\fR, \fB\-\-this=\fIID\fR Specifies the identifier under | 196 | \fB\-t \fIID\fR, \fB\-\-this=\fIID\fR |
185 | which the file is to be published under a pseudonym. This option is | 197 | Specifies the identifier under which the file is to be published under |
186 | only valid together with the\ \-P option. | 198 | a pseudonym. |
187 | 199 | This option is only valid together with the\ \-P option. | |
188 | .TP | 200 | .TP |
189 | \fB\-u \fIURI\fR, \fB\-\-uri=\fIURI\fR This option can be used to | 201 | \fB\-u \fIURI\fR, \fB\-\-uri=\fIURI\fR |
190 | specify the URI of a file instead of a filename (this is the only case | 202 | This option can be used to specify the URI of a file instead of a |
191 | where the otherwise mandatory filename argument must be omitted). | 203 | filename (this is the only case where the otherwise mandatory filename |
204 | argument must be omitted). | ||
192 | Instead of publishing a file or directory and using the corresponding | 205 | Instead of publishing a file or directory and using the corresponding |
193 | URI, gnunet\-publish will use this URI and perform the selected | 206 | URI, gnunet\-publish will use this URI and perform the selected |
194 | namespace or keyword operations. This can be used to add additional | 207 | namespace or keyword operations. |
195 | keywords to a file that has already been shared or to add files to a | 208 | This can be used to add additional keywords to a file that has already |
196 | namespace for which the URI is known but the content is not locally | 209 | been shared or to add files to a namespace for which the URI is known |
197 | available. | 210 | but the content is not locally available. |
198 | |||
199 | .TP | 211 | .TP |
200 | \fB\-v\fR, \fB\-\-version\fR Print the version number. | 212 | \fB\-v\fR, \fB\-\-version\fR |
201 | 213 | Print the version number. | |
202 | .TP | 214 | .TP |
203 | \fB\-V\fR, \fB\-\-verbose\fR Be verbose. Using this option causes | 215 | \fB\-V\fR, \fB\-\-verbose\fR |
204 | gnunet\-publish to print progress information and at the end the file | 216 | Be verbose. |
205 | identification that can be used to download the file from GNUnet. | 217 | Using this option causes gnunet\-publish to print progress information |
206 | 218 | and at the end the file identification that can be used to download | |
207 | 219 | the file from GNUnet. | |
208 | .SH SETTING ANONYMITY LEVEL | 220 | .SH SETTING ANONYMITY LEVEL |
209 | |||
210 | The \fB\-a\fR option can be used to specify additional anonymity | 221 | The \fB\-a\fR option can be used to specify additional anonymity |
211 | constraints. If set to 0, GNUnet will publish the file non-anonymously | 222 | constraints. |
212 | and in fact sign the advertisement for the file using your peer's | 223 | If set to 0, GNUnet will publish the file non-anonymously and in fact |
213 | private key. This will allow other users to download the file as fast | 224 | sign the advertisement for the file using your peer's private key. |
214 | as possible, including using non-anonymous methods (DHT, direct | 225 | This will allow other users to download the file as fast as possible, |
215 | transfer). If you set it to 1 (default), you use the standard | 226 | including using non-anonymous methods (DHT, direct transfer). |
216 | anonymous routing algorithm (which does not explicitly leak your | 227 | If you set it to 1 (default), you use the standard anonymous routing |
217 | identity). However, a powerful adversary may still be able to perform | 228 | algorithm (which does not explicitly leak your identity). |
218 | traffic analysis (statistics) to over time infer data about your | 229 | However, a powerful adversary may still be able to perform traffic |
219 | identity. You can gain better privacy by specifying a higher level of | 230 | analysis (statistics) to over time infer data about your identity. |
220 | anonymity, which increases the amount of cover traffic your own | 231 | You can gain better privacy by specifying a higher level of anonymity, |
221 | traffic will get, at the expense of performance. Note that regardless | 232 | which increases the amount of cover traffic your own traffic will get, |
222 | of the anonymity level you choose, peers that cache content in the | 233 | at the expense of performance. |
223 | network always use anonymity level 1. | 234 | Note that regardless of the anonymity level you choose, peers that |
224 | 235 | cache content in the network always use anonymity level 1. | |
225 | The definition of the ANONYMITY LEVEL is the following. 0 means no | 236 | .PP |
226 | anonymity is required. Otherwise a value of 'v' means that 1 out of v | 237 | The definition of the ANONYMITY LEVEL is the following. |
227 | bytes of "anonymous" traffic can be from the local user, leaving 'v-1' | 238 | 0 means no anonymity is required. |
228 | bytes of cover traffic per byte on the wire. Thus, if GNUnet routes n | 239 | Otherwise a value of 'v' means that 1 out of v bytes of "anonymous" |
229 | bytes of messages from foreign peers (using anonymous routing), it may | 240 | traffic can be from the local user, leaving 'v-1' bytes of cover |
230 | originate n/(v-1) bytes of data in the same time\-period. The | 241 | traffic per byte on the wire. |
231 | time\-period is twice the average delay that GNUnet defers forwarded | 242 | Thus, if GNUnet routes n bytes of messages from foreign peers (using |
232 | queries. | 243 | anonymous routing), it may originate n/(v-1) bytes of data in the same |
233 | 244 | time\-period. | |
234 | The default is 1 and this should be fine for most users. Also notice | 245 | The time\-period is twice the average delay that GNUnet defers |
235 | that if you choose very large values, you may end up having no | 246 | forwarded queries. |
236 | throughput at all, especially if many of your fellow GNUnet\-peers all | 247 | .PP |
237 | do the same. | 248 | The default is 1 and this should be fine for most users. |
238 | 249 | Also notice that if you choose very large values, you may end up | |
239 | 250 | having no throughput at all, especially if many of your fellow | |
251 | GNUnet\-peers all do the same. | ||
240 | .SH EXAMPLES | 252 | .SH EXAMPLES |
241 | .PP | 253 | .PP |
242 | |||
243 | \fBBasic examples\fR | 254 | \fBBasic examples\fR |
244 | 255 | .TP | |
245 | Index a file COPYING: | 256 | gnunet\-publish COPYING |
246 | 257 | Index a file COPYING | |
247 | # gnunet\-publish COPYING | 258 | .TP |
248 | 259 | gnunet\-publish \-n COPYING | |
249 | Publish a file COPYING: | 260 | Publish a file COPYING |
250 | 261 | .TP | |
251 | # gnunet\-publish \-n COPYING | 262 | gnunet\-publish \-k gpl \-k test COPYING |
252 | 263 | Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR | |
253 | Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR: | 264 | .TP |
254 | 265 | gnunet\-publish \-m "description:GNU License" \-k gpl \-k test \-m "mimetype:text/plain" COPYING | |
255 | # gnunet\-publish \-k gpl \-k test COPYING | ||
256 | |||
257 | Index a file COPYING with description "GNU License", mime-type | 266 | Index a file COPYING with description "GNU License", mime-type |
258 | "text/plain" and keywords \fBgpl\fR and \fBtest\fR: | 267 | "text/plain" and keywords \fBgpl\fR and \fBtest\fR |
259 | 268 | .PP | |
260 | # gnunet\-publish \-m "description:GNU License" \-k gpl \-k test \-m | ||
261 | "mimetype:text/plain" COPYING | ||
262 | |||
263 | \fBUsing directories\fR | 269 | \fBUsing directories\fR |
264 | 270 | .TP | |
271 | mkdir gnu ; mv COPYING AUTHORS gnu/ ; gnunet\-publish \-k test \-k gnu \-D gnu/ | ||
265 | Index the files COPYING and AUTHORS with keyword \fBtest\fR and build | 272 | Index the files COPYING and AUTHORS with keyword \fBtest\fR and build |
266 | a directory containing the two files. Make the directory itself | 273 | a directory containing the two files. Make the directory itself |
267 | available under keyword \fBgnu\fR and disable keyword extraction using | 274 | available under keyword \fBgnu\fR and disable keyword extraction using |
268 | libextractor: | 275 | libextractor |
269 | 276 | .TP | |
270 | # mkdir gnu mv COPYING AUTHORS gnu/ gnunet\-publish \-k test \-k gnu | 277 | gnunet\-publish \-n \-m "description:Kitten collection" \-k kittens kittendir/ |
271 | # \-D gnu/ | ||
272 | |||
273 | Neatly publish an image gallery in \fBkittendir/\fR and its subdirs | 278 | Neatly publish an image gallery in \fBkittendir/\fR and its subdirs |
274 | with keyword \fBkittens\fR for the directory but no keywords for the | 279 | with keyword \fBkittens\fR for the directory but no keywords for the |
275 | individual files or subdirs (\-n). Force description for all files: | 280 | individual files or subdirs (\-n). |
276 | 281 | Force description for all files. | |
277 | # gnunet\-publish \-n \-m "description:Kitten collection" \-k kittens | 282 | .PP |
278 | kittendir/ | ||
279 | |||
280 | \fBSecure publishing with namespaces\fR | 283 | \fBSecure publishing with namespaces\fR |
281 | 284 | .TP | |
285 | gnunet\-publish \-P RIAA-2 \-t gpl COPYING | ||
282 | Publish file COPYING with pseudonym RIAA-2 (\-P) and with identifier | 286 | Publish file COPYING with pseudonym RIAA-2 (\-P) and with identifier |
283 | \fBgpl\fR (\-t) and no updates: | 287 | \fBgpl\fR (\-t) and no updates |
284 | 288 | .TP | |
285 | # gnunet\-publish \-P RIAA-2 \-t gpl COPYING | 289 | gnunet\-publish \-P RIAA-2 \-t MUSIC \-N VIDEOS /home/ogg |
286 | |||
287 | Recursively index /home/ogg and build a matching directory | 290 | Recursively index /home/ogg and build a matching directory |
288 | structure. Publish the top\-level directory into the namespace under | 291 | structure. Publish the top\-level directory into the namespace under |
289 | the pseudonym RIAA\-2 (\-P) under identifier 'MUSIC' (\-t) and promise | 292 | the pseudonym RIAA\-2 (\-P) under identifier 'MUSIC' (\-t) and promise |
290 | to provide an update with identifier 'VIDEOS' (\-N): | 293 | to provide an update with identifier 'VIDEOS' (\-N): |
291 | 294 | .TP | |
292 | # gnunet\-publish \-P RIAA-2 \-t MUSIC \-N VIDEOS /home/ogg | 295 | gnunet\-publish \-nV /var/lib/mysql |
293 | |||
294 | Recursively publish (\-n) /var/lib/mysql and build a matching | 296 | Recursively publish (\-n) /var/lib/mysql and build a matching |
295 | directory structure, but disable the use of libextractor to extract | 297 | directory structure, but disable the use of libextractor to extract |
296 | keywords (\-n). Print the file identifiers (\-V) that can be used to | 298 | keywords (\-n). |
297 | retrieve the files. This will store a copy of the MySQL database in | 299 | Print the file identifiers (\-V) that can be used to retrieve the |
298 | GNUnet but without adding any keywords to search for it. Thus only | 300 | files. |
299 | people that have been told the secret file identifiers printed with | 301 | This will store a copy of the MySQL database in GNUnet but without |
300 | the \-V option can retrieve the (secret?) files: | 302 | adding any keywords to search for it. |
301 | 303 | Thus only people that have been told the secret file identifiers | |
302 | # gnunet\-publish \-nV /var/lib/mysql | 304 | printed with the \-V option can retrieve the (secret?) files: |
303 | 305 | .TP | |
306 | gnunet\-publish \-P MPAA-1 \-t root \-N next noise.mp3 | ||
304 | Create a namespace entry 'root' in namespace MPAA-1 and announce that | 307 | Create a namespace entry 'root' in namespace MPAA-1 and announce that |
305 | the next update will be called 'next': | 308 | the next update will be called 'next': |
306 | 309 | .TP | |
307 | # gnunet\-publish \-P MPAA-1 \-t root \-N next noise.mp3 | 310 | gnunet\-publish \-P MPAA-1 \-t next noise_updated.mp3 |
308 | |||
309 | Update the previous entry, do not allow any future updates: | 311 | Update the previous entry, do not allow any future updates: |
310 | |||
311 | # gnunet\-publish \-P MPAA-1 \-t next noise_updated.mp3 | ||
312 | |||
313 | |||
314 | .SH FILES | 312 | .SH FILES |
315 | .TP | 313 | .TP |
316 | ~/.config/gnunet.conf | 314 | ~/.config/gnunet.conf |
317 | GNUnet configuration file | 315 | GNUnet configuration file |
318 | .SH "REPORTING BUGS" | 316 | .SH BUGS |
319 | Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 317 | Report bugs to <https://gnunet.org/bugs/> or by sending electronic |
320 | .SH "SEE ALSO" | 318 | mail to <gnunet\-developers@gnu.org> |
321 | \fBgnunet\-auto\-share\fP(1), \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1), \fBgnunet\-identity\fP(1) | 319 | .SH SEE ALSO |
320 | \fBgnunet\-auto\-share\fP(1) | ||
321 | \fBgnunet\-fs\-gtk\fP(1) | ||
322 | \fBgnunet\-search\fP(1) | ||
323 | \fBgnunet\-download\fP(1) | ||
324 | \fBgnunet.conf\fP(5) | ||
325 | \fBextract\fP(1) | ||
326 | \fBgnunet\-identity\fP(1) | ||
327 | .PP | ||
322 | The full documentation for | 328 | The full documentation for |
323 | .B gnunet | 329 | .B gnunet |
324 | is maintained as a Texinfo manual. If the | 330 | is maintained as a Texinfo manual. |
331 | If the | ||
325 | .B info | 332 | .B info |
326 | and | 333 | and |
327 | .B gnunet | 334 | .B gnunet |