~ubuntu-branches/ubuntu/karmic/mdbtools/karmic

« back to all changes in this revision

Viewing changes to doc/install.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Filip Van Raemdonck
  • Date: 2004-02-18 19:05:35 UTC
  • Revision ID: james.westby@ubuntu.com-20040218190535-605n6otjeg9xa8za
Tags: upstream-0.5.99
ImportĀ upstreamĀ versionĀ 0.5.99

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!doctype book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
 
2
]>
 
3
<book>
 
4
        <bookinfo>
 
5
                <date>$Date: 2004/02/08 18:41:07 $</date>
 
6
                <releaseinfo>$Revision: 1.3 $</releaseinfo>
 
7
                <title><productname>MDB Tools</productname> Installation Guide</title>
 
8
                <subtitle>A Guide to Installing and  Configuring <productname>MDB Tools</productname></subtitle>
 
9
                <author>
 
10
                        <firstname>Brian</firstname>
 
11
                        <surname>Bruns</surname>
 
12
                </author>
 
13
                <copyright>
 
14
                  <year>2003</year>
 
15
                  <holder>Brian Bruns</holder>
 
16
                </copyright>
 
17
                <legalnotice><para>
 
18
      Permission is granted to copy, distribute and/or modify this document
 
19
      under the terms of the GNU Free Documentation License, Version 1.1
 
20
      or any later version published by the Free Software Foundation;
 
21
      with no Invariant Sections, with no
 
22
      Front-Cover Texts, and with no Back-Cover Texts.
 
23
      A copy of the license is included in the section entitled <link linkend="gfdl">GNU
 
24
      Free Documentation License</link>.</para>
 
25
                </legalnotice>
 
26
        </bookinfo>
 
27
 
 
28
        <toc></toc>
 
29
                                <!-- ////////////////// CHAPTER /////////////////////// -->
 
30
        <preface><title>About this Guide</title>
 
31
                        <para>
 
32
This guide is intended to provide help with installing and configuring the <productname>MDB Tools</productname> suite of programs. It is a work in progress and the author will happily accept new material, clarifications, or other enhancements in any format.  Patches to the original DocBook format can be uploaded to the SourceForge patch area under the <ulink url="http://www.sourceforge.net/projects/mdbtools">MDB Tools project page</ulink>.  Changes in plain text and other formats can be submitted directly to the mailing list or the author.
 
33
                        </para>
 
34
                        <para>
 
35
A few technical notes.  This guide is written in SGML DocBook format, specifications for which are found in the <ulink url="http://www.docbook.org/tdg/en/html/docbook.html">DocBook book</ulink>.  It was converted to HTML with <ulink url="http://openjade.sourceforge.net">OpenJade</ulink>.  
 
36
The document you are reading is version 
 
37
$Revision: 1.3 $
 
38
, dated 
 
39
$Date: 2004/02/08 18:41:07 $ (CVS control number $Id: install.sgml,v 1.3 2004/02/08 18:41:07 brianb Exp $).  The most recent version can be found on the <productname>MDB Tools</productname> 
 
40
<ulink url="http://mdbtools.sourceforge.net/userguide/">web site</ulink>.
 
41
                        </para>
 
42
        </preface>
 
43
 
 
44
        <chapter id="what">
 
45
                <title>What is <productname>MDB Tools</productname>?</title>
 
46
 
 
47
                <para>
 
48
<productname>MDB Tools</productname> is a suite of libraries and programs to facilitate the use of Microsoft Access databases, also known as Jet databases after the Microsoft's Jet Database Engine or as MDB databases after the .mdb extension used by the file containing the database. 
 
49
                </para>
 
50
                <para>
 
51
<productname>MDB Tools</productname>is open source software (also known as free software if you prefer) which means source code is provided under a license which allows you as a user to modify and redistribute the software.  In particular, the libraries that come with <productname>MDB Tools</productname> are licensed under the Gnu LGPL (Lesser General Public License) and the utility programs, graphical interface, and miscellania are licensed under the Gnu GPL (General Public License).  More information about these licenses can be found in the <filename>COPYING.LIB</filename> and <filename>COPYING</filename> files distributed with <productname>MDB Tools</productname> or from the <ulink url="http://www.gnu.org">Gnu site</ulink>.
 
52
                </para>
 
53
                <para>
 
54
                </para>
 
55
        </chapter>
 
56
                <chapter id="components">
 
57
                        <title>Components of the <productname>MDB Tools</productname> Suite</title>
 
58
                        <para>
 
59
<productname>MDB Tools</productname> is composed of three libraries, a set of command line utilities and a graphical interface.
 
60
                        </para>
 
61
                <sect1 id="libmdb">
 
62
                <title>LibMDB</title>
 
63
                <para>
 
64
libmdb is the lowest level library. It handles the details of reading from and writing to the MDB file format. Atop this library sits all the other functionality of <productname>MDB Tools</productname>.
 
65
                </para>
 
66
                <para>
 
67
A complete description of libmdb will be available in the forthcoming <productname>MDB Tools</productname> Programmer's Guide. For now you can look at the utility programs for a general idea of how to use the API, it's fairly straightforward.
 
68
                </para>
 
69
                </sect1>
 
70
                <sect1 id="utilities">
 
71
                <title>Command Line Utilities</title>
 
72
                <para>
 
73
<productname>MDB Tools</productname> comes with a set of command line utilties that allow mdb files to be used in shell scripting, extraction to another database, and similar functions. Each program is documented in its man page. A brief synopsis follows.
 
74
<table>
 
75
<title>MDB Utilities</title>
 
76
<tgroup cols="2">
 
77
<thead>
 
78
        <row>
 
79
        <entry>Name</entry>
 
80
        <entry>Description</entry>
 
81
        </row>
 
82
</thead>
 
83
<tbody>
 
84
        <row>
 
85
        <entry>mdb-tables</entry>
 
86
        <entry>list tables in the specified file</entry>
 
87
        </row>
 
88
        <row>
 
89
        <entry>mdb-schema</entry>
 
90
        <entry>generate schema DDL for the specified file</entry>
 
91
        </row>
 
92
        <row>
 
93
        <entry>mdb-export</entry>
 
94
        <entry>generate CSV style output for a table</entry>
 
95
        </row>
 
96
        <row>
 
97
        <entry>mdb-ver</entry>
 
98
        <entry>display the version of the specified file</entry>
 
99
        </row>
 
100
        <row>
 
101
        <entry>mdb-header</entry>
 
102
        <entry>support for using MDB data in C</entry>
 
103
        </row>
 
104
        <row>
 
105
        <entry>mdb-parsecsv</entry>
 
106
        <entry>support for using MDB data in C</entry>
 
107
        </row>
 
108
        <row>
 
109
        <entry>mdb-sql</entry>
 
110
        <entry>command line SQL query tool</entry>
 
111
        </row>
 
112
</tbody>
 
113
</tgroup>
 
114
</table>
 
115
                </para>
 
116
                </sect1>
 
117
                <sect1 id="libmdbsql">
 
118
                <title>LibMDBSQL (the SQL Engine)</title>
 
119
                <para>
 
120
LibMDBSQL is an SQL engine which provides a subset of the SQL query language to access MDB databases.  It is used with the ODBC driver, by the mdb-sql utility, and by the query window in gmdb2.
 
121
                </para>
 
122
                <para>
 
123
For a description of the supported SQL, see the mdb-sql man page.
 
124
                </para>
 
125
                </sect1>
 
126
                <sect1 id="libmdbodbc">
 
127
                <title>LibMDBODBC</title>
 
128
                <para>
 
129
LibMDBODBC is an ODBC driver that works with the unixODBC driver manager to allow MDB Tools to work with such programs as PHP and Perl (via DBD::ODBC).  At the time of this writing, the breadth of coverage for the driver is rather limited. If you have specific problems with it, please contact the list and they can most likely be resolved.  
 
130
                </para>
 
131
                <para>
 
132
The ODBC driver relies on LibMDB and LibMDBSQL. 
 
133
                </para>
 
134
                </sect1>
 
135
                <sect1 id="gmdb2">
 
136
                <title>Gmdb2</title>
 
137
                <para>
 
138
Gmdb2 is a graphical interface to the functionality of MDB Tools.  Its interface resembles that of access with a tabbed interface to each of the object types in the database (tables, queries, forms, etc...).  Additonally, it sports an SQL Query window, and a file debugger useful for developers or anybody interested in examining the dark secrets of the MDB file format.
 
139
                </para>
 
140
                <para>
 
141
For information on how to use gmdb2, see the manual under the Help menu.
 
142
                </para>
 
143
                </sect1>
 
144
        </chapter>
 
145
        <chapter id="requirements">
 
146
                <title>Requirements</title>
 
147
                <para>
 
148
<productname>MDB Tools</productname> like most packages has some requirements for libraries and such on your system.  Most of them are optional and will turn off certain features if not present.
 
149
                </para>
 
150
                <sect1 id="reqtable">
 
151
                <title>Requirements Matrix</title>
 
152
                <para>
 
153
The following matrix lists all requirements and which features they affect.  An X in the major feature categories (SQL, ODBC, gmdb2) means these features will be turned off if the prequisite is not found. 
 
154
                </para>
 
155
<table>
 
156
<title>Prerequisites</title>
 
157
<tgroup cols="6">
 
158
<thead>
 
159
        <row>
 
160
        <entry>Name</entry>
 
161
        <entry>SQL</entry>
 
162
        <entry>ODBC</entry>
 
163
        <entry>gmdb2</entry>
 
164
        <entry>Source</entry>
 
165
        <entry>Notes</entry>
 
166
        </row>
 
167
</thead>
 
168
<tbody>
 
169
        <row>
 
170
        <entry>glib 2.0</entry>
 
171
        <entry>X</entry>
 
172
        <entry>X</entry>
 
173
        <entry>X</entry>
 
174
        <entry><ulink url="http://www.gtk.org">www.gtk.org</ulink></entry>
 
175
        <entry>Absolutely required, will not install without</entry>
 
176
        </row>
 
177
        <row>
 
178
        <entry>readline</entry>
 
179
        <entry></entry>
 
180
        <entry></entry>
 
181
        <entry></entry>
 
182
        <entry><ulink url="http://cnswww.cns.cwru.edu/~chet/readline/rltop.html">http://cnswww.cns.cwru.edu/~chet/readline/rltop.html</ulink></entry>
 
183
        <entry>Supports history in mdb-sql, will compile without history if not found.</entry>
 
184
        </row>
 
185
        <row>
 
186
        <entry>bison</entry>
 
187
        <entry>X</entry>
 
188
        <entry>X</entry>
 
189
        <entry></entry>
 
190
        <entry><ulink url="http://www.gnu.org/software/bison/bison.html">www.gnu.org</ulink></entry>
 
191
        <entry>gmdb2 will not have a SQL window and mdb-sql will be stubbed out.</entry>
 
192
        </row>
 
193
        <row>
 
194
        <entry>flex</entry>
 
195
        <entry>X</entry>
 
196
        <entry>X</entry>
 
197
        <entry></entry>
 
198
        <entry><ulink url="http://www.gnu.org/software/flex/flex.html">www.gnu.org</ulink></entry>
 
199
        <entry>gmdb2 will not have a SQL window and mdb-sql will be stubbed out.</entry>
 
200
        </row>
 
201
        <row>
 
202
        <entry>unixODBC</entry>
 
203
        <entry></entry>
 
204
        <entry>X</entry>
 
205
        <entry></entry>
 
206
        <entry><ulink url="http://www.unixodbc.com">www.unixodbc.com</ulink></entry>
 
207
        <entry></entry>
 
208
        </row>
 
209
        <row>
 
210
        <entry>Gnome 2.0</entry>
 
211
        <entry></entry>
 
212
        <entry></entry>
 
213
        <entry>X</entry>
 
214
        <entry><ulink url="http://www.gnome.org">www.gnome.org</ulink></entry>
 
215
        <entry></entry>
 
216
        </row>
 
217
        <row>
 
218
        <entry>libglade</entry>
 
219
        <entry></entry>
 
220
        <entry></entry>
 
221
        <entry>X</entry>
 
222
        <entry><ulink url="http://www.gnome.org">www.gnome.org</ulink></entry>
 
223
        <entry></entry>
 
224
        </row>
 
225
        <row>
 
226
        <entry>wordexp</entry>
 
227
        <entry></entry>
 
228
        <entry></entry>
 
229
        <entry></entry>
 
230
        <entry></entry>
 
231
        <entry>Part of the OS, without it ~ expansion in SQL engine will be disabled</entry>
 
232
        </row>
 
233
</tbody>
 
234
</tgroup>
 
235
</table>
 
236
                </sect1>
 
237
        </chapter>
 
238
        <chapter id="installopts">
 
239
                <title>Installation Options</title>
 
240
                <para>
 
241
<productname>MDB Tools</productname> call be installed from binaries or by compiling the source package.
 
242
                </para>
 
243
                <sect1 id="rpm">
 
244
                <title>RPMs</title>
 
245
                <para>
 
246
RPMs are made available for major releases (not including pre-release or release candidates). The RPM packages are split up along feature boundaries with a core package, a development package, an ODBC package, and a graphical package. To install, simply log in as root and run the following.
 
247
<screen>
 
248
<prompt>$ </prompt><userinput>rpm -i mdbtools-0.5-1.rpm</userinput> 
 
249
<prompt>$ </prompt><userinput>rpm -i mdbtools-devel-0.5-1.rpm</userinput> 
 
250
<prompt>$ </prompt><userinput>rpm -i mdbtools-odbc-0.5-1.rpm</userinput> 
 
251
<prompt>$ </prompt><userinput>rpm -i mdbtools-gui-0.5-1.rpm</userinput> 
 
252
</screen>
 
253
                </para>
 
254
                </sect1>
 
255
                <sect1 id="otherpkg">
 
256
                <title>Other Binary Packages</title>
 
257
                <para>
 
258
Packages for other systems (debian, bsd ports, etc...) may be available, check with your OS vendor.
 
259
                </para>
 
260
                </sect1>
 
261
                <sect1 id="source">
 
262
                <title>Source</title>
 
263
                <para>
 
264
If none of the binary options are available to you, or if you prefer, you can configure and compile from the source packages. The next chapter will demonstrate that.
 
265
                </para>
 
266
                </sect1>
 
267
        </chapter>
 
268
        <chapter id="srcinstall">
 
269
                <title>Installing from Source</title>
 
270
                <para>
 
271
There are three basic steps to installing from source
 
272
                </para>
 
273
<orderedlist>
 
274
                        <listitem><para>configuring</para></listitem>
 
275
                        <listitem><para>building</para></listitem>
 
276
                        <listitem><para>installing</para></listitem>
 
277
</orderedlist>
 
278
                <sect1 id="tarcfg">
 
279
                <title>Configuring from the tarball</title>
 
280
                <para>
 
281
If you are installing a release or snapshot tarball follow these steps. These steps assume the tarballs name is <filename>mdbtools-0.5.tgz</filename>.
 
282
<screen>
 
283
<prompt>$ </prompt><userinput>zcat mdbtools-0.5.tgz | tar xvf -</userinput> 
 
284
<prompt>$ </prompt><userinput>cd mdbtools-0.5</userinput> 
 
285
<prompt>$ </prompt><userinput>./configure</userinput> 
 
286
</screen>
 
287
If you want to include ODBC support, use the --with-unixodbc argument with the location you installed it to (<filename>/usr/local</filename> by default).
 
288
<screen>
 
289
<prompt>$ </prompt><userinput>zcat mdbtools-0.5.tgz | tar xvf -</userinput> 
 
290
<prompt>$ </prompt><userinput>cd mdbtools-0.5</userinput> 
 
291
<prompt>$ </prompt><userinput>./configure --with-unixodbc=/usr/local</userinput> 
 
292
</screen>
 
293
                </para>
 
294
                </sect1>
 
295
                <sect1 id="cvscfg">
 
296
                <title>Configuring from CVS</title>
 
297
                <para>
 
298
If you are looking for the very latest code you can check out it out of CVS and compile.  The configure step uses the <filename>autogen.sh</filename> script so it's a bit different.
 
299
<screen>
 
300
<prompt>$ </prompt><userinput>cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/mdbtools login</userinput> 
 
301
<prompt>$ </prompt><userinput>cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/mdbtools co</userinput> 
 
302
<prompt>$ </prompt><userinput>cd mdbtools</userinput> 
 
303
<prompt>$ </prompt><userinput>./autogen.sh --with-unixodbc=/usr/local</userinput> 
 
304
</screen>
 
305
Again, if you don't want ODBC support remove the --with-unixodbc flag.
 
306
                </para>
 
307
                </sect1>
 
308
                <sect1 id="build">
 
309
                <title>Building</title>
 
310
                <para>
 
311
Once you are finished configuring simply type <command>make</command> to build.
 
312
<screen>
 
313
<prompt>$ </prompt><userinput>make</userinput> 
 
314
</screen>
 
315
                </para>
 
316
                </sect1>
 
317
                <sect1 id="install">
 
318
                <title>Installing</title>
 
319
                <para>
 
320
To install, sign in as root and type <command>make install</command>
 
321
<screen>
 
322
<prompt>$ </prompt><userinput>su -</userinput> 
 
323
<prompt># </prompt><userinput>make install</userinput> 
 
324
</screen>
 
325
                </para>
 
326
                </sect1>
 
327
        </chapter>
 
328
        <chapter id="postinstall">
 
329
        <title>Post Install Configuration</title>
 
330
        <para>
 
331
There are a couple of things that can be configured in the package.
 
332
        </para>
 
333
                <sect1 id="mdbpath">
 
334
                <title>MDBPATH</title>
 
335
                <para>
 
336
If you store your MDB files together in directories you can use the MDBPATH environment variable to have <productname>MDB Tools</productname> search the path similiar to PATH, MANPATH, LD_LIBRARY_PATH (or LIBPATH), etc... Like those, the : (colon) is used as a separator.
 
337
                </para>
 
338
                <para>
 
339
If you run sh, ksh, or bash
 
340
<screen>
 
341
<prompt>$ </prompt><userinput>MDBPATH=/home/myuser/mdbfiles:/data/mdbfiles ; export MDBPATH</userinput> 
 
342
</screen>
 
343
If you run csh or tcsh
 
344
<screen>
 
345
<prompt>$ </prompt><userinput>setenv MDBPATH /home/myuser/mdbfiles:/data/mdbfiles</userinput> 
 
346
</screen>
 
347
This will cause <productname>MDB Tools</productname> to first attempt to open the file using the filename or path provided (current directory or absolute path), then to walk through each entry in the MDBPATH file looking for it. It will stop at the first match.
 
348
                </para>
 
349
                <para>
 
350
The MDBPATH variable affects all utilities and any program calling mdb_open().
 
351
                </para>
 
352
                </sect1>
 
353
                <sect1 id="odbcini">
 
354
                <title>ODBC</title>
 
355
                <para>
 
356
In order to use ODBC you must place an entry in the <filename>odbc.ini</filename> file.
 
357
                </para>
 
358
<example>
 
359
<title><filename>odbc.ini</filename> file</title>
 
360
<programlisting>
 
361
[Northwind]
 
362
Description = Northwind Sample Database
 
363
Driver = /usr/local/lib/libmdbodbc.so
 
364
Database = /data/mdbfiles/Northwind.mdb
 
365
</programlisting>
 
366
</example>
 
367
                <para>
 
368
Consult the unixODBC documentation for full details.
 
369
                </para>
 
370
                </sect1>
 
371
        </chapter>
 
372
<appendix id="gfdl">
 
373
<title>GNU Free Documentation License</title>
 
374
<!-- - GNU Project - Free Software Foundation (FSF) -->
 
375
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
 
376
 
 
377
 
 
378
  <!-- sect1>
 
379
    <title>GNU Free Documentation License</title -->
 
380
 
 
381
    <para>Version 1.1, March 2000</para>
 
382
 
 
383
    <blockquote id="fsf-copyright">
 
384
      <para>Copyright (C) 2000  Free Software Foundation, Inc.
 
385
59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
386
Everyone is permitted to copy and distribute verbatim copies
 
387
of this license document, but changing it is not allowed.</para>
 
388
    </blockquote>
 
389
 
 
390
  <sect1 id="gfdl-0">
 
391
    <title>PREAMBLE</title>
 
392
 
 
393
    <para>The purpose of this License is to make a manual, textbook,
 
394
    or other written document "free" in the sense of freedom: to
 
395
    assure everyone the effective freedom to copy and redistribute it,
 
396
    with or without modifying it, either commercially or
 
397
    noncommercially.  Secondarily, this License preserves for the
 
