-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
mono-beginning-windows.xml
1065 lines (916 loc) · 39.8 KB
/
mono-beginning-windows.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" []>
<article>
<articleinfo>
<!-- Use "HOWTO", "mini HOWTO", "FAQ" in title, if appropriate -->
<title>Mono Beginners HOWTO for Windows users</title>
<author>
<firstname>Jaime</firstname>
<surname>Anguiano Olarra</surname>
<affiliation>
<address><email>jaime@geneura.ugr.es</email></address>
</affiliation>
</author>
<author>
<firstname>Hinne</firstname>
<surname>Hettema</surname>
<affiliation>
<address><email>h.hettema@auckland.ac.nz</email></address>
</affiliation>
</author>
<pubdate>2002-08</pubdate>
<!-- Most recent revision goes at the top; list in descending order -->
<!-- All dates specified in ISO "YYYY-MM-DD" format -->
<revhistory>
<revision>
<revnumber>0.1</revnumber>
<date>2002-08-05</date>
<authorinitials>JA</authorinitials>
<revremark>First release</revremark>
</revision>
</revhistory>
<!-- Provide a good abstract; a couple of sentences is sufficient -->
<abstract>
<para>
The goal of this document is to guide people through the setup of a Mono
framework in a Windows box. Because some people might want to just test
Mono a bit and use the compiler, etc, I have made two distinctions, one
for the Mono user that only wants to get precompiled binaries and another
for the one how wants to build Mono from the CVS and probably contribute
to the project actively. Each kind of user has to read the corresponding
part of this document. I hope a lot of Windows users will get a nice
approach to the free software world by starting using Mono.
</para>
</abstract>
</articleinfo>
<sect1 id="intro">
<title>Introduction</title>
<para>
Mono is an open source implementation of the Common Language Infrastructure
(CLI) specified in ECMA standard 335. It comes with a C# compiler and
provides an extensible platform to develop and run applications that
are interoperable with Microsoft .NET.
</para>
<para>
Mono is not finished--it is a project still under development. As a
result, installation and configuration may not be as smooth as you
will be used to from other Linux or Windows applications. Nevertheless,
mono is in a state that will allow you to get it up and running and gain
experience with it--which is, I would suggest, a very smart thing to do.
</para>
<para>
This document is aimed at the mono beginner, and aims to present a complete
view of a minimal installation, which will allow you to experiment with
mono to some degree. It also describes some of those experiments. We
expect that after reading this document you'll go on to do either of
two things:
</para>
<orderedlist>
<listitem>
<para>
Continue to contribute to the mono project in some shape or form. The
website has some ideas and suggestions under the heading 'Contributing'.
</para>
</listitem>
<listitem>
<para>
Continue to write applications that run in mono.
</para>
</listitem>
</orderedlist>
<para>
We hope this document will be useful to you in your first steps with mono.
Happy hacking!
</para>
<sect2 id="disclaimer"> <title>Disclaimer</title>
<para>
No liability for the contents of this document can be accepted.
Use the concepts, examples and information at your own risk. There may
be errors and inaccuracies, that could be damaging to your system.
Proceed with caution, and although this is highly unlikely, the author(s)
do not take any responsibility.
</para>
<para>
All copyrights are held by their by their respective owners,
unless specifically noted otherwise. Use of a term in this document
should not be regarded as affecting the validity of any trademark or
service mark. Naming of particular products or brands should not be
seen as endorsements.
</para>
</sect2>
<!-- Give credit where credit is due...very important -->
<sect2 id="credits"> <title>Credits / Contributors</title>
<para> Credits are due to </para>
<itemizedlist>
<listitem>
<para>Hinne Hettema <email>h.hettema@auckland.ac.nz</email>
for creating the xml template I used for this document, for
reviewing and make an excellent job with the other HOWTO and
for his feedback. As you can see a lot of his work has been
included in this document too.
</para>
</listitem>
<listitem>
<para>
The Mono Hackers.
</para>
</listitem>
</itemizedlist>
</sect2>
<!-- Feedback -->
<sect2 id="feedback"> <title>Feedback</title>
<para>
Feedback is most certainly welcome for this document. Send your
additions, comments and criticisms to the following email address:
<email>mono-docs-list@ximian.com</email>. I am lurking on this list
and will maintain this document as required.
</para>
</sect2>
</sect1>
<!-- This is the preamble stuff over with the rest of document follows... -->
<sect1 id="installation">
<title> Installing Mono</title>
<sect2 id="obtaining">
<title>Obtaining Mono</title>
<para>
In order to obtain the required software you just need to visit the
Mono download page at http://www.go-mono.org/download or any of the
related sites.
</para>
<para>
You'll be able to complete everything in this document if you just install
the runtime, but taking a look at the compiler package is well worth the
effort. The compiler is written in C# and is 'self hosting' which means it
is able to compile itself.
</para>
<para>
This page also lists the current versions of the software
mono depends on. Make sure that your system has all the
required versions, otherwise mono won't compile.
</para>
</sect2>
<sect2 id="easyinstall">
<title>Installing Mono on Windows, the easy way</title>
<para>
Oh. This is a very easy task now. If you just want to take a look at
the possibilities of Mono get the Mono installer from the site of
Johannes Roith <johannes\@jroith.de>:
</para>
<para>
http://www.superin.informativ.net/mono/mono.htm. You can get a link in
</para>
<para>
the download section of the Mono site too: http://www.go-mono.org/download
</para>
<para>
Then you just need a Windows machine. Better use
Windows 2000 Professional. </para>
<para>
Once you've got it, run the installer.
</para>
<para>
Remember, building your own Mono runtime and compiler from the sources
is strongly recommended. You won't discover the power of Mono until
you get it made this way. If you feel hungry about real programming with
Mono, proceed like in the next section.
</para>
</sect2>
<sect2 id="hardinstall">
<title>Building Mono under Windows</title>
<itemizedlist>
<listitem>
<para>
1.- Get Windows 2000 Professional or any Windows System supporting .NET SDK.
Avoid using XP and the redistributable version of the SDK (necessary for
WinME, etc).
</para>
</listitem>
<listitem>
<para>
2.- Get the latest Cygwin distribution, be sure you install the GNU Build Tools
packages. Take the openssh package if you plan to contribute to the project.
If you feel insecure about the packages you need to install, install all of
them, of course, Text, Admin, Games and Web are not necessary at all and you
can pass of those. The fitness of your choice will depend of your knowledge
on Linux and/or Cygwin. If in doubt install all.
</para>
</listitem>
<listitem>
<para>
3.- Install the .NET SDK.
</para>
</listitem>
<listitem>
<para>
4.- Install Cygwin.
</para>
</listitem>
<listitem>
<para>
5.- Get http://www.go-mono.org/mono-build-w32.sh and put it into your home
directory in the cygwin setup.
</para>
</listitem>
<listitem>
<para>
6.- Enter your cygwin environment. If you have an account in the mono cvs, then
export the variables as shown in http://www.go-mono.org/ccvs.html
</para>
<programlisting>
This means. Enter: export CVSROOT=user@mono-cvs.ximian.com:/cvs/public
and export CVS_RSH=ssh
</programlisting>
<para>
If you have no account DO NOTHING.
</para>
</listitem>
<listitem>
<para>
7.- Enter:
<programlisting>
export ACLOCAL_FLAGS="-I /usr/local/share/aclocal"
and this: export PKG_CONFIG_PATH="/usr/local/bin"
</programlisting>
</para>
</listitem>
<listitem>
<para>
8.- Run the script (mono-build-w32.sh)
</para>
</listitem>
<listitem>
<para>
9.- All should work fine know and you should see it download what necessary and
build mono.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="errors">
<title>Troubleshooting</title>
<para>
If you have noticed problems during step 8 and the execution stops because of
errors as I cannot find that or such library or alike, try to:
</para>
<itemizedlist>
<listitem>
<para>
1.- Create a directory mono-temp for example.
</para>
</listitem>
<listitem>
<para>
2.- Move and unzip all the zips the mono-build script downloads to /usr/local
to that new directory. Do it one by one, copying the content of the created
subdirectories (include, bin, etc) to their respectives in /usr/local. Take
care, some libraries like libglib... must go into /usr/local/bin and not
into /usr/local/lib.
</para>
</listitem>
<listitem>
<para>
3.- Jump into the /usr/local/mono directory and run ./autogen.sh
</para>
</listitem>
<listitem>
<para>
4.- Then run ./configure and after it: make and finally: make install.
</para>
</listitem>
</itemizedlist>
</sect2>
</sect1>
<sect1 id="running">
<title>Running mono</title>
<sect2 id="basic">
<title>Basic steps</title>
<para>
To work with mono, you first have to create a C# program. Open up
your favourite editor, and type in the following code:
</para>
<programlisting>
using System;
class Hello
{
public static void Main(String[] args)
{
Console.WriteLine("mono:: is alive and well...");
for (int i = 0; i < args.Length; i++)
Console.WriteLine("Argument {0} = {1}", i, args[i]);
}
}
</programlisting>
<para>
Save the file as hello.cs. To compile this into a working program,
type mcs hello.cs. If you get the following:
</para>
<programlisting>
mcs hello.cs
RESULT: 0
</programlisting>
<para>
you know the compile worked fine. If you see some strange error
messages including the word 'parser' somewhere, you made a mistake in
your program. Fix this up first.
</para>
<para>
You are now ready to execute your first mono program. To execute
the code, type
</para>
<programlisting>
mono hello.exe arg1 arg2 arg 3
</programlisting>
<para>
(where we have given some arguments just for fun) and you'll
see the following:
</para>
<programlisting>
mono:: is alive and well...
Argument 0 = arg1
Argument 1 = arg2
Argument 2 = arg
Argument 3 = 3
RESULT: 0
</programlisting>
<para>
As you can see, mono printed the line "mono:: is alive and well"
and printed the list of arguments. This completes the creation
and execution of your first mono program.
</para>
</sect2>
<sect2 id="interpreter">
<title>Interpreter</title>
<para>
But mono will allow you to do more. First of all, mono is the
compiled mono execution environment which uses the Just in
Time (JIT) compiler. Mono also comes with an interpreted
environment, which can be accessed using the command 'mint'
as follows
</para>
<programlisting>
mint hello.exe arg1 arg 2
mono:: is alive and well...
Argument 0 = arg1
Argument 1 = arg
Argument 2 = 2
</programlisting>
<para>
As you can see, it makes no difference to mono output which
environment you use, but what happens under the hood is very
different. If you use 'mono' as the command line tool, you
call the 'production' execution environment which will read
your portable executable (PE) file, and call the just in
time (JIT) compiler to compile the PE code down to machine
level code (in my case, an x86 architecture) after which
it is executed.
</para>
<para>
If you use mint, the JIT is not used, and the PE code is
interpreted into x86 instructions for execution. In fact,
for our simple 'hello' mint is slightly faster. The point
is that the JIT compiler will take some time to compile the
code of our program and store it in some location in memory,
but the subsequent execution of the code is faster with mono.
</para>
<para>
After this simple run of mono, it is time to play with some options.
I won't cover these in detail since there are quite a few, and also because
I assume you downloaded mono to hack it around in the first place. So
I'll leave some pointers.
</para>
<sect3 id="debugging">
<title>Debugging</title>
<para>
Mono supports a debugging option when you specify the "-d" flag while running
the runtime. Utilising this flag will get you a significant amount of output,
and it may be an idea to specify an output file as well. The interesting aspect
of this file is that it allows you to see to some extent (quite precisely,
actually) what the JIT compiler is up to.
</para>
</sect3>
<sect3 id="statistics">
<title>Statistics</title>
<para>
It is also possible to collect some runtime statistics on your program. These
will give you some idea of the resource utilisation of your program.
</para>
<programlisting>
mono --stats hello.exe
mono:: is alive and well...
RESULT: 0
Mono Jit statistics
Compiled methods: 58
Methods cache lookup: 15
Method trampolines: 698
Basic blocks: 188
Max basic blocks: 15
Allocated vars: 238
Analyze stack repeat: 61
Compiled CIL code size: 2450
Native code size: 10167
Max code size ratio: 7.13 (FileStream::FlushBuffer)
Biggest method: 1016 (StreamWriter::Write)
Code reallocs: 27
Allocated code size: 22073
Inlineable methods: 17
Inlined methods: 22
Created object count: 18
Initialized classes: 127
Used classes: 37
Static data size: 288
VTable data size: 8292
</programlisting>
</sect3>
</sect2>
<sect2 id="ILAsm_code" >
<title>Inspecting IL Assembly code</title>
<para>
Mono also provides a small tool that will let you disassemble
the executable (.exe) file so you can have a peek
under the hood. This tool is monodis, and is run as
follows:
</para>
<programlisting>
monodis hello.exe
.assembly extern mscorlib
{
.ver 0:0:0:0
}
.assembly 'hello'
{
.hash algorithm 0x00008004
.ver 0:0:0:0
}
.class private auto ansi beforefieldinit Hello
extends [mscorlib]System.Object
{
// method line 1
.method public hidebysig specialname rtspecialname
instance default void .ctor() cil managed
{
// Method begins at RVA 0x20ec
// Code size 7 (0x7)
.maxstack 8
IL_0000: ldarg.0
IL_0001: call instance void System.Object::.ctor()
IL_0006: ret
} // end of method instance default void .ctor()
// method line 2
.method public static
default void Main(string[] args) cil managed
{
// Method begins at RVA 0x20f4
.entrypoint
// Code size 56 (0x38)
.maxstack 5
.locals init (
int32 V_0,
int32 V_1)
IL_0000: ldstr "mono:: is alive and well..."
IL_0005: call void System.Console::WriteLine(string)
IL_000a: ldc.i4.0
IL_000b: stloc.0
IL_000c: ldloc.0
IL_000d: ldarg.s 0
IL_000f: ldlen
IL_0010: clt
IL_0012: brfalse IL_0037
IL_0017: ldstr "Argument {0} = {1}"
IL_001c: ldloc.0
IL_001d: box [mscorlib]System.Int32
IL_0022: ldarg.s 0
IL_0024: ldloc.0
IL_0025: ldelem.ref
IL_0026: call void System.Console::WriteLine(string, object, object)
IL_002b: nop
IL_002c: ldloc.0
IL_002d: ldc.i4.1
IL_002e: add
IL_002f: stloc.1
IL_0030: ldloc.1
IL_0031: stloc.0
IL_0032: br IL_000c
IL_0037: ret
} // end of method default void Main(string[] args)
} // end of type Hello
</programlisting>
<para>
This is the listing of the code of your program in a language
called IL assembly, or Common Intermediate Language (CIL). The
CIL provides the portability of the mono platform, and ensures
that code compiled with Microsoft's .NET framework will work
on mono and vice versa.
</para>
</sect2>
<sect2 id="man_pages">
<title>Man pages</title>
<para>
Mono has man pages already installed, and generally, typing <command>
man</command> before the command you wish to execute should help in
getting a list of the options. In many cases, it's still up to you
to figure out what they do.
</para>
</sect2>
</sect1>
<sect1 id="problems">
<title>Problems</title>
<para>
With mono being as new as it is, it is likely that you will have some
problems with installation. The following are some ideas to help you
out in a bind:
</para>
<orderedlist>
<listitem>
<para>
See the Ximian Bugzilla page to find out if there is a bug
report about your specific issue.
</para>
</listitem>
<listitem>
<para>Read this document. If it does not solve your problem, we want to
know about it. Please send a message to the email address listed for
feedback at the beginning of the document.</para>
</listitem>
<listitem>
<para>
Visit the mono mailing lists' archives and do a little
research in there for threads talking about the problem you have.
</para>
</listitem>
<listitem>
<para>
If you still cannot correct the problem, send a message to the
mono list. When you do this, please be as precise as possible--i.e.
mention the system you are running, the version of mono that you have the
problem with, and give any error codes and other output that might appear.
</para>
</listitem>
</orderedlist>
</sect1>
<!-- Legal Sections --> <sect1 id="copyright">
<title>Copyright and License</title>
<!-- The LDP recommends, but doesn't require, the GFDL --> <para>
This document, <emphasis>Running mono</emphasis>, is copyrighted
(c) 2002 by <emphasis>Hinne Hettema</emphasis> and
<emphasis>Jaime Anguiano Olarra</emphasis>. Permission is
granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.1 or any later
version published by the Free Software Foundation; with no Invariant
Sections, with no Front-Cover Texts, and with no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU Free
Documentation License".
</para>
<sect2 id="gfdl"> <title>GNU Free Documentation License</title>
<!-- GNU Project - Free Software Foundation (FSF) -->
<para>Version 1.1, March 2000</para>
<blockquote> <para>Copyright (C) 2000 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is
permitted to copy and distribute verbatim copies of this license document,
but changing it is not allowed.</para> </blockquote>
<sect3 id="gfdl-0"> <title>PREAMBLE</title>
<para>The purpose of this License is to make a manual, textbook,
or other written document "free" in the sense of freedom: to assure
everyone the effective freedom to copy and redistribute it, with
or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher
a way to get credit for their work, while not being considered
responsible for modifications made by others.</para>
<para>This License is a kind of "copyleft", which means that
derivative works of the document must themselves be free in the
same sense. It complements the GNU General Public License, which
is a copyleft license designed for free software.</para>
<para>We have designed this License in order to use it for manuals
for free software, because free software needs free documentation:
a free program should come with manuals providing the same freedoms
that the software does. But this License is not limited to software
manuals; it can be used for any textual work, regardless of subject
matter or whether it is published as a printed book. We recommend
this License principally for works whose purpose is instruction
or reference.</para>
</sect3>
<sect3 id="gfdl-1"> <title>APPLICABILITY AND DEFINITIONS</title>
<para>This License applies to any manual or other work that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. The "Document", below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as "you".</para>
<para>A "Modified Version" of the Document means any work
containing the Document or a portion of it, either copied verbatim,
or with modifications and/or translated into another language.</para>
<para>A "Secondary Section" is a named appendix or a front-matter
section of the Document that deals exclusively with the relationship
of the publishers or authors of the Document to the Document's overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (For example, if the Document
is in part a textbook of mathematics, a Secondary Section may not
explain any mathematics.) The relationship could be a matter of
historical connection with the subject or with related matters, or
of legal, commercial, philosophical, ethical or political position
regarding them.</para>
<para>The "Invariant Sections" are certain Secondary Sections
whose titles are designated, as being those of Invariant Sections,
in the notice that says that the Document is released under this
License.</para>
<para>The "Cover Texts" are certain short passages of text that
are listed, as Front-Cover Texts or Back-Cover Texts, in the notice
that says that the Document is released under this License.</para>
<para>A "Transparent" copy of the Document means a
machine-readable copy, represented in a format whose specification
is available to the general public, whose contents can be viewed and
edited directly and straightforwardly with generic text editors
or (for images composed of pixels) generic paint programs or
(for drawings) some widely available drawing editor, and that is
suitable for input to text formatters or for automatic translation
to a variety of formats suitable for input to text formatters.
A copy made in an otherwise Transparent file format whose markup
has been designed to thwart or discourage subsequent modification
by readers is not Transparent. A copy that is not "Transparent"
is called "Opaque".</para>
<para>Examples of suitable formats for Transparent copies include
plain ASCII without markup, Texinfo input format, LaTeX input format,
SGML or XML using a publicly available DTD, and standard-conforming
simple HTML designed for human modification. Opaque formats include
PostScript, PDF, proprietary formats that can be read and edited
only by proprietary word processors, SGML or XML for which the
DTD and/or processing tools are not generally available, and the
machine-generated HTML produced by some word processors for output
purposes only.</para>
<para>The "Title Page" means, for a printed book, the title page
itself, plus such following pages as are needed to hold, legibly,
the material this License requires to appear in the title page.
For works in formats which do not have any title page as such,
"Title Page" means the text near the most prominent appearance of the
work's title, preceding the beginning of the body of the text.</para>
</sect3>
<sect3 id="gfdl-2"> <title>VERBATIM COPYING</title>
<para>You may copy and distribute the Document in any medium,
either commercially or noncommercially, provided that this License,
the copyright notices, and the license notice saying this License
applies to the Document are reproduced in all copies, and that
you add no other conditions whatsoever to those of this License.
You may not use technical measures to obstruct or control the
reading or further copying of the copies you make or distribute.
However, you may accept compensation in exchange for copies. If you
distribute a large enough number of copies you must also follow the
conditions in section 3.</para>
<para>You may also lend copies, under the same conditions stated
above, and you may publicly display copies.</para>
</sect3>
<sect3 id="gfdl-3"> <title>COPYING IN QUANTITY</title>
<para>If you publish printed copies of the Document numbering more
than 100, and the Document's license notice requires Cover Texts, you
must enclose the copies in covers that carry, clearly and legibly,
all these Cover Texts: Front-Cover Texts on the front cover, and
Back-Cover Texts on the back cover. Both covers must also clearly
and legibly identify you as the publisher of these copies. The front
cover must present the full title with all words of the title equally
prominent and visible. You may add other material on the covers
in addition. Copying with changes limited to the covers, as long as
they preserve the title of the Document and satisfy these conditions,
can be treated as verbatim copying in other respects.</para>
<para>If the required texts for either cover are too voluminous to
fit legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.</para>
<para>If you publish or distribute Opaque copies of the Document
numbering more than 100, you must either include a machine-readable
Transparent copy along with each Opaque copy, or state in or with each
Opaque copy a publicly-accessible computer-network location containing
a complete Transparent copy of the Document, free of added material,
which the general network-using public has access to download
anonymously at no charge using public-standard network protocols.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute
an Opaque copy (directly or through your agents or retailers) of
that edition to the public.</para>
<para>It is requested, but not required, that you contact the
authors of the Document well before redistributing any large number
of copies, to give them a chance to provide you with an updated
version of the Document.</para>
</sect3>
<sect3 id="gfdl-4"> <title>MODIFICATIONS</title>
<para>You may copy and distribute a Modified Version of the
Document under the conditions of sections 2 and 3 above, provided
that you release the Modified Version under precisely this License,
with the Modified Version filling the role of the Document, thus
licensing distribution and modification of the Modified Version
to whoever possesses a copy of it. In addition, you must do these
things in the Modified Version:</para>
<orderedlist numeration="upperalpha"> <listitem><para>Use in the
Title Page
(and on the covers, if any) a title distinct from that of the
Document, and from those of previous versions (which should, if
there were any, be listed in the History section of the Document).
You may use the same title as a previous version if the original
publisher of that version gives permission.</para>
</listitem>
<listitem><para>List on the Title Page,
as authors, one or more persons or entities responsible for
authorship of the modifications in the Modified Version, together
with at least five of the principal authors of the Document (all
of its principal authors, if it has less than five).</para>
</listitem>
<listitem><para>State on the Title page
the name of the publisher of the Modified Version, as the
publisher.</para>
</listitem>
<listitem><para>Preserve all the
copyright notices of the Document.</para>
</listitem>
<listitem><para>Add an appropriate
copyright notice for your modifications adjacent to the other
copyright notices.</para>
</listitem>
<listitem><para>Include, immediately
after the copyright notices, a license notice giving the public
permission to use the Modified Version under the terms of this
License, in the form shown in the Addendum below.</para>
</listitem>
<listitem><para>Preserve in that license
notice the full lists of Invariant Sections and required Cover
Texts given in the Document's license notice.</para>
</listitem>
<listitem><para>Include an unaltered
copy of this License.</para>
</listitem>
<listitem><para>Preserve the section
entitled "History", and its title, and add to it an item stating at
least the title, year, new authors, and publisher of the Modified
Version as given on the Title Page. If there is no section entitled
"History" in the Document, create one stating the title, year,
authors, and publisher of the Document as given on its Title Page,
then add an item describing the Modified Version as stated in the
previous sentence.</para>
</listitem>
<listitem><para>Preserve the network
location, if any, given in the Document for public access to
a Transparent copy of the Document, and likewise the network
locations given in the Document for previous versions it was
based on. These may be placed in the "History" section. You may
omit a network location for a work that was published at least four
years before the Document itself, or if the original publisher of
the version it refers to gives permission.</para>
</listitem>
<listitem><para>In any section entitled
"Acknowledgements" or "Dedications", preserve the section's title,
and preserve in the section all the substance and tone of each
of the contributor acknowledgements and/or dedications given
therein.</para>
</listitem>
<listitem><para>Preserve all the
Invariant Sections of the Document, unaltered in their text and in
their titles. Section numbers or the equivalent are not considered
part of the section titles.</para>
</listitem>
<listitem><para>Delete any section
entitled "Endorsements". Such a section may not be included in
the Modified Version.</para>
</listitem>
<listitem><para>Do not retitle any
existing section as "Endorsements" or to conflict in title with
any Invariant Section.</para>
</listitem> </orderedlist> <para>If the Modified Version includes new
front-matter sections
or appendices that qualify as Secondary Sections and contain no
material copied from the Document, you may at your option designate
some or all of these sections as invariant. To do this, add their
titles to the list of Invariant Sections in the Modified Version's
license notice. These titles must be distinct from any other section
titles.</para>
<para>You may add a section entitled "Endorsements", provided it
contains nothing but endorsements of your Modified Version by various
parties--for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of
a standard.</para>
<para>You may add a passage of up to five words as a Front-Cover
Text, and a passage of up to 25 words as a Back-Cover Text, to the end
of the list of Cover Texts in the Modified Version. Only one passage
of Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.</para>
<para>The author(s) and publisher(s) of the Document do not by
this License give permission to use their names for publicity for
or to assert or imply endorsement of any Modified Version.</para>
</sect3>
<sect3 id="gfdl-5"> <title>COMBINING DOCUMENTS</title>
<para>You may combine the Document with other documents released
under this License, under the terms defined in section 4 above for
modified versions, provided that you include in the combination all of
the Invariant Sections of all of the original documents, unmodified,
and list them all as Invariant Sections of your combined work in
its license notice.</para>
<para>The combined work need only contain one copy of this
License, and multiple identical Invariant Sections may be replaced
with a single copy. If there are multiple Invariant Sections with
the same name but different contents, make the title of each such
section unique by adding at the end of it, in parentheses, the
name of the original author or publisher of that section if known,
or else a unique number. Make the same adjustment to the section
titles in the list of Invariant Sections in the license notice of
the combined work.</para>
<para>In the combination, you must combine any sections entitled
"History" in the various original documents, forming one section
entitled "History"; likewise combine any sections entitled
"Acknowledgements", and any sections entitled "Dedications".
You must delete all sections entitled "Endorsements."</para>
</sect3>
<sect3 id="gfdl-6"> <title>COLLECTIONS OF DOCUMENTS</title>
<para>You may make a collection consisting of the Document and
other documents released under this License, and replace the
individual copies of this License in the various documents with a
single copy that is included in the collection, provided that you
follow the rules of this License for verbatim copying of each of
the documents in all other respects.</para>
<para>You may extract a single document from such a collection,
and distribute it individually under this License, provided you
insert a copy of this License into the extracted document, and follow
this License in all other respects regarding verbatim copying of
that document.</para>
</sect3>
<sect3 id="gfdl-7"> <title>AGGREGATION WITH INDEPENDENT WORKS</title>
<para>A compilation of the Document or its derivatives with other
separate and independent documents or works, in or on a volume
of a storage or distribution medium, does not as a whole count
as a Modified Version of the Document, provided no compilation
copyright is claimed for the compilation. Such a compilation is
called an "aggregate", and this License does not apply to the other
self-contained works thus compiled with the Document, on account
of their being thus compiled, if they are not themselves derivative
works of the Document.</para>
<para>If the Cover Text requirement of section 3 is applicable to
these copies of the Document, then if the Document is less than
one quarter of the entire aggregate, the Document's Cover Texts
may be placed on covers that surround only the Document within
the aggregate. Otherwise they must appear on covers around the
whole aggregate.</para>
</sect3>
<sect3 id="gfdl-8"> <title>TRANSLATION</title>
<para>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include
a translation of this License provided that you also include the
original English version of this License. In case of a disagreement
between the translation and the original English version of this
License, the original English version will prevail.</para>
</sect3>
<sect3 id="gfdl-9"> <title>TERMINATION</title> <para>You may not copy,
modify, sublicense, or distribute the
Document except as expressly provided for under this License.
Any other attempt to copy, modify, sublicense or distribute the