diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/documentation/Makefile.am | 5 | ||||
-rw-r--r-- | doc/documentation/agpl-3.0.texi | 698 | ||||
-rw-r--r-- | doc/documentation/chapters/contributing.texi | 25 | ||||
-rw-r--r-- | doc/documentation/chapters/developer.texi | 13 | ||||
-rw-r--r-- | doc/documentation/chapters/installation.texi | 129 | ||||
-rw-r--r-- | doc/documentation/chapters/preface.texi | 67 | ||||
-rw-r--r-- | doc/documentation/chapters/user.texi | 364 | ||||
-rw-r--r-- | doc/documentation/gnunet.texi | 21 | ||||
-rw-r--r-- | doc/man/Makefile.am | 1 | ||||
-rw-r--r-- | doc/man/gnunet-gns.1 | 2 | ||||
-rw-r--r-- | doc/man/gnunet-timeout.1 | 20 |
11 files changed, 1206 insertions, 139 deletions
diff --git a/doc/documentation/Makefile.am b/doc/documentation/Makefile.am index 0ee81304e..b6c666c4d 100644 --- a/doc/documentation/Makefile.am +++ b/doc/documentation/Makefile.am | |||
@@ -144,6 +144,7 @@ DISTCLEANFILES = \ | |||
144 | chapters/terminology.cps \ | 144 | chapters/terminology.cps \ |
145 | chapters/vocabulary.cps \ | 145 | chapters/vocabulary.cps \ |
146 | fdl-1.3.cps \ | 146 | fdl-1.3.cps \ |
147 | agpl-3.0.cps \ | ||
147 | gpl-3.0.cps | 148 | gpl-3.0.cps |
148 | 149 | ||
149 | # if HAVE_EXTENDED_DOCUMENTATION_BUILDING | 150 | # if HAVE_EXTENDED_DOCUMENTATION_BUILDING |
@@ -166,8 +167,8 @@ lego_stack.png: images/lego_stack.svg | |||
166 | # echo "@set EDITION $(PACKAGE_VERSION)" >> $@ | 167 | # echo "@set EDITION $(PACKAGE_VERSION)" >> $@ |
167 | # echo "@set VERSION $(PACKAGE_VERSION)" >> $@ | 168 | # echo "@set VERSION $(PACKAGE_VERSION)" >> $@ |
168 | 169 | ||
169 | # Workaround for makeinfo error. Whcih in turn introduces more | 170 | # Workaround for makeinfo error. Which in turn introduces more |
170 | # date-related 'warnings'. Well. | 171 | # date-related 'warnings' for GNUism. Well. |
171 | version2.texi: | 172 | version2.texi: |
172 | echo "@set UPDATED $(date +'%d %B %Y')" > $@ | 173 | echo "@set UPDATED $(date +'%d %B %Y')" > $@ |
173 | echo "@set UPDATED-MONTH $(date +'%B %Y')" >> $@ | 174 | echo "@set UPDATED-MONTH $(date +'%B %Y')" >> $@ |
diff --git a/doc/documentation/agpl-3.0.texi b/doc/documentation/agpl-3.0.texi new file mode 100644 index 000000000..eabb0c6df --- /dev/null +++ b/doc/documentation/agpl-3.0.texi | |||
@@ -0,0 +1,698 @@ | |||
1 | @c The GNU Affero General Public License. | ||
2 | @center Version 3, 19 November 2007 | ||
3 | |||
4 | @c This file is intended to be included within another document, | ||
5 | @c hence no sectioning command or @node. | ||
6 | |||
7 | @display | ||
8 | Copyright @copyright{} 2007 Free Software Foundation, Inc. @url{https://fsf.org/} | ||
9 | |||
10 | Everyone is permitted to copy and distribute verbatim copies of this | ||
11 | license document, but changing it is not allowed. | ||
12 | @end display | ||
13 | |||
14 | @heading Preamble | ||
15 | |||
16 | The GNU Affero General Public License is a free, copyleft license | ||
17 | for software and other kinds of works, specifically designed to ensure | ||
18 | cooperation with the community in the case of network server software. | ||
19 | |||
20 | The licenses for most software and other practical works are | ||
21 | designed to take away your freedom to share and change the works. By | ||
22 | contrast, our General Public Licenses are intended to guarantee your | ||
23 | freedom to share and change all versions of a program--to make sure it | ||
24 | remains free software for all its users. | ||
25 | |||
26 | When we speak of free software, we are referring to freedom, not | ||
27 | price. Our General Public Licenses are designed to make sure that you | ||
28 | have the freedom to distribute copies of free software (and charge for | ||
29 | them if you wish), that you receive source code or can get it if you | ||
30 | want it, that you can change the software or use pieces of it in new | ||
31 | free programs, and that you know you can do these things. | ||
32 | |||
33 | Developers that use our General Public Licenses protect your rights | ||
34 | with two steps: (1) assert copyright on the software, and (2) offer | ||
35 | you this License which gives you legal permission to copy, distribute | ||
36 | and/or modify the software. | ||
37 | |||
38 | A secondary benefit of defending all users' freedom is that | ||
39 | improvements made in alternate versions of the program, if they | ||
40 | receive widespread use, become available for other developers to | ||
41 | incorporate. Many developers of free software are heartened and | ||
42 | encouraged by the resulting cooperation. However, in the case of | ||
43 | software used on network servers, this result may fail to come about. | ||
44 | The GNU General Public License permits making a modified version and | ||
45 | letting the public access it on a server without ever releasing its | ||
46 | source code to the public. | ||
47 | |||
48 | The GNU Affero General Public License is designed specifically to | ||
49 | ensure that, in such cases, the modified source code becomes available | ||
50 | to the community. It requires the operator of a network server to | ||
51 | provide the source code of the modified version running there to the | ||
52 | users of that server. Therefore, public use of a modified version, on | ||
53 | a publicly accessible server, gives the public access to the source | ||
54 | code of the modified version. | ||
55 | |||
56 | An older license, called the Affero General Public License and | ||
57 | published by Affero, was designed to accomplish similar goals. This is | ||
58 | a different license, not a version of the Affero GPL, but Affero has | ||
59 | released a new version of the Affero GPL which permits relicensing under | ||
60 | this license. | ||
61 | |||
62 | The precise terms and conditions for copying, distribution and | ||
63 | modification follow. | ||
64 | |||
65 | @heading TERMS AND CONDITIONS | ||
66 | |||
67 | @enumerate 0 | ||
68 | @item Definitions. | ||
69 | |||
70 | ``This License'' refers to version 3 of the GNU Affero General Public License. | ||
71 | |||
72 | ``Copyright'' also means copyright-like laws that apply to other kinds | ||
73 | of works, such as semiconductor masks. | ||
74 | |||
75 | ``The Program'' refers to any copyrightable work licensed under this | ||
76 | License. Each licensee is addressed as ``you''. ``Licensees'' and | ||
77 | ``recipients'' may be individuals or organizations. | ||
78 | |||
79 | To ``modify'' a work means to copy from or adapt all or part of the work | ||
80 | in a fashion requiring copyright permission, other than the making of | ||
81 | an exact copy. The resulting work is called a ``modified version'' of | ||
82 | the earlier work or a work ``based on'' the earlier work. | ||
83 | |||
84 | A ``covered work'' means either the unmodified Program or a work based | ||
85 | on the Program. | ||
86 | |||
87 | To ``propagate'' a work means to do anything with it that, without | ||
88 | permission, would make you directly or secondarily liable for | ||
89 | infringement under applicable copyright law, except executing it on a | ||
90 | computer or modifying a private copy. Propagation includes copying, | ||
91 | distribution (with or without modification), making available to the | ||
92 | public, and in some countries other activities as well. | ||
93 | |||
94 | To ``convey'' a work means any kind of propagation that enables other | ||
95 | parties to make or receive copies. Mere interaction with a user | ||
96 | through a computer network, with no transfer of a copy, is not | ||
97 | conveying. | ||
98 | |||
99 | An interactive user interface displays ``Appropriate Legal Notices'' to | ||
100 | the extent that it includes a convenient and prominently visible | ||
101 | feature that (1) displays an appropriate copyright notice, and (2) | ||
102 | tells the user that there is no warranty for the work (except to the | ||
103 | extent that warranties are provided), that licensees may convey the | ||
104 | work under this License, and how to view a copy of this License. If | ||
105 | the interface presents a list of user commands or options, such as a | ||
106 | menu, a prominent item in the list meets this criterion. | ||
107 | |||
108 | @item Source Code. | ||
109 | |||
110 | The ``source code'' for a work means the preferred form of the work for | ||
111 | making modifications to it. ``Object code'' means any non-source form | ||
112 | of a work. | ||
113 | |||
114 | A ``Standard Interface'' means an interface that either is an official | ||
115 | standard defined by a recognized standards body, or, in the case of | ||
116 | interfaces specified for a particular programming language, one that | ||
117 | is widely used among developers working in that language. | ||
118 | |||
119 | The ``System Libraries'' of an executable work include anything, other | ||
120 | than the work as a whole, that (a) is included in the normal form of | ||
121 | packaging a Major Component, but which is not part of that Major | ||
122 | Component, and (b) serves only to enable use of the work with that | ||
123 | Major Component, or to implement a Standard Interface for which an | ||
124 | implementation is available to the public in source code form. A | ||
125 | ``Major Component'', in this context, means a major essential component | ||
126 | (kernel, window system, and so on) of the specific operating system | ||
127 | (if any) on which the executable work runs, or a compiler used to | ||
128 | produce the work, or an object code interpreter used to run it. | ||
129 | |||
130 | The ``Corresponding Source'' for a work in object code form means all | ||
131 | the source code needed to generate, install, and (for an executable | ||
132 | work) run the object code and to modify the work, including scripts to | ||
133 | control those activities. However, it does not include the work's | ||
134 | System Libraries, or general-purpose tools or generally available free | ||
135 | programs which are used unmodified in performing those activities but | ||
136 | which are not part of the work. For example, Corresponding Source | ||
137 | includes interface definition files associated with source files for | ||
138 | the work, and the source code for shared libraries and dynamically | ||
139 | linked subprograms that the work is specifically designed to require, | ||
140 | such as by intimate data communication or control flow between those | ||
141 | subprograms and other parts of the work. | ||
142 | |||
143 | The Corresponding Source need not include anything that users can | ||
144 | regenerate automatically from other parts of the Corresponding Source. | ||
145 | |||
146 | The Corresponding Source for a work in source code form is that same | ||
147 | work. | ||
148 | |||
149 | @item Basic Permissions. | ||
150 | |||
151 | All rights granted under this License are granted for the term of | ||
152 | copyright on the Program, and are irrevocable provided the stated | ||
153 | conditions are met. This License explicitly affirms your unlimited | ||
154 | permission to run the unmodified Program. The output from running a | ||
155 | covered work is covered by this License only if the output, given its | ||
156 | content, constitutes a covered work. This License acknowledges your | ||
157 | rights of fair use or other equivalent, as provided by copyright law. | ||
158 | |||
159 | You may make, run and propagate covered works that you do not convey, | ||
160 | without conditions so long as your license otherwise remains in force. | ||
161 | You may convey covered works to others for the sole purpose of having | ||
162 | them make modifications exclusively for you, or provide you with | ||
163 | facilities for running those works, provided that you comply with the | ||
164 | terms of this License in conveying all material for which you do not | ||
165 | control copyright. Those thus making or running the covered works for | ||
166 | you must do so exclusively on your behalf, under your direction and | ||
167 | control, on terms that prohibit them from making any copies of your | ||
168 | copyrighted material outside their relationship with you. | ||
169 | |||
170 | Conveying under any other circumstances is permitted solely under the | ||
171 | conditions stated below. Sublicensing is not allowed; section 10 | ||
172 | makes it unnecessary. | ||
173 | |||
174 | @item Protecting Users' Legal Rights From Anti-Circumvention Law. | ||
175 | |||
176 | No covered work shall be deemed part of an effective technological | ||
177 | measure under any applicable law fulfilling obligations under article | ||
178 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or | ||
179 | similar laws prohibiting or restricting circumvention of such | ||
180 | measures. | ||
181 | |||
182 | When you convey a covered work, you waive any legal power to forbid | ||
183 | circumvention of technological measures to the extent such | ||
184 | circumvention is effected by exercising rights under this License with | ||
185 | respect to the covered work, and you disclaim any intention to limit | ||
186 | operation or modification of the work as a means of enforcing, against | ||
187 | the work's users, your or third parties' legal rights to forbid | ||
188 | circumvention of technological measures. | ||
189 | |||
190 | @item Conveying Verbatim Copies. | ||
191 | |||
192 | You may convey verbatim copies of the Program's source code as you | ||
193 | receive it, in any medium, provided that you conspicuously and | ||
194 | appropriately publish on each copy an appropriate copyright notice; | ||
195 | keep intact all notices stating that this License and any | ||
196 | non-permissive terms added in accord with section 7 apply to the code; | ||
197 | keep intact all notices of the absence of any warranty; and give all | ||
198 | recipients a copy of this License along with the Program. | ||
199 | |||
200 | You may charge any price or no price for each copy that you convey, | ||
201 | and you may offer support or warranty protection for a fee. | ||
202 | |||
203 | @item Conveying Modified Source Versions. | ||
204 | |||
205 | You may convey a work based on the Program, or the modifications to | ||
206 | produce it from the Program, in the form of source code under the | ||
207 | terms of section 4, provided that you also meet all of these | ||
208 | conditions: | ||
209 | |||
210 | @enumerate a | ||
211 | @item | ||
212 | The work must carry prominent notices stating that you modified it, | ||
213 | and giving a relevant date. | ||
214 | |||
215 | @item | ||
216 | The work must carry prominent notices stating that it is released | ||
217 | under this License and any conditions added under section 7. This | ||
218 | requirement modifies the requirement in section 4 to ``keep intact all | ||
219 | notices''. | ||
220 | |||
221 | @item | ||
222 | You must license the entire work, as a whole, under this License to | ||
223 | anyone who comes into possession of a copy. This License will | ||
224 | therefore apply, along with any applicable section 7 additional terms, | ||
225 | to the whole of the work, and all its parts, regardless of how they | ||
226 | are packaged. This License gives no permission to license the work in | ||
227 | any other way, but it does not invalidate such permission if you have | ||
228 | separately received it. | ||
229 | |||
230 | @item | ||
231 | If the work has interactive user interfaces, each must display | ||
232 | Appropriate Legal Notices; however, if the Program has interactive | ||
233 | interfaces that do not display Appropriate Legal Notices, your work | ||
234 | need not make them do so. | ||
235 | @end enumerate | ||
236 | |||
237 | A compilation of a covered work with other separate and independent | ||
238 | works, which are not by their nature extensions of the covered work, | ||
239 | and which are not combined with it such as to form a larger program, | ||
240 | in or on a volume of a storage or distribution medium, is called an | ||
241 | ``aggregate'' if the compilation and its resulting copyright are not | ||
242 | used to limit the access or legal rights of the compilation's users | ||
243 | beyond what the individual works permit. Inclusion of a covered work | ||
244 | in an aggregate does not cause this License to apply to the other | ||
245 | parts of the aggregate. | ||
246 | |||
247 | @item Conveying Non-Source Forms. | ||
248 | |||
249 | You may convey a covered work in object code form under the terms of | ||
250 | sections 4 and 5, provided that you also convey the machine-readable | ||
251 | Corresponding Source under the terms of this License, in one of these | ||
252 | ways: | ||
253 | |||
254 | @enumerate a | ||
255 | @item | ||
256 | Convey the object code in, or embodied in, a physical product | ||
257 | (including a physical distribution medium), accompanied by the | ||
258 | Corresponding Source fixed on a durable physical medium customarily | ||
259 | used for software interchange. | ||
260 | |||
261 | @item | ||
262 | Convey the object code in, or embodied in, a physical product | ||
263 | (including a physical distribution medium), accompanied by a written | ||
264 | offer, valid for at least three years and valid for as long as you | ||
265 | offer spare parts or customer support for that product model, to give | ||
266 | anyone who possesses the object code either (1) a copy of the | ||
267 | Corresponding Source for all the software in the product that is | ||
268 | covered by this License, on a durable physical medium customarily used | ||
269 | for software interchange, for a price no more than your reasonable | ||
270 | cost of physically performing this conveying of source, or (2) access | ||
271 | to copy the Corresponding Source from a network server at no charge. | ||
272 | |||
273 | @item | ||
274 | Convey individual copies of the object code with a copy of the written | ||
275 | offer to provide the Corresponding Source. This alternative is | ||
276 | allowed only occasionally and noncommercially, and only if you | ||
277 | received the object code with such an offer, in accord with subsection | ||
278 | 6b. | ||
279 | |||
280 | @item | ||
281 | Convey the object code by offering access from a designated place | ||
282 | (gratis or for a charge), and offer equivalent access to the | ||
283 | Corresponding Source in the same way through the same place at no | ||
284 | further charge. You need not require recipients to copy the | ||
285 | Corresponding Source along with the object code. If the place to copy | ||
286 | the object code is a network server, the Corresponding Source may be | ||
287 | on a different server (operated by you or a third party) that supports | ||
288 | equivalent copying facilities, provided you maintain clear directions | ||
289 | next to the object code saying where to find the Corresponding Source. | ||
290 | Regardless of what server hosts the Corresponding Source, you remain | ||
291 | obligated to ensure that it is available for as long as needed to | ||
292 | satisfy these requirements. | ||
293 | |||
294 | @item | ||
295 | Convey the object code using peer-to-peer transmission, provided you | ||
296 | inform other peers where the object code and Corresponding Source of | ||
297 | the work are being offered to the general public at no charge under | ||
298 | subsection 6d. | ||
299 | |||
300 | @end enumerate | ||
301 | |||
302 | A separable portion of the object code, whose source code is excluded | ||
303 | from the Corresponding Source as a System Library, need not be | ||
304 | included in conveying the object code work. | ||
305 | |||
306 | A ``User Product'' is either (1) a ``consumer product'', which means any | ||
307 | tangible personal property which is normally used for personal, | ||
308 | family, or household purposes, or (2) anything designed or sold for | ||
309 | incorporation into a dwelling. In determining whether a product is a | ||
310 | consumer product, doubtful cases shall be resolved in favor of | ||
311 | coverage. For a particular product received by a particular user, | ||
312 | ``normally used'' refers to a typical or common use of that class of | ||
313 | product, regardless of the status of the particular user or of the way | ||
314 | in which the particular user actually uses, or expects or is expected | ||
315 | to use, the product. A product is a consumer product regardless of | ||
316 | whether the product has substantial commercial, industrial or | ||
317 | non-consumer uses, unless such uses represent the only significant | ||
318 | mode of use of the product. | ||
319 | |||
320 | ``Installation Information'' for a User Product means any methods, | ||
321 | procedures, authorization keys, or other information required to | ||
322 | install and execute modified versions of a covered work in that User | ||
323 | Product from a modified version of its Corresponding Source. The | ||
324 | information must suffice to ensure that the continued functioning of | ||
325 | the modified object code is in no case prevented or interfered with | ||
326 | solely because modification has been made. | ||
327 | |||
328 | If you convey an object code work under this section in, or with, or | ||
329 | specifically for use in, a User Product, and the conveying occurs as | ||
330 | part of a transaction in which the right of possession and use of the | ||
331 | User Product is transferred to the recipient in perpetuity or for a | ||
332 | fixed term (regardless of how the transaction is characterized), the | ||
333 | Corresponding Source conveyed under this section must be accompanied | ||
334 | by the Installation Information. But this requirement does not apply | ||
335 | if neither you nor any third party retains the ability to install | ||
336 | modified object code on the User Product (for example, the work has | ||
337 | been installed in ROM). | ||
338 | |||
339 | The requirement to provide Installation Information does not include a | ||
340 | requirement to continue to provide support service, warranty, or | ||
341 | updates for a work that has been modified or installed by the | ||
342 | recipient, or for the User Product in which it has been modified or | ||
343 | installed. Access to a network may be denied when the modification | ||
344 | itself materially and adversely affects the operation of the network | ||
345 | or violates the rules and protocols for communication across the | ||
346 | network. | ||
347 | |||
348 | Corresponding Source conveyed, and Installation Information provided, | ||
349 | in accord with this section must be in a format that is publicly | ||
350 | documented (and with an implementation available to the public in | ||
351 | source code form), and must require no special password or key for | ||
352 | unpacking, reading or copying. | ||
353 | |||
354 | @item Additional Terms. | ||
355 | |||
356 | ``Additional permissions'' are terms that supplement the terms of this | ||
357 | License by making exceptions from one or more of its conditions. | ||
358 | Additional permissions that are applicable to the entire Program shall | ||
359 | be treated as though they were included in this License, to the extent | ||
360 | that they are valid under applicable law. If additional permissions | ||
361 | apply only to part of the Program, that part may be used separately | ||
362 | under those permissions, but the entire Program remains governed by | ||
363 | this License without regard to the additional permissions. | ||
364 | |||
365 | When you convey a copy of a covered work, you may at your option | ||
366 | remove any additional permissions from that copy, or from any part of | ||
367 | it. (Additional permissions may be written to require their own | ||
368 | removal in certain cases when you modify the work.) You may place | ||
369 | additional permissions on material, added by you to a covered work, | ||
370 | for which you have or can give appropriate copyright permission. | ||
371 | |||
372 | Notwithstanding any other provision of this License, for material you | ||
373 | add to a covered work, you may (if authorized by the copyright holders | ||
374 | of that material) supplement the terms of this License with terms: | ||
375 | |||
376 | @enumerate a | ||
377 | @item | ||
378 | Disclaiming warranty or limiting liability differently from the terms | ||
379 | of sections 15 and 16 of this License; or | ||
380 | |||
381 | @item | ||
382 | Requiring preservation of specified reasonable legal notices or author | ||
383 | attributions in that material or in the Appropriate Legal Notices | ||
384 | displayed by works containing it; or | ||
385 | |||
386 | @item | ||
387 | Prohibiting misrepresentation of the origin of that material, or | ||
388 | requiring that modified versions of such material be marked in | ||
389 | reasonable ways as different from the original version; or | ||
390 | |||
391 | @item | ||
392 | Limiting the use for publicity purposes of names of licensors or | ||
393 | authors of the material; or | ||
394 | |||
395 | @item | ||
396 | Declining to grant rights under trademark law for use of some trade | ||
397 | names, trademarks, or service marks; or | ||
398 | |||
399 | @item | ||
400 | Requiring indemnification of licensors and authors of that material by | ||
401 | anyone who conveys the material (or modified versions of it) with | ||
402 | contractual assumptions of liability to the recipient, for any | ||
403 | liability that these contractual assumptions directly impose on those | ||
404 | licensors and authors. | ||
405 | @end enumerate | ||
406 | |||
407 | All other non-permissive additional terms are considered ``further | ||
408 | restrictions'' within the meaning of section 10. If the Program as you | ||
409 | received it, or any part of it, contains a notice stating that it is | ||
410 | governed by this License along with a term that is a further | ||
411 | restriction, you may remove that term. If a license document contains | ||
412 | a further restriction but permits relicensing or conveying under this | ||
413 | License, you may add to a covered work material governed by the terms | ||
414 | of that license document, provided that the further restriction does | ||
415 | not survive such relicensing or conveying. | ||
416 | |||
417 | If you add terms to a covered work in accord with this section, you | ||
418 | must place, in the relevant source files, a statement of the | ||
419 | additional terms that apply to those files, or a notice indicating | ||
420 | where to find the applicable terms. | ||
421 | |||
422 | Additional terms, permissive or non-permissive, may be stated in the | ||
423 | form of a separately written license, or stated as exceptions; the | ||
424 | above requirements apply either way. | ||
425 | |||
426 | @item Termination. | ||
427 | |||
428 | You may not propagate or modify a covered work except as expressly | ||
429 | provided under this License. Any attempt otherwise to propagate or | ||
430 | modify it is void, and will automatically terminate your rights under | ||
431 | this License (including any patent licenses granted under the third | ||
432 | paragraph of section 11). | ||
433 | |||
434 | However, if you cease all violation of this License, then your license | ||
435 | from a particular copyright holder is reinstated (a) provisionally, | ||
436 | unless and until the copyright holder explicitly and finally | ||
437 | terminates your license, and (b) permanently, if the copyright holder | ||
438 | fails to notify you of the violation by some reasonable means prior to | ||
439 | 60 days after the cessation. | ||
440 | |||
441 | Moreover, your license from a particular copyright holder is | ||
442 | reinstated permanently if the copyright holder notifies you of the | ||
443 | violation by some reasonable means, this is the first time you have | ||
444 | received notice of violation of this License (for any work) from that | ||
445 | copyright holder, and you cure the violation prior to 30 days after | ||
446 | your receipt of the notice. | ||
447 | |||
448 | Termination of your rights under this section does not terminate the | ||
449 | licenses of parties who have received copies or rights from you under | ||
450 | this License. If your rights have been terminated and not permanently | ||
451 | reinstated, you do not qualify to receive new licenses for the same | ||
452 | material under section 10. | ||
453 | |||
454 | @item Acceptance Not Required for Having Copies. | ||
455 | |||
456 | You are not required to accept this License in order to receive or run | ||
457 | a copy of the Program. Ancillary propagation of a covered work | ||
458 | occurring solely as a consequence of using peer-to-peer transmission | ||
459 | to receive a copy likewise does not require acceptance. However, | ||
460 | nothing other than this License grants you permission to propagate or | ||
461 | modify any covered work. These actions infringe copyright if you do | ||
462 | not accept this License. Therefore, by modifying or propagating a | ||
463 | covered work, you indicate your acceptance of this License to do so. | ||
464 | |||
465 | @item Automatic Licensing of Downstream Recipients. | ||
466 | |||
467 | Each time you convey a covered work, the recipient automatically | ||
468 | receives a license from the original licensors, to run, modify and | ||
469 | propagate that work, subject to this License. You are not responsible | ||
470 | for enforcing compliance by third parties with this License. | ||
471 | |||
472 | An ``entity transaction'' is a transaction transferring control of an | ||
473 | organization, or substantially all assets of one, or subdividing an | ||
474 | organization, or merging organizations. If propagation of a covered | ||
475 | work results from an entity transaction, each party to that | ||
476 | transaction who receives a copy of the work also receives whatever | ||
477 | licenses to the work the party's predecessor in interest had or could | ||
478 | give under the previous paragraph, plus a right to possession of the | ||
479 | Corresponding Source of the work from the predecessor in interest, if | ||
480 | the predecessor has it or can get it with reasonable efforts. | ||
481 | |||
482 | You may not impose any further restrictions on the exercise of the | ||
483 | rights granted or affirmed under this License. For example, you may | ||
484 | not impose a license fee, royalty, or other charge for exercise of | ||
485 | rights granted under this License, and you may not initiate litigation | ||
486 | (including a cross-claim or counterclaim in a lawsuit) alleging that | ||
487 | any patent claim is infringed by making, using, selling, offering for | ||
488 | sale, or importing the Program or any portion of it. | ||
489 | |||
490 | @item Patents. | ||
491 | |||
492 | A ``contributor'' is a copyright holder who authorizes use under this | ||
493 | License of the Program or a work on which the Program is based. The | ||
494 | work thus licensed is called the contributor's ``contributor version''. | ||
495 | |||
496 | A contributor's ``essential patent claims'' are all patent claims owned | ||
497 | or controlled by the contributor, whether already acquired or | ||
498 | hereafter acquired, that would be infringed by some manner, permitted | ||
499 | by this License, of making, using, or selling its contributor version, | ||
500 | but do not include claims that would be infringed only as a | ||
501 | consequence of further modification of the contributor version. For | ||
502 | purposes of this definition, ``control'' includes the right to grant | ||
503 | patent sublicenses in a manner consistent with the requirements of | ||
504 | this License. | ||
505 | |||
506 | Each contributor grants you a non-exclusive, worldwide, royalty-free | ||
507 | patent license under the contributor's essential patent claims, to | ||
508 | make, use, sell, offer for sale, import and otherwise run, modify and | ||
509 | propagate the contents of its contributor version. | ||
510 | |||
511 | In the following three paragraphs, a ``patent license'' is any express | ||
512 | agreement or commitment, however denominated, not to enforce a patent | ||
513 | (such as an express permission to practice a patent or covenant not to | ||
514 | sue for patent infringement). To ``grant'' such a patent license to a | ||
515 | party means to make such an agreement or commitment not to enforce a | ||
516 | patent against the party. | ||
517 | |||
518 | If you convey a covered work, knowingly relying on a patent license, | ||
519 | and the Corresponding Source of the work is not available for anyone | ||
520 | to copy, free of charge and under the terms of this License, through a | ||
521 | publicly available network server or other readily accessible means, | ||
522 | then you must either (1) cause the Corresponding Source to be so | ||
523 | available, or (2) arrange to deprive yourself of the benefit of the | ||
524 | patent license for this particular work, or (3) arrange, in a manner | ||
525 | consistent with the requirements of this License, to extend the patent | ||
526 | license to downstream recipients. ``Knowingly relying'' means you have | ||
527 | actual knowledge that, but for the patent license, your conveying the | ||
528 | covered work in a country, or your recipient's use of the covered work | ||
529 | in a country, would infringe one or more identifiable patents in that | ||
530 | country that you have reason to believe are valid. | ||
531 | |||
532 | If, pursuant to or in connection with a single transaction or | ||
533 | arrangement, you convey, or propagate by procuring conveyance of, a | ||
534 | covered work, and grant a patent license to some of the parties | ||
535 | receiving the covered work authorizing them to use, propagate, modify | ||
536 | or convey a specific copy of the covered work, then the patent license | ||
537 | you grant is automatically extended to all recipients of the covered | ||
538 | work and works based on it. | ||
539 | |||
540 | A patent license is ``discriminatory'' if it does not include within the | ||
541 | scope of its coverage, prohibits the exercise of, or is conditioned on | ||
542 | the non-exercise of one or more of the rights that are specifically | ||
543 | granted under this License. You may not convey a covered work if you | ||
544 | are a party to an arrangement with a third party that is in the | ||
545 | business of distributing software, under which you make payment to the | ||
546 | third party based on the extent of your activity of conveying the | ||
547 | work, and under which the third party grants, to any of the parties | ||
548 | who would receive the covered work from you, a discriminatory patent | ||
549 | license (a) in connection with copies of the covered work conveyed by | ||
550 | you (or copies made from those copies), or (b) primarily for and in | ||
551 | connection with specific products or compilations that contain the | ||
552 | covered work, unless you entered into that arrangement, or that patent | ||
553 | license was granted, prior to 28 March 2007. | ||
554 | |||
555 | Nothing in this License shall be construed as excluding or limiting | ||
556 | any implied license or other defenses to infringement that may | ||
557 | otherwise be available to you under applicable patent law. | ||
558 | |||
559 | @item No Surrender of Others' Freedom. | ||
560 | |||
561 | If conditions are imposed on you (whether by court order, agreement or | ||
562 | otherwise) that contradict the conditions of this License, they do not | ||
563 | excuse you from the conditions of this License. If you cannot convey | ||
564 | a covered work so as to satisfy simultaneously your obligations under | ||
565 | this License and any other pertinent obligations, then as a | ||
566 | consequence you may not convey it at all. For example, if you agree | ||
567 | to terms that obligate you to collect a royalty for further conveying | ||
568 | from those to whom you convey the Program, the only way you could | ||
569 | satisfy both those terms and this License would be to refrain entirely | ||
570 | from conveying the Program. | ||
571 | |||
572 | @item Remote Network Interaction; Use with the GNU General Public License. | ||
573 | |||
574 | Notwithstanding any other provision of this License, if you modify the | ||
575 | Program, your modified version must prominently offer all users interacting | ||
576 | with it remotely through a computer network (if your version supports such | ||
577 | interaction) an opportunity to receive the Corresponding Source of your | ||
578 | version by providing access to the Corresponding Source from a network | ||
579 | server at no charge, through some standard or customary means of | ||
580 | facilitating copying of software. This Corresponding Source shall include | ||
581 | the Corresponding Source for any work covered by version 3 of the GNU | ||
582 | General Public License that is incorporated pursuant to the following | ||
583 | paragraph. | ||
584 | |||
585 | Notwithstanding any other provision of this License, you have permission to | ||
586 | link or combine any covered work with a work licensed under version 3 of | ||
587 | the GNU General Public License into a single combined work, and to convey | ||
588 | the resulting work. The terms of this License will continue to apply to | ||
589 | the part which is the covered work, but the work with which it is combined | ||
590 | will remain governed by version 3 of the GNU General Public License. | ||
591 | |||
592 | @item Revised Versions of this License. | ||
593 | |||
594 | The Free Software Foundation may publish revised and/or new versions | ||
595 | of the GNU Affero General Public License from time to time. Such new | ||
596 | versions will be similar in spirit to the present version, but may | ||
597 | differ in detail to address new problems or concerns. | ||
598 | |||
599 | Each version is given a distinguishing version number. If the Program | ||
600 | specifies that a certain numbered version of the GNU Affero General Public | ||
601 | License ``or any later version'' applies to it, you have the option of | ||
602 | following the terms and conditions either of that numbered version or | ||
603 | of any later version published by the Free Software Foundation. If | ||
604 | the Program does not specify a version number of the GNU Affero General | ||
605 | Public License, you may choose any version ever published by the Free | ||
606 | Software Foundation. | ||
607 | |||
608 | If the Program specifies that a proxy can decide which future versions | ||
609 | of the GNU Affero General Public License can be used, that proxy's public | ||
610 | statement of acceptance of a version permanently authorizes you to | ||
611 | choose that version for the Program. | ||
612 | |||
613 | Later license versions may give you additional or different | ||
614 | permissions. However, no additional obligations are imposed on any | ||
615 | author or copyright holder as a result of your choosing to follow a | ||
616 | later version. | ||
617 | |||
618 | @item Disclaimer of Warranty. | ||
619 | |||
620 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY | ||
621 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT | ||
622 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ``AS IS'' WITHOUT | ||
623 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT | ||
624 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
625 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND | ||
626 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE | ||
627 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR | ||
628 | CORRECTION. | ||
629 | |||
630 | @item Limitation of Liability. | ||
631 | |||
632 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | ||
633 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR | ||
634 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, | ||
635 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES | ||
636 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT | ||
637 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR | ||
638 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM | ||
639 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER | ||
640 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. | ||
641 | |||
642 | @item Interpretation of Sections 15 and 16. | ||
643 | |||
644 | If the disclaimer of warranty and limitation of liability provided | ||
645 | above cannot be given local legal effect according to their terms, | ||
646 | reviewing courts shall apply local law that most closely approximates | ||
647 | an absolute waiver of all civil liability in connection with the | ||
648 | Program, unless a warranty or assumption of liability accompanies a | ||
649 | copy of the Program in return for a fee. | ||
650 | |||
651 | @end enumerate | ||
652 | |||
653 | @heading END OF TERMS AND CONDITIONS | ||
654 | |||
655 | @heading How to Apply These Terms to Your New Programs | ||
656 | |||
657 | If you develop a new program, and you want it to be of the greatest | ||
658 | possible use to the public, the best way to achieve this is to make it | ||
659 | free software which everyone can redistribute and change under these | ||
660 | terms. | ||
661 | |||
662 | To do so, attach the following notices to the program. It is safest | ||
663 | to attach them to the start of each source file to most effectively | ||
664 | state the exclusion of warranty; and each file should have at least | ||
665 | the ``copyright'' line and a pointer to where the full notice is found. | ||
666 | |||
667 | @smallexample | ||
668 | @var{one line to give the program's name and a brief idea of what it does.} | ||
669 | Copyright (C) @var{year} @var{name of author} | ||
670 | |||
671 | This program is free software: you can redistribute it and/or modify | ||
672 | it under the terms of the GNU Affero General Public License as published by | ||
673 | the Free Software Foundation, either version 3 of the License, or (at | ||
674 | your option) any later version. | ||
675 | |||
676 | This program is distributed in the hope that it will be useful, but | ||
677 | WITHOUT ANY WARRANTY; without even the implied warranty of | ||
678 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
679 | Affero General Public License for more details. | ||
680 | |||
681 | You should have received a copy of the GNU Affero General Public License | ||
682 | along with this program. If not, see @url{https://www.gnu.org/licenses/}. | ||
683 | @end smallexample | ||
684 | |||
685 | Also add information on how to contact you by electronic and paper mail. | ||
686 | |||
687 | If your software can interact with users remotely through a computer | ||
688 | network, you should also make sure that it provides a way for users to | ||
689 | get its source. For example, if your program is a web application, its | ||
690 | interface could display a ``Source'' link that leads users to an archive | ||
691 | of the code. There are many ways you could offer source, and different | ||
692 | solutions will be better for different programs; see section 13 for the | ||
693 | specific requirements. | ||
694 | |||
695 | You should also get your employer (if you work as a programmer) or school, | ||
696 | if any, to sign a ``copyright disclaimer'' for the program, if necessary. | ||
697 | For more information on this, and how to apply and follow the GNU AGPL, see | ||
698 | @url{https://www.gnu.org/licenses/}. | ||
diff --git a/doc/documentation/chapters/contributing.texi b/doc/documentation/chapters/contributing.texi index 745acca77..a92df45c3 100644 --- a/doc/documentation/chapters/contributing.texi +++ b/doc/documentation/chapters/contributing.texi | |||
@@ -6,17 +6,20 @@ | |||
6 | * Licenses of contributions:: | 6 | * Licenses of contributions:: |
7 | * Copyright Assignment:: | 7 | * Copyright Assignment:: |
8 | * Contributing to the Reference Manual:: | 8 | * Contributing to the Reference Manual:: |
9 | * Contributing testcases:: | ||
9 | @end menu | 10 | @end menu |
10 | 11 | ||
11 | @node Contributing to GNUnet | 12 | @node Contributing to GNUnet |
12 | @section Contributing to GNUnet | 13 | @section Contributing to GNUnet |
13 | 14 | ||
15 | @cindex licenses | ||
16 | @cindex licenses of contributions | ||
14 | @node Licenses of contributions | 17 | @node Licenses of contributions |
15 | @section Licenses of contributions | 18 | @section Licenses of contributions |
16 | 19 | ||
17 | GNUnet is a @uref{https://www.gnu.org/, GNU} package. | 20 | GNUnet is a @uref{https://www.gnu.org/, GNU} package. |
18 | All code contributions must thus be put under the | 21 | All code contributions must thus be put under the |
19 | @uref{https://www.gnu.org/copyleft/gpl.html, GNU Public License (GPL)}. | 22 | @uref{https://www.gnu.org/licenses/agpl.html, GNU Affero Public License (AGPL)}. |
20 | All documentation should be put under FSF approved licenses | 23 | All documentation should be put under FSF approved licenses |
21 | (see @uref{https://www.gnu.org/copyleft/fdl.html, fdl}). | 24 | (see @uref{https://www.gnu.org/copyleft/fdl.html, fdl}). |
22 | 25 | ||
@@ -40,7 +43,7 @@ rights, and in particular is allowed to dual-license the code. You | |||
40 | retain non-exclusive rights to your contributions, so you can also | 43 | retain non-exclusive rights to your contributions, so you can also |
41 | share your contributions freely with other projects. | 44 | share your contributions freely with other projects. |
42 | 45 | ||
43 | GNUnet e.V. will publish all accepted contributions under the GPLv3 | 46 | GNUnet e.V. will publish all accepted contributions under the AGPLv3 |
44 | or any later version. The association may decide to publish | 47 | or any later version. The association may decide to publish |
45 | contributions under additional licenses (dual-licensing). | 48 | contributions under additional licenses (dual-licensing). |
46 | 49 | ||
@@ -88,3 +91,21 @@ In a 200+ pages handbook it's better to have footnotes accessible | |||
88 | without having to skip over to the end. | 91 | without having to skip over to the end. |
89 | 92 | ||
90 | @end itemize | 93 | @end itemize |
94 | |||
95 | @node Contributing testcases | ||
96 | @section Contributing testcases | ||
97 | |||
98 | In the core of gnunet, we restrict new testcases to a small subset | ||
99 | of languages, in order of preference: | ||
100 | @enumerate | ||
101 | @item C | ||
102 | @item Bash (preferable portable without too much specifics to Bash) | ||
103 | @item Python (@geq{}3.6) | ||
104 | @end enumerate | ||
105 | |||
106 | We welcome efforts to remove our existing python-2.7 scripts to | ||
107 | replace them either with Bash or, at your choice, python-3.6+. | ||
108 | |||
109 | If you contribute new python based testcases, we advise you to | ||
110 | not repeat our past misfortunes and write the tests in a standard | ||
111 | test framework like for example pytest. | ||
diff --git a/doc/documentation/chapters/developer.texi b/doc/documentation/chapters/developer.texi index 1f74a8163..e82e32b59 100644 --- a/doc/documentation/chapters/developer.texi +++ b/doc/documentation/chapters/developer.texi | |||
@@ -214,9 +214,7 @@ Installation and update tool | |||
214 | Template for starting 'external' GNUnet projects | 214 | Template for starting 'external' GNUnet projects |
215 | @item @command{gnunet-java} | 215 | @item @command{gnunet-java} |
216 | Java APIs for writing GNUnet services and applications | 216 | Java APIs for writing GNUnet services and applications |
217 | @c ** FIXME: Point to new website repository once we have it: | 217 | @item @command{gnunet-java-ext} |
218 | @c ** @item svn/gnunet-www/ Code and media helping drive the GNUnet | ||
219 | @c website | ||
220 | @item @command{eclectic} | 218 | @item @command{eclectic} |
221 | Code to run GNUnet nodes on testbeds for research, development, | 219 | Code to run GNUnet nodes on testbeds for research, development, |
222 | testing and evaluation | 220 | testing and evaluation |
@@ -227,6 +225,8 @@ Qt-based GNUnet GUI (is it deprecated?) | |||
227 | cocoa-based GNUnet GUI (is it deprecated?) | 225 | cocoa-based GNUnet GUI (is it deprecated?) |
228 | @item @command{gnunet-guile} | 226 | @item @command{gnunet-guile} |
229 | Guile bindings for GNUnet | 227 | Guile bindings for GNUnet |
228 | @item @command{gnunet-python} | ||
229 | Python bindings for GNUnet | ||
230 | 230 | ||
231 | @end table | 231 | @end table |
232 | 232 | ||
@@ -246,6 +246,13 @@ Tool for automated debugging of distributed systems | |||
246 | Library for accessing satellite connection quality reports | 246 | Library for accessing satellite connection quality reports |
247 | @item @command{libgnurl} | 247 | @item @command{libgnurl} |
248 | gnURL (feature-restricted variant of cURL/libcurl) | 248 | gnURL (feature-restricted variant of cURL/libcurl) |
249 | @item @command{www} | ||
250 | work in progress of the new gnunet.org website (Jinja2 framework based to | ||
251 | replace our current Drupal website) | ||
252 | @item @command{bibliography} | ||
253 | Our collected bibliography, papers, references, and so forth | ||
254 | @item @command{gnunet-videos-} | ||
255 | Videos about and around gnunet activities | ||
249 | @end table | 256 | @end table |
250 | 257 | ||
251 | Finally, there are various external projects (see links for a list of | 258 | Finally, there are various external projects (see links for a list of |
diff --git a/doc/documentation/chapters/installation.texi b/doc/documentation/chapters/installation.texi index f5e38fd3d..559a97f96 100644 --- a/doc/documentation/chapters/installation.texi +++ b/doc/documentation/chapters/installation.texi | |||
@@ -1,22 +1,40 @@ | |||
1 | @node Installing GNUnet | 1 | @node Installing GNUnet |
2 | @chapter Installing GNUnet | 2 | @chapter Installing GNUnet |
3 | 3 | ||
4 | This guide is intended for those who want to install Gnunet from source. For instructions on how to install GNUnet as a binary package please refer to the official documentation of your operating system or package manager. | 4 | This guide is intended for those who want to install Gnunet from |
5 | source. For instructions on how to install GNUnet as a binary package | ||
6 | please refer to the official documentation of your operating system or | ||
7 | package manager. | ||
5 | 8 | ||
6 | @node Getting the Source Code | 9 | @menu |
10 | * Installing dependencies:: | ||
11 | * Getting the Source Code:: | ||
12 | * Create @code{gnunet} user and group:: | ||
13 | * Preparing and Compiling the Source Code:: | ||
14 | * Installation:: | ||
15 | * MOVED FROM USER Checking the Installation:: | ||
16 | * MOVED FROM USER The graphical configuration interface:: | ||
17 | * MOVED FROM USER Config Leftovers:: | ||
18 | @end menu | ||
19 | |||
20 | @c ----------------------------------------------------------------------- | ||
21 | @node Installing dependencies | ||
7 | @section Installing dependencies | 22 | @section Installing dependencies |
8 | GNUnet needs few libraries and applications for being able to run and another few optional ones for using certain features. Preferably they should be installed with a package manager. Just in case we include a link to the project websites. | 23 | GNUnet needs few libraries and applications for being able to run and |
24 | another few optional ones for using certain features. Preferably they | ||
25 | should be installed with a package manager. Just in case we include a | ||
26 | link to the project websites. | ||
9 | 27 | ||
10 | The mandatory libraries and applications are | 28 | The mandatory libraries and applications are |
11 | @itemize @bullet | 29 | @itemize @bullet |
12 | @item libtool | 30 | @item libtool |
13 | @item autoconf >= version 2.59 | 31 | @item autoconf @geq{}2.59 |
14 | @item automake >= version 1.11.1 | 32 | @item automake @geq{}1.11.1 |
15 | @item pkg-config | 33 | @item pkg-config |
16 | @item libgcrypt >= version 1.6 | 34 | @item libgcrypt @geq{}1.6 |
17 | @item libextractor | 35 | @item libextractor |
18 | @item libidn | 36 | @item libidn |
19 | @item libmicrohttpd >= version 0.9.52 | 37 | @item libmicrohttpd @geq{}0.9.52 |
20 | @item libnss | 38 | @item libnss |
21 | @item libunistring | 39 | @item libunistring |
22 | @item gettext | 40 | @item gettext |
@@ -43,30 +61,43 @@ These are the dependencies only required for certain features | |||
43 | @item libpulse (for running the GNUnet conversation telephony application) | 61 | @item libpulse (for running the GNUnet conversation telephony application) |
44 | @item libogg (for running the GNUnet conversation telephony application) | 62 | @item libogg (for running the GNUnet conversation telephony application) |
45 | @item bluez (for bluetooth support) | 63 | @item bluez (for bluetooth support) |
46 | @item libpbc (for attribute-based encryption and the identity provider subsystem) | 64 | @item libpbc |
47 | @item libgabe (for attribute-based encryption and the identity provider subsystem) | 65 | (for attribute-based encryption and the identity provider subsystem) |
66 | @item libgabe | ||
67 | (for attribute-based encryption and the identity provider subsystem) | ||
48 | @end itemize | 68 | @end itemize |
49 | 69 | ||
50 | 70 | @c ----------------------------------------------------------------------- | |
71 | @node Getting the Source Code | ||
51 | @section Getting the Source Code | 72 | @section Getting the Source Code |
52 | You can either download the source code using git (you obviously need git installed) or as an archive. | 73 | You can either download the source code using git (you obviously need |
74 | git installed) or as an archive. | ||
53 | 75 | ||
54 | Using git type | 76 | Using git type |
55 | @example | 77 | @example |
56 | git clone https://gnunet.org/git/gnunet.git | 78 | git clone https://gnunet.org/git/gnunet.git |
57 | @end example | 79 | @end example |
58 | 80 | ||
59 | The archive can be found at @uref{https://gnunet.org/downloads}. Extract it using a graphical archive tool or @code{tar}: | 81 | The archive can be found at |
82 | @uref{https://gnunet.org/downloads}. Extract it using a graphical | ||
83 | archive tool or @code{tar}: | ||
60 | @example | 84 | @example |
61 | tar xzvf gnunet-0.11.0pre66.tar.gz | 85 | tar xzvf gnunet-0.11.0pre66.tar.gz |
62 | @end example | 86 | @end example |
63 | 87 | ||
64 | In the next chapter we will assume that the source code is available in the home directory at @code{~/gnunet}. | 88 | In the next chapter we will assume that the source code is available |
89 | in the home directory at @code{~/gnunet}. | ||
65 | 90 | ||
91 | @c ----------------------------------------------------------------------- | ||
92 | @node Create @code{gnunet} user and group | ||
66 | @section Create @code{gnunet} user and group | 93 | @section Create @code{gnunet} user and group |
67 | The GNUnet services should be run as a dedicated user called @code{gnunet}. For using them a user should be in the same group as this system user. | 94 | The GNUnet services should be run as a dedicated user called |
95 | @code{gnunet}. For using them a user should be in the same group as | ||
96 | this system user. | ||
68 | 97 | ||
69 | Create user @code{gnunet} who is member of the group @code{gnunet} and specify a home directory where the GNUnet services will store persistant data such as information about peers. | 98 | Create user @code{gnunet} who is member of the group @code{gnunet} and |
99 | specify a home directory where the GNUnet services will store | ||
100 | persistant data such as information about peers. | ||
70 | @example | 101 | @example |
71 | $ sudo useradd --system --groups gnunet --home-dir /var/lib/gnunet | 102 | $ sudo useradd --system --groups gnunet --home-dir /var/lib/gnunet |
72 | @end example | 103 | @end example |
@@ -76,8 +107,13 @@ Now add your own user to the @code{gnunet} group. | |||
76 | $ sudo adduser alice gnunet | 107 | $ sudo adduser alice gnunet |
77 | @end example | 108 | @end example |
78 | 109 | ||
110 | @c ----------------------------------------------------------------------- | ||
111 | @node Preparing and Compiling the Source Code | ||
79 | @section Preparing and Compiling the Source Code | 112 | @section Preparing and Compiling the Source Code |
80 | For preparing the source code for compilation a bootstrap script and @code{configure} has to be run from the source code directory. When running @code{configure} the following options can be specified to customize the compilation and installation process: | 113 | For preparing the source code for compilation a bootstrap script and |
114 | @code{configure} has to be run from the source code directory. When | ||
115 | running @code{configure} the following options can be specified to | ||
116 | customize the compilation and installation process: | ||
81 | 117 | ||
82 | @itemize @bullet | 118 | @itemize @bullet |
83 | @item @code{--disable-documentation} - don't build the configuration documents | 119 | @item @code{--disable-documentation} - don't build the configuration documents |
@@ -91,27 +127,39 @@ For preparing the source code for compilation a bootstrap script and @code{confi | |||
91 | @item @code{--with-sudo=[PATH]} - path to the sudo binary (no need to run @code{make install} as root if specified) | 127 | @item @code{--with-sudo=[PATH]} - path to the sudo binary (no need to run @code{make install} as root if specified) |
92 | @end itemize | 128 | @end itemize |
93 | 129 | ||
94 | The following example configures the installation prefix @code{/usr/lib} and disables building the documentation | 130 | The following example configures the installation prefix |
131 | @code{/usr/lib} and disables building the documentation | ||
95 | @example | 132 | @example |
96 | $ cd ~/gnunet | 133 | $ cd ~/gnunet |
97 | $ ./bootstrap | 134 | $ ./bootstrap |
98 | $ configure --prefix=/usr/lib --disable-configuration | 135 | $ configure --prefix=/usr/lib --disable-configuration |
99 | @end example | 136 | @end example |
100 | 137 | ||
101 | After running the bootstrap script and @code{configure} successfully the source code can be compiled with make. Here @code{-j5} specifies that 5 threads should be used. | 138 | After running the bootstrap script and @code{configure} successfully |
139 | the source code can be compiled with make. Here @code{-j5} specifies | ||
140 | that 5 threads should be used. | ||
102 | @example | 141 | @example |
103 | $ make -j5 | 142 | $ make -j5 |
104 | @end example | 143 | @end example |
105 | 144 | ||
106 | 145 | @c ----------------------------------------------------------------------- | |
146 | @node Installation | ||
107 | @section Installation | 147 | @section Installation |
108 | The compiled binaries can be installed using @code{make install}. It needs to be run as root (or with sudo) because some binaries need the @code{suid} bit set. Without that some GNUnet subsystems (such as VPN) will not work. | 148 | The compiled binaries can be installed using @code{make install}. It |
149 | needs to be run as root (or with sudo) because some binaries need the | ||
150 | @code{suid} bit set. Without that some GNUnet subsystems (such as VPN) | ||
151 | will not work. | ||
109 | 152 | ||
110 | @example | 153 | @example |
111 | $ sudo make install | 154 | $ sudo make install |
112 | @end example | 155 | @end example |
113 | 156 | ||
114 | One important library is the GNS plugin for NSS (the name services switch) which allows using GNS (the GNU name system) in the normal DNS resolution process. Unfortunately NSS expects it in a specific location (probably @code{/lib}) which may differ from the installation prefix (see @code{--prefix} option in the previous section). This is why the pugin has to be installed manually. | 157 | One important library is the GNS plugin for NSS (the name services |
158 | switch) which allows using GNS (the GNU name system) in the normal DNS | ||
159 | resolution process. Unfortunately NSS expects it in a specific | ||
160 | location (probably @code{/lib}) which may differ from the installation | ||
161 | prefix (see @code{--prefix} option in the previous section). This is | ||
162 | why the pugin has to be installed manually. | ||
115 | 163 | ||
116 | Find the directory where nss plugins are installed on your system, e.g. | 164 | Find the directory where nss plugins are installed on your system, e.g. |
117 | 165 | ||
@@ -129,24 +177,30 @@ Copy the GNS NSS plugin to that directory: | |||
129 | cp ~/gnunet/src/gns/nss/libnss_gns.so.2 /lib | 177 | cp ~/gnunet/src/gns/nss/libnss_gns.so.2 /lib |
130 | @end example | 178 | @end example |
131 | 179 | ||
132 | Now, to activate the plugin, you need to edit your @code{/etc/nsswitch.conf} where you should find a line like this: | 180 | Now, to activate the plugin, you need to edit your |
181 | @code{/etc/nsswitch.conf} where you should find a line like this: | ||
133 | 182 | ||
134 | @example | 183 | @example |
135 | hosts: files mdns4_minimal [NOTFOUND=return] dns mdns4 | 184 | hosts: files mdns4_minimal [NOTFOUND=return] dns mdns4 |
136 | @end example | 185 | @end example |
137 | 186 | ||
138 | The exact details may differ a bit, which is fine. Add the text @code{"gns [NOTFOUND=return]"} after @code{"files"}. | 187 | The exact details may differ a bit, which is fine. Add the text |
188 | @code{"gns [NOTFOUND=return]"} after @code{"files"}. | ||
139 | 189 | ||
140 | @example | 190 | @example |
141 | hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4 | 191 | hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4 |
142 | @end example | 192 | @end example |
143 | 193 | ||
144 | Optionally, if GNS shall be used with a browser, execute the GNS CA-setup script. It will isetup the GNS Certificate Authority with the user's browser. | 194 | Optionally, if GNS shall be used with a browser, execute the GNS |
195 | CA-setup script. It will isetup the GNS Certificate Authority with the | ||
196 | user's browser. | ||
145 | @example | 197 | @example |
146 | $ gnunet-gns-proxy-setup-ca | 198 | $ gnunet-gns-proxy-setup-ca |
147 | @end example | 199 | @end example |
148 | 200 | ||
149 | Finally install a configuration file in @code{~/.gnunet/gnunet.conf}. Below you find an example config which allows you to start GNUnet. | 201 | Finally install a configuration file in |
202 | @code{~/.gnunet/gnunet.conf}. Below you find an example config which | ||
203 | allows you to start GNUnet. | ||
150 | 204 | ||
151 | @example | 205 | @example |
152 | [arm] | 206 | [arm] |
@@ -170,7 +224,8 @@ This section describes a quick, casual way to check if your GNUnet | |||
170 | installation works. However, if it does not, we do not cover | 224 | installation works. However, if it does not, we do not cover |
171 | steps for recovery --- for this, please study the instructions | 225 | steps for recovery --- for this, please study the instructions |
172 | provided in the developer handbook as well as the system-specific | 226 | provided in the developer handbook as well as the system-specific |
173 | instruction in the source code repository@footnote{The system specific instructions are not provided as part of this handbook!}. | 227 | instruction in the source code repository@footnote{The system specific |
228 | instructions are not provided as part of this handbook!}. | ||
174 | 229 | ||
175 | 230 | ||
176 | @menu | 231 | @menu |
@@ -203,21 +258,25 @@ Currently these interfaces cover: | |||
203 | @subsection Statistics | 258 | @subsection Statistics |
204 | @c %**end of header | 259 | @c %**end of header |
205 | 260 | ||
206 | First, you should launch GNUnet gtk@footnote{Obviously you should also start gnunet, via gnunet-arm or the system provided method}. | 261 | First, you should launch GNUnet gtk@footnote{Obviously you should also |
262 | start gnunet, via gnunet-arm or the system provided method}. | ||
207 | You can do this from the command-line by typing | 263 | You can do this from the command-line by typing |
208 | 264 | ||
209 | @example | 265 | @example |
210 | gnunet-statistics-gtk | 266 | gnunet-statistics-gtk |
211 | @end example | 267 | @end example |
212 | 268 | ||
213 | If your peer@footnote{The term ``peer'' is a common word used in federated and distributed networks to describe a participating device which is connected to the network. Thus, your Personal Computer or whatever it is you are looking at the Gtk+ interface describes a ``Peer'' or a ``Node''.} | 269 | If your peer@footnote{The term ``peer'' is a common word used in |
214 | is running correctly, you should see a bunch of lines, | 270 | federated and distributed networks to describe a participating device |
215 | all of which should be ``significantly'' above zero (at least if your | 271 | which is connected to the network. Thus, your Personal Computer or |
216 | peer has been running for more than a few seconds). The lines indicate | 272 | whatever it is you are looking at the Gtk+ interface describes a |
217 | how many other peers your peer is connected to (via different | 273 | ``Peer'' or a ``Node''.} is running correctly, you should see a bunch |
218 | mechanisms) and how large the entire overlay network is currently | 274 | of lines, all of which should be ``significantly'' above zero (at |
219 | estimated to be. The X-axis represents time (in seconds since the | 275 | least if your peer has been running for more than a few seconds). The |
220 | start of @command{gnunet-gtk}). | 276 | lines indicate how many other peers your peer is connected to (via |
277 | different mechanisms) and how large the entire overlay network is | ||
278 | currently estimated to be. The X-axis represents time (in seconds | ||
279 | since the start of @command{gnunet-gtk}). | ||
221 | 280 | ||
222 | You can click on "Traffic" to see information about the amount of | 281 | You can click on "Traffic" to see information about the amount of |
223 | bandwidth your peer has consumed, and on "Storage" to check the amount | 282 | bandwidth your peer has consumed, and on "Storage" to check the amount |
diff --git a/doc/documentation/chapters/preface.texi b/doc/documentation/chapters/preface.texi index 00e6290f0..29cf924a2 100644 --- a/doc/documentation/chapters/preface.texi +++ b/doc/documentation/chapters/preface.texi | |||
@@ -12,9 +12,9 @@ all kinds of basic applications for the foundation of a new Internet. | |||
12 | 12 | ||
13 | @menu | 13 | @menu |
14 | * About this book:: | 14 | * About this book:: |
15 | * Contributing to this book:: | ||
15 | * Introduction:: | 16 | * Introduction:: |
16 | * Project governance:: | 17 | * Project governance:: |
17 | * General Terminology:: | ||
18 | * Typography:: | 18 | * Typography:: |
19 | @end menu | 19 | @end menu |
20 | 20 | ||
@@ -37,6 +37,26 @@ The first chapter (``Preface'') as well as the the second | |||
37 | chapter (``Philosophy'') give an introduction to GNUnet as a project, | 37 | chapter (``Philosophy'') give an introduction to GNUnet as a project, |
38 | what GNUnet tries to achieve. | 38 | what GNUnet tries to achieve. |
39 | 39 | ||
40 | @node Contributing to this book | ||
41 | @section Contributing to this book | ||
42 | |||
43 | The GNUnet Reference Manual is a collective work produced by various | ||
44 | people throughout the years. The version you are reading is derived | ||
45 | from many individual efforts hosted on our website. This was a failed | ||
46 | experiment, and with the conversion to Texinfo we hope to address this | ||
47 | in the longterm. Texinfo is the documentation language of the GNU project. | ||
48 | While it can be intimidating at first and look scary or complicated, | ||
49 | it is just another way to express text format instructions. We encourage | ||
50 | you to take this opportunity and learn about Texinfo, learn about GNUnet, | ||
51 | and one word at a time we will arrive at a book which explains GNUnet in | ||
52 | the least complicated way to you. Even when you don't want or can't learn | ||
53 | Texinfo, you can contribute. Send us an Email or join our IRC chat room | ||
54 | on freenode and talk with us about the documentation (the prefered way | ||
55 | to reach out is the mailinglist, since you can communicate with us | ||
56 | without waiting on someone in the chatroom). One way or another you | ||
57 | can help shape the understanding of GNUnet without the ability to read | ||
58 | and understand its sourcecode. | ||
59 | |||
40 | @node Introduction | 60 | @node Introduction |
41 | @section Introduction | 61 | @section Introduction |
42 | 62 | ||
@@ -66,25 +86,31 @@ immediately. A few months after the first release we contacted the | |||
66 | GNU project, happily agreed to their governance model and became an | 86 | GNU project, happily agreed to their governance model and became an |
67 | official GNU package. | 87 | official GNU package. |
68 | 88 | ||
69 | Within the first year, we created GNU libextractor, a helper library | 89 | Within the first year, we created |
90 | @uref{https://gnu.org/s/libextractor, GNU libextractor}, a helper library | ||
70 | for meta data extraction which has been used by a few other projects | 91 | for meta data extraction which has been used by a few other projects |
71 | as well. 2003 saw the emergence of pluggable transports, the ability | 92 | as well. 2003 saw the emergence of pluggable transports, the ability |
72 | for GNUnet to use different mechanisms for communication, starting | 93 | for GNUnet to use different mechanisms for communication, starting |
73 | with TCP, UDP and SMTP (support for the latter was later dropped due | 94 | with TCP, UDP and SMTP (support for the latter was later dropped due |
74 | to a lack of maintenance). In 2005, the project first started to | 95 | to a lack of maintenance). In 2005, the project first started to |
75 | evolve beyond the original file-sharing application with a first | 96 | evolve beyond the original file-sharing application with a first |
76 | simple P2P chat. In 2007, we created GNU libmicrohttpd | 97 | simple P2P chat. In 2007, we created |
98 | @uref{https://gnu.org/s/libmicrohttpd, GNU libmicrohttpd} | ||
77 | to support a pluggable transport based on HTTP. In 2009, the | 99 | to support a pluggable transport based on HTTP. In 2009, the |
78 | architecture was radically modularized into the multi-process system | 100 | architecture was radically modularized into the multi-process system |
79 | that exists today. Coincidentally, the first version of the ARM | 101 | that exists today. Coincidentally, the first version of the ARM@footnote{ARM: Automatic Restart Manager} |
80 | service was implemented a day before systemd was announced. From 2009 | 102 | service was implemented a day before systemd was announced. From 2009 |
81 | to 2014 work progressed rapidly thanks to a significant research grant | 103 | to 2014 work progressed rapidly thanks to a significant research grant |
82 | from the Deutsche Forschungsgesellschaft. This resulted in particular | 104 | from the Deutsche Forschungsgesellschaft. This resulted in particular |
83 | in the creation of the R5N DHT, CADET, ATS and the GNU Name System. | 105 | in the creation of the R5N DHT, CADET, ATS and the GNU Name System. |
84 | In 2010, GNUnet was selected as the basis for the SecuShare online | 106 | In 2010, GNUnet was selected as the basis for the |
85 | social network, resutling in a significant growth of the core team. | 107 | @uref{https://secushare.org, secushare} online |
86 | In 2013, we launched GNU Taler to address the challenge of convenient | 108 | social network, resulting in a significant growth of the core team. |
87 | and privacy-preserving online payments. In 2015, the pEp project | 109 | In 2013, we launched @uref{https://taler.net, GNU Taler} to address |
110 | the challenge of convenient | ||
111 | and privacy-preserving online payments. In 2015, the | ||
112 | @c TODO: Maybe even markup for the E if it renders in most outputs. | ||
113 | @uref{https://pep.foundation/, pEp}@footnote{pretty easy privacy} project | ||
88 | announced that they will use GNUnet as the technology for their | 114 | announced that they will use GNUnet as the technology for their |
89 | meta-data protection layer, ultimately resulting in GNUnet e.V. | 115 | meta-data protection layer, ultimately resulting in GNUnet e.V. |
90 | entering into a formal long-term collaboration with the pEp | 116 | entering into a formal long-term collaboration with the pEp |
@@ -99,9 +125,9 @@ computing has been the core driver of the GNU project. With GNUnet we | |||
99 | are focusing on informational self-determination for collaborative | 125 | are focusing on informational self-determination for collaborative |
100 | computing and communication over networks. | 126 | computing and communication over networks. |
101 | 127 | ||
102 | The Internet is shaped as much by code and protocols as by its | 128 | The Internet is shaped as much by code and protocols as it is by its |
103 | associated political processes (IETF, ICANN, IEEE, etc.), and its | 129 | associated political processes (IETF, ICANN, IEEE, etc.). |
104 | flaws are similarly not limited to the protocol design. Thus, | 130 | Similarly its flaws are not limited to the protocol design. Thus, |
105 | technical excellence by itself will not suffice to create a better | 131 | technical excellence by itself will not suffice to create a better |
106 | network. We also need to build a community that is wise, humble and | 132 | network. We also need to build a community that is wise, humble and |
107 | has a sense of humor to achieve our goal to create a technical | 133 | has a sense of humor to achieve our goal to create a technical |
@@ -116,23 +142,22 @@ follows the governance model of a benevolent dictator. This means | |||
116 | that ultimately, the GNU project appoints the GNU maintainer and can | 142 | that ultimately, the GNU project appoints the GNU maintainer and can |
117 | overrule decisions made by the GNUnet maintainer. Similarly, the | 143 | overrule decisions made by the GNUnet maintainer. Similarly, the |
118 | GNUnet maintainer can overrule any decisions made by individual | 144 | GNUnet maintainer can overrule any decisions made by individual |
145 | @c TODO: Should we mention if this is just about GNUnet? Other projects | ||
146 | @c TODO: in GNU seem to have rare issues (GCC, the 2018 documentation | ||
147 | @c TODO: discussion. | ||
119 | developers. Still, in practice neither has happened in the last 20 | 148 | developers. Still, in practice neither has happened in the last 20 |
120 | years, and we hope to keep it that way. | 149 | years, and we hope to keep it that way. |
121 | 150 | ||
151 | @c TODO: Actually we are a Swiss association, or just a German association | ||
152 | @c TODO: with Swiss bylaws/Satzung? | ||
153 | @c TODO: Rewrite one of the 'GNUnet eV may also' sentences. | ||
122 | The GNUnet project is supported by GNUnet e.V., a German association | 154 | The GNUnet project is supported by GNUnet e.V., a German association |
123 | where any developer can become a member. GNUnet e.V. servers as a | 155 | where any developer can become a member. GNUnet e.V. serves as a |
124 | legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also | 156 | legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also |
125 | choose to pay for project resources, and can collect donations. | 157 | choose to pay for project resources, and can collect donations. |
126 | GNUnet e.V. may also choose to adjust the license of the | 158 | GNUnet e.V. may also choose to adjust the license of the |
127 | software (with the constraint that it has to remain free software). | 159 | software (with the constraint that it has to remain free software)@footnote{For example in 2018 we switched from GPL3 to AGPL3. In practice these changes do not happen very often.} |
128 | |||
129 | |||
130 | @node General Terminology | ||
131 | @section General Terminology | ||
132 | 160 | ||
133 | In the following manual we may use words that can not be found in the | ||
134 | Appendix. Since we want to keep the manual selfcontained, we will | ||
135 | explain words here. | ||
136 | 161 | ||
137 | @node Typography | 162 | @node Typography |
138 | @section Typography | 163 | @section Typography |
@@ -142,3 +167,5 @@ command should/can be issued as root, or if "normal" user privileges are | |||
142 | sufficient. We use a @code{#} for root's shell prompt, a | 167 | sufficient. We use a @code{#} for root's shell prompt, a |
143 | @code{%} for users' shell prompt, assuming they use the C-shell or tcsh | 168 | @code{%} for users' shell prompt, assuming they use the C-shell or tcsh |
144 | and a @code{$} for bourne shell and derivatives. | 169 | and a @code{$} for bourne shell and derivatives. |
170 | @c TODO: Really? Why the different prompts? Do we already have c-shell | ||
171 | @c TODO: examples? | ||
diff --git a/doc/documentation/chapters/user.texi b/doc/documentation/chapters/user.texi index fe47abb86..50b795197 100644 --- a/doc/documentation/chapters/user.texi +++ b/doc/documentation/chapters/user.texi | |||
@@ -26,6 +26,7 @@ always welcome. | |||
26 | * First steps - Using the GNUnet VPN:: | 26 | * First steps - Using the GNUnet VPN:: |
27 | * File-sharing:: | 27 | * File-sharing:: |
28 | * The GNU Name System:: | 28 | * The GNU Name System:: |
29 | * re@:claim Identity Provider:: | ||
29 | * Using the Virtual Public Network:: | 30 | * Using the Virtual Public Network:: |
30 | @end menu | 31 | @end menu |
31 | 32 | ||
@@ -43,6 +44,7 @@ To stop GNUnet: | |||
43 | @example | 44 | @example |
44 | $ gnunet-arm -e | 45 | $ gnunet-arm -e |
45 | @end example | 46 | @end example |
47 | |||
46 | @node First steps - Using the GNU Name System | 48 | @node First steps - Using the GNU Name System |
47 | @section First steps - Using the GNU Name System | 49 | @section First steps - Using the GNU Name System |
48 | @c %**end of header | 50 | @c %**end of header |
@@ -246,7 +248,7 @@ more an experimental feature and not really our primary goal at this | |||
246 | time. Still, it is a possible use-case and we welcome help with testing | 248 | time. Still, it is a possible use-case and we welcome help with testing |
247 | and development. | 249 | and development. |
248 | 250 | ||
249 | 251 | @pindex gnunet-bcd | |
250 | @node Creating a Business Card | 252 | @node Creating a Business Card |
251 | @subsection Creating a Business Card | 253 | @subsection Creating a Business Card |
252 | @c FIXME: Which parts of texlive are needed? Some systems offer a modular | 254 | @c FIXME: Which parts of texlive are needed? Some systems offer a modular |
@@ -257,7 +259,9 @@ Note that this requires having @command{LaTeX} installed on your system. | |||
257 | If you are using a Debian GNU/Linux based operating system, the | 259 | If you are using a Debian GNU/Linux based operating system, the |
258 | following command should install the required components. | 260 | following command should install the required components. |
259 | Keep in mind that this @b{requires 3GB} of downloaded data and possibly | 261 | Keep in mind that this @b{requires 3GB} of downloaded data and possibly |
260 | @b{even more} when unpacked. | 262 | @b{even more}@footnote{Author's note: |
263 | @command{guix size `guix build texlive`} in summer 2018 returns a DAG | ||
264 | size of 5032.4 MiB} when unpacked. | ||
261 | @b{We welcome any help in identifying the required components of the | 265 | @b{We welcome any help in identifying the required components of the |
262 | TexLive Distribution. This way we could just state the required components | 266 | TexLive Distribution. This way we could just state the required components |
263 | without pulling in the full distribution of TexLive.} | 267 | without pulling in the full distribution of TexLive.} |
@@ -312,12 +316,14 @@ you might need a trip to the store together. | |||
312 | Before we get started, we need to tell @code{gnunet-qr} which zone | 316 | Before we get started, we need to tell @code{gnunet-qr} which zone |
313 | it should import new records into. For this, run: | 317 | it should import new records into. For this, run: |
314 | 318 | ||
319 | @pindex gnunet-identity | ||
315 | @example | 320 | @example |
316 | $ gnunet-identity -s namestore -e NAME | 321 | $ gnunet-identity -s namestore -e NAME |
317 | @end example | 322 | @end example |
318 | where NAME is the name of the zone you want to import records | 323 | where NAME is the name of the zone you want to import records |
319 | into. In our running example, this would be ``gnu''. | 324 | into. In our running example, this would be ``gnu''. |
320 | 325 | ||
326 | @pindex gnunet-qr | ||
321 | Henceforth, for every business card you collect, simply run: | 327 | Henceforth, for every business card you collect, simply run: |
322 | @example | 328 | @example |
323 | $ gnunet-qr | 329 | $ gnunet-qr |
@@ -335,6 +341,7 @@ GNUnet network at this time, you should thus be able to | |||
335 | resolve your friends names. Suppose your friend's nickname | 341 | resolve your friends names. Suppose your friend's nickname |
336 | is "Bob". Then, type | 342 | is "Bob". Then, type |
337 | 343 | ||
344 | @pindex gnunet-gns | ||
338 | @example | 345 | @example |
339 | $ gnunet-gns -u test.bob.gnu | 346 | $ gnunet-gns -u test.bob.gnu |
340 | @end example | 347 | @end example |
@@ -381,6 +388,7 @@ a revocation certificate corresponding to your ego. This certificate, | |||
381 | when published on the P2P network, flags your private key as invalid, | 388 | when published on the P2P network, flags your private key as invalid, |
382 | and all further resolutions or other checks involving the key will fail. | 389 | and all further resolutions or other checks involving the key will fail. |
383 | 390 | ||
391 | @pindex gnunet-revocation | ||
384 | A revocation certificate is thus a useful tool when things go out of | 392 | A revocation certificate is thus a useful tool when things go out of |
385 | control, but at the same time it should be stored securely. | 393 | control, but at the same time it should be stored securely. |
386 | Generation of the revocation certificate for a zone can be done through | 394 | Generation of the revocation certificate for a zone can be done through |
@@ -433,6 +441,7 @@ private conversation with your friend. Finally, help us | |||
433 | with the next GNUnet release for even more applications | 441 | with the next GNUnet release for even more applications |
434 | using this new public key infrastructure. | 442 | using this new public key infrastructure. |
435 | 443 | ||
444 | @pindex gnunet-conservation-gtk | ||
436 | @node First steps - Using GNUnet Conversation | 445 | @node First steps - Using GNUnet Conversation |
437 | @section First steps - Using GNUnet Conversation | 446 | @section First steps - Using GNUnet Conversation |
438 | @c %**end of header | 447 | @c %**end of header |
@@ -485,6 +494,7 @@ that will show up when you call somebody else, as well as the | |||
485 | GNS zone that will be used to resolve names of users that you | 494 | GNS zone that will be used to resolve names of users that you |
486 | are calling. Run | 495 | are calling. Run |
487 | 496 | ||
497 | @pindex gnunet-conversation | ||
488 | @example | 498 | @example |
489 | gnunet-conversation -e zone-name | 499 | gnunet-conversation -e zone-name |
490 | @end example | 500 | @end example |
@@ -564,7 +574,7 @@ Either of you can end the call using @command{/cancel}. You can exit | |||
564 | 574 | ||
565 | @menu | 575 | @menu |
566 | * VPN Preliminaries:: | 576 | * VPN Preliminaries:: |
567 | * Exit configuration:: | 577 | * GNUnet-Exit configuration:: |
568 | * GNS configuration:: | 578 | * GNS configuration:: |
569 | * Accessing the service:: | 579 | * Accessing the service:: |
570 | * Using a Browser:: | 580 | * Using a Browser:: |
@@ -595,6 +605,9 @@ The exact details may differ a bit, which is fine. Add the text | |||
595 | hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4 | 605 | hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4 |
596 | @end example | 606 | @end example |
597 | 607 | ||
608 | @c TODO: outdated section, we no longer install this as part of the | ||
609 | @c TODO: standard installation procedure and should point out the manual | ||
610 | @c TODO: steps required to make it useful. | ||
598 | @noindent | 611 | @noindent |
599 | You might want to make sure that @code{/lib/libnss_gns.so.2} exists on | 612 | You might want to make sure that @code{/lib/libnss_gns.so.2} exists on |
600 | your system, it should have been created during the installation. | 613 | your system, it should have been created during the installation. |
@@ -608,8 +621,8 @@ $ cd src/gns/nss; sudo make install | |||
608 | @noindent | 621 | @noindent |
609 | to install the NSS plugins in the proper location. | 622 | to install the NSS plugins in the proper location. |
610 | 623 | ||
611 | @node Exit configuration | 624 | @node GNUnet-Exit configuration |
612 | @subsection Exit configuration | 625 | @subsection GNUnet-Exit configuration |
613 | @c %**end of header | 626 | @c %**end of header |
614 | 627 | ||
615 | Stop your peer (as user @code{gnunet}, run @command{gnunet-arm -e}) and | 628 | Stop your peer (as user @code{gnunet}, run @command{gnunet-arm -e}) and |
@@ -696,9 +709,10 @@ the searcher/downloader specify "no anonymity", non-anonymous | |||
696 | file-sharing is used. If either user specifies some desired degree | 709 | file-sharing is used. If either user specifies some desired degree |
697 | of anonymity, anonymous file-sharing will be used. | 710 | of anonymity, anonymous file-sharing will be used. |
698 | 711 | ||
699 | After a short introduction, we will first look at the various concepts in | 712 | After a short introduction, we will first look at the various concepts |
700 | GNUnet's file-sharing implementation. Then, we will discuss specifics as to how | 713 | in GNUnet's file-sharing implementation. Then, we will discuss |
701 | they impact users that publish, search or download files. | 714 | specifics as to how they impact users that publish, search or download |
715 | files. | ||
702 | 716 | ||
703 | 717 | ||
704 | @menu | 718 | @menu |
@@ -706,7 +720,6 @@ they impact users that publish, search or download files. | |||
706 | * fs-Downloading:: | 720 | * fs-Downloading:: |
707 | * fs-Publishing:: | 721 | * fs-Publishing:: |
708 | * fs-Concepts:: | 722 | * fs-Concepts:: |
709 | * fs-Directories:: | ||
710 | * Namespace Management:: | 723 | * Namespace Management:: |
711 | * File-Sharing URIs:: | 724 | * File-Sharing URIs:: |
712 | * GTK User Interface:: | 725 | * GTK User Interface:: |
@@ -724,10 +737,11 @@ $ gnunet-search [-t TIMEOUT] KEYWORD | |||
724 | @end example | 737 | @end example |
725 | 738 | ||
726 | @noindent | 739 | @noindent |
727 | The -t option specifies that the query should timeout after | 740 | The @command{-t} option specifies that the query should timeout after |
728 | approximately TIMEOUT seconds. A value of zero is interpreted | 741 | approximately TIMEOUT seconds. A value of zero (``0'') is interpreted |
729 | as @emph{no timeout}, which is also the default. In this case, | 742 | as @emph{no timeout}, which is the default. In this case, |
730 | gnunet-search will never terminate (unless you press CTRL-C). | 743 | @command{gnunet-search} will never terminate (unless you press |
744 | @command{CTRL-C}). | ||
731 | 745 | ||
732 | If multiple words are passed as keywords, they will all be | 746 | If multiple words are passed as keywords, they will all be |
733 | considered optional. Prefix keywords with a "+" to make them mandatory. | 747 | considered optional. Prefix keywords with a "+" to make them mandatory. |
@@ -750,10 +764,11 @@ as the first will match files shared under the keywords | |||
750 | "Das" or "Kapital" whereas the second will match files | 764 | "Das" or "Kapital" whereas the second will match files |
751 | shared under the keyword "Das Kapital". | 765 | shared under the keyword "Das Kapital". |
752 | 766 | ||
753 | Search results are printed by gnunet-search like this: | 767 | Search results are printed by @command{gnunet-search} like this: |
754 | 768 | ||
755 | @c it will be better the avoid the ellipsis altogether because I don't | 769 | @c it will be better the avoid the ellipsis altogether because I don't |
756 | @c understand the explanation below that | 770 | @c understand the explanation below that |
771 | @c ng0: who is ``I'' and what was the complete sentence? | ||
757 | @example | 772 | @example |
758 | #15: | 773 | #15: |
759 | gnunet-download -o "COPYING" gnunet://fs/chk/PGK8M...3EK130.75446 | 774 | gnunet-download -o "COPYING" gnunet://fs/chk/PGK8M...3EK130.75446 |
@@ -762,10 +777,11 @@ gnunet-download -o "COPYING" gnunet://fs/chk/PGK8M...3EK130.75446 | |||
762 | 777 | ||
763 | @noindent | 778 | @noindent |
764 | The whole line is the command you would have to enter to download | 779 | The whole line is the command you would have to enter to download |
765 | the file. The argument passed to @code{-o} is the suggested | 780 | the file. The first argument passed to @code{-o} is the suggested |
766 | filename (you may change it to whatever you like). | 781 | filename (you may change it to whatever you like). |
767 | It is followed by the key for decrypting the file, the query for searching the | 782 | It is followed by the key for decrypting the file, the query for |
768 | file, a checksum (in hexadecimal) finally the size of the file in bytes. | 783 | searching the file, a checksum (in hexadecimal) finally the size of |
784 | the file in bytes. | ||
769 | 785 | ||
770 | @node fs-Downloading | 786 | @node fs-Downloading |
771 | @subsection Downloading | 787 | @subsection Downloading |
@@ -802,9 +818,9 @@ already present. | |||
802 | GNUnet's file-encoding mechanism will ensure file integrity, even if the | 818 | GNUnet's file-encoding mechanism will ensure file integrity, even if the |
803 | existing file was not downloaded from GNUnet in the first place. | 819 | existing file was not downloaded from GNUnet in the first place. |
804 | 820 | ||
805 | You may want to use the @command{-V} switch to turn on verbose reporting. In | 821 | You may want to use the @command{-V} switch to turn on verbose |
806 | this case, @command{gnunet-download} will print the current number of bytes | 822 | reporting. In this case, @command{gnunet-download} will print the |
807 | downloaded whenever new data was received. | 823 | current number of bytes downloaded whenever new data was received. |
808 | 824 | ||
809 | @node fs-Publishing | 825 | @node fs-Publishing |
810 | @subsection Publishing | 826 | @subsection Publishing |
@@ -834,7 +850,7 @@ $ gnunet-publish -m "description:GNU License" -k gpl -k test -m "mimetype:text/p | |||
834 | The option @code{-k} is used to specify keywords for the file that | 850 | The option @code{-k} is used to specify keywords for the file that |
835 | should be inserted. You can supply any number of keywords, | 851 | should be inserted. You can supply any number of keywords, |
836 | and each of the keywords will be sufficient to locate and | 852 | and each of the keywords will be sufficient to locate and |
837 | retrieve the file. Please note that you must use the @code{-k} option | 853 | retrieve the file. Please note that you must use the @code{-k} option |
838 | more than once -- one for each expression you use as a keyword for | 854 | more than once -- one for each expression you use as a keyword for |
839 | the filename. | 855 | the filename. |
840 | 856 | ||
@@ -845,10 +861,14 @@ list by running @command{extract -L}. Use quotes around the entire | |||
845 | meta-data argument if the value contains spaces. The meta-data | 861 | meta-data argument if the value contains spaces. The meta-data |
846 | is displayed to other users when they select which files to | 862 | is displayed to other users when they select which files to |
847 | download. The meta-data and the keywords are optional and | 863 | download. The meta-data and the keywords are optional and |
848 | maybe inferred using @code{GNU libextractor}. | 864 | may be inferred using @code{GNU libextractor}. |
865 | |||
866 | @command{gnunet-publish} has a few additional options to handle | ||
867 | namespaces and directories. Refer to the man-page for details: | ||
849 | 868 | ||
850 | gnunet-publish has a few additional options to handle namespaces and | 869 | @example |
851 | directories. See the man-page for details. | 870 | man gnunet-publish |
871 | @end example | ||
852 | 872 | ||
853 | @node Indexing vs. Inserting | 873 | @node Indexing vs. Inserting |
854 | @subsubsection Indexing vs Inserting | 874 | @subsubsection Indexing vs Inserting |
@@ -890,18 +910,17 @@ able to crack the encryption (e.g. by guessing the keyword. | |||
890 | @subsection Concepts | 910 | @subsection Concepts |
891 | @c %**end of header | 911 | @c %**end of header |
892 | 912 | ||
893 | Sharing files in GNUnet is not quite as simple as in traditional | 913 | For better results with filesharing it is useful to understand the |
894 | file sharing systems. For example, it is not sufficient to just | 914 | following concepts. |
895 | place files into a specific directory to share them. In addition | 915 | In addition to anonymous routing GNUnet attempts to give users a better |
896 | to anonymous routing GNUnet attempts to give users a better experience | 916 | experience in searching for content. GNUnet uses cryptography to safely |
897 | in searching for content. GNUnet uses cryptography to safely break | 917 | break content into smaller pieces that can be obtained from different |
898 | content into smaller pieces that can be obtained from different | 918 | sources without allowing participants to corrupt files. GNUnet makes it |
899 | sources without allowing participants to corrupt files. GNUnet | 919 | difficult for an adversary to send back bogus search results. GNUnet |
900 | makes it difficult for an adversary to send back bogus search | 920 | enables content providers to group related content and to establish a |
901 | results. GNUnet enables content providers to group related content | 921 | reputation. Furthermore, GNUnet allows updates to certain content to be |
902 | and to establish a reputation. Furthermore, GNUnet allows updates | 922 | made available. This section is supposed to introduce users to the |
903 | to certain content to be made available. This section is supposed | 923 | concepts that are used to achieve these goals. |
904 | to introduce users to the concepts that are used to achieve these goals. | ||
905 | 924 | ||
906 | 925 | ||
907 | @menu | 926 | @menu |
@@ -921,10 +940,10 @@ to introduce users to the concepts that are used to achieve these goals. | |||
921 | @c %**end of header | 940 | @c %**end of header |
922 | 941 | ||
923 | A file in GNUnet is just a sequence of bytes. Any file-format is allowed | 942 | A file in GNUnet is just a sequence of bytes. Any file-format is allowed |
924 | and the maximum file size is theoretically 264 bytes, except that it | 943 | and the maximum file size is theoretically @math{2^64 - 1} bytes, except |
925 | would take an impractical amount of time to share such a file. | 944 | that it would take an impractical amount of time to share such a file. |
926 | GNUnet itself never interprets the contents of shared files, except | 945 | GNUnet itself never interprets the contents of shared files, except when |
927 | when using GNU libextractor to obtain keywords. | 946 | using GNU libextractor to obtain keywords. |
928 | 947 | ||
929 | @node Keywords | 948 | @node Keywords |
930 | @subsubsection Keywords | 949 | @subsubsection Keywords |
@@ -954,10 +973,26 @@ it cannot be changed since it is treated just like an ordinary file | |||
954 | by the network. Small files (of a few kilobytes) can be inlined in | 973 | by the network. Small files (of a few kilobytes) can be inlined in |
955 | the directory, so that a separate download becomes unnecessary. | 974 | the directory, so that a separate download becomes unnecessary. |
956 | 975 | ||
976 | Directories are shared just like ordinary files. If you download a | ||
977 | directory with @command{gnunet-download}, you can use | ||
978 | @command{gnunet-directory} to list its contents. The canonical | ||
979 | extension for GNUnet directories when stored as files in your | ||
980 | local file-system is ".gnd". The contents of a directory are URIs and | ||
981 | meta data. | ||
982 | The URIs contain all the information required by | ||
983 | @command{gnunet-download} to retrieve the file. The meta data | ||
984 | typically includes the mime-type, description, a filename and | ||
985 | other meta information, and possibly even the full original file | ||
986 | (if it was small). | ||
987 | |||
957 | @node Pseudonyms | 988 | @node Pseudonyms |
958 | @subsubsection Pseudonyms | 989 | @subsubsection Pseudonyms |
959 | @c %**end of header | 990 | @c %**end of header |
960 | 991 | ||
992 | @b{Please note that the text in this subsection is outdated and needs} | ||
993 | @b{to be rewritten for version 0.10!} | ||
994 | @b{This especially concerns the terminology of Pseudonym/Ego/Identity.} | ||
995 | |||
961 | Pseudonyms in GNUnet are essentially public-private (RSA) key pairs | 996 | Pseudonyms in GNUnet are essentially public-private (RSA) key pairs |
962 | that allow a GNUnet user to maintain an identity (which may or may not | 997 | that allow a GNUnet user to maintain an identity (which may or may not |
963 | be detached from their real-life identity). GNUnet's pseudonyms are not | 998 | be detached from their real-life identity). GNUnet's pseudonyms are not |
@@ -973,6 +1008,10 @@ to copy around). | |||
973 | @subsubsection Namespaces | 1008 | @subsubsection Namespaces |
974 | @c %**end of header | 1009 | @c %**end of header |
975 | 1010 | ||
1011 | @b{Please note that the text in this subsection is outdated and needs} | ||
1012 | @b{to be rewritten for version 0.10!} | ||
1013 | @b{This especially concerns the terminology of Pseudonym/Ego/Identity.} | ||
1014 | |||
976 | A namespace is a set of files that were signed by the same pseudonym. | 1015 | A namespace is a set of files that were signed by the same pseudonym. |
977 | Files (or directories) that have been signed and placed into a namespace | 1016 | Files (or directories) that have been signed and placed into a namespace |
978 | can be updated. Updates are identified as authentic if the same secret | 1017 | can be updated. Updates are identified as authentic if the same secret |
@@ -984,11 +1023,15 @@ same entity (which does not have to be the same person). | |||
984 | @subsubsection Advertisements | 1023 | @subsubsection Advertisements |
985 | @c %**end of header | 1024 | @c %**end of header |
986 | 1025 | ||
1026 | @b{Please note that the text in this subsection is outdated and needs} | ||
1027 | @b{to be rewritten for version 0.10!} | ||
1028 | @b{This especially concerns the terminology of Pseudonym/Ego/Identity.} | ||
1029 | |||
987 | Advertisements are used to notify other users about the existence of a | 1030 | Advertisements are used to notify other users about the existence of a |
988 | namespace. Advertisements are propagated using the normal keyword search. | 1031 | namespace. Advertisements are propagated using the normal keyword search. |
989 | When an advertisement is received (in response to a search), the namespace | 1032 | When an advertisement is received (in response to a search), the namespace |
990 | is added to the list of namespaces available in the namespace-search | 1033 | is added to the list of namespaces available in the namespace-search |
991 | dialogs of gnunet-fs-gtk and printed by gnunet-pseudonym. Whenever a | 1034 | dialogs of gnunet-fs-gtk and printed by @code{gnunet-identity}. Whenever a |
992 | namespace is created, an appropriate advertisement can be generated. | 1035 | namespace is created, an appropriate advertisement can be generated. |
993 | The default keyword for the advertising of namespaces is "namespace". | 1036 | The default keyword for the advertising of namespaces is "namespace". |
994 | 1037 | ||
@@ -996,7 +1039,7 @@ Note that GNUnet differentiates between your pseudonyms (the identities | |||
996 | that you control) and namespaces. If you create a pseudonym, you will | 1039 | that you control) and namespaces. If you create a pseudonym, you will |
997 | not automatically see the respective namespace. You first have to create | 1040 | not automatically see the respective namespace. You first have to create |
998 | an advertisement for the namespace and find it using keyword | 1041 | an advertisement for the namespace and find it using keyword |
999 | search --- even for your own namespaces. The @command{gnunet-pseudonym} | 1042 | search --- even for your own namespaces. The @command{gnunet-identity} |
1000 | tool is currently responsible for both managing pseudonyms and namespaces. | 1043 | tool is currently responsible for both managing pseudonyms and namespaces. |
1001 | This will likely change in the future to reduce the potential for | 1044 | This will likely change in the future to reduce the potential for |
1002 | confusion. | 1045 | confusion. |
@@ -1044,22 +1087,6 @@ level by one. If all blocks reach replication level zero, the | |||
1044 | selection is simply random. | 1087 | selection is simply random. |
1045 | 1088 | ||
1046 | 1089 | ||
1047 | @node fs-Directories | ||
1048 | @subsection Directories | ||
1049 | @c %**end of header | ||
1050 | |||
1051 | Directories are shared just like ordinary files. If you download a | ||
1052 | directory with @command{gnunet-download}, you can use | ||
1053 | @command{gnunet-directory} to list its contents. The canonical | ||
1054 | extension for GNUnet directories when stored as files in your | ||
1055 | local file-system is ".gnd". The contents of a directory are URIs and | ||
1056 | meta data. | ||
1057 | The URIs contain all the information required by | ||
1058 | @command{gnunet-download} to retrieve the file. The meta data | ||
1059 | typically includes the mime-type, description, a filename and | ||
1060 | other meta information, and possibly even the full original file | ||
1061 | (if it was small). | ||
1062 | |||
1063 | @node Namespace Management | 1090 | @node Namespace Management |
1064 | @subsection Namespace Management | 1091 | @subsection Namespace Management |
1065 | @c %**end of header | 1092 | @c %**end of header |
@@ -1067,8 +1094,8 @@ other meta information, and possibly even the full original file | |||
1067 | @b{Please note that the text in this subsection is outdated and needs} | 1094 | @b{Please note that the text in this subsection is outdated and needs} |
1068 | @b{to be rewritten for version 0.10!} | 1095 | @b{to be rewritten for version 0.10!} |
1069 | 1096 | ||
1070 | The gnunet-pseudonym tool can be used to create pseudonyms and | 1097 | The @code{gnunet-identity} tool can be used to create pseudonyms and |
1071 | to advertise namespaces. By default, gnunet-pseudonym simply | 1098 | to advertise namespaces. By default, @code{gnunet-identity -D} simply |
1072 | lists all locally available pseudonyms. | 1099 | lists all locally available pseudonyms. |
1073 | 1100 | ||
1074 | 1101 | ||
@@ -1084,6 +1111,10 @@ lists all locally available pseudonyms. | |||
1084 | @subsubsection Creating Pseudonyms | 1111 | @subsubsection Creating Pseudonyms |
1085 | @c %**end of header | 1112 | @c %**end of header |
1086 | 1113 | ||
1114 | @b{Please note that the text in this subsection is outdated and needs} | ||
1115 | @b{to be rewritten for version 0.10!} | ||
1116 | @b{This especially concerns the terminology of Pseudonym/Ego/Identity.} | ||
1117 | |||
1087 | With the @command{-C NICK} option it can also be used to | 1118 | With the @command{-C NICK} option it can also be used to |
1088 | create a new pseudonym. A pseudonym is the virtual identity | 1119 | create a new pseudonym. A pseudonym is the virtual identity |
1089 | of the entity in control of a namespace. Anyone can create | 1120 | of the entity in control of a namespace. Anyone can create |
@@ -1095,6 +1126,10 @@ used. | |||
1095 | @subsubsection Deleting Pseudonyms | 1126 | @subsubsection Deleting Pseudonyms |
1096 | @c %**end of header | 1127 | @c %**end of header |
1097 | 1128 | ||
1129 | @b{Please note that the text in this subsection is outdated and needs} | ||
1130 | @b{to be rewritten for version 0.10!} | ||
1131 | @b{This especially concerns the terminology of Pseudonym/Ego/Identity.} | ||
1132 | |||
1098 | With the @command{-D NICK} option pseudonyms can be deleted. | 1133 | With the @command{-D NICK} option pseudonyms can be deleted. |
1099 | Once the pseudonym has been deleted it is impossible to add | 1134 | Once the pseudonym has been deleted it is impossible to add |
1100 | content to the corresponding namespace. Deleting the | 1135 | content to the corresponding namespace. Deleting the |
@@ -1105,6 +1140,10 @@ unavailable. | |||
1105 | @subsubsection Advertising namespaces | 1140 | @subsubsection Advertising namespaces |
1106 | @c %**end of header | 1141 | @c %**end of header |
1107 | 1142 | ||
1143 | @b{Please note that the text in this subsection is outdated and needs} | ||
1144 | @b{to be rewritten for version 0.10!} | ||
1145 | @b{This especially concerns the terminology of Pseudonym/Ego/Identity.} | ||
1146 | |||
1108 | Each namespace is associated with meta-data that describes | 1147 | Each namespace is associated with meta-data that describes |
1109 | the namespace. This meta-data is provided by the user at | 1148 | the namespace. This meta-data is provided by the user at |
1110 | the time that the namespace is advertised. Advertisements | 1149 | the time that the namespace is advertised. Advertisements |
@@ -1121,6 +1160,10 @@ the quality of the content found in it. | |||
1121 | @subsubsection Namespace names | 1160 | @subsubsection Namespace names |
1122 | @c %**end of header | 1161 | @c %**end of header |
1123 | 1162 | ||
1163 | @b{Please note that the text in this subsection is outdated and needs} | ||
1164 | @b{to be rewritten for version 0.10!} | ||
1165 | @b{This especially concerns the terminology of Pseudonym/Ego/Identity.} | ||
1166 | |||
1124 | While the namespace is uniquely identified by its ID, another way | 1167 | While the namespace is uniquely identified by its ID, another way |
1125 | to refer to the namespace is to use the NICKNAME. | 1168 | to refer to the namespace is to use the NICKNAME. |
1126 | The NICKNAME can be freely chosen by the creator of the namespace and | 1169 | The NICKNAME can be freely chosen by the creator of the namespace and |
@@ -1132,6 +1175,10 @@ to the NICKNAME to get a unique identifier. | |||
1132 | @subsubsection Namespace root | 1175 | @subsubsection Namespace root |
1133 | @c %**end of header | 1176 | @c %**end of header |
1134 | 1177 | ||
1178 | @b{Please note that the text in this subsection is outdated and needs} | ||
1179 | @b{to be rewritten for version 0.10!} | ||
1180 | @b{This especially concerns the terminology of Pseudonym/Ego/Identity.} | ||
1181 | |||
1135 | An item of particular interest in the namespace advertisement is | 1182 | An item of particular interest in the namespace advertisement is |
1136 | the ROOT. The ROOT is the identifier of a designated entry in the | 1183 | the ROOT. The ROOT is the identifier of a designated entry in the |
1137 | namespace. The idea is that the ROOT can be used to advertise an | 1184 | namespace. The idea is that the ROOT can be used to advertise an |
@@ -1219,6 +1266,10 @@ Furthermore they must not contain '++'. | |||
1219 | @subsubsection Namespace content (sks) | 1266 | @subsubsection Namespace content (sks) |
1220 | @c %**end of header | 1267 | @c %**end of header |
1221 | 1268 | ||
1269 | @b{Please note that the text in this subsection is outdated and needs} | ||
1270 | @b{to be rewritten for version 0.10!} | ||
1271 | @b{This especially concerns the terminology of Pseudonym/Ego/Identity.} | ||
1272 | |||
1222 | Namespaces are sets of files that have been approved by some (usually | 1273 | Namespaces are sets of files that have been approved by some (usually |
1223 | pseudonymous) user --- typically by that user publishing all of the | 1274 | pseudonymous) user --- typically by that user publishing all of the |
1224 | files together. A file can be in many namespaces. A file is in a | 1275 | files together. A file can be in many namespaces. A file is in a |
@@ -1419,8 +1470,8 @@ $ gnunet-identity -C "myzone" | |||
1419 | 1470 | ||
1420 | Henceforth, on your system you control the TLD ``myzone''. | 1471 | Henceforth, on your system you control the TLD ``myzone''. |
1421 | 1472 | ||
1422 | All of your zones can be listed using the @command{gnunet-identity} | 1473 | All of your zones can be listed (displayed) using the |
1423 | command line tool as well: | 1474 | @command{gnunet-identity} command line tool as well: |
1424 | 1475 | ||
1425 | @example | 1476 | @example |
1426 | $ gnunet-identity -d | 1477 | $ gnunet-identity -d |
@@ -1528,11 +1579,11 @@ record you want to access). | |||
1528 | @subsection Using Public Keys as Top Level Domains | 1579 | @subsection Using Public Keys as Top Level Domains |
1529 | 1580 | ||
1530 | 1581 | ||
1531 | GNS also assumes responsibility for any name that uses in a well-formed | 1582 | GNS also assumes responsibility for any name that uses in a |
1532 | public key for the TLD. Names ending this way are then resolved by querying | 1583 | well-formed public key for the TLD. Names ending this way are then |
1533 | the respective zone. Such public key TLDs are expected to be used under rare | 1584 | resolved by querying the respective zone. Such public key TLDs are |
1534 | circumstances where globally unique names are required, and for | 1585 | expected to be used under rare circumstances where globally unique |
1535 | integration with legacy systems. | 1586 | names are required, and for integration with legacy systems. |
1536 | 1587 | ||
1537 | @node Resource Records in GNS | 1588 | @node Resource Records in GNS |
1538 | @subsection Resource Records in GNS | 1589 | @subsection Resource Records in GNS |
@@ -1569,18 +1620,31 @@ GNS currently supports the following record types: | |||
1569 | * CNAME:: | 1620 | * CNAME:: |
1570 | * GNS2DNS:: | 1621 | * GNS2DNS:: |
1571 | * SOA SRV PTR and MX:: | 1622 | * SOA SRV PTR and MX:: |
1623 | * PLACE:: | ||
1624 | * PHONE:: | ||
1625 | * ID ATTR:: | ||
1626 | * ID TOKEN:: | ||
1627 | * ID TOKEN METADATA:: | ||
1628 | * CREDENTIAL:: | ||
1629 | * POLICY:: | ||
1630 | * ATTRIBUTE:: | ||
1631 | * ABE KEY:: | ||
1632 | * ABE MASTER:: | ||
1633 | * RECLAIM OIDC CLIENT:: | ||
1634 | * RECLAIM OIDC REDIRECT:: | ||
1572 | @end menu | 1635 | @end menu |
1573 | 1636 | ||
1574 | @node NICK | 1637 | @node NICK |
1575 | @subsubsection NICK | 1638 | @subsubsection NICK |
1576 | 1639 | ||
1577 | A NICK record is used to give a zone a name. With a NICK record, you can | 1640 | A NICK record is used to give a zone a name. With a NICK record, you |
1578 | essentially specify how you would like to be called. GNS expects this | 1641 | can essentially specify how you would like to be called. GNS expects |
1579 | record under the empty label ``@@'' in the zone's database (NAMESTORE); however, | 1642 | this record under the empty label ``@@'' in the zone's database |
1580 | it will then automatically be copied into each record set, so that | 1643 | (NAMESTORE); however, it will then automatically be copied into each |
1581 | clients never need to do a separate lookup to discover the NICK record. | 1644 | record set, so that clients never need to do a separate lookup to |
1582 | Also, users do not usually have to worry about setting the NICK record: | 1645 | discover the NICK record. Also, users do not usually have to worry |
1583 | it is automatically set to the local name of the TLD. | 1646 | about setting the NICK record: it is automatically set to the local |
1647 | name of the TLD. | ||
1584 | 1648 | ||
1585 | @b{Example}@ | 1649 | @b{Example}@ |
1586 | 1650 | ||
@@ -1739,6 +1803,66 @@ should use the ZKEY zone as the destination hostname and | |||
1739 | GNS-enabled mail servers should be configured to accept | 1803 | GNS-enabled mail servers should be configured to accept |
1740 | e-mails to the ZKEY-zones of all local users. | 1804 | e-mails to the ZKEY-zones of all local users. |
1741 | 1805 | ||
1806 | @node PLACE | ||
1807 | @subsubsection PLACE | ||
1808 | |||
1809 | Record type for a social place. | ||
1810 | |||
1811 | @node PHONE | ||
1812 | @subsubsection PHONE | ||
1813 | |||
1814 | Record type for a phone (of CONVERSATION). | ||
1815 | |||
1816 | @node ID ATTR | ||
1817 | @subsubsection ID ATTR | ||
1818 | |||
1819 | Record type for identity attributes (of IDENTITY). | ||
1820 | |||
1821 | @node ID TOKEN | ||
1822 | @subsubsection ID TOKEN | ||
1823 | |||
1824 | Record type for an identity token (of IDENTITY-TOKEN). | ||
1825 | |||
1826 | @node ID TOKEN METADATA | ||
1827 | @subsubsection ID TOKEN METADATA | ||
1828 | |||
1829 | Record type for the private metadata of an identity token (of IDENTITY-TOKEN). | ||
1830 | |||
1831 | @node CREDENTIAL | ||
1832 | @subsubsection CREDENTIAL | ||
1833 | |||
1834 | Record type for credential. | ||
1835 | |||
1836 | @node POLICY | ||
1837 | @subsubsection POLICY | ||
1838 | |||
1839 | Record type for policies. | ||
1840 | |||
1841 | @node ATTRIBUTE | ||
1842 | @subsubsection ATTRIBUTE | ||
1843 | |||
1844 | Record type for reverse lookups. | ||
1845 | |||
1846 | @node ABE KEY | ||
1847 | @subsubsection ABE KEY | ||
1848 | |||
1849 | Record type for ABE records. | ||
1850 | |||
1851 | @node ABE MASTER | ||
1852 | @subsubsection ABE MASTER | ||
1853 | |||
1854 | Record type for ABE master keys. | ||
1855 | |||
1856 | @node RECLAIM OIDC CLIENT | ||
1857 | @subsubsection RECLAIM OIDC CLIENT | ||
1858 | |||
1859 | Record type for reclaim OIDC clients. | ||
1860 | |||
1861 | @node RECLAIM OIDC REDIRECT | ||
1862 | @subsubsection RECLAIM OIDC REDIRECT | ||
1863 | |||
1864 | Record type for reclaim OIDC redirect URIs. | ||
1865 | |||
1742 | @node Synchronizing with legacy DNS | 1866 | @node Synchronizing with legacy DNS |
1743 | @subsection Synchronizing with legacy DNS | 1867 | @subsection Synchronizing with legacy DNS |
1744 | 1868 | ||
@@ -1769,6 +1893,98 @@ is thus advisable to disable the namecache by setting the | |||
1769 | option ``DISABLE'' to ``YES'' in section ``[namecache]''. | 1893 | option ``DISABLE'' to ``YES'' in section ``[namecache]''. |
1770 | 1894 | ||
1771 | 1895 | ||
1896 | @node re@:claim Identity Provider | ||
1897 | @section re@:claim Identity Provider | ||
1898 | |||
1899 | The re:claim Identity Provider (IdP) is a decentralized IdP service. | ||
1900 | It allows its users to manage and authorize third parties to access their identity attributes such as email or shipping addresses. | ||
1901 | |||
1902 | It basically mimics the concepts of centralized IdPs, such as those offered by Google or Facebook. | ||
1903 | Like other IdPs, re:claim features an (optional) OpenID-Connect 1.0-compliant protocol layer that can be used for websites to integrate re:claim as an Identity Provider with little effort. | ||
1904 | |||
1905 | @menu | ||
1906 | * Managing Attributes:: | ||
1907 | * Sharing Attributes with Third Parties:: | ||
1908 | * Revoking Authorizations of Third Parties:: | ||
1909 | * Using the OpenID-Connect IdP:: | ||
1910 | @end menu | ||
1911 | |||
1912 | @node Managing Attributes | ||
1913 | @subsection Managing Attributes | ||
1914 | |||
1915 | Before adding attributes to an identity, you must first create an ego: | ||
1916 | |||
1917 | @example | ||
1918 | $ gnunet-identity -C "username" | ||
1919 | @end example | ||
1920 | |||
1921 | Henceforth, you can manage a new user profile of the user ``username''. | ||
1922 | |||
1923 | To add an email address to your user profile, simply use the @command{gnunet-reclaim} command line tool:: | ||
1924 | |||
1925 | @example | ||
1926 | $ gnunet-reclaim -e "username" -a "email" -V "username@@example.gnunet" | ||
1927 | @end example | ||
1928 | |||
1929 | All of your attributes can be listed using the @command{gnunet-reclaim} | ||
1930 | command line tool as well: | ||
1931 | |||
1932 | @example | ||
1933 | $ gnunet-reclaim -e "username" -D | ||
1934 | @end example | ||
1935 | |||
1936 | Currently, and by default, attribute values are interpreted as plain text. | ||
1937 | In the future there might be more value types such as X.509 certificate credentials. | ||
1938 | |||
1939 | @node Sharing Attributes with Third Parties | ||
1940 | @subsection Sharing Attributes with Third Parties | ||
1941 | |||
1942 | If you want to allow a third party such as a website or friend to access to your attributes (or a subset thereof) execute: | ||
1943 | |||
1944 | @example | ||
1945 | $ gnunet-reclaim -e "username" -r "PKEY" -i "attribute1,attribute2,..." | ||
1946 | @end example | ||
1947 | |||
1948 | Where "PKEY" is the public key of the third party and "attribute1,attribute2,..." is a comma-separated list of attribute names, such as "email", that you want to share. | ||
1949 | |||
1950 | The command will return a "ticket" string. | ||
1951 | You must give this "ticket" to the requesting third party. | ||
1952 | |||
1953 | The third party can then retrieve your shared identity attributes using: | ||
1954 | |||
1955 | @example | ||
1956 | $ gnunet-reclaim -e "friend" -C "ticket" | ||
1957 | @end example | ||
1958 | |||
1959 | This will retrieve and list the shared identity attributes. | ||
1960 | The above command will also work if the user "username" is currently offline since the attributes are retrieved from GNS. | ||
1961 | Further, the "ticket" can be re-used later to retrieve up-to-date attributes in case "username" has changed the value(s). For instance, becasue his email address changed. | ||
1962 | |||
1963 | To list all given authorizations (tickets) you can execute: | ||
1964 | @example | ||
1965 | $ gnunet-reclaim -e "friend" -T (TODO there is only a REST API for this ATM) | ||
1966 | @end example | ||
1967 | |||
1968 | |||
1969 | @node Revoking Authorizations of Third Parties | ||
1970 | @subsection Revoking Authorizations of Third Parties | ||
1971 | |||
1972 | If you want to revoke the access of a third party to your attributes you can execute: | ||
1973 | |||
1974 | @example | ||
1975 | $ gnunet-idp -e "username" -R "ticket" | ||
1976 | @end example | ||
1977 | |||
1978 | This will prevent the third party from accessing the attribute in the future. | ||
1979 | Please note that if the third party has previously accessed the attribute, there is not way in which the system could have prevented the thiry party from storing the data. | ||
1980 | As such, only access to updated data in the future can be revoked. | ||
1981 | This behaviour is _exactly the same_ as with other IdPs. | ||
1982 | |||
1983 | @node Using the OpenID-Connect IdP | ||
1984 | @subsection Using the OpenID-Connect IdP | ||
1985 | |||
1986 | TODO: Document setup and REST endpoints | ||
1987 | |||
1772 | @node Using the Virtual Public Network | 1988 | @node Using the Virtual Public Network |
1773 | @section Using the Virtual Public Network | 1989 | @section Using the Virtual Public Network |
1774 | 1990 | ||
diff --git a/doc/documentation/gnunet.texi b/doc/documentation/gnunet.texi index 2ef5a2b59..50630d4fe 100644 --- a/doc/documentation/gnunet.texi +++ b/doc/documentation/gnunet.texi | |||
@@ -90,7 +90,8 @@ This document is the Reference Manual for GNUnet version @value{VERSION}. | |||
90 | * GNUnet Contributors Handbook:: Contributing to GNUnet | 90 | * GNUnet Contributors Handbook:: Contributing to GNUnet |
91 | * GNUnet Developer Handbook:: Developing GNUnet | 91 | * GNUnet Developer Handbook:: Developing GNUnet |
92 | * GNU Free Documentation License:: The license of this manual | 92 | * GNU Free Documentation License:: The license of this manual |
93 | * GNU General Public License:: The license of this manual | 93 | * GNU General Public License:: |
94 | * GNU Affero General Public License:: | ||
94 | * Concept Index:: Concepts | 95 | * Concept Index:: Concepts |
95 | * Programming Index:: Data types, functions, and variables | 96 | * Programming Index:: Data types, functions, and variables |
96 | 97 | ||
@@ -100,8 +101,8 @@ This document is the Reference Manual for GNUnet version @value{VERSION}. | |||
100 | Preface | 101 | Preface |
101 | 102 | ||
102 | * About this book | 103 | * About this book |
104 | * Contributing to this book | ||
103 | * Introduction | 105 | * Introduction |
104 | * General Terminology:: | ||
105 | * Typography:: | 106 | * Typography:: |
106 | 107 | ||
107 | Philosophy | 108 | Philosophy |
@@ -124,6 +125,14 @@ Key Concepts | |||
124 | * Revocation:: | 125 | * Revocation:: |
125 | 126 | ||
126 | Installing GNUnet | 127 | Installing GNUnet |
128 | * Installing dependencies:: | ||
129 | * Getting the Source Code:: | ||
130 | * Create @code{gnunet} user and group:: | ||
131 | * Preparing and Compiling the Source Code:: | ||
132 | * Installation:: | ||
133 | * MOVED FROM USER Checking the Installation:: | ||
134 | * MOVED FROM USER The graphical configuration interface:: | ||
135 | * MOVED FROM USER Config Leftovers:: | ||
127 | 136 | ||
128 | Using GNUnet | 137 | Using GNUnet |
129 | 138 | ||
@@ -141,6 +150,7 @@ GNUnet Contributors Handbook | |||
141 | * Licenses of contributions:: | 150 | * Licenses of contributions:: |
142 | * Copyright Assignment:: | 151 | * Copyright Assignment:: |
143 | * Contributing to the Reference Manual:: | 152 | * Contributing to the Reference Manual:: |
153 | * Contributing testcases:: | ||
144 | 154 | ||
145 | GNUnet Developer Handbook | 155 | GNUnet Developer Handbook |
146 | 156 | ||
@@ -227,6 +237,12 @@ GNUnet Developer Handbook | |||
227 | @include gpl-3.0.texi | 237 | @include gpl-3.0.texi |
228 | 238 | ||
229 | @c ********************************************************************* | 239 | @c ********************************************************************* |
240 | @node GNU Affero General Public License | ||
241 | @appendix GNU Affero General Public License | ||
242 | @cindex license, GNU Affero General Public License | ||
243 | @include agpl-3.0.texi | ||
244 | |||
245 | @c ********************************************************************* | ||
230 | @node Concept Index | 246 | @node Concept Index |
231 | @unnumbered Concept Index | 247 | @unnumbered Concept Index |
232 | @printindex cp | 248 | @printindex cp |
@@ -235,6 +251,7 @@ GNUnet Developer Handbook | |||
235 | @unnumbered Programming Index | 251 | @unnumbered Programming Index |
236 | @syncodeindex tp fn | 252 | @syncodeindex tp fn |
237 | @syncodeindex vr fn | 253 | @syncodeindex vr fn |
254 | @syncodeindex pg fn | ||
238 | @printindex fn | 255 | @printindex fn |
239 | 256 | ||
240 | @bye | 257 | @bye |
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index a6a116dca..37f881d60 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am | |||
@@ -37,6 +37,7 @@ man_MANS = \ | |||
37 | gnunet-statistics.1 \ | 37 | gnunet-statistics.1 \ |
38 | gnunet-testbed-profiler.1 \ | 38 | gnunet-testbed-profiler.1 \ |
39 | gnunet-testing-run-service.1 \ | 39 | gnunet-testing-run-service.1 \ |
40 | gnunet-timeout.1 \ | ||
40 | gnunet-transport.1 \ | 41 | gnunet-transport.1 \ |
41 | gnunet-transport-certificate-creation.1 \ | 42 | gnunet-transport-certificate-creation.1 \ |
42 | gnunet-unindex.1 \ | 43 | gnunet-unindex.1 \ |
diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1 index 9466dae03..9e4482653 100644 --- a/doc/man/gnunet-gns.1 +++ b/doc/man/gnunet-gns.1 | |||
@@ -46,7 +46,7 @@ Print GNUnet version number. | |||
46 | .SH RETURN VALUE | 46 | .SH RETURN VALUE |
47 | 47 | ||
48 | gnunet\-gns will return 0 on success, 1 on internal failures, 2 on | 48 | gnunet\-gns will return 0 on success, 1 on internal failures, 2 on |
49 | launch failures, 3 if the given name is not configured to use GNS. | 49 | launch failures, 4 if the given name is not configured to use GNS. |
50 | 50 | ||
51 | 51 | ||
52 | .SH BUGS | 52 | .SH BUGS |
diff --git a/doc/man/gnunet-timeout.1 b/doc/man/gnunet-timeout.1 new file mode 100644 index 000000000..e413254f4 --- /dev/null +++ b/doc/man/gnunet-timeout.1 | |||
@@ -0,0 +1,20 @@ | |||
1 | .TH GNUNET\-TIMOUET 1 "Jun 5, 2018" "GNUnet" | ||
2 | |||
3 | .SH NAME | ||
4 | gnunet\-timeout \- run process with timeout | ||
5 | |||
6 | .SH SYNOPSIS | ||
7 | .B gnunet\-timeout | ||
8 | .RI TIMEOUT PROGRAM ARGS | ||
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | ||
12 | \fBgnunet\-timeout\fP can be used to run another process with a | ||
13 | timeout. Provided as the standard "timout" utility may not be | ||
14 | available on all platforms. | ||
15 | |||
16 | .SH BUGS | ||
17 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | ||
18 | |||
19 | .SH SEE | ||
20 | timeout(1) | ||