398
    author and publisher a way to get credit for their work, while not
 
399
    being considered responsible for modifications made by
 
400
    others.</para>
 
401
 
 
402
    <para>This License is a kind of "copyleft", which means that
 
403
    derivative works of the document must themselves be free in the
 
404
    same sense.  It complements the GNU General Public License, which
 
405
    is a copyleft license designed for free software.</para>
 
406
 
 
407
    <para>We have designed this License in order to use it for manuals
 
408
    for free software, because free software needs free documentation:
 
409
    a free program should come with manuals providing the same
 
410
    freedoms that the software does.  But this License is not limited
 
411
    to software manuals; it can be used for any textual work,
 
412
    regardless of subject matter or whether it is published as a
 
413
    printed book.  We recommend this License principally for works
 
414
    whose purpose is instruction or reference.</para>
 
415
  </sect1>
 
416
 
 
417
  <sect1 id="gfdl-1">
 
418
    <title>APPLICABILITY AND DEFINITIONS</title>
 
419
 
 
420
    <para>This License applies to any manual or other work that
 
421
    contains a notice placed by the copyright holder saying it can be
 
422
    distributed under the terms of this License.  The "Document",
 
423
    below, refers to any such manual or work.  Any member of the
 
424
    public is a licensee, and is addressed as "you".</para>
 
425
 
 
426
    <para>A "Modified Version" of the Document means any work
 
427
    containing the Document or a portion of it, either copied
 
428
    verbatim, or with modifications and/or translated into another
 
429
    language.</para>
 
430
 
 
431
    <para>A "Secondary Section" is a named appendix or a front-matter
 
432
    section of the Document that deals exclusively with the
 
433
    relationship of the publishers or authors of the Document to the
 
434
    Document's overall subject (or to related matters) and contains
 
435
    nothing that could fall directly within that overall subject.
 
436
    (For example, if the Document is in part a textbook of
 
437
    mathematics, a Secondary Section may not explain any mathematics.)
 
438
    The relationship could be a matter of historical connection with
 
439
    the subject or with related matters, or of legal, commercial,
 
440
    philosophical, ethical or political position regarding
 
441
    them.</para>
 
442
 
 
443
    <para>The "Invariant Sections" are certain Secondary Sections
 
444
    whose titles are designated, as being those of Invariant Sections,
 
445
    in the notice that says that the Document is released under this
 
446
    License.</para>
 
447
 
 
448
    <para>The "Cover Texts" are certain short passages of text that
 
449
    are listed, as Front-Cover Texts or Back-Cover Texts, in the
 
450
    notice that says that the Document is released under this
 
451
    License.</para>
 
452
 
 
453
    <para>A "Transparent" copy of the Document means a
 
454
    machine-readable copy, represented in a format whose specification
 
455
    is available to the general public, whose contents can be viewed
 
456
    and edited directly and straightforwardly with generic text
 
457
    editors or (for images composed of pixels) generic paint programs
 
458
    or (for drawings) some widely available drawing editor, and that
 
459
    is suitable for input to text formatters or for automatic
 
460
    translation to a variety of formats suitable for input to text
 
461
    formatters.  A copy made in an otherwise Transparent file format
 
462
    whose markup has been designed to thwart or discourage subsequent
 
463
    modification by readers is not Transparent.  A copy that is not
 
464
    "Transparent" is called "Opaque".</para>
 
465
 
 
466
    <para>Examples of suitable formats for Transparent copies include
 
467
    plain ASCII without markup, Texinfo input format, LaTeX input
 
468
    format, SGML or XML using a publicly available DTD, and
 
469
    standard-conforming simple HTML designed for human modification.
 
470
    Opaque formats include PostScript, PDF, proprietary formats that
 
471
    can be read and edited only by proprietary word processors, SGML
 
472
    or XML for which the DTD and/or processing tools are not generally
 
473
    available, and the machine-generated HTML produced by some word
 
474
    processors for output purposes only.</para>
 
475
 
 
476
    <para>The "Title Page" means, for a printed book, the title page
 
477
    itself, plus such following pages as are needed to hold, legibly,
 
478
    the material this License requires to appear in the title page.
 
479
    For works in formats which do not have any title page as such,
 
480
    "Title Page" means the text near the most prominent appearance of
 
481
    the work's title, preceding the beginning of the body of the
 
482
    text.</para>
 
483
  </sect1>
 
484
 
 
485
  <sect1 id="gfdl-2">
 
486
    <title>VERBATIM COPYING</title>
 
487
 
 
488
    <para>You may copy and distribute the Document in any medium,
 
489
    either commercially or noncommercially, provided that this
 
490
    License, the copyright notices, and the license notice saying this
 
491
    License applies to the Document are reproduced in all copies, and
 
492
    that you add no other conditions whatsoever to those of this
 
493
    License.  You may not use technical measures to obstruct or
 
494
    control the reading or further copying of the copies you make or
 
495
    distribute.  However, you may accept compensation in exchange for
 
496
    copies.  If you distribute a large enough number of copies you
 
497
    must also follow the conditions in section 3.</para>
 
498
 
 
499
    <para>You may also lend copies, under the same conditions stated
 
500
    above, and you may publicly display copies.</para>
 
501
  </sect1>
 
502
 
 
503
  <sect1 id="gfdl-3">
 
