diff options
author | Florian Dold <florian.dold@gmail.com> | 2019-08-29 13:34:07 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2019-08-29 13:34:19 +0200 |
commit | 180da005f4d8cf78121dfe765c47de060006e005 (patch) | |
tree | 264b7527fb14c73431498f78194d6e87e2bd92e2 | |
parent | 7b20ee8c8d691c0d79403462411ec66c5ada36c4 (diff) | |
download | exchange-180da005f4d8cf78121dfe765c47de060006e005.tar.gz exchange-180da005f4d8cf78121dfe765c47de060006e005.zip |
move documentation to docs repo
-rw-r--r-- | doc/Makefile.am | 16 | ||||
-rw-r--r-- | doc/agpl.texi | 698 | ||||
-rw-r--r-- | doc/brown-paper.css | 63 | ||||
-rw-r--r-- | doc/configuration-format.texi | 73 | ||||
-rw-r--r-- | doc/docstyle.css | 76 | ||||
-rwxr-xr-x | doc/exchange-db-generate.sh | 3 | ||||
-rw-r--r-- | doc/exchange-db.png | bin | 564934 -> 0 bytes | |||
-rw-r--r-- | doc/fdl-1.3.texi | 506 | ||||
-rw-r--r-- | doc/syntax.texi | 44 | ||||
-rw-r--r-- | doc/taler-config.texi | 47 | ||||
-rw-r--r-- | doc/taler-exchange.texi | 972 |
11 files changed, 0 insertions, 2498 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 09793ddcf..33bde2743 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am | |||
@@ -18,22 +18,6 @@ man_MANS = \ | |||
18 | taler-exchange-benchmark.1 \ | 18 | taler-exchange-benchmark.1 \ |
19 | taler.conf.5 | 19 | taler.conf.5 |
20 | 20 | ||
21 | AM_MAKEINFOHTMLFLAGS = --no-split --css-ref=docstyle.css --css-ref=brown-paper.css | ||
22 | |||
23 | DISTCLEANFILES = \ | ||
24 | taler-exchange.cps \ | ||
25 | taler-exchange.dvi | ||
26 | |||
27 | info_TEXINFOS = \ | ||
28 | taler-exchange.texi | ||
29 | extra_TEXINFOS = \ | ||
30 | fdl-1.3.texi \ | ||
31 | agpl.texi \ | ||
32 | syntax.texi | ||
33 | EXTRA_DIST = \ | 21 | EXTRA_DIST = \ |
34 | coding-style.txt \ | 22 | coding-style.txt \ |
35 | $(man_MANS) \ | 23 | $(man_MANS) \ |
36 | $(extra_TEXINFOS) \ | ||
37 | docstyle.css \ | ||
38 | brown-paper.css \ | ||
39 | exchange-db.png | ||
diff --git a/doc/agpl.texi b/doc/agpl.texi deleted file mode 100644 index e6ee662e3..000000000 --- a/doc/agpl.texi +++ /dev/null | |||
@@ -1,698 +0,0 @@ | |||
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{http://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{http://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{http://www.gnu.org/licenses/}. | ||
diff --git a/doc/brown-paper.css b/doc/brown-paper.css deleted file mode 100644 index 65e2e7902..000000000 --- a/doc/brown-paper.css +++ /dev/null | |||
@@ -1,63 +0,0 @@ | |||
1 | /* | ||
2 | |||
3 | Brown Paper style from goldblog.com.ua (c) Zaripov Yura <yur4ik7@ukr.net> | ||
4 | |||
5 | */ | ||
6 | |||
7 | .hljs { | ||
8 | display: block; | ||
9 | overflow-x: auto; | ||
10 | padding: 0.5em; | ||
11 | } | ||
12 | |||
13 | .hljs-keyword, | ||
14 | .hljs-selector-tag, | ||
15 | .hljs-literal { | ||
16 | color:#005599; | ||
17 | font-weight:bold; | ||
18 | } | ||
19 | |||
20 | .hljs, | ||
21 | .hljs-subst { | ||
22 | color: #363c69; | ||
23 | } | ||
24 | |||
25 | .hljs-string, | ||
26 | .hljs-title, | ||
27 | .hljs-section, | ||
28 | .hljs-type, | ||
29 | .hljs-attribute, | ||
30 | .hljs-symbol, | ||
31 | .hljs-bullet, | ||
32 | .hljs-built_in, | ||
33 | .hljs-addition, | ||
34 | .hljs-variable, | ||
35 | .hljs-template-tag, | ||
36 | .hljs-template-variable, | ||
37 | .hljs-link, | ||
38 | .hljs-name { | ||
39 | color: #2c009f; | ||
40 | } | ||
41 | |||
42 | .hljs-comment, | ||
43 | .hljs-quote, | ||
44 | .hljs-meta, | ||
45 | .hljs-deletion { | ||
46 | color: #802022; | ||
47 | } | ||
48 | |||
49 | .hljs-keyword, | ||
50 | .hljs-selector-tag, | ||
51 | .hljs-literal, | ||
52 | .hljs-doctag, | ||
53 | .hljs-title, | ||
54 | .hljs-section, | ||
55 | .hljs-type, | ||
56 | .hljs-name, | ||
57 | .hljs-strong { | ||
58 | font-weight: bold; | ||
59 | } | ||
60 | |||
61 | .hljs-emphasis { | ||
62 | font-style: italic; | ||
63 | } | ||
diff --git a/doc/configuration-format.texi b/doc/configuration-format.texi deleted file mode 100644 index 6453ba601..000000000 --- a/doc/configuration-format.texi +++ /dev/null | |||
@@ -1,73 +0,0 @@ | |||
1 | @c This file is used both in the exchange and merchant | ||
2 | @c manuals. Edits should be propagated to both Gits! | ||
3 | |||
4 | @node Configuration format | ||
5 | @section Configuration format | ||
6 | @cindex configuration | ||
7 | |||
8 | In Taler realm, any component obeys to the same pattern to get configuration | ||
9 | values. According to this pattern, once the component has been installed, the | ||
10 | installation deploys default values in @cite{$@{prefix@}/share/taler/config.d/}, in | ||
11 | @cite{.conf} files. In order to override these defaults, the user can write a custom | ||
12 | @cite{.conf} file and either pass it to the component at execution time, or name it | ||
13 | @cite{taler.conf} and place it under @cite{$HOME/.config/}. | ||
14 | |||
15 | |||
16 | A config file is a text file containing @cite{sections}, and each section contains | ||
17 | its @cite{values}. The right format follows: | ||
18 | |||
19 | @example | ||
20 | [section1] | ||
21 | value1 = string | ||
22 | value2 = 23 | ||
23 | |||
24 | [section2] | ||
25 | value21 = string | ||
26 | value22 = /path22 | ||
27 | @end example | ||
28 | |||
29 | Throughout any configuration file, it is possible to use @code{$}-prefixed variables, | ||
30 | like @code{$VAR}, especially when they represent filesystem paths. | ||
31 | It is also possible to provide defaults values for those variables that are unset, | ||
32 | by using the following syntax: @code{$@{VAR:-default@}}. | ||
33 | However, there are two ways a user can set @code{$}-prefixable variables: | ||
34 | |||
35 | by defining them under a @code{[paths]} section, see example below, | ||
36 | |||
37 | @example | ||
38 | [paths] | ||
39 | TALER_DEPLOYMENT_SHARED = $@{HOME@}/shared-data | ||
40 | .. | ||
41 | [section-x] | ||
42 | path-x = $@{TALER_DEPLOYMENT_SHARED@}/x | ||
43 | @end example | ||
44 | |||
45 | or by setting them in the environment: | ||
46 | |||
47 | @example | ||
48 | $ export VAR=/x | ||
49 | @end example | ||
50 | |||
51 | The configuration loader will give precedence to variables set under @code{[path]}, | ||
52 | though. | ||
53 | |||
54 | The utility @code{taler-config}, which gets installed along with the exchange, serves | ||
55 | to get and set configuration values without directly editing the @cite{.conf}. | ||
56 | The option @code{-f} is particularly useful to resolve pathnames, when they use | ||
57 | several levels of @code{$}-expanded variables. See @code{taler-config --help}. | ||
58 | |||
59 | Note that, in this stage of development, the file @code{$HOME/.config/taler.conf} | ||
60 | can contain sections for @emph{all} the component. For example, both an exchange and | ||
61 | a bank can read values from it. | ||
62 | |||
63 | The repository @code{git://taler.net/deployment} contains examples of configuration | ||
64 | file used in our demos. See under @code{deployment/config}. | ||
65 | |||
66 | @cartouche | ||
67 | @quotation Note | ||
68 | Expectably, some components will not work just by using default values, as their | ||
69 | work is often interdependent. For example, a merchant needs to know an exchange | ||
70 | URL, or a database name. | ||
71 | @end quotation | ||
72 | @end cartouche | ||
73 | |||
diff --git a/doc/docstyle.css b/doc/docstyle.css deleted file mode 100644 index c91d3f796..000000000 --- a/doc/docstyle.css +++ /dev/null | |||
@@ -1,76 +0,0 @@ | |||
1 | html, body { | ||
2 | font-size: 1em; | ||
3 | text-align: left; | ||
4 | text-decoration: none; | ||
5 | } | ||
6 | html { background-color: #e7e7e7; } | ||
7 | |||
8 | body { | ||
9 | max-width: 74.92em; | ||
10 | margin: 0 auto; | ||
11 | padding: .5em 1em 1em 1em; | ||
12 | background-color: white; | ||
13 | border: .1em solid #c0c0c0; | ||
14 | } | ||
15 | |||
16 | h1, h2, h3, h4 { color: #333; } | ||
17 | h5, h6, dt { color: #222; } | ||
18 | |||
19 | |||
20 | a h3 { | ||
21 | color: #005090; | ||
22 | } | ||
23 | |||
24 | a[href] { color: #005090; } | ||
25 | a[href]:visited { color: #100070; } | ||
26 | a[href]:active, a[href]:hover { | ||
27 | color: #100070; | ||
28 | text-decoration: none; | ||
29 | } | ||
30 | |||
31 | .linkrow { | ||
32 | margin: 3em 0; | ||
33 | } | ||
34 | |||
35 | .linkrow { | ||
36 | text-align: center; | ||
37 | } | ||
38 | |||
39 | div.example { padding: .8em 1.2em .4em; } | ||
40 | pre.example { padding: .8em 1.2em; } | ||
41 | div.example, pre.example { | ||
42 | margin: 1em 0 1em 3% ; | ||
43 | -webkit-border-radius: .3em; | ||
44 | -moz-border-radius: .3em; | ||
45 | border-radius: .3em; | ||
46 | border: 1px solid #d4cbb6; | ||
47 | background-color: #f2efe4; | ||
48 | } | ||
49 | div.example > pre.example { | ||
50 | padding: 0 0 .4em; | ||
51 | margin: 0; | ||
52 | border: none; | ||
53 | } | ||
54 | |||
55 | |||
56 | /* This makes the very long tables of contents in Gnulib and other | ||
57 | manuals easier to read. */ | ||
58 | .contents ul, .shortcontents ul { font-weight: bold; } | ||
59 | .contents ul ul, .shortcontents ul ul { font-weight: normal; } | ||
60 | .contents ul { list-style: none; } | ||
61 | |||
62 | /* For colored navigation bars (Emacs manual): make the bar extend | ||
63 | across the whole width of the page and give it a decent height. */ | ||
64 | .header, .node { margin: 0 -1em; padding: 0 1em; } | ||
65 | .header p, .node p { line-height: 2em; } | ||
66 | |||
67 | /* For navigation links */ | ||
68 | .node a, .header a { display: inline-block; line-height: 2em; } | ||
69 | .node a:hover, .header a:hover { background: #f2efe4; } | ||
70 | |||
71 | table.cartouche { | ||
72 | border-collapse: collapse; | ||
73 | border-color: darkred; | ||
74 | border-style: solid; | ||
75 | border-width: 3px; | ||
76 | } | ||
diff --git a/doc/exchange-db-generate.sh b/doc/exchange-db-generate.sh deleted file mode 100755 index b296e0c9d..000000000 --- a/doc/exchange-db-generate.sh +++ /dev/null | |||
@@ -1,3 +0,0 @@ | |||
1 | #!/bin/sh | ||
2 | taler-exchange-dbinit -r | ||
3 | java -jar schemaSpy_5.0.0.jar -t pgsql -db taler -o taler -host localhost -dp /usr/share/java/postgresql-jdbc3-9.2.jar -u grothoff -p test -s public -hq | ||
diff --git a/doc/exchange-db.png b/doc/exchange-db.png deleted file mode 100644 index 421e5941b..000000000 --- a/doc/exchange-db.png +++ /dev/null | |||
Binary files differ | |||
diff --git a/doc/fdl-1.3.texi b/doc/fdl-1.3.texi deleted file mode 100644 index 8805f1a47..000000000 --- a/doc/fdl-1.3.texi +++ /dev/null | |||
@@ -1,506 +0,0 @@ | |||
1 | @c The GNU Free Documentation License. | ||
2 | @center Version 1.3, 3 November 2008 | ||
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{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. | ||
9 | @uref{http://fsf.org/} | ||
10 | |||
11 | Everyone is permitted to copy and distribute verbatim copies | ||
12 | of this license document, but changing it is not allowed. | ||
13 | @end display | ||
14 | |||
15 | @enumerate 0 | ||
16 | @item | ||
17 | PREAMBLE | ||
18 | |||
19 | The purpose of this License is to make a manual, textbook, or other | ||
20 | functional and useful document @dfn{free} in the sense of freedom: to | ||
21 | assure everyone the effective freedom to copy and redistribute it, | ||
22 | with or without modifying it, either commercially or noncommercially. | ||
23 | Secondarily, this License preserves for the author and publisher a way | ||
24 | to get credit for their work, while not being considered responsible | ||
25 | for modifications made by others. | ||
26 | |||
27 | This License is a kind of ``copyleft'', which means that derivative | ||
28 | works of the document must themselves be free in the same sense. It | ||
29 | complements the GNU General Public License, which is a copyleft | ||
30 | license designed for free software. | ||
31 | |||
32 | We have designed this License in order to use it for manuals for free | ||
33 | software, because free software needs free documentation: a free | ||
34 | program should come with manuals providing the same freedoms that the | ||
35 | software does. But this License is not limited to software manuals; | ||
36 | it can be used for any textual work, regardless of subject matter or | ||
37 | whether it is published as a printed book. We recommend this License | ||
38 | principally for works whose purpose is instruction or reference. | ||
39 | |||
40 | @item | ||
41 | APPLICABILITY AND DEFINITIONS | ||
42 | |||
43 | This License applies to any manual or other work, in any medium, that | ||
44 | contains a notice placed by the copyright holder saying it can be | ||
45 | distributed under the terms of this License. Such a notice grants a | ||
46 | world-wide, royalty-free license, unlimited in duration, to use that | ||
47 | work under the conditions stated herein. The ``Document'', below, | ||
48 | refers to any such manual or work. Any member of the public is a | ||
49 | licensee, and is addressed as ``you''. You accept the license if you | ||
50 | copy, modify or distribute the work in a way requiring permission | ||
51 | under copyright law. | ||
52 | |||
53 | A ``Modified Version'' of the Document means any work containing the | ||
54 | Document or a portion of it, either copied verbatim, or with | ||
55 | modifications and/or translated into another language. | ||
56 | |||
57 | A ``Secondary Section'' is a named appendix or a front-matter section | ||
58 | of the Document that deals exclusively with the relationship of the | ||
59 | publishers or authors of the Document to the Document's overall | ||
60 | subject (or to related matters) and contains nothing that could fall | ||
61 | directly within that overall subject. (Thus, if the Document is in | ||
62 | part a textbook of mathematics, a Secondary Section may not explain | ||
63 | any mathematics.) The relationship could be a matter of historical | ||
64 | connection with the subject or with related matters, or of legal, | ||
65 | commercial, philosophical, ethical or political position regarding | ||
66 | them. | ||
67 | |||
68 | The ``Invariant Sections'' are certain Secondary Sections whose titles | ||
69 | are designated, as being those of Invariant Sections, in the notice | ||
70 | that says that the Document is released under this License. If a | ||
71 | section does not fit the above definition of Secondary then it is not | ||
72 | allowed to be designated as Invariant. The Document may contain zero | ||
73 | Invariant Sections. If the Document does not identify any Invariant | ||
74 | Sections then there are none. | ||
75 | |||
76 | The ``Cover Texts'' are certain short passages of text that are listed, | ||
77 | as Front-Cover Texts or Back-Cover Texts, in the notice that says that | ||
78 | the Document is released under this License. A Front-Cover Text may | ||
79 | be at most 5 words, and a Back-Cover Text may be at most 25 words. | ||
80 | |||
81 | A ``Transparent'' copy of the Document means a machine-readable copy, | ||
82 | represented in a format whose specification is available to the | ||
83 | general public, that is suitable for revising the document | ||
84 | straightforwardly with generic text editors or (for images composed of | ||
85 | pixels) generic paint programs or (for drawings) some widely available | ||
86 | drawing editor, and that is suitable for input to text formatters or | ||
87 | for automatic translation to a variety of formats suitable for input | ||
88 | to text formatters. A copy made in an otherwise Transparent file | ||
89 | format whose markup, or absence of markup, has been arranged to thwart | ||
90 | or discourage subsequent modification by readers is not Transparent. | ||
91 | An image format is not Transparent if used for any substantial amount | ||
92 | of text. A copy that is not ``Transparent'' is called ``Opaque''. | ||
93 | |||
94 | Examples of suitable formats for Transparent copies include plain | ||
95 | @sc{ascii} without markup, Texinfo input format, La@TeX{} input | ||
96 | format, @acronym{SGML} or @acronym{XML} using a publicly available | ||
97 | @acronym{DTD}, and standard-conforming simple @acronym{HTML}, | ||
98 | PostScript or @acronym{PDF} designed for human modification. Examples | ||
99 | of transparent image formats include @acronym{PNG}, @acronym{XCF} and | ||
100 | @acronym{JPG}. Opaque formats include proprietary formats that can be | ||
101 | read and edited only by proprietary word processors, @acronym{SGML} or | ||
102 | @acronym{XML} for which the @acronym{DTD} and/or processing tools are | ||
103 | not generally available, and the machine-generated @acronym{HTML}, | ||
104 | PostScript or @acronym{PDF} produced by some word processors for | ||
105 | output purposes only. | ||
106 | |||
107 | The ``Title Page'' means, for a printed book, the title page itself, | ||
108 | plus such following pages as are needed to hold, legibly, the material | ||
109 | this License requires to appear in the title page. For works in | ||
110 | formats which do not have any title page as such, ``Title Page'' means | ||
111 | the text near the most prominent appearance of the work's title, | ||
112 | preceding the beginning of the body of the text. | ||
113 | |||
114 | The ``publisher'' means any person or entity that distributes copies | ||
115 | of the Document to the public. | ||
116 | |||
117 | A section ``Entitled XYZ'' means a named subunit of the Document whose | ||
118 | title either is precisely XYZ or contains XYZ in parentheses following | ||
119 | text that translates XYZ in another language. (Here XYZ stands for a | ||
120 | specific section name mentioned below, such as ``Acknowledgements'', | ||
121 | ``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' | ||
122 | of such a section when you modify the Document means that it remains a | ||
123 | section ``Entitled XYZ'' according to this definition. | ||
124 | |||
125 | The Document may include Warranty Disclaimers next to the notice which | ||
126 | states that this License applies to the Document. These Warranty | ||
127 | Disclaimers are considered to be included by reference in this | ||
128 | License, but only as regards disclaiming warranties: any other | ||
129 | implication that these Warranty Disclaimers may have is void and has | ||
130 | no effect on the meaning of this License. | ||
131 | |||
132 | @item | ||
133 | VERBATIM COPYING | ||
134 | |||
135 | You may copy and distribute the Document in any medium, either | ||
136 | commercially or noncommercially, provided that this License, the | ||
137 | copyright notices, and the license notice saying this License applies | ||
138 | to the Document are reproduced in all copies, and that you add no other | ||
139 | conditions whatsoever to those of this License. You may not use | ||
140 | technical measures to obstruct or control the reading or further | ||
141 | copying of the copies you make or distribute. However, you may accept | ||
142 | compensation in exchange for copies. If you distribute a large enough | ||
143 | number of copies you must also follow the conditions in section 3. | ||
144 | |||
145 | You may also lend copies, under the same conditions stated above, and | ||
146 | you may publicly display copies. | ||
147 | |||
148 | @item | ||
149 | COPYING IN QUANTITY | ||
150 | |||
151 | If you publish printed copies (or copies in media that commonly have | ||
152 | printed covers) of the Document, numbering more than 100, and the | ||
153 | Document's license notice requires Cover Texts, you must enclose the | ||
154 | copies in covers that carry, clearly and legibly, all these Cover | ||
155 | Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on | ||
156 | the back cover. Both covers must also clearly and legibly identify | ||
157 | you as the publisher of these copies. The front cover must present | ||
158 | the full title with all words of the title equally prominent and | ||
159 | visible. You may add other material on the covers in addition. | ||
160 | Copying with changes limited to the covers, as long as they preserve | ||
161 | the title of the Document and satisfy these conditions, can be treated | ||
162 | as verbatim copying in other respects. | ||
163 | |||
164 | If the required texts for either cover are too voluminous to fit | ||
165 | legibly, you should put the first ones listed (as many as fit | ||
166 | reasonably) on the actual cover, and continue the rest onto adjacent | ||
167 | pages. | ||
168 | |||
169 | If you publish or distribute Opaque copies of the Document numbering | ||
170 | more than 100, you must either include a machine-readable Transparent | ||
171 | copy along with each Opaque copy, or state in or with each Opaque copy | ||
172 | a computer-network location from which the general network-using | ||
173 | public has access to download using public-standard network protocols | ||
174 | a complete Transparent copy of the Document, free of added material. | ||
175 | If you use the latter option, you must take reasonably prudent steps, | ||
176 | when you begin distribution of Opaque copies in quantity, to ensure | ||
177 | that this Transparent copy will remain thus accessible at the stated | ||
178 | location until at least one year after the last time you distribute an | ||
179 | Opaque copy (directly or through your agents or retailers) of that | ||
180 | edition to the public. | ||
181 | |||
182 | It is requested, but not required, that you contact the authors of the | ||
183 | Document well before redistributing any large number of copies, to give | ||
184 | them a chance to provide you with an updated version of the Document. | ||
185 | |||
186 | @item | ||
187 | MODIFICATIONS | ||
188 | |||
189 | You may copy and distribute a Modified Version of the Document under | ||
190 | the conditions of sections 2 and 3 above, provided that you release | ||
191 | the Modified Version under precisely this License, with the Modified | ||
192 | Version filling the role of the Document, thus licensing distribution | ||
193 | and modification of the Modified Version to whoever possesses a copy | ||
194 | of it. In addition, you must do these things in the Modified Version: | ||
195 | |||
196 | @enumerate A | ||
197 | @item | ||
198 | Use in the Title Page (and on the covers, if any) a title distinct | ||
199 | from that of the Document, and from those of previous versions | ||
200 | (which should, if there were any, be listed in the History section | ||
201 | of the Document). You may use the same title as a previous version | ||
202 | if the original publisher of that version gives permission. | ||
203 | |||
204 | @item | ||
205 | List on the Title Page, as authors, one or more persons or entities | ||
206 | responsible for authorship of the modifications in the Modified | ||
207 | Version, together with at least five of the principal authors of the | ||
208 | Document (all of its principal authors, if it has fewer than five), | ||
209 | unless they release you from this requirement. | ||
210 | |||
211 | @item | ||
212 | State on the Title page the name of the publisher of the | ||
213 | Modified Version, as the publisher. | ||
214 | |||
215 | @item | ||
216 | Preserve all the copyright notices of the Document. | ||
217 | |||
218 | @item | ||
219 | Add an appropriate copyright notice for your modifications | ||
220 | adjacent to the other copyright notices. | ||
221 | |||
222 | @item | ||
223 | Include, immediately after the copyright notices, a license notice | ||
224 | giving the public permission to use the Modified Version under the | ||
225 | terms of this License, in the form shown in the Addendum below. | ||
226 | |||
227 | @item | ||
228 | Preserve in that license notice the full lists of Invariant Sections | ||
229 | and required Cover Texts given in the Document's license notice. | ||
230 | |||
231 | @item | ||
232 | Include an unaltered copy of this License. | ||
233 | |||
234 | @item | ||
235 | Preserve the section Entitled ``History'', Preserve its Title, and add | ||
236 | to it an item stating at least the title, year, new authors, and | ||
237 | publisher of the Modified Version as given on the Title Page. If | ||
238 | there is no section Entitled ``History'' in the Document, create one | ||
239 | stating the title, year, authors, and publisher of the Document as | ||
240 | given on its Title Page, then add an item describing the Modified | ||
241 | Version as stated in the previous sentence. | ||
242 | |||
243 | @item | ||
244 | Preserve the network location, if any, given in the Document for | ||
245 | public access to a Transparent copy of the Document, and likewise | ||
246 | the network locations given in the Document for previous versions | ||
247 | it was based on. These may be placed in the ``History'' section. | ||
248 | You may omit a network location for a work that was published at | ||
249 | least four years before the Document itself, or if the original | ||
250 | publisher of the version it refers to gives permission. | ||
251 | |||
252 | @item | ||
253 | For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve | ||
254 | the Title of the section, and preserve in the section all the | ||
255 | substance and tone of each of the contributor acknowledgements and/or | ||
256 | dedications given therein. | ||
257 | |||
258 | @item | ||
259 | Preserve all the Invariant Sections of the Document, | ||
260 | unaltered in their text and in their titles. Section numbers | ||
261 | or the equivalent are not considered part of the section titles. | ||
262 | |||
263 | @item | ||
264 | Delete any section Entitled ``Endorsements''. Such a section | ||
265 | may not be included in the Modified Version. | ||
266 | |||
267 | @item | ||
268 | Do not retitle any existing section to be Entitled ``Endorsements'' or | ||
269 | to conflict in title with any Invariant Section. | ||
270 | |||
271 | @item | ||
272 | Preserve any Warranty Disclaimers. | ||
273 | @end enumerate | ||
274 | |||
275 | If the Modified Version includes new front-matter sections or | ||
276 | appendices that qualify as Secondary Sections and contain no material | ||
277 | copied from the Document, you may at your option designate some or all | ||
278 | of these sections as invariant. To do this, add their titles to the | ||
279 | list of Invariant Sections in the Modified Version's license notice. | ||
280 | These titles must be distinct from any other section titles. | ||
281 | |||
282 | You may add a section Entitled ``Endorsements'', provided it contains | ||
283 | nothing but endorsements of your Modified Version by various | ||
284 | parties---for example, statements of peer review or that the text has | ||
285 | been approved by an organization as the authoritative definition of a | ||
286 | standard. | ||
287 | |||
288 | You may add a passage of up to five words as a Front-Cover Text, and a | ||
289 | passage of up to 25 words as a Back-Cover Text, to the end of the list | ||
290 | of Cover Texts in the Modified Version. Only one passage of | ||
291 | Front-Cover Text and one of Back-Cover Text may be added by (or | ||
292 | through arrangements made by) any one entity. If the Document already | ||
293 | includes a cover text for the same cover, previously added by you or | ||
294 | by arrangement made by the same entity you are acting on behalf of, | ||
295 | you may not add another; but you may replace the old one, on explicit | ||
296 | permission from the previous publisher that added the old one. | ||
297 | |||
298 | The author(s) and publisher(s) of the Document do not by this License | ||
299 | give permission to use their names for publicity for or to assert or | ||
300 | imply endorsement of any Modified Version. | ||
301 | |||
302 | @item | ||
303 | COMBINING DOCUMENTS | ||
304 | |||
305 | You may combine the Document with other documents released under this | ||
306 | License, under the terms defined in section 4 above for modified | ||
307 | versions, provided that you include in the combination all of the | ||
308 | Invariant Sections of all of the original documents, unmodified, and | ||
309 | list them all as Invariant Sections of your combined work in its | ||
310 | license notice, and that you preserve all their Warranty Disclaimers. | ||
311 | |||
312 | The combined work need only contain one copy of this License, and | ||
313 | multiple identical Invariant Sections may be replaced with a single | ||
314 | copy. If there are multiple Invariant Sections with the same name but | ||
315 | different contents, make the title of each such section unique by | ||
316 | adding at the end of it, in parentheses, the name of the original | ||
317 | author or publisher of that section if known, or else a unique number. | ||
318 | Make the same adjustment to the section titles in the list of | ||
319 | Invariant Sections in the license notice of the combined work. | ||
320 | |||
321 | In the combination, you must combine any sections Entitled ``History'' | ||
322 | in the various original documents, forming one section Entitled | ||
323 | ``History''; likewise combine any sections Entitled ``Acknowledgements'', | ||
324 | and any sections Entitled ``Dedications''. You must delete all | ||
325 | sections Entitled ``Endorsements.'' | ||
326 | |||
327 | @item | ||
328 | COLLECTIONS OF DOCUMENTS | ||
329 | |||
330 | You may make a collection consisting of the Document and other documents | ||
331 | released under this License, and replace the individual copies of this | ||
332 | License in the various documents with a single copy that is included in | ||
333 | the collection, provided that you follow the rules of this License for | ||
334 | verbatim copying of each of the documents in all other respects. | ||
335 | |||
336 | You may extract a single document from such a collection, and distribute | ||
337 | it individually under this License, provided you insert a copy of this | ||
338 | License into the extracted document, and follow this License in all | ||
339 | other respects regarding verbatim copying of that document. | ||
340 | |||
341 | @item | ||
342 | AGGREGATION WITH INDEPENDENT WORKS | ||
343 | |||
344 | A compilation of the Document or its derivatives with other separate | ||
345 | and independent documents or works, in or on a volume of a storage or | ||
346 | distribution medium, is called an ``aggregate'' if the copyright | ||
347 | resulting from the compilation is not used to limit the legal rights | ||
348 | of the compilation's users beyond what the individual works permit. | ||
349 | When the Document is included in an aggregate, this License does not | ||
350 | apply to the other works in the aggregate which are not themselves | ||
351 | derivative works of the Document. | ||
352 | |||
353 | If the Cover Text requirement of section 3 is applicable to these | ||
354 | copies of the Document, then if the Document is less than one half of | ||
355 | the entire aggregate, the Document's Cover Texts may be placed on | ||
356 | covers that bracket the Document within the aggregate, or the | ||
357 | electronic equivalent of covers if the Document is in electronic form. | ||
358 | Otherwise they must appear on printed covers that bracket the whole | ||
359 | aggregate. | ||
360 | |||
361 | @item | ||
362 | TRANSLATION | ||
363 | |||
364 | Translation is considered a kind of modification, so you may | ||
365 | distribute translations of the Document under the terms of section 4. | ||
366 | Replacing Invariant Sections with translations requires special | ||
367 | permission from their copyright holders, but you may include | ||
368 | translations of some or all Invariant Sections in addition to the | ||
369 | original versions of these Invariant Sections. You may include a | ||
370 | translation of this License, and all the license notices in the | ||
371 | Document, and any Warranty Disclaimers, provided that you also include | ||
372 | the original English version of this License and the original versions | ||
373 | of those notices and disclaimers. In case of a disagreement between | ||
374 | the translation and the original version of this License or a notice | ||
375 | or disclaimer, the original version will prevail. | ||
376 | |||
377 | If a section in the Document is Entitled ``Acknowledgements'', | ||
378 | ``Dedications'', or ``History'', the requirement (section 4) to Preserve | ||
379 | its Title (section 1) will typically require changing the actual | ||
380 | title. | ||
381 | |||
382 | @item | ||
383 | TERMINATION | ||
384 | |||
385 | You may not copy, modify, sublicense, or distribute the Document | ||
386 | except as expressly provided under this License. Any attempt | ||
387 | otherwise to copy, modify, sublicense, or distribute it is void, and | ||
388 | will automatically terminate your rights under this License. | ||
389 | |||
390 | However, if you cease all violation of this License, then your license | ||
391 | from a particular copyright holder is reinstated (a) provisionally, | ||
392 | unless and until the copyright holder explicitly and finally | ||
393 | terminates your license, and (b) permanently, if the copyright holder | ||
394 | fails to notify you of the violation by some reasonable means prior to | ||
395 | 60 days after the cessation. | ||
396 | |||
397 | Moreover, your license from a particular copyright holder is | ||
398 | reinstated permanently if the copyright holder notifies you of the | ||
399 | violation by some reasonable means, this is the first time you have | ||
400 | received notice of violation of this License (for any work) from that | ||
401 | copyright holder, and you cure the violation prior to 30 days after | ||
402 | your receipt of the notice. | ||
403 | |||
404 | Termination of your rights under this section does not terminate the | ||
405 | licenses of parties who have received copies or rights from you under | ||
406 | this License. If your rights have been terminated and not permanently | ||
407 | reinstated, receipt of a copy of some or all of the same material does | ||
408 | not give you any rights to use it. | ||
409 | |||
410 | @item | ||
411 | FUTURE REVISIONS OF THIS LICENSE | ||
412 | |||
413 | The Free Software Foundation may publish new, revised versions | ||
414 | of the GNU Free Documentation License from time to time. Such new | ||
415 | versions will be similar in spirit to the present version, but may | ||
416 | differ in detail to address new problems or concerns. See | ||
417 | @uref{http://www.gnu.org/copyleft/}. | ||
418 | |||
419 | Each version of the License is given a distinguishing version number. | ||
420 | If the Document specifies that a particular numbered version of this | ||
421 | License ``or any later version'' applies to it, you have the option of | ||
422 | following the terms and conditions either of that specified version or | ||
423 | of any later version that has been published (not as a draft) by the | ||
424 | Free Software Foundation. If the Document does not specify a version | ||
425 | number of this License, you may choose any version ever published (not | ||
426 | as a draft) by the Free Software Foundation. If the Document | ||
427 | specifies that a proxy can decide which future versions of this | ||
428 | License can be used, that proxy's public statement of acceptance of a | ||
429 | version permanently authorizes you to choose that version for the | ||
430 | Document. | ||
431 | |||
432 | @item | ||
433 | RELICENSING | ||
434 | |||
435 | ``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any | ||
436 | World Wide Web server that publishes copyrightable works and also | ||
437 | provides prominent facilities for anybody to edit those works. A | ||
438 | public wiki that anybody can edit is an example of such a server. A | ||
439 | ``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the | ||
440 | site means any set of copyrightable works thus published on the MMC | ||
441 | site. | ||
442 | |||
443 | ``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 | ||
444 | license published by Creative Commons Corporation, a not-for-profit | ||
445 | corporation with a principal place of business in San Francisco, | ||
446 | California, as well as future copyleft versions of that license | ||
447 | published by that same organization. | ||
448 | |||
449 | ``Incorporate'' means to publish or republish a Document, in whole or | ||
450 | in part, as part of another Document. | ||
451 | |||
452 | An MMC is ``eligible for relicensing'' if it is licensed under this | ||
453 | License, and if all works that were first published under this License | ||
454 | somewhere other than this MMC, and subsequently incorporated in whole | ||
455 | or in part into the MMC, (1) had no cover texts or invariant sections, | ||
456 | and (2) were thus incorporated prior to November 1, 2008. | ||
457 | |||
458 | The operator of an MMC Site may republish an MMC contained in the site | ||
459 | under CC-BY-SA on the same site at any time before August 1, 2009, | ||
460 | provided the MMC is eligible for relicensing. | ||
461 | |||
462 | @end enumerate | ||
463 | |||
464 | @page | ||
465 | @heading ADDENDUM: How to use this License for your documents | ||
466 | |||
467 | To use this License in a document you have written, include a copy of | ||
468 | the License in the document and put the following copyright and | ||
469 | license notices just after the title page: | ||
470 | |||
471 | @smallexample | ||
472 | @group | ||
473 | Copyright (C) @var{year} @var{your name}. | ||
474 | Permission is granted to copy, distribute and/or modify this document | ||
475 | under the terms of the GNU Free Documentation License, Version 1.3 | ||
476 | or any later version published by the Free Software Foundation; | ||
477 | with no Invariant Sections, no Front-Cover Texts, and no Back-Cover | ||
478 | Texts. A copy of the license is included in the section entitled ``GNU | ||
479 | Free Documentation License''. | ||
480 | @end group | ||
481 | @end smallexample | ||
482 | |||
483 | If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, | ||
484 | replace the ``with@dots{}Texts.'' line with this: | ||
485 | |||
486 | @smallexample | ||
487 | @group | ||
488 | with the Invariant Sections being @var{list their titles}, with | ||
489 | the Front-Cover Texts being @var{list}, and with the Back-Cover Texts | ||
490 | being @var{list}. | ||
491 | @end group | ||
492 | @end smallexample | ||
493 | |||
494 | If you have Invariant Sections without Cover Texts, or some other | ||
495 | combination of the three, merge those two alternatives to suit the | ||
496 | situation. | ||
497 | |||
498 | If your document contains nontrivial examples of program code, we | ||
499 | recommend releasing these examples in parallel under your choice of | ||
500 | free software license, such as the GNU General Public License, | ||
501 | to permit their use in free software. | ||
502 | |||
503 | @c Local Variables: | ||
504 | @c ispell-local-pdict: "ispell-dict" | ||
505 | @c End: | ||
506 | |||
diff --git a/doc/syntax.texi b/doc/syntax.texi deleted file mode 100644 index 8aca39d8d..000000000 --- a/doc/syntax.texi +++ /dev/null | |||
@@ -1,44 +0,0 @@ | |||
1 | @c Syntax highlighting for texinfo's HTML output | ||
2 | |||
3 | @html | ||
4 | <script src="highlight.pack.js"></script> | ||
5 | <script> | ||
6 | var hls = []; | ||
7 | var syntaxAuto = true; | ||
8 | addEventListener("DOMContentLoaded", function() { | ||
9 | // Highlight blocks with fixed language | ||
10 | for (let x of hls) { | ||
11 | let next = x[0].nextElementSibling; | ||
12 | console.log("next", next); | ||
13 | let blocks = next.querySelectorAll("pre.example"); | ||
14 | for (let i = 0; i < blocks.length; i++) { | ||
15 | blocks[i].classList.add("language-" + x[1]); | ||
16 | hljs.highlightBlock(blocks[i]); | ||
17 | } | ||
18 | } | ||
19 | // auto-detect other blocks if not disabled | ||
20 | if (syntaxAuto) { | ||
21 | let blocks = document.querySelectorAll("pre.example"); | ||
22 | for (let i = 0; i < blocks.length; i++) { | ||
23 | hljs.highlightBlock(blocks[i]); | ||
24 | } | ||
25 | } | ||
26 | }); | ||
27 | </script> | ||
28 | @end html | ||
29 | |||
30 | @macro setsyntax{lang} | ||
31 | @html | ||
32 | <script> | ||
33 | hls.push([document.currentScript, "\lang\"]); | ||
34 | </script> | ||
35 | @end html | ||
36 | @end macro | ||
37 | |||
38 | @macro setsyntaxnoauto{} | ||
39 | @html | ||
40 | <script> | ||
41 | syntaxAuto = false; | ||
42 | </script> | ||
43 | @end html | ||
44 | @end macro | ||
diff --git a/doc/taler-config.texi b/doc/taler-config.texi deleted file mode 100644 index efca5a2d7..000000000 --- a/doc/taler-config.texi +++ /dev/null | |||
@@ -1,47 +0,0 @@ | |||
1 | @c This file is used both in the exchange and merchant | ||
2 | @c manuals. Edits should be propagated to both Gits! | ||
3 | |||
4 | @node Using taler-config | ||
5 | @section Using taler-config | ||
6 | @cindex taler-config | ||
7 | |||
8 | The tool @code{taler-config} can be used to | ||
9 | extract or manipulate configuration values; however, the configuration | ||
10 | use the well-known INI file format and can also be edited by hand. | ||
11 | |||
12 | Run | ||
13 | @example | ||
14 | $ taler-config -s $SECTION | ||
15 | @end example | ||
16 | to list all of the configuration values in section @code{$SECTION}. | ||
17 | |||
18 | Run | ||
19 | @example | ||
20 | $ taler-config -s $section -o $option | ||
21 | @end example | ||
22 | to extract the respective configuration value for option @code{$option} | ||
23 | in section @code{$section}. | ||
24 | |||
25 | Finally, to change a setting, run | ||
26 | @example | ||
27 | $ taler-config -s $section -o $option -V $value | ||
28 | @end example | ||
29 | to set the respective configuration value to @code{$value}. Note that you have to | ||
30 | manually restart the Taler backend after you change the configuration to | ||
31 | make the new configuration go into effect. | ||
32 | |||
33 | Some default options will use $-variables, such as @code{$DATADIR} | ||
34 | within their value. To expand the @code{$DATADIR} or other $-variables | ||
35 | in the configuration, pass the @code{-f} option to | ||
36 | @code{taler-config}. For example, compare: | ||
37 | @example | ||
38 | $ taler-config -s ACCOUNT-bank \ | ||
39 | -o WIRE_RESPONSE | ||
40 | $ taler-config -f -s ACCOUNT-bank \ | ||
41 | -o WIRE_RESPONSE | ||
42 | @end example | ||
43 | |||
44 | While the configuration file is typically located at | ||
45 | @code{$HOME/.config/taler.conf}, an alternative location can be | ||
46 | specified to @code{taler-merchant-httpd} and @code{taler-config} using | ||
47 | the @code{-c} option. | ||
diff --git a/doc/taler-exchange.texi b/doc/taler-exchange.texi deleted file mode 100644 index 209e2dd5b..000000000 --- a/doc/taler-exchange.texi +++ /dev/null | |||
@@ -1,972 +0,0 @@ | |||
1 | \input texinfo @c -*-texinfo-*- | ||
2 | @setfilename taler-exchange.info | ||
3 | @documentencoding UTF-8 | ||
4 | @include version.texi | ||
5 | @settitle The GNU Taler Exchange Operator Manual | ||
6 | @paragraphindent 0 | ||
7 | @exampleindent 4 | ||
8 | |||
9 | @include syntax.texi | ||
10 | |||
11 | @copying | ||
12 | This manual is for the GNU Taler Exchange | ||
13 | (version @value{VERSION}, @value{UPDATED}), | ||
14 | a payment service provider for GNU Taler. | ||
15 | |||
16 | Copyright @copyright{} 2014-2018 Taler Systems SA | ||
17 | |||
18 | @quotation | ||
19 | Permission is granted to copy, distribute and/or modify this document | ||
20 | under the terms of the GNU Free Documentation License, Version 1.3 | ||
21 | or any later version published by the Free Software Foundation; | ||
22 | with no Invariant Sections, no Front-Cover Texts, and no Back-Cover | ||
23 | Texts. A copy of the license is included in the section entitled "GNU | ||
24 | Free Documentation License". | ||
25 | @end quotation | ||
26 | @end copying | ||
27 | |||
28 | @dircategory Network applications | ||
29 | @direntry | ||
30 | * GNU Taler Exchange: (taler-exchange). Electronic payment system. | ||
31 | @end direntry | ||
32 | |||
33 | |||
34 | @titlepage | ||
35 | @title The GNU Taler Exchange Operator Manual | ||
36 | @subtitle Version @value{VERSION} | ||
37 | @subtitle @value{UPDATED} | ||
38 | @author Christian Grothoff (@email{grothoff@@taler.net}) | ||
39 | @author Marcello Stanisci (@email{stanisci@@taler.net}) | ||
40 | @page | ||
41 | @vskip 0pt plus 1filll | ||
42 | @insertcopying | ||
43 | @end titlepage | ||
44 | |||
45 | @summarycontents | ||
46 | @contents | ||
47 | |||
48 | @ifnottex | ||
49 | @node Top | ||
50 | @top The GNU Taler Exchange Operator Manual | ||
51 | @insertcopying | ||
52 | @end ifnottex | ||
53 | |||
54 | |||
55 | @menu | ||
56 | * Introduction:: | ||
57 | * Installation:: | ||
58 | * Configuration:: | ||
59 | * Deployment:: | ||
60 | * Diagnostics:: | ||
61 | |||
62 | |||
63 | |||
64 | Appendices | ||
65 | |||
66 | * GNU-AGPL:: The GNU Affero General Public License says how you | ||
67 | can copy and share the code of the `GNU Taler Exchange'. | ||
68 | * GNU-FDL:: The GNU Free Documentation License says how you | ||
69 | can copy and share the documentation of `GNU Taler'. | ||
70 | |||
71 | Indices | ||
72 | |||
73 | * Concept Index:: Index of concepts and programs. | ||
74 | @end menu | ||
75 | |||
76 | @node Introduction | ||
77 | @chapter Introduction | ||
78 | |||
79 | This manual is an early draft that still needs significant editing | ||
80 | work to become readable. | ||
81 | |||
82 | |||
83 | @section About GNU Taler | ||
84 | |||
85 | GNU Taler is an open protocol for an electronic payment system with a | ||
86 | free software reference implementation. GNU Taler offers secure, fast | ||
87 | and easy payment processing using well understood cryptographic | ||
88 | techniques. GNU Taler allows customers to remain anonymous, while | ||
89 | ensuring that merchants can be held accountable by governments. | ||
90 | Hence, GNU Taler is compatible with anti-money-laundering (AML) and | ||
91 | know-your-customer (KYC) regulation, as well as data protection | ||
92 | regulation (such as GDPR). | ||
93 | |||
94 | GNU Taler is not yet production-ready, after following this manual | ||
95 | you will have a backend that can process payments in ``KUDOS'', but | ||
96 | not regular currencies. This is not so much because of limitations | ||
97 | in the backend, but because we are not aware of a Taler exchange | ||
98 | operator offering regular currencies today. | ||
99 | |||
100 | @section About this manual | ||
101 | |||
102 | This tutorial targets system administrators who want to install and | ||
103 | operate a GNU Taler exchange. | ||
104 | |||
105 | @section Organizational prerequisites | ||
106 | |||
107 | Operating a GNU Taler exchange means that you are operating a payment | ||
108 | service provider, which means that you will most likely need a bank | ||
109 | license and/or follow applicable financial regulation. | ||
110 | |||
111 | @cindex availability | ||
112 | @cindex backup | ||
113 | @cindex replication | ||
114 | GNU Taler payment service providers generally need to ensure high | ||
115 | availability and have @emph{really} good backups (synchronous | ||
116 | replication, asynchronous remote replication, off-site backup, 24/7 | ||
117 | monitoring, etc.).@footnote{Naturally, you could operate a Taler | ||
118 | exchange for a toy currency without any real value on low-cost setups | ||
119 | like a Raspberry Pi, but we urge you to limit the use of such setups | ||
120 | to research and education as with GNU Taler data loss instantly | ||
121 | results in financial losses.} This manual will not cover these | ||
122 | aspects of operating a payment service provider. | ||
123 | |||
124 | @cindex HSM | ||
125 | @cindex offline | ||
126 | @cindex database | ||
127 | @cindex operational security | ||
128 | We will assume that you can operate a (high-availability, | ||
129 | high-assurance) Postgres database. Furthermore, we expect some | ||
130 | moderate familiarity with the compilation and installation of free | ||
131 | software packages. You need to understand the cryptographic concepts | ||
132 | of private and public keys and must be able to protect private keys | ||
133 | stored in files on disk. An exchange uses an @emph{offline} master | ||
134 | key as well as @emph{online} keys. You are advised to secure your | ||
135 | private master key and any copies on encrypted, always-offline | ||
136 | computers. Again, we assume that you are familiar with good best | ||
137 | practices in operational security, including securing key | ||
138 | material.@footnote{The current implementation does not make provisions | ||
139 | for secret splitting. Still, the use of a hardware security module | ||
140 | (HSM) for protecting private keys is adviseable, so please contact the | ||
141 | developers for HSM integration support.} | ||
142 | |||
143 | |||
144 | @section Architecture overview | ||
145 | |||
146 | @cindex crypto-currency | ||
147 | @cindex bank | ||
148 | @cindex escrow | ||
149 | @cindex coin | ||
150 | Taler is a pure payment system, not a new crypto-currency. As such, it | ||
151 | operates in a traditional banking context. In particular, this means | ||
152 | that in order to receive funds via Taler, the merchant must have a | ||
153 | regular bank account, and payments can be executed in ordinary | ||
154 | currencies such as USD or EUR. Similarly, the Taler exchange must | ||
155 | interact with a bank. The bank of the exchange holds the exchange's | ||
156 | funds in an escrow account. | ||
157 | |||
158 | @cindex reserve | ||
159 | @cindex fee | ||
160 | @cindex aggregator | ||
161 | @cindex deposit | ||
162 | When customers wire money to the escrow account, the bank notifies | ||
163 | the exchange about the incoming wire transfers. The exchange then | ||
164 | creates a @emph{reserve} based on the subject of the wire transfer. | ||
165 | The wallet which knows the secret key matching the wire transfer | ||
166 | subject can then withdraw coins from the reserve, thereby draining | ||
167 | it. The liability of the exchange against the reserve is thereby | ||
168 | converted into a liability against digital coins issued by the | ||
169 | exchange. When the customer later spends the coins at a merchant, | ||
170 | and the merchant @emph{deposits} the coins at the exchange, the | ||
171 | exchange first @emph{aggregates} the amount from multiple deposits | ||
172 | from the same merchant and then instructs its bank to make a | ||
173 | wire transfer to the merchant, thereby fulfilling its obligation | ||
174 | and eliminating the liability. The exchange charges @emph{fees} | ||
175 | for some or all of its operations to cover costs and possibly make | ||
176 | a profit. | ||
177 | |||
178 | @cindex auditor | ||
179 | @cindex accounting | ||
180 | @emph{Auditors} are third parties, for example financial regulators, | ||
181 | that verify that the exchange operates correctly. The same software | ||
182 | is also used to calculate the exchange's profits, risk and liabilities | ||
183 | by the accountants of the exchange. | ||
184 | |||
185 | The Taler software stack for an exchange consists of the | ||
186 | following components: | ||
187 | |||
188 | @itemize | ||
189 | @cindex HTTP frontend | ||
190 | @item The HTTP frontend interacts with Taler wallets and | ||
191 | merchant backends. It is used to withdraw coins, deposit | ||
192 | coins, refresh coins, issue refunds, map wire transfers to | ||
193 | Taler transactions, inquire about the exchange's bank account | ||
194 | details, signing keys and fee structure. | ||
195 | The binary is the @code{taler-exchange-httpd}. | ||
196 | @cindex Aggregator | ||
197 | @item The aggregator combines multiple deposits made by | ||
198 | the same merchant and (eventually) triggers wire transfers for the | ||
199 | aggregate amount. The merchant can control how quickly wire | ||
200 | transfers are made. The exchange may be charge a fee per wire transfer | ||
201 | to discourage excessively frequent transfers. The binary | ||
202 | is the @code{taler-exchange-aggregator}. | ||
203 | @cindex Auditor | ||
204 | @item The auditor verifies that the transactions performed by | ||
205 | the exchange were done properly. It checks the various signatures, | ||
206 | totals up the amounts and alerts the operator to any inconsistencies. | ||
207 | It also computes the expected bank balance, revenue and risk exposure | ||
208 | of the exchange operator. The main binary is the | ||
209 | @code{taler-auditor}. | ||
210 | @cindex Wire plugin | ||
211 | @item A wire plugin enables the HTTP frontend to talk to the | ||
212 | bank. Its role is to allow the exchange to validate bank | ||
213 | addresses (i.e. IBAN numbers), for the aggregator to execute | ||
214 | wire transfers and for the auditor to query bank transaction | ||
215 | histories. Wire plugins are @emph{plugins} as there can be | ||
216 | many different implementations to deal with different | ||
217 | banking standards. Wire plugins are automatically located | ||
218 | and used by the exchange, aggregator and auditor. | ||
219 | @cindex DBMS | ||
220 | @cindex Postgres | ||
221 | @item The exchange requires a DBMS to stores the transaction history for | ||
222 | the Taler exchange and aggregator, and a (typically separate) DBMS for | ||
223 | the Taler auditor. | ||
224 | For now, the GNU Taler reference implemenation only supports Postgres, | ||
225 | but the code could be easily extended to support another DBMS. | ||
226 | @end itemize | ||
227 | |||
228 | @c The following image illustrates the various interactions of these | ||
229 | @c key components: | ||
230 | |||
231 | @c @center @image{arch, 3in, 4in} | ||
232 | |||
233 | |||
234 | @node Installation | ||
235 | @chapter Installation | ||
236 | |||
237 | Please install the following packages before proceeding with the exchange compilation. | ||
238 | |||
239 | @itemize | ||
240 | |||
241 | @item | ||
242 | GNU autoconf >= 2.69 | ||
243 | |||
244 | @item | ||
245 | GNU automake >= 1.14 | ||
246 | |||
247 | @item | ||
248 | GNU libtool >= 2.4 | ||
249 | |||
250 | @item | ||
251 | GNU autopoint >= 0.19 | ||
252 | |||
253 | @item | ||
254 | GNU libltdl >= 2.4 | ||
255 | |||
256 | @item | ||
257 | GNU libunistring >= 0.9.3 | ||
258 | |||
259 | @item | ||
260 | libcurl >= 7.26 (or libgnurl >= 7.26) | ||
261 | |||
262 | @item | ||
263 | GNU libmicrohttpd >= 0.9.59 | ||
264 | |||
265 | @item | ||
266 | GNU libgcrypt >= 1.6 | ||
267 | |||
268 | @item | ||
269 | libjansson >= 2.7 | ||
270 | |||
271 | @item | ||
272 | Postgres >= 9.6, including libpq | ||
273 | |||
274 | @item | ||
275 | libgnunetutil (from Git) | ||
276 | |||
277 | @item | ||
278 | GNU Taler exchange (from Git) | ||
279 | @end itemize | ||
280 | |||
281 | Except for the last two, these are available in most GNU/Linux | ||
282 | distributions and should just be installed using the respective | ||
283 | package manager. | ||
284 | |||
285 | The following instructions will show how to install libgnunetutil and | ||
286 | the GNU Taler exchange. | ||
287 | |||
288 | Before you install libgnunetutil, you must download and install the | ||
289 | dependencies mentioned above, otherwise the build may succeed but fail | ||
290 | to export some of the tooling required by Taler. | ||
291 | |||
292 | To download and install libgnunetutil, proceed as follows: | ||
293 | |||
294 | @example | ||
295 | $ git clone https://git.gnunet.org/gnunet/ | ||
296 | $ cd gnunet/ | ||
297 | $ ./bootstrap | ||
298 | $ ./configure [--prefix=GNUNETPFX] | ||
299 | $ # Each dependency can be fetched from non standard locations via | ||
300 | $ # the '--with-<LIBNAME>' option. See './configure --help'. | ||
301 | $ make | ||
302 | # make install | ||
303 | @end example | ||
304 | |||
305 | If you did not specify a prefix, GNUnet will install to | ||
306 | @code{/usr/local}, which requires you to run the last step as | ||
307 | @code{root}. | ||
308 | |||
309 | To download and install the GNU Taler exchange, proceeds as follows: | ||
310 | |||
311 | @setsyntax shell | ||
312 | @example | ||
313 | $ git clone git://git.taler.net/exchange | ||
314 | $ cd exchange | ||
315 | $ ./bootstrap | ||
316 | $ ./configure [--prefix=EXCHANGEPFX] \ | ||
317 | [--with-gnunet=GNUNETPFX] | ||
318 | $ # Each dependency can be fetched from non standard locations via | ||
319 | $ # the '--with-<LIBNAME>' option. See './configure --help'. | ||
320 | $ make | ||
321 | # make install | ||
322 | @end example | ||
323 | |||
324 | If you did not specify a prefix, the exchange will install to | ||
325 | @code{/usr/local}, which requires you to run the last step as | ||
326 | @code{root}. Note that you have to specify @code{--with-gnunet=/usr/local} | ||
327 | if you installed GNUnet to @code{/usr/local} in the previous step. | ||
328 | |||
329 | |||
330 | |||
331 | |||
332 | @node Configuration | ||
333 | @chapter Configuration | ||
334 | |||
335 | @c In this document, we assume that @code{$HOME/.config/taler.conf} is being customized. | ||
336 | |||
337 | This chapter provides an overview of the exchange configuration. Or | ||
338 | at least eventually will do so, for now it is a somewhat wild | ||
339 | description of some of the options. | ||
340 | |||
341 | @menu | ||
342 | * Configuration format:: | ||
343 | * Using taler-config:: | ||
344 | * Keying:: | ||
345 | * Serving:: | ||
346 | * Currency:: | ||
347 | * Bank account:: | ||
348 | * Database:: | ||
349 | * Coins (denomination keys): Coins denomination keys. | ||
350 | * Keys duration:: | ||
351 | |||
352 | @end menu | ||
353 | |||
354 | @include configuration-format.texi | ||
355 | @include taler-config.texi | ||
356 | |||
357 | |||
358 | |||
359 | |||
360 | @node Keying | ||
361 | @section Keying | ||
362 | |||
363 | The exchange works with three types of keys: | ||
364 | |||
365 | @c FIXME: explain better! | ||
366 | |||
367 | @itemize | ||
368 | |||
369 | @item | ||
370 | @cite{master key} | ||
371 | |||
372 | @item | ||
373 | @cite{sign keys} | ||
374 | |||
375 | @item | ||
376 | @cite{denomination keys} (see section @cite{Coins}) | ||
377 | @end itemize | ||
378 | |||
379 | @c FIXME: text here. | ||
380 | |||
381 | @itemize | ||
382 | @item | ||
383 | @cite{MASTER_PRIV_FILE}: Path to the exchange's master private file. | ||
384 | |||
385 | @item | ||
386 | @cite{MASTER_PUBLIC_KEY}: Must specify the exchange's master public key. | ||
387 | @end itemize | ||
388 | |||
389 | |||
390 | |||
391 | |||
392 | |||
393 | @node Serving | ||
394 | @section Serving | ||
395 | |||
396 | |||
397 | The exchange can serve HTTP over both TCP and UNIX domain socket. | ||
398 | |||
399 | The following values are to be configured in the section | ||
400 | @cite{[exchange]}: | ||
401 | |||
402 | |||
403 | @itemize | ||
404 | |||
405 | @item | ||
406 | @cite{serve}: must be set to @cite{tcp} to serve HTTP over TCP, or | ||
407 | @cite{unix} to serve HTTP over a UNIX domain socket | ||
408 | |||
409 | @item | ||
410 | @cite{port}: Set to the TCP port to listen on if @cite{serve} Is | ||
411 | @cite{tcp}. | ||
412 | |||
413 | @item | ||
414 | @cite{unixpath}: set to the UNIX domain socket path to listen on if | ||
415 | @cite{serve} Is @cite{unix} | ||
416 | |||
417 | @item | ||
418 | @cite{unixpath_mode}: number giving the mode with the access | ||
419 | permission MASK for the @cite{unixpath} (i.e. 660 = rw-rw----). | ||
420 | @end itemize | ||
421 | |||
422 | |||
423 | @node Currency | ||
424 | @section Currency | ||
425 | |||
426 | |||
427 | The exchange supports only one currency. This data is set under the respective | ||
428 | option @cite{currency} in section @cite{[taler]}. | ||
429 | |||
430 | @node Bank account | ||
431 | @section Bank account | ||
432 | |||
433 | To configure a bank account in Taler, we need to furnish four | ||
434 | pieces of information: | ||
435 | @itemize | ||
436 | @item | ||
437 | The @code{payto://} URL of the bank account, which uniquely idenfies | ||
438 | the account. Examples for such URLs include | ||
439 | @code{payto://sepa/CH9300762011623852957} for a bank account | ||
440 | in the single European payment area (SEPA) or | ||
441 | @code{payto://x-taler-bank/localhost:8080/2} for the 2nd bank | ||
442 | account a the Taler bank demonstrator running at @code{localhost} | ||
443 | on port 8080. The first part of the URL following @code{payto://} | ||
444 | (``sepa'' or ``x-taler-bank'') is called the wire method. | ||
445 | @item | ||
446 | A matching wire plugin that implements a protocol to interact | ||
447 | with the banking system. For example, the EBICS plugin can | ||
448 | be used for SEPA transfers, or the ``taler-bank'' plugin can | ||
449 | interact with the Taler bank demonstrator. A wire plugin | ||
450 | only supports one particular wire method. Thus, you must make | ||
451 | sure to pick a plugin that supports the wire method used in the | ||
452 | URL. | ||
453 | @item | ||
454 | A file containing the signed JSON-encoded bank account details | ||
455 | for the /wire API. This is necessary as Taler supports offline | ||
456 | signing for bank accounts for additional security. | ||
457 | @item | ||
458 | Finally, the plugin needs to be provided resources for | ||
459 | authentication to the respective banking service. The format | ||
460 | in which the authentication information must be provided | ||
461 | depends on the wire plugin. | ||
462 | @end itemize | ||
463 | |||
464 | You can configure multiple accounts for an exchange by creating | ||
465 | sections starting with ``account-'' for the section name. You can | ||
466 | ENABLE for each account whether it should be used, and for what | ||
467 | (incoming or outgoing wire transfers): | ||
468 | |||
469 | @setsyntax ini | ||
470 | @example | ||
471 | |||
472 | [account-1] | ||
473 | URL = "payto://sepa/CH9300762011623852957" | ||
474 | WIRE_RESPONSE = $@{TALER_CONFIG_HOME@}/account-1.json | ||
475 | |||
476 | # Currently, only the 'taler_bank' plugin is implemented. | ||
477 | PLUGIN = <plugin_name_here> | ||
478 | |||
479 | # Use for exchange-aggregator (outgoing transfers) | ||
480 | ENABLE_DEBIT = YES | ||
481 | # Use for exchange-wirewatch (and listed in /wire) | ||
482 | ENABLE_CREDIT = YES | ||
483 | |||
484 | # Authentication options for the chosen plugin go here. | ||
485 | # (Next sections have examples of authentication mechanisms) | ||
486 | @end example | ||
487 | |||
488 | The command line tool @cite{taler-exchange-wire} is used to create | ||
489 | the @code{account-1.json} file. | ||
490 | For example, the utility may be invoked as follows to create | ||
491 | all of the WIRE_RESPONSE files (in the locations specified by the configuration): | ||
492 | |||
493 | @example | ||
494 | $ taler-exchange-wire | ||
495 | @end example | ||
496 | |||
497 | The generated file will be echoed by the exchange when serving | ||
498 | /wire@footnote{https://api.taler.net/api-exchange.html#wire-req} | ||
499 | requests. | ||
500 | |||
501 | |||
502 | @menu | ||
503 | * Wire plugin ``taler_bank'':: | ||
504 | * Wire plugin ``ebics'':: | ||
505 | * Wire fee structure:: | ||
506 | @end menu | ||
507 | |||
508 | @node Wire plugin ``taler_bank'' | ||
509 | @subsection Wire plugin ``taler_bank'' | ||
510 | @cindex x-taler-bank | ||
511 | @cindex taler_bank plugin | ||
512 | |||
513 | The @code{taler_bank} plugin implements the wire method ``x-taler-bank''. | ||
514 | |||
515 | The format of the @code{payto://} URL is @code{payto://x-taler-bank/HOSTNAME[:PORT]}. | ||
516 | |||
517 | For basic authentication, the @code{taler_bank} plugin only supports | ||
518 | simple password-based authentication. For this, the configuration | ||
519 | must contain the ``USERNAME'' and ``PASSWORD'' of the respective | ||
520 | account at the bank. | ||
521 | |||
522 | @setsyntax ini | ||
523 | @example | ||
524 | [account-1] | ||
525 | |||
526 | # Bank account details here.. | ||
527 | # .. | ||
528 | |||
529 | # Authentication options for the taler_bank plugin below: | ||
530 | |||
531 | TALER_BANK_AUTH_METHOD = basic | ||
532 | USERNAME = exchange | ||
533 | PASSWORD = super-secure | ||
534 | @end example | ||
535 | |||
536 | |||
537 | @node Wire plugin ``ebics'' | ||
538 | @subsection Wire plugin ``ebics'' | ||
539 | |||
540 | The ``ebics'' wire plugin is not fully implemented and today | ||
541 | does not support actual wire transfers. | ||
542 | |||
543 | |||
544 | @cartouche | ||
545 | @quotation Note | ||
546 | The rationale behind having multiple bank accounts is that the exchange operator, as a security | ||
547 | measure, may want to instruct the bank that the incoming bank account is only supposed to | ||
548 | @emph{receive} money. | ||
549 | @end quotation | ||
550 | @end cartouche | ||
551 | |||
552 | |||
553 | @node Wire fee structure | ||
554 | @subsection Wire fee structure | ||
555 | @cindex wire fee | ||
556 | @cindex fee | ||
557 | |||
558 | For each wire method (``sepa'' or ``x-taler-wire'', but not per plugin!) the | ||
559 | exchange configuration must specify applicable wire fees. This is done | ||
560 | in configuration sections of the format @code{fees-METHOD}. There are two | ||
561 | types of fees, simple wire fees and closing fees. Wire fees apply whenever | ||
562 | the aggregator transfers funds to a merchant. Closing fees apply whenever | ||
563 | the exchange closes a reserve (sending back funds to the customer). The | ||
564 | fees must be constant for a full year, which is specified as part of the name | ||
565 | of the option. | ||
566 | |||
567 | @setsyntax ini | ||
568 | @example | ||
569 | [fees-iban] | ||
570 | WIRE-FEE-2018 = EUR:0.01 | ||
571 | WIRE-FEE-2019 = EUR:0.01 | ||
572 | CLOSING-FEE-2018 = EUR:0.01 | ||
573 | CLOSING-FEE-2019 = EUR:0.01 | ||
574 | |||
575 | [fees-x-taler-bank] | ||
576 | WIRE-FEE-2018 = KUDOS:0.01 | ||
577 | WIRE-FEE-2019 = KUDOS:0.01 | ||
578 | CLOSING-FEE-2018 = KUDOS:0.01 | ||
579 | CLOSING-FEE-2019 = KUDOS:0.01 | ||
580 | @end example | ||
581 | |||
582 | |||
583 | @node Database | ||
584 | @section Database | ||
585 | |||
586 | |||
587 | The option @cite{db} under section @cite{[exchange]} gets the DB backend's name the exchange | ||
588 | is going to use. So far, only @cite{db = postgres} is supported. After choosing the backend, | ||
589 | it is mandatory to supply the connection string (namely, the database name). This is | ||
590 | possible in two ways: | ||
591 | |||
592 | |||
593 | @itemize | ||
594 | |||
595 | @item | ||
596 | via an environment variable: @cite{TALER_EXCHANGEDB_POSTGRES_CONFIG}. | ||
597 | |||
598 | @item | ||
599 | via configuration option @cite{CONFIG}, under section @cite{[exchangedb-BACKEND]}. For example, the demo exchange is configured as follows: | ||
600 | @end itemize | ||
601 | |||
602 | @setsyntax ini | ||
603 | @example | ||
604 | [exchange] | ||
605 | ... | ||
606 | DB = postgres | ||
607 | ... | ||
608 | |||
609 | [exchangedb-postgres] | ||
610 | CONFIG = postgres:///talerdemo | ||
611 | @end example | ||
612 | |||
613 | @node Coins denomination keys | ||
614 | @section Coins (denomination keys) | ||
615 | |||
616 | |||
617 | Sections specifying denomination (coin) information start with | ||
618 | "coin_". By convention, the name continues with | ||
619 | "$CURRENCY_[$SUBUNIT]_$VALUE", i.e. @cite{[coin_eur_ct_10]} for a 10 | ||
620 | cent piece. However, only the "coin_" prefix is mandatory. Each | ||
621 | "coin_"-section must then have the following options: | ||
622 | |||
623 | |||
624 | @itemize | ||
625 | |||
626 | @item | ||
627 | @cite{value}: How much is the coin worth, the format is | ||
628 | CURRENCY:VALUE.FRACTION. For example, a 10 cent piece is "EUR:0.10". | ||
629 | |||
630 | @item | ||
631 | @cite{duration_withdraw}: How long can a coin of this type be | ||
632 | withdrawn? This limits the losses incurred by the exchange when a | ||
633 | denomination key is compromised. | ||
634 | |||
635 | @item | ||
636 | @cite{duration_overlap}: What is the overlap of the withdrawal | ||
637 | timespan for this coin type? | ||
638 | |||
639 | @item | ||
640 | @cite{duration_spend}: How long is a coin of the given type valid? | ||
641 | Smaller values result in lower storage costs for the exchange. | ||
642 | |||
643 | @item | ||
644 | @cite{fee_withdraw}: What does it cost to withdraw this coin? | ||
645 | Specified using the same format as @cite{value}. | ||
646 | |||
647 | @item | ||
648 | @cite{fee_deposit}: What does it cost to deposit this coin? Specified | ||
649 | using the same format as @cite{value}. | ||
650 | |||
651 | @item | ||
652 | @cite{fee_refresh}: What does it cost to refresh this coin? Specified | ||
653 | using the same format as @cite{value}. | ||
654 | |||
655 | @item | ||
656 | @cite{rsa_keysize}: How many bits should the RSA modulus (product of | ||
657 | the two primes) have for this type of coin. | ||
658 | @end itemize | ||
659 | |||
660 | |||
661 | @node Keys duration | ||
662 | @section Keys duration | ||
663 | |||
664 | |||
665 | Both @cite{signkeys} and @cite{denom keys} have a starting date. The | ||
666 | option @cite{lookahead_provide}, under section @cite{[exchange]}, | ||
667 | is such that only keys whose starting date is younger than | ||
668 | @cite{lookahead_provide} will be issued by the exchange. | ||
669 | |||
670 | @cite{signkeys}. The option @cite{lookahead_sign} is such that, being | ||
671 | @cite{t} the time when @cite{taler-exchange-keyup} is run, | ||
672 | @cite{taler-exchange-keyup} will generate @cite{n} @cite{signkeys}, | ||
673 | where @cite{t + (n * signkey_duration) = t + lookahead_sign}. In other | ||
674 | words, we generate a number of keys which is sufficient to cover a | ||
675 | period of @cite{lookahead_sign}. As for the starting date, the first | ||
676 | generated key will get a starting time of @cite{t}, and the | ||
677 | @cite{j}-th key will get a starting time of @cite{x + | ||
678 | signkey_duration}, where @cite{x} is the starting time of the | ||
679 | @cite{(j-1)}-th key. | ||
680 | |||
681 | @cite{denom keys}. The option @cite{lookahead_sign} is such that, | ||
682 | being @cite{t} the time when @cite{taler-exchange-keyup} is run, | ||
683 | @cite{taler-exchange-keyup} will generate @cite{n} @cite{denom keys} | ||
684 | for each denomination, where @cite{t + (n * duration_withdraw) = t + | ||
685 | lookahead_sign}. In other words, for each denomination, we generate a | ||
686 | number of keys which is sufficient to cover a period of | ||
687 | @cite{lookahead_sign}. As for the starting date, the first generated | ||
688 | key will get a starting time of @cite{t}, and the @cite{j}-th key will | ||
689 | get a starting time of @cite{x + duration_withdraw}, where @cite{x} is | ||
690 | the starting time of the @cite{(j-1)}-th key. | ||
691 | |||
692 | To change these settings, edit the following | ||
693 | values in section @cite{[exchange]}: | ||
694 | |||
695 | @itemize | ||
696 | @item | ||
697 | @cite{SIGNKEY_DURATION}: How long should one signing key be used? | ||
698 | |||
699 | @item | ||
700 | @cite{LOOKAHEAD_SIGN}: How much time we want to cover with our | ||
701 | signing keys? Note that if @cite{SIGNKEY_DURATION} is bigger than | ||
702 | @cite{LOOKAHEAD_SIGN}, @code{taler-exchange-keyup} will generate a | ||
703 | quantity of signing keys which is sufficient to cover all the | ||
704 | gap. | ||
705 | @end itemize | ||
706 | |||
707 | @c FIXME: LEGAL_DURATION not covered! | ||
708 | @c FIXME: LOOKAHEAD_PROVIDE not covered! | ||
709 | |||
710 | |||
711 | @node Deployment | ||
712 | @chapter Deployment | ||
713 | |||
714 | |||
715 | @menu | ||
716 | * Keys generation:: | ||
717 | * Database upgrades:: | ||
718 | @end menu | ||
719 | |||
720 | @node Keys generation | ||
721 | @section Keys generation | ||
722 | |||
723 | Once the configuration is properly set up, all the keys can be generated | ||
724 | by the tool @code{taler-exchange-keyup}. The following command generates denomkeys | ||
725 | and signkeys, plus the "blob" that is to be signed by the auditor. | ||
726 | |||
727 | @example | ||
728 | taler-exchange-keyup -o blob | ||
729 | @end example | ||
730 | |||
731 | @emph{blob} contains data about denomkeys that the exchange operator needs to | ||
732 | get signed by every auditor he wishes (or is forced to) work with. | ||
733 | |||
734 | In a normal scenario, an auditor must have some way of receiving the blob to | ||
735 | sign (Website, manual delivery, ..). Nonetheless, the exchange admin can fake | ||
736 | an auditor signature --- for testing purposes --- by running the following command | ||
737 | |||
738 | @example | ||
739 | taler-auditor-sign -m EXCHANGE_MASTER_PUB -r BLOB -u AUDITOR_URL -o OUTPUT_FILE | ||
740 | @end example | ||
741 | |||
742 | Those arguments are all mandatory. | ||
743 | |||
744 | @itemize | ||
745 | @item @code{EXCHANGE_MASTER_PUB} the base32 Crockford-encoded exchange's master | ||
746 | public key. Tipically, this value lies in the configuration option | ||
747 | @code{[exchange]/master_public_key}. | ||
748 | @item @code{BLOB} the blob generated in the previous step. | ||
749 | @item @code{AUDITOR_URL} the URL that identifies the auditor. | ||
750 | @item @code{OUTPUT_FILE} where on the disk the signed blob is to be saved. | ||
751 | @end itemize | ||
752 | |||
753 | @code{OUTPUT_FILE} must then be copied into the directory specified | ||
754 | by the option @code{AUDITOR_BASE_DIR} under the section @code{[exchangedb]}. | ||
755 | Assuming @code{AUDITOR_BASE_DIR = $@{HOME@}/.local/share/taler/auditors}, the | ||
756 | following command will "add" the auditor identified by @code{AUDITOR_URL} to | ||
757 | the exchange. | ||
758 | |||
759 | @example | ||
760 | cp OUTPUT_FILE $@{HOME@}/.local/share/taler/auditors | ||
761 | @end example | ||
762 | |||
763 | If the auditor has been correctly added, the exchange's @code{/keys} response | ||
764 | must contain an entry in the @code{auditors} array mentioning the auditor's URL. | ||
765 | |||
766 | |||
767 | @c FIXME: reference section about where keys are stored. | ||
768 | |||
769 | @node Database upgrades | ||
770 | @section Database upgrades | ||
771 | |||
772 | Currently, there is no way to upgrade the database between Taler versions. | ||
773 | |||
774 | The exchange database can be re-initialized using: | ||
775 | |||
776 | @example | ||
777 | $ taler-exchange-dbinit -r | ||
778 | @end example | ||
779 | |||
780 | However, running this command will result in all data in the database | ||
781 | being lost, which may result in significant financial liabilities as | ||
782 | the exchange can then not detect double-spending. Hence this | ||
783 | operation must not be performed in a production system. | ||
784 | |||
785 | @node Diagnostics | ||
786 | @chapter Diagnostics | ||
787 | |||
788 | This chapter includes various (very unpolished) sections on specific topics | ||
789 | that might be helpful to understand how the exchange operates, which files | ||
790 | should be backed up. The information may also be helpful for diagnostics. | ||
791 | |||
792 | @menu | ||
793 | * Reserve management:: | ||
794 | * Database Scheme:: | ||
795 | * Signing key storage:: | ||
796 | * Denomination key storage:: | ||
797 | * Auditor signature storage:: | ||
798 | @end menu | ||
799 | |||
800 | |||
801 | @node Reserve management | ||
802 | @section Reserve management | ||
803 | |||
804 | |||
805 | Incoming transactions to the exchange's provider result in the | ||
806 | creation or update of reserves, identified by their reserve key. The | ||
807 | command line tool @cite{taler-exchange-reservemod} allows create and | ||
808 | add money to reserves in the exchange's database. | ||
809 | |||
810 | |||
811 | |||
812 | |||
813 | @node Database Scheme | ||
814 | @section Database Scheme | ||
815 | |||
816 | |||
817 | The exchange database must be initialized using @cite{taler-exchange-dbinit}. This | ||
818 | tool creates the tables required by the Taler exchange to operate. The | ||
819 | tool also allows you to reset the Taler exchange database, which is useful | ||
820 | for test cases but should never be used in production. Finally, | ||
821 | @cite{taler-exchange-dbinit} has a function to garbage collect a database, | ||
822 | allowing administrators to purge records that are no longer required. | ||
823 | |||
824 | The database scheme used by the exchange look as follows: | ||
825 | |||
826 | @image{exchange-db,5in,,,png} | ||
827 | |||
828 | |||
829 | @node Signing key storage | ||
830 | @section Signing key storage | ||
831 | |||
832 | |||
833 | The private online signing keys of the exchange are stored in a | ||
834 | subdirectory "signkeys/" of the "KEYDIR" which is an option in the | ||
835 | "[exchange]" section of the configuration file. The filename is the | ||
836 | starting time at which the signing key can be used in microseconds | ||
837 | since the Epoch. The file format is defined by the @cite{struct TALER_EXCHANGEDB_PrivateSigningKeyInformationP}: | ||
838 | |||
839 | @example | ||
840 | struct TALER_EXCHANGEDB_PrivateSigningKeyInformationP @{ | ||
841 | struct TALER_ExchangePrivateKeyP signkey_priv; | ||
842 | struct TALER_ExchangeSigningKeyValidityPS issue; | ||
843 | @}; | ||
844 | @end example | ||
845 | |||
846 | |||
847 | @node Denomination key storage | ||
848 | @section Denomination key storage | ||
849 | |||
850 | The private denomination keys of the exchange are store in a | ||
851 | subdirectory "denomkeys/" of the "KEYDIR" which is an option in the | ||
852 | "[exchange]" section of the configuration file. "denomkeys/" contains | ||
853 | further subdirectories, one per denomination. The specific name of | ||
854 | the subdirectory under "denomkeys/" is ignored by the exchange. | ||
855 | However, the name is important for the "taler-exchange-keyup" tool | ||
856 | that generates the keys. The tool combines a human-readable encoding | ||
857 | of the denomination (i.e. for EUR:1.50 the prefix would be | ||
858 | "EUR_1_5-", or for EUR:0.01 the name would be "EUR_0_01-") with a | ||
859 | postfix that is a truncated Crockford32 encoded hash of the various | ||
860 | attributes of the denomination key (relative validity periods, fee | ||
861 | structure and key size). Thus, if any attributes of a coin change, | ||
862 | the name of the subdirectory will also change, even if the | ||
863 | denomination remains the same. | ||
864 | |||
865 | Within this subdirectory, each file represents a particular | ||
866 | denomination key. The filename is the starting time at which the | ||
867 | signing key can be used in microseconds since the Epoch. The | ||
868 | format on disk begins with a | ||
869 | @cite{struct TALER_EXCHANGEDB_DenominationKeyInformationP} giving | ||
870 | the attributes of the denomination key and the associated | ||
871 | signature with the exchange's long-term offline key: | ||
872 | |||
873 | @example | ||
874 | struct TALER_EXCHANGEDB_DenominationKeyInformationP @{ | ||
875 | struct TALER_MasterSignatureP signature; | ||
876 | struct TALER_DenominationKeyValidityPS properties; | ||
877 | @}; | ||
878 | @end example | ||
879 | |||
880 | This is then followed by the variable-size RSA private key in | ||
881 | libgcrypt's S-expression format, which can be decoded using | ||
882 | @cite{GNUNET_CRYPTO_rsa_private_key_decode()}. | ||
883 | |||
884 | @menu | ||
885 | * Revocations:: | ||
886 | @end menu | ||
887 | |||
888 | @node Revocations | ||
889 | @subsection Revocations | ||
890 | |||
891 | @cindex payback | ||
892 | @cindex revocation | ||
893 | When an exchange goes out of business or detects that the private | ||
894 | key of a denomination key pair has been compromised, it may revoke | ||
895 | some or all of its denomination keys. At this point, the hashes | ||
896 | of the revoked keys must be returned as part of the @code{/keys} response | ||
897 | under ``payback''. Wallets detect this, and then return unspent | ||
898 | coins of the respective denomination key using the @code{/payback} | ||
899 | API. | ||
900 | |||
901 | When a denomination key is revoked, a revocation file is placed | ||
902 | into the respective subdirectory of ``denomkeys/''. The file has the | ||
903 | same prefix as the file that stores the | ||
904 | @cite{struct TALER_EXCHANGEDB_DenominationKeyInformationP} information, | ||
905 | but is followed by the ``.rev'' suffix. It contains a 64-byte | ||
906 | EdDSA signature made with the master key of the exchange with purpose | ||
907 | @code{TALER_SIGNATURE_MASTER_DENOMINATION_KEY_REVOKED}. If such a file | ||
908 | is present, the exchange must check the signature and if it is valid | ||
909 | treat the respective denomination key as revoked. | ||
910 | |||
911 | Revocation files can be generated using the | ||
912 | @code{taler-exchange-keyup} command-line tool using the @code{-r} | ||
913 | option. The Taler auditor will instruct operators to generate | ||
914 | revocations if it detects a key compromise (which is possible more | ||
915 | coins of a particular denomination were deposited than issued). | ||
916 | |||
917 | It should be noted that denomination key revocations should only happen | ||
918 | under highly unusual (``emergency'') conditions and not under normal | ||
919 | conditions. | ||
920 | |||
921 | |||
922 | @node Auditor signature storage | ||
923 | @section Auditor signature storage | ||
924 | |||
925 | |||
926 | Signatures from auditors are stored in the directory specified | ||
927 | in the exchange configuration section "exchangedb" under the | ||
928 | option "AUDITOR_BASE_DIR". The exchange does not care about | ||
929 | the specific names of the files in this directory. | ||
930 | |||
931 | Each file must contain a header with the public key information | ||
932 | of the auditor, the master public key of the exchange, and | ||
933 | the number of signed denomination keys: | ||
934 | |||
935 | @example | ||
936 | struct AuditorFileHeaderP @{ | ||
937 | struct TALER_AuditorPublicKeyP apub; | ||
938 | struct TALER_MasterPublicKeyP mpub; | ||
939 | uint32_t dki_len; | ||
940 | @}; | ||
941 | @end example | ||
942 | |||
943 | This is then followed by @cite{dki_len} signatures of the auditor of type | ||
944 | @cite{struct TALER_AuditorSignatureP}, which are then followed by another | ||
945 | @cite{dki_len} blocks of type @cite{struct TALER_DenominationKeyValidityPS}. | ||
946 | The auditor's signatures must be signatures over the information of | ||
947 | the corresponding denomination key validity structures embedded in a | ||
948 | @cite{struct TALER_ExchangeKeyValidityPS} structure using the | ||
949 | @cite{TALER_SIGNATURE_AUDITOR_EXCHANGE_KEYS} purpose. | ||
950 | |||
951 | |||
952 | |||
953 | @c ********************************************************** | ||
954 | @c ******************* Appendices ************************* | ||
955 | @c ********************************************************** | ||
956 | |||
957 | @node GNU-AGPL | ||
958 | @chapter GNU Affero GPL | ||
959 | @cindex license | ||
960 | @include agpl.texi | ||
961 | |||
962 | @node GNU-FDL | ||
963 | @chapter GNU Free Documentation License | ||
964 | @cindex license | ||
965 | @include fdl-1.3.texi | ||
966 | |||
967 | @node Concept Index | ||
968 | @chapter Concept Index | ||
969 | |||
970 | @printindex cp | ||
971 | |||
972 | @bye | ||