504
    <title>COPYING IN QUANTITY</title>
 
505
 
 
506
    <para>If you publish printed copies of the Document numbering more
 
507
    than 100, and the Document's license notice requires Cover Texts,
 
508
    you must enclose the copies in covers that carry, clearly and
 
509
    legibly, all these Cover Texts: Front-Cover Texts on the front
 
510
    cover, and Back-Cover Texts on the back cover.  Both covers must
 
511
    also clearly and legibly identify you as the publisher of these
 
512
    copies.  The front cover must present the full title with all
 
513
    words of the title equally prominent and visible.  You may add
 
514
    other material on the covers in addition.  Copying with changes
 
515
    limited to the covers, as long as they preserve the title of the
 
516
    Document and satisfy these conditions, can be treated as verbatim
 
517
    copying in other respects.</para>
 
518
 
 
519
    <para>If the required texts for either cover are too voluminous to
 
520
    fit legibly, you should put the first ones listed (as many as fit
 
521
    reasonably) on the actual cover, and continue the rest onto
 
522
    adjacent pages.</para>
 
523
 
 
524
    <para>If you publish or distribute Opaque copies of the Document
 
525
    numbering more than 100, you must either include a
 
526
    machine-readable Transparent copy along with each Opaque copy, or
 
527
    state in or with each Opaque copy a publicly-accessible
 
528
    computer-network location containing a complete Transparent copy
 
529
    of the Document, free of added material, which the general
 
530
    network-using public has access to download anonymously at no
 
531
    charge using public-standard network protocols.  If you use the
 
532
    latter option, you must take reasonably prudent steps, when you
 
533
    begin distribution of Opaque copies in quantity, to ensure that
 
534
    this Transparent copy will remain thus accessible at the stated
 
535
    location until at least one year after the last time you
 
536
    distribute an Opaque copy (directly or through your agents or
 
537
    retailers) of that edition to the public.</para>
 
538
 
 
539
    <para>It is requested, but not required, that you contact the
 
540
    authors of the Document well before redistributing any large
 
541
    number of copies, to give them a chance to provide you with an
 
542
    updated version of the Document.</para>
 
543
  </sect1>
 
544
 
 
545
  <sect1 id="gfdl-4">
 
546
    <title>MODIFICATIONS</title>
 
547
 
 
548
    <para>You may copy and distribute a Modified Version of the
 
549
    Document under the conditions of sections 2 and 3 above, provided
 
550
    that you release the Modified Version under precisely this
 
551
    License, with the Modified Version filling the role of the
 
552
    Document, thus licensing distribution and modification of the
 
553
    Modified Version to whoever possesses a copy of it.  In addition,
 
554
    you must do these things in the Modified Version:</para>
 
555
 
 
556
    <orderedlist numeration="upperalpha">
 
557
      <listitem><para>Use in the Title Page
 
558
      (and on the covers, if any) a title distinct from that of the
 
559
      Document, and from those of previous versions (which should, if
 
560
      there were any, be listed in the History section of the
 
561
      Document).  You may use the same title as a previous version if
 
562
      the original publisher of that version gives permission.</para>
 
563
      </listitem>
 
564
 
 
565
      <listitem><para>List on the Title Page,
 
566
      as authors, one or more persons or entities responsible for
 
567
      authorship of the modifications in the Modified Version,
 
568
      together with at least five of the principal authors of the
 
569
      Document (all of its principal authors, if it has less than
 
570
      five).</para>
 
571
      </listitem>
 
572
 
 
573
      <listitem><para>State on the Title page
 
574
      the name of the publisher of the Modified Version, as the
 
575
      publisher.</para>
 
576
      </listitem>
 
577
 
 
578
      <listitem><para>Preserve all the
 
579
      copyright notices of the Document.</para>
 
580
      </listitem>
 
581
 
 
582
      <listitem><para>Add an appropriate
 
583
      copyright notice for your modifications adjacent to the other
 
584
      copyright notices.</para>
 
585
      </listitem>
 
586
 
 
587
      <listitem><para>Include, immediately
 
588
      after the copyright notices, a license notice giving the public
 
589
      permission to use the Modified Version under the terms of this
 
590
      License, in the form shown in the Addendum below.</para>
 
591
      </listitem>
 
592
 
 
593
      <listitem><para>Preserve in that license
 
594
      notice the full lists of Invariant Sections and required Cover
 
595
      Texts given in the Document's license notice.</para>
 
596
      </listitem>
 
597
 
 
598
      <listitem><para>Include an unaltered
 
599
      copy of this License.</para>
 
600
      </listitem>
 
601
 
 
602
      <listitem><para>Preserve the section
 
603
      entitled "History", and its title, and add to it an item stating
 
604
      at least the title, year, new authors, and publisher of the
 
605
      Modified Version as given on the Title Page.  If there is no
 
606
      section entitled "History" in the Document, create one stating
 
607
      the title, year, authors, and publisher of the Document as given
 
608
      on its Title Page, then add an item describing the Modified
 
609
      Version as stated in the previous sentence.</para>
 
610
      </listitem>
 
611
 
 
612
      <listitem><para>Preserve the network
 
613
      location, if any, given in the Document for public access to a
 
614
      Transparent copy of the Document, and likewise the network
 
615
      locations given in the Document for previous versions it was
 
616
      based on.  These may be placed in the "History" section.  You
 
617
      may omit a network location for a work that was published at
 
618
      least four years before the Document itself, or if the original
 
619
      publisher of the version it refers to gives permission.</para>
 
620
      </listitem>
 
621
 
 
622
      <listitem><para>In any section entitled
 
623
      "Acknowledgements" or "Dedications", preserve the section's
 
624
      title, and preserve in the section all the substance and tone of
 
625
      each of the contributor acknowledgements and/or dedications
 
626
      given therein.</para>
 
627
      </listitem>
 
628
 
 
629
      <listitem><para>Preserve all the
 
630
      Invariant Sections of the Document, unaltered in their text and
 
631
      in their titles.  Section numbers or the equivalent are not
 
632
      considered part of the section titles.</para>
 
633
      </listitem>
 
634
 
 
635
      <listitem><para>Delete any section
 
636
      entitled "Endorsements".  Such a section may not be included in
 
637
      the Modified Version.</para>
 
638
      </listitem>
 
639
 
 
640
      <listitem><para>Do not retitle any
 
641
      existing section as "Endorsements" or to conflict in title with
 
642
      any Invariant Section.</para>
 
643
      </listitem>
 
644
    </orderedlist>
 
645
    
 
646
    <para>If the Modified Version includes new front-matter sections
 
647
    or appendices that qualify as Secondary Sections and contain no
 
648
    material copied from the Document, you may at your option
 
649
    designate some or all of these sections as invariant.  To do this,
 
650
    add their titles to the list of Invariant Sections in the Modified
 
651
    Version's license notice.  These titles must be distinct from any
 
652
    other section titles.</para>
 
653
 
 
654
    <para>You may add a section entitled "Endorsements", provided it
 
655
    contains nothing but endorsements of your Modified Version by
 
656
    various parties--for example, statements of peer review or that
 
657
    the text has been approved by an organization as the authoritative
 
658
    definition of a standard.</para>
 
659
 
 
660
    <para>You may add a passage of up to five words as a Front-Cover
 
661
    Text, and a passage of up to 25 words as a Back-Cover Text, to the
 
662
    end of the list of Cover Texts in the Modified Version.  Only one
 
663
    passage of Front-Cover Text and one of Back-Cover Text may be
 
664
    added by (or through arrangements made by) any one entity.  If the
 
665
    Document already includes a cover text for the same cover,
 
666
    previously added by you or by arrangement made by the same entity
 
667
    you are acting on behalf of, you may not add another; but you may
 
668
    replace the old one, on explicit permission from the previous
 
669
    publisher that added the old one.</para>
 
670
 
 
671
    <para>The author(s) and publisher(s) of the Document do not by
 
672
    this License give permission to use their names for publicity for
 
673
    or to assert or imply endorsement of any Modified Version.</para>
 
674
  </sect1>
 
675
 
 
676
  <sect1 id="gfdl-5">
 
677
    <title>COMBINING DOCUMENTS</title>
 
678
 
 
679
    <para>You may combine the Document with other documents released
 
680
    under this License, under the terms defined in section 4 above for
 
681
    modified versions, provided that you include in the combination
 
682
    all of the Invariant Sections of all of the original documents,
 
683
    unmodified, and list them all as Invariant Sections of your
 
684
    combined work in its license notice.</para>
 
685
 
 
686
    <para>The combined work need only contain one copy of this
 
687
    License, and multiple identical Invariant Sections may be replaced
 
688
    with a single copy.  If there are multiple Invariant Sections with
 
689
    the same name but different contents, make the title of each such
 
690
    section unique by adding at the end of it, in parentheses, the
 
691
    name of the original author or publisher of that section if known,
 
692
    or else a unique number.  Make the same adjustment to the section
 
693
    titles in the list of Invariant Sections in the license notice of
 
694
    the combined work.</para>
 
695
 
 
696
    <para>In the combination, you must combine any sections entitled
 
697
    "History" in the various original documents, forming one section
 
698
    entitled "History"; likewise combine any sections entitled
 
699
    "Acknowledgements", and any sections entitled "Dedications".  You
 
700
    must delete all sections entitled "Endorsements."</para>
 
701
  </sect1>
 
702
 
 
703
  <sect1 id="gfdl-6">
 
704
    <title>COLLECTIONS OF DOCUMENTS</title>
 
705
 
 
706
    <para>You may make a collection consisting of the Document and
 
707
    other documents released under this License, and replace the
 
708
    individual copies of this License in the various documents with a
 
709
    single copy that is included in the collection, provided that you
 
710
    follow the rules of this License for verbatim copying of each of
 
711
    the documents in all other respects.</para>
 
712
 
 
713
    <para>You may extract a single document from such a collection,
 
714
    and distribute it individually under this License, provided you
 
715
    insert a copy of this License into the extracted document, and
 
716
    follow this License in all other respects regarding verbatim
 
717
    copying of that document.</para>
 
718
  </sect1>
 
719
 
 
720
  <sect1 id="gfdl-7">
 
721
    <title>AGGREGATION WITH INDEPENDENT WORKS</title>
 
722
    
 
723
    <para>A compilation of the Document or its derivatives with other
 
724
    separate and independent documents or works, in or on a volume of
 
725
    a storage or distribution medium, does not as a whole count as a
 
726
    Modified Version of the Document, provided no compilation
 
727
    copyright is claimed for the compilation.  Such a compilation is
 
728
    called an "aggregate", and this License does not apply to the
 
729
    other self-contained works thus compiled with the Document, on
 
730
    account of their being thus compiled, if they are not themselves
 
731
    derivative works of the Document.</para>
 
732
 
 
733
    <para>If the Cover Text requirement of section 3 is applicable to
 
734
    these copies of the Document, then if the Document is less than
 
735
    one quarter of the entire aggregate, the Document's Cover Texts
 
736
    may be placed on covers that surround only the Document within the
 
737
    aggregate.  Otherwise they must appear on covers around the whole
 
738
    aggregate.</para>
 
739
  </sect1>
 
740
 
 
741
  <sect1 id="gfdl-8">
 
742
    <title>TRANSLATION</title>
 
743
 
 
744
    <para>Translation is considered a kind of modification, so you may
 
745
    distribute translations of the Document under the terms of section
 
746
    4.  Replacing Invariant Sections with translations requires
 
747
    special permission from their copyright holders, but you may
 
748
    include translations of some or all Invariant Sections in addition
 
749
    to the original versions of these Invariant Sections.  You may
 
750
    include a translation of this License provided that you also
 
751
    include the original English version of this License.  In case of
 
752
    a disagreement between the translation and the original English
 
753
    version of this License, the original English version will
 
754
    prevail.</para>
 
755
  </sect1>
 
756
 
 
757
  <sect1 id="gfdl-9">
 
758
    <title>TERMINATION</title>
 
759
    
 
760
    <para>You may not copy, modify, sublicense, or distribute the
 
761
    Document except as expressly provided for under this License.  Any
 
762
    other attempt to copy, modify, sublicense or distribute the
 
763
    Document is void, and will automatically terminate your rights
 
764
    under this License.  However, parties who have received copies, or
 
765
    rights, from you under this License will not have their licenses
 
766
    terminated so long as such parties remain in full
 
767
    compliance.</para>
 
768
  </sect1>
 
769
 
 
770
  <sect1 id="gfdl-10">
 
771
    <title>FUTURE REVISIONS OF THIS LICENSE</title>
 
772
 
 
773
    <para>The Free Software Foundation may publish new, revised
 
774
    versions of the GNU Free Documentation License from time to time.
 
775
    Such new versions will be similar in spirit to the present
 
776
    version, but may differ in detail to address new problems or
 
777
    concerns.  See <ulink
 
778
    url="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</ulink>.</para>
 
779
 
 
780
    <para>Each version of the License is given a distinguishing
 
781
    version number.  If the Document specifies that a particular
 
782
    numbered version of this License "or any later version" applies to
 
783
    it, you have the option of following the terms and conditions
 
784
    either of that specified version or of any later version that has
 
785
    been published (not as a draft) by the Free Software Foundation.
 
786
    If the Document does not specify a version number of this License,
 
787
    you may choose any version ever published (not as a draft) by the
 
788
    Free Software Foundation.</para>
 
789
  </sect1>
 
790
 
 
791
  <sect1 id="gfdl-11">
 
792
    <title>How to use this License for your documents</title>
 
793
 
 
794
    <para>To use this License in a document you have written, include
 
795
    a copy of the License in the document and put the following
 
796
    copyright and license notices just after the title page:</para>
 
797
 
 
798
<blockquote id="sample-copyright"><para>
 
799
      Copyright (c)  YEAR  YOUR NAME.
 
800
      Permission is granted to copy, distribute and/or modify this document
 
801
      under the terms of the GNU Free Documentation License, Version 1.1
 
802
      or any later version published by the Free Software Foundation;
 
803
      with the Invariant Sections being LIST THEIR TITLES, with the
 
804
      Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
 
805
      A copy of the license is included in the section entitled "GNU
 
806
      Free Documentation License".
 
807
</para></blockquote>
 
808
 
 
809
    <para>If you have no Invariant Sections, write "with no Invariant
 
810
    Sections" instead of saying which ones are invariant.  If you have
 
811
    no Front-Cover Texts, write "no Front-Cover Texts" instead of
 
812
    "Front-Cover Texts being LIST"; likewise for Back-Cover
 
813
    Texts.</para>
 
814
 
 
815
    <para>If your document contains nontrivial examples of program
 
816
    code, we recommend releasing these examples in parallel under your
 
817
    choice of free software license, such as the GNU General Public
 
818
    License, to permit their use in free software.</para>
 
819
  </sect1>
 
820
 
 
821
</appendix>
 
822
<!-- Keep this comment at the end of the file
 
823
Local variables:
 
824
mode: sgml
 
825
sgml-omittag:nil
 
826
sgml-shorttag:t
 
827
sgml-minimize-attributes:nil
 
828
sgml-always-quote-attributes:t
 
829
sgml-indent-step:2
 
830
sgml-parent-document: ("referenz.sgml" "appendix")
 
831
sgml-exposed-tags:nil
 
832
sgml-local-ecat-files:nil
 
833
sgml-local-catalogs: CATALOG
 
834
sgml-validate-command: "nsgmls -s referenz.sgml"
 
835
ispell-skip-sgml: t
 
836
End:
 
837
-->
 
838
</book>