1 <?xml version="1.0" encoding="ISO-8859-1"?>
\r
3 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" []>
\r
8 <!-- Use "HOWTO", "mini HOWTO", "FAQ" in title, if appropriate -->
\r
9 <title>Mono Beginners HOWTO for Windows users</title>
\r
12 <firstname>Jaime</firstname>
\r
13 <surname>Anguiano Olarra</surname>
\r
15 <address><email>jaime@geneura.ugr.es</email></address>
\r
20 <firstname>Hinne</firstname>
\r
21 <surname>Hettema</surname>
\r
23 <address><email>h.hettema@auckland.ac.nz</email></address>
\r
27 <pubdate>2002-08</pubdate>
\r
29 <!-- Most recent revision goes at the top; list in descending order -->
\r
30 <!-- All dates specified in ISO "YYYY-MM-DD" format -->
\r
33 <revnumber>0.1</revnumber>
\r
34 <date>2002-08-05</date>
\r
35 <authorinitials>JA</authorinitials>
\r
36 <revremark>First release</revremark>
\r
40 <!-- Provide a good abstract; a couple of sentences is sufficient -->
\r
43 The goal of this document is to guide people through the setup of a Mono
\r
44 framework in a Windows box. Because some people might want to just test
\r
45 Mono a bit and use the compiler, etc, I have made two distinctions, one
\r
46 for the Mono user that only wants to get precompiled binaries and another
\r
47 for the one how wants to build Mono from the CVS and probably contribute
\r
48 to the project actively. Each kind of user has to read the corresponding
\r
49 part of this document. I hope a lot of Windows users will get a nice
\r
50 approach to the free software world by starting using Mono.
\r
57 <title>Introduction</title>
\r
60 Mono is an open source implementation of the Common Language Infrastructure
\r
61 (CLI) specified in ECMA standard 335. It comes with a C# compiler and
\r
62 provides an extensible platform to develop and run applications that
\r
63 are interoperable with Microsoft .NET.
\r
67 Mono is not finished--it is a project still under development. As a
\r
68 result, installation and configuration may not be as smooth as you
\r
69 will be used to from other Linux or Windows applications. Nevertheless,
\r
70 mono is in a state that will allow you to get it up and running and gain
\r
71 experience with it--which is, I would suggest, a very smart thing to do.
\r
75 This document is aimed at the mono beginner, and aims to present a complete
\r
76 view of a minimal installation, which will allow you to experiment with
\r
77 mono to some degree. It also describes some of those experiments. We
\r
78 expect that after reading this document you'll go on to do either of
\r
84 Continue to contribute to the mono project in some shape or form. The
\r
85 website has some ideas and suggestions under the heading 'Contributing'.
\r
90 Continue to write applications that run in mono.
\r
96 We hope this document will be useful to you in your first steps with mono.
\r
100 <sect2 id="disclaimer"> <title>Disclaimer</title>
\r
103 No liability for the contents of this document can be accepted.
\r
104 Use the concepts, examples and information at your own risk. There may
\r
105 be errors and inaccuracies, that could be damaging to your system.
\r
106 Proceed with caution, and although this is highly unlikely, the author(s)
\r
107 do not take any responsibility.
\r
111 All copyrights are held by their by their respective owners,
\r
112 unless specifically noted otherwise. Use of a term in this document
\r
113 should not be regarded as affecting the validity of any trademark or
\r
114 service mark. Naming of particular products or brands should not be
\r
115 seen as endorsements.
\r
119 <!-- Give credit where credit is due...very important -->
\r
120 <sect2 id="credits"> <title>Credits / Contributors</title>
\r
122 <para> Credits are due to </para>
\r
125 <para>Hinne Hettema <email>h.hettema@auckland.ac.nz</email>
\r
126 for creating the xml template I used for this document, for
\r
127 reviewing and make an excellent job with the other HOWTO and
\r
128 for his feedback. As you can see a lot of his work has been
\r
129 included in this document too.
\r
141 <sect2 id="feedback"> <title>Feedback</title>
\r
144 Feedback is most certainly welcome for this document. Send your
\r
145 additions, comments and criticisms to the following email address:
\r
146 <email>mono-docs-list@ximian.com</email>. I am lurking on this list
\r
147 and will maintain this document as required.
\r
152 <!-- This is the preamble stuff over with the rest of document follows... -->
\r
153 <sect1 id="installation">
\r
154 <title> Installing Mono</title>
\r
156 <sect2 id="obtaining">
\r
157 <title>Obtaining Mono</title>
\r
159 In order to obtain the required software you just need to visit the
\r
160 Mono download page at http://www.go-mono.org/download or any of the
\r
165 You'll be able to complete everything in this document if you just install
\r
166 the runtime, but taking a look at the compiler package is well worth the
\r
167 effort. The compiler is written in C# and is 'self hosting' which means it
\r
168 is able to compile itself.
\r
172 This page also lists the current versions of the software
\r
173 mono depends on. Make sure that your system has all the
\r
174 required versions, otherwise mono won't compile.
\r
179 <sect2 id="easyinstall">
\r
180 <title>Installing Mono on Windows, the easy way</title>
\r
182 Oh. This is a very easy task now. If you just want to take a look at
\r
183 the possibilities of Mono get the Mono installer from the site of
\r
184 Johannes Roith <johannes\@jroith.de>:
\r
188 http://www.superin.informativ.net/mono/mono.htm. You can get a link in
\r
191 the download section of the Mono site too: http://www.go-mono.org/download
\r
194 Then you just need a Windows machine. Better use
\r
195 Windows 2000 Professional. </para>
\r
197 Once you've got it, run the installer.
\r
200 Remember, building your own Mono runtime and compiler from the sources
\r
201 is strongly recommended. You won't discover the power of Mono until
\r
202 you get it made this way. If you feel hungry about real programming with
\r
203 Mono, proceed like in the next section.
\r
207 <sect2 id="hardinstall">
\r
208 <title>Building Mono under Windows</title>
\r
212 1.- Get Windows 2000 Professional or any Windows System supporting .NET SDK.
\r
213 Avoid using XP and the redistributable version of the SDK (necessary for
\r
220 2.- Get the latest Cygwin distribution, be sure you install the GNU Build Tools
\r
221 packages. Take the openssh package if you plan to contribute to the project.
\r
222 If you feel insecure about the packages you need to install, install all of
\r
223 them, of course, Text, Admin, Games and Web are not necessary at all and you
\r
224 can pass of those. The fitness of your choice will depend of your knowledge
\r
225 on Linux and/or Cygwin. If in doubt install all.
\r
231 3.- Install the .NET SDK.
\r
236 4.- Install Cygwin.
\r
241 5.- Get http://www.go-mono.org/mono-build-w32.sh and put it into your home
\r
242 directory in the cygwin setup.
\r
248 6.- Enter your cygwin environment. If you have an account in the mono cvs, then
\r
249 export the variables as shown in http://www.go-mono.org/ccvs.html
\r
253 This means. Enter: export CVSROOT=user@mono-cvs.ximian.com:/cvs/public
\r
255 and export CVS_RSH=ssh
\r
258 If you have no account DO NOTHING.
\r
265 export ACLOCAL_FLAGS="-I /usr/local/share/aclocal"
\r
266 and this: export PKG_CONFIG_PATH="/usr/local/bin"
\r
272 8.- Run the script (mono-build-w32.sh)
\r
277 9.- All should work fine know and you should see it download what necessary and
\r
284 <sect2 id="errors">
\r
285 <title>Troubleshooting</title>
\r
287 If you have noticed problems during step 8 and the execution stops because of
\r
288 errors as I cannot find that or such library or alike, try to:
\r
294 1.- Create a directory mono-temp for example.
\r
300 2.- Move and unzip all the zips the mono-build script downloads to /usr/local
\r
301 to that new directory. Do it one by one, copying the content of the created
\r
302 subdirectories (include, bin, etc) to their respectives in /usr/local. Take
\r
303 care, some libraries like libglib... must go into /usr/local/bin and not
\r
304 into /usr/local/lib.
\r
310 3.- Jump into the /usr/local/mono directory and run ./autogen.sh
\r
316 4.- Then run ./configure and after it: make and finally: make install.
\r
323 <sect1 id="running">
\r
324 <title>Running mono</title>
\r
326 <title>Basic steps</title>
\r
328 To work with mono, you first have to create a C# program. Open up
\r
329 your favourite editor, and type in the following code:
\r
336 public static void Main(String[] args)
\r
338 Console.WriteLine("mono:: is alive and well...");
\r
340 for (int i = 0; i < args.Length; i++)
\r
341 Console.WriteLine("Argument {0} = {1}", i, args[i]);
\r
347 Save the file as hello.cs. To compile this into a working program,
\r
348 type mcs hello.cs. If you get the following:
\r
355 you know the compile worked fine. If you see some strange error
\r
356 messages including the word 'parser' somewhere, you made a mistake in
\r
357 your program. Fix this up first.
\r
361 You are now ready to execute your first mono program. To execute
\r
366 mono hello.exe arg1 arg2 arg 3
\r
369 (where we have given some arguments just for fun) and you'll
\r
374 mono:: is alive and well...
\r
382 As you can see, mono printed the line "mono:: is alive and well"
\r
383 and printed the list of arguments. This completes the creation
\r
384 and execution of your first mono program.
\r
388 <sect2 id="interpreter">
\r
389 <title>Interpreter</title>
\r
391 But mono will allow you to do more. First of all, mono is the
\r
392 compiled mono execution environment which uses the Just in
\r
393 Time (JIT) compiler. Mono also comes with an interpreted
\r
394 environment, which can be accessed using the command 'mint'
\r
398 mint hello.exe arg1 arg 2
\r
399 mono:: is alive and well...
\r
405 As you can see, it makes no difference to mono output which
\r
406 environment you use, but what happens under the hood is very
\r
407 different. If you use 'mono' as the command line tool, you
\r
408 call the 'production' execution environment which will read
\r
409 your portable executable (PE) file, and call the just in
\r
410 time (JIT) compiler to compile the PE code down to machine
\r
411 level code (in my case, an x86 architecture) after which
\r
415 If you use mint, the JIT is not used, and the PE code is
\r
416 interpreted into x86 instructions for execution. In fact,
\r
417 for our simple 'hello' mint is slightly faster. The point
\r
418 is that the JIT compiler will take some time to compile the
\r
419 code of our program and store it in some location in memory,
\r
420 but the subsequent execution of the code is faster with mono.
\r
424 After this simple run of mono, it is time to play with some options.
\r
425 I won't cover these in detail since there are quite a few, and also because
\r
426 I assume you downloaded mono to hack it around in the first place. So
\r
427 I'll leave some pointers.
\r
431 <sect3 id="debugging">
\r
432 <title>Debugging</title>
\r
434 Mono supports a debugging option when you specify the "-d" flag while running
\r
435 the runtime. Utilising this flag will get you a significant amount of output,
\r
436 and it may be an idea to specify an output file as well. The interesting aspect
\r
437 of this file is that it allows you to see to some extent (quite precisely,
\r
438 actually) what the JIT compiler is up to.
\r
442 <sect3 id="statistics">
\r
443 <title>Statistics</title>
\r
445 It is also possible to collect some runtime statistics on your program. These
\r
446 will give you some idea of the resource utilisation of your program.
\r
449 mono --stats hello.exe
\r
450 mono:: is alive and well...
\r
452 Mono Jit statistics
\r
453 Compiled methods: 58
\r
454 Methods cache lookup: 15
\r
455 Method trampolines: 698
\r
457 Max basic blocks: 15
\r
458 Allocated vars: 238
\r
459 Analyze stack repeat: 61
\r
460 Compiled CIL code size: 2450
\r
461 Native code size: 10167
\r
462 Max code size ratio: 7.13 (FileStream::FlushBuffer)
\r
463 Biggest method: 1016 (StreamWriter::Write)
\r
465 Allocated code size: 22073
\r
466 Inlineable methods: 17
\r
467 Inlined methods: 22
\r
469 Created object count: 18
\r
470 Initialized classes: 127
\r
472 Static data size: 288
\r
473 VTable data size: 8292
\r
479 <sect2 id="ILAsm_code" >
\r
480 <title>Inspecting IL Assembly code</title>
\r
482 Mono also provides a small tool that will let you disassemble
\r
483 the executable (.exe) file so you can have a peek
\r
484 under the hood. This tool is monodis, and is run as
\r
490 .assembly extern mscorlib
\r
496 .hash algorithm 0x00008004
\r
499 .class private auto ansi beforefieldinit Hello
\r
500 extends [mscorlib]System.Object
\r
504 .method public hidebysig specialname rtspecialname
\r
505 instance default void .ctor() cil managed
\r
507 // Method begins at RVA 0x20ec
\r
508 // Code size 7 (0x7)
\r
511 IL_0001: call instance void System.Object::.ctor()
\r
513 } // end of method instance default void .ctor()
\r
516 .method public static
\r
517 default void Main(string[] args) cil managed
\r
519 // Method begins at RVA 0x20f4
\r
521 // Code size 56 (0x38)
\r
526 IL_0000: ldstr "mono:: is alive and well..."
\r
527 IL_0005: call void System.Console::WriteLine(string)
\r
534 IL_0012: brfalse IL_0037
\r
536 IL_0017: ldstr "Argument {0} = {1}"
\r
538 IL_001d: box [mscorlib]System.Int32
\r
541 IL_0025: ldelem.ref
\r
542 IL_0026: call void System.Console::WriteLine(string, object, object)
\r
550 IL_0032: br IL_000c
\r
553 } // end of method default void Main(string[] args)
\r
555 } // end of type Hello
\r
560 This is the listing of the code of your program in a language
\r
561 called IL assembly, or Common Intermediate Language (CIL). The
\r
562 CIL provides the portability of the mono platform, and ensures
\r
563 that code compiled with Microsoft's .NET framework will work
\r
564 on mono and vice versa.
\r
568 <sect2 id="man_pages">
\r
569 <title>Man pages</title>
\r
572 Mono has man pages already installed, and generally, typing <command>
\r
573 man</command> before the command you wish to execute should help in
\r
574 getting a list of the options. In many cases, it's still up to you
\r
575 to figure out what they do.
\r
584 <sect1 id="problems">
\r
585 <title>Problems</title>
\r
587 With mono being as new as it is, it is likely that you will have some
\r
588 problems with installation. The following are some ideas to help you
\r
595 See the Ximian Bugzilla page to find out if there is a bug
\r
596 report about your specific issue.
\r
601 <para>Read this document. If it does not solve your problem, we want to
\r
602 know about it. Please send a message to the email address listed for
\r
603 feedback at the beginning of the document.</para>
\r
609 Visit the mono mailing lists' archives and do a little
\r
610 research in there for threads talking about the problem you have.
\r
616 If you still cannot correct the problem, send a message to the
\r
617 mono list. When you do this, please be as precise as possible--i.e.
\r
618 mention the system you are running, the version of mono that you have the
\r
619 problem with, and give any error codes and other output that might appear.
\r
627 <!-- Legal Sections --> <sect1 id="copyright">
\r
628 <title>Copyright and License</title>
\r
630 <!-- The LDP recommends, but doesn't require, the GFDL --> <para>
\r
631 This document, <emphasis>Running mono</emphasis>, is copyrighted
\r
632 (c) 2002 by <emphasis>Hinne Hettema</emphasis> and
\r
633 <emphasis>Jaime Anguiano Olarra</emphasis>. Permission is
\r
634 granted to copy, distribute and/or modify this document under the
\r
635 terms of the GNU Free Documentation License, Version 1.1 or any later
\r
636 version published by the Free Software Foundation; with no Invariant
\r
637 Sections, with no Front-Cover Texts, and with no Back-Cover Texts.
\r
638 A copy of the license is included in the section entitled "GNU Free
\r
639 Documentation License".
\r
642 <sect2 id="gfdl"> <title>GNU Free Documentation License</title>
\r
643 <!-- GNU Project - Free Software Foundation (FSF) -->
\r
645 <para>Version 1.1, March 2000</para>
\r
647 <blockquote> <para>Copyright (C) 2000 Free Software Foundation, Inc.
\r
648 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is
\r
649 permitted to copy and distribute verbatim copies of this license document,
\r
650 but changing it is not allowed.</para> </blockquote>
\r
652 <sect3 id="gfdl-0"> <title>PREAMBLE</title>
\r
654 <para>The purpose of this License is to make a manual, textbook,
\r
655 or other written document "free" in the sense of freedom: to assure
\r
656 everyone the effective freedom to copy and redistribute it, with
\r
657 or without modifying it, either commercially or noncommercially.
\r
658 Secondarily, this License preserves for the author and publisher
\r
659 a way to get credit for their work, while not being considered
\r
660 responsible for modifications made by others.</para>
\r
662 <para>This License is a kind of "copyleft", which means that
\r
663 derivative works of the document must themselves be free in the
\r
664 same sense. It complements the GNU General Public License, which
\r
665 is a copyleft license designed for free software.</para>
\r
667 <para>We have designed this License in order to use it for manuals
\r
668 for free software, because free software needs free documentation:
\r
669 a free program should come with manuals providing the same freedoms
\r
670 that the software does. But this License is not limited to software
\r
671 manuals; it can be used for any textual work, regardless of subject
\r
672 matter or whether it is published as a printed book. We recommend
\r
673 this License principally for works whose purpose is instruction
\r
674 or reference.</para>
\r
677 <sect3 id="gfdl-1"> <title>APPLICABILITY AND DEFINITIONS</title>
\r
679 <para>This License applies to any manual or other work that
\r
680 contains a notice placed by the copyright holder saying it can be
\r
681 distributed under the terms of this License. The "Document", below,
\r
682 refers to any such manual or work. Any member of the public is a
\r
683 licensee, and is addressed as "you".</para>
\r
685 <para>A "Modified Version" of the Document means any work
\r
686 containing the Document or a portion of it, either copied verbatim,
\r
687 or with modifications and/or translated into another language.</para>
\r
689 <para>A "Secondary Section" is a named appendix or a front-matter
\r
690 section of the Document that deals exclusively with the relationship
\r
691 of the publishers or authors of the Document to the Document's overall
\r
692 subject (or to related matters) and contains nothing that could fall
\r
693 directly within that overall subject. (For example, if the Document
\r
694 is in part a textbook of mathematics, a Secondary Section may not
\r
695 explain any mathematics.) The relationship could be a matter of
\r
696 historical connection with the subject or with related matters, or
\r
697 of legal, commercial, philosophical, ethical or political position
\r
698 regarding them.</para>
\r
700 <para>The "Invariant Sections" are certain Secondary Sections
\r
701 whose titles are designated, as being those of Invariant Sections,
\r
702 in the notice that says that the Document is released under this
\r
705 <para>The "Cover Texts" are certain short passages of text that
\r
706 are listed, as Front-Cover Texts or Back-Cover Texts, in the notice
\r
707 that says that the Document is released under this License.</para>
\r
709 <para>A "Transparent" copy of the Document means a
\r
710 machine-readable copy, represented in a format whose specification
\r
711 is available to the general public, whose contents can be viewed and
\r
712 edited directly and straightforwardly with generic text editors
\r
713 or (for images composed of pixels) generic paint programs or
\r
714 (for drawings) some widely available drawing editor, and that is
\r
715 suitable for input to text formatters or for automatic translation
\r
716 to a variety of formats suitable for input to text formatters.
\r
717 A copy made in an otherwise Transparent file format whose markup
\r
718 has been designed to thwart or discourage subsequent modification
\r
719 by readers is not Transparent. A copy that is not "Transparent"
\r
720 is called "Opaque".</para>
\r
722 <para>Examples of suitable formats for Transparent copies include
\r
723 plain ASCII without markup, Texinfo input format, LaTeX input format,
\r
724 SGML or XML using a publicly available DTD, and standard-conforming
\r
725 simple HTML designed for human modification. Opaque formats include
\r
726 PostScript, PDF, proprietary formats that can be read and edited
\r
727 only by proprietary word processors, SGML or XML for which the
\r
728 DTD and/or processing tools are not generally available, and the
\r
729 machine-generated HTML produced by some word processors for output
\r
730 purposes only.</para>
\r
732 <para>The "Title Page" means, for a printed book, the title page
\r
733 itself, plus such following pages as are needed to hold, legibly,
\r
734 the material this License requires to appear in the title page.
\r
735 For works in formats which do not have any title page as such,
\r
736 "Title Page" means the text near the most prominent appearance of the
\r
737 work's title, preceding the beginning of the body of the text.</para>
\r
740 <sect3 id="gfdl-2"> <title>VERBATIM COPYING</title>
\r
742 <para>You may copy and distribute the Document in any medium,
\r
743 either commercially or noncommercially, provided that this License,
\r
744 the copyright notices, and the license notice saying this License
\r
745 applies to the Document are reproduced in all copies, and that
\r
746 you add no other conditions whatsoever to those of this License.
\r
747 You may not use technical measures to obstruct or control the
\r
748 reading or further copying of the copies you make or distribute.
\r
749 However, you may accept compensation in exchange for copies. If you
\r
750 distribute a large enough number of copies you must also follow the
\r
751 conditions in section 3.</para>
\r
753 <para>You may also lend copies, under the same conditions stated
\r
754 above, and you may publicly display copies.</para>
\r
757 <sect3 id="gfdl-3"> <title>COPYING IN QUANTITY</title>
\r
759 <para>If you publish printed copies of the Document numbering more
\r
760 than 100, and the Document's license notice requires Cover Texts, you
\r
761 must enclose the copies in covers that carry, clearly and legibly,
\r
762 all these Cover Texts: Front-Cover Texts on the front cover, and
\r
763 Back-Cover Texts on the back cover. Both covers must also clearly
\r
764 and legibly identify you as the publisher of these copies. The front
\r
765 cover must present the full title with all words of the title equally
\r
766 prominent and visible. You may add other material on the covers
\r
767 in addition. Copying with changes limited to the covers, as long as
\r
768 they preserve the title of the Document and satisfy these conditions,
\r
769 can be treated as verbatim copying in other respects.</para>
\r
771 <para>If the required texts for either cover are too voluminous to
\r
772 fit legibly, you should put the first ones listed (as many as fit
\r
773 reasonably) on the actual cover, and continue the rest onto adjacent
\r
776 <para>If you publish or distribute Opaque copies of the Document
\r
777 numbering more than 100, you must either include a machine-readable
\r
778 Transparent copy along with each Opaque copy, or state in or with each
\r
779 Opaque copy a publicly-accessible computer-network location containing
\r
780 a complete Transparent copy of the Document, free of added material,
\r
781 which the general network-using public has access to download
\r
782 anonymously at no charge using public-standard network protocols.
\r
783 If you use the latter option, you must take reasonably prudent steps,
\r
784 when you begin distribution of Opaque copies in quantity, to ensure
\r
785 that this Transparent copy will remain thus accessible at the stated
\r
786 location until at least one year after the last time you distribute
\r
787 an Opaque copy (directly or through your agents or retailers) of
\r
788 that edition to the public.</para>
\r
790 <para>It is requested, but not required, that you contact the
\r
791 authors of the Document well before redistributing any large number
\r
792 of copies, to give them a chance to provide you with an updated
\r
793 version of the Document.</para>
\r
796 <sect3 id="gfdl-4"> <title>MODIFICATIONS</title>
\r
798 <para>You may copy and distribute a Modified Version of the
\r
799 Document under the conditions of sections 2 and 3 above, provided
\r
800 that you release the Modified Version under precisely this License,
\r
801 with the Modified Version filling the role of the Document, thus
\r
802 licensing distribution and modification of the Modified Version
\r
803 to whoever possesses a copy of it. In addition, you must do these
\r
804 things in the Modified Version:</para>
\r
806 <orderedlist numeration="upperalpha"> <listitem><para>Use in the
\r
808 (and on the covers, if any) a title distinct from that of the
\r
809 Document, and from those of previous versions (which should, if
\r
810 there were any, be listed in the History section of the Document).
\r
811 You may use the same title as a previous version if the original
\r
812 publisher of that version gives permission.</para>
\r
815 <listitem><para>List on the Title Page,
\r
816 as authors, one or more persons or entities responsible for
\r
817 authorship of the modifications in the Modified Version, together
\r
818 with at least five of the principal authors of the Document (all
\r
819 of its principal authors, if it has less than five).</para>
\r
822 <listitem><para>State on the Title page
\r
823 the name of the publisher of the Modified Version, as the
\r
827 <listitem><para>Preserve all the
\r
828 copyright notices of the Document.</para>
\r
831 <listitem><para>Add an appropriate
\r
832 copyright notice for your modifications adjacent to the other
\r
833 copyright notices.</para>
\r
836 <listitem><para>Include, immediately
\r
837 after the copyright notices, a license notice giving the public
\r
838 permission to use the Modified Version under the terms of this
\r
839 License, in the form shown in the Addendum below.</para>
\r
842 <listitem><para>Preserve in that license
\r
843 notice the full lists of Invariant Sections and required Cover
\r
844 Texts given in the Document's license notice.</para>
\r
847 <listitem><para>Include an unaltered
\r
848 copy of this License.</para>
\r
851 <listitem><para>Preserve the section
\r
852 entitled "History", and its title, and add to it an item stating at
\r
853 least the title, year, new authors, and publisher of the Modified
\r
854 Version as given on the Title Page. If there is no section entitled
\r
855 "History" in the Document, create one stating the title, year,
\r
856 authors, and publisher of the Document as given on its Title Page,
\r
857 then add an item describing the Modified Version as stated in the
\r
858 previous sentence.</para>
\r
861 <listitem><para>Preserve the network
\r
862 location, if any, given in the Document for public access to
\r
863 a Transparent copy of the Document, and likewise the network
\r
864 locations given in the Document for previous versions it was
\r
865 based on. These may be placed in the "History" section. You may
\r
866 omit a network location for a work that was published at least four
\r
867 years before the Document itself, or if the original publisher of
\r
868 the version it refers to gives permission.</para>
\r
871 <listitem><para>In any section entitled
\r
872 "Acknowledgements" or "Dedications", preserve the section's title,
\r
873 and preserve in the section all the substance and tone of each
\r
874 of the contributor acknowledgements and/or dedications given
\r
878 <listitem><para>Preserve all the
\r
879 Invariant Sections of the Document, unaltered in their text and in
\r
880 their titles. Section numbers or the equivalent are not considered
\r
881 part of the section titles.</para>
\r
884 <listitem><para>Delete any section
\r
885 entitled "Endorsements". Such a section may not be included in
\r
886 the Modified Version.</para>
\r
889 <listitem><para>Do not retitle any
\r
890 existing section as "Endorsements" or to conflict in title with
\r
891 any Invariant Section.</para>
\r
892 </listitem> </orderedlist> <para>If the Modified Version includes new
\r
893 front-matter sections
\r
894 or appendices that qualify as Secondary Sections and contain no
\r
895 material copied from the Document, you may at your option designate
\r
896 some or all of these sections as invariant. To do this, add their
\r
897 titles to the list of Invariant Sections in the Modified Version's
\r
898 license notice. These titles must be distinct from any other section
\r
901 <para>You may add a section entitled "Endorsements", provided it
\r
902 contains nothing but endorsements of your Modified Version by various
\r
903 parties--for example, statements of peer review or that the text has
\r
904 been approved by an organization as the authoritative definition of
\r
907 <para>You may add a passage of up to five words as a Front-Cover
\r
908 Text, and a passage of up to 25 words as a Back-Cover Text, to the end
\r
909 of the list of Cover Texts in the Modified Version. Only one passage
\r
910 of Front-Cover Text and one of Back-Cover Text may be added by (or
\r
911 through arrangements made by) any one entity. If the Document already
\r
912 includes a cover text for the same cover, previously added by you or
\r
913 by arrangement made by the same entity you are acting on behalf of,
\r
914 you may not add another; but you may replace the old one, on explicit
\r
915 permission from the previous publisher that added the old one.</para>
\r
917 <para>The author(s) and publisher(s) of the Document do not by
\r
918 this License give permission to use their names for publicity for
\r
919 or to assert or imply endorsement of any Modified Version.</para>
\r
922 <sect3 id="gfdl-5"> <title>COMBINING DOCUMENTS</title>
\r
924 <para>You may combine the Document with other documents released
\r
925 under this License, under the terms defined in section 4 above for
\r
926 modified versions, provided that you include in the combination all of
\r
927 the Invariant Sections of all of the original documents, unmodified,
\r
928 and list them all as Invariant Sections of your combined work in
\r
929 its license notice.</para>
\r
931 <para>The combined work need only contain one copy of this
\r
932 License, and multiple identical Invariant Sections may be replaced
\r
933 with a single copy. If there are multiple Invariant Sections with
\r
934 the same name but different contents, make the title of each such
\r
935 section unique by adding at the end of it, in parentheses, the
\r
936 name of the original author or publisher of that section if known,
\r
937 or else a unique number. Make the same adjustment to the section
\r
938 titles in the list of Invariant Sections in the license notice of
\r
939 the combined work.</para>
\r
941 <para>In the combination, you must combine any sections entitled
\r
942 "History" in the various original documents, forming one section
\r
943 entitled "History"; likewise combine any sections entitled
\r
944 "Acknowledgements", and any sections entitled "Dedications".
\r
945 You must delete all sections entitled "Endorsements."</para>
\r
948 <sect3 id="gfdl-6"> <title>COLLECTIONS OF DOCUMENTS</title>
\r
950 <para>You may make a collection consisting of the Document and
\r
951 other documents released under this License, and replace the
\r
952 individual copies of this License in the various documents with a
\r
953 single copy that is included in the collection, provided that you
\r
954 follow the rules of this License for verbatim copying of each of
\r
955 the documents in all other respects.</para>
\r
957 <para>You may extract a single document from such a collection,
\r
958 and distribute it individually under this License, provided you
\r
959 insert a copy of this License into the extracted document, and follow
\r
960 this License in all other respects regarding verbatim copying of
\r
961 that document.</para>
\r
964 <sect3 id="gfdl-7"> <title>AGGREGATION WITH INDEPENDENT WORKS</title>
\r
965 <para>A compilation of the Document or its derivatives with other
\r
966 separate and independent documents or works, in or on a volume
\r
967 of a storage or distribution medium, does not as a whole count
\r
968 as a Modified Version of the Document, provided no compilation
\r
969 copyright is claimed for the compilation. Such a compilation is
\r
970 called an "aggregate", and this License does not apply to the other
\r
971 self-contained works thus compiled with the Document, on account
\r
972 of their being thus compiled, if they are not themselves derivative
\r
973 works of the Document.</para>
\r
975 <para>If the Cover Text requirement of section 3 is applicable to
\r
976 these copies of the Document, then if the Document is less than
\r
977 one quarter of the entire aggregate, the Document's Cover Texts
\r
978 may be placed on covers that surround only the Document within
\r
979 the aggregate. Otherwise they must appear on covers around the
\r
980 whole aggregate.</para>
\r
983 <sect3 id="gfdl-8"> <title>TRANSLATION</title>
\r
985 <para>Translation is considered a kind of modification, so you may
\r
986 distribute translations of the Document under the terms of section 4.
\r
987 Replacing Invariant Sections with translations requires special
\r
988 permission from their copyright holders, but you may include
\r
989 translations of some or all Invariant Sections in addition to the
\r
990 original versions of these Invariant Sections. You may include
\r
991 a translation of this License provided that you also include the
\r
992 original English version of this License. In case of a disagreement
\r
993 between the translation and the original English version of this
\r
994 License, the original English version will prevail.</para>
\r
997 <sect3 id="gfdl-9"> <title>TERMINATION</title> <para>You may not copy,
\r
998 modify, sublicense, or distribute the
\r
999 Document except as expressly provided for under this License.
\r
1000 Any other attempt to copy, modify, sublicense or distribute the
\r
1001 Document is void, and will automatically terminate your rights under
\r
1002 this License. However, parties who have received copies, or rights,
\r
1003 from you under this License will not have their licenses terminated
\r
1004 so long as such parties remain in full compliance.</para>
\r
1007 <sect3 id="gfdl-10"> <title>FUTURE REVISIONS OF THIS LICENSE</title>
\r
1009 <para>The Free Software Foundation may publish new, revised
\r
1010 versions of the GNU Free Documentation License from
\r
1011 time to time. Such new versions will be similar
\r
1012 in spirit to the present version, but may differ in
\r
1013 detail to address new problems or concerns. See <ulink
\r
1014 url="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</ulink>.</para>
\r
1016 <para>Each version of the License is given a distinguishing
\r
1017 version number. If the Document specifies that a particular
\r
1018 numbered version of this License "or any later version" applies
\r
1019 to it, you have the option of following the terms and conditions
\r
1020 either of that specified version or of any later version that has
\r
1021 been published (not as a draft) by the Free Software Foundation.
\r
1022 If the Document does not specify a version number of this License,
\r
1023 you may choose any version ever published (not as a draft) by the
\r
1024 Free Software Foundation.</para>
\r
1027 <sect3 id="gfdl-11"> <title>How to use this License for your
\r
1030 <para>To use this License in a document you have written, include
\r
1031 a copy of the License in the document and put the following copyright
\r
1032 and license notices just after the title page:</para>
\r
1034 <blockquote><para> Copyright (c) YEAR YOUR NAME.
\r
1035 Permission is granted to copy, distribute and/or modify this
\r
1036 document under the terms of the GNU Free Documentation License,
\r
1037 Version 1.1 or any later version published by the Free Software
\r
1038 Foundation; with the Invariant Sections being LIST THEIR TITLES,
\r
1039 with the Front-Cover Texts being LIST, and with the Back-Cover
\r
1040 Texts being LIST. A copy of the license is included in the section
\r
1041 entitled "GNU Free Documentation License".
\r
1042 </para></blockquote>
\r
1044 <para>If you have no Invariant Sections, write "with no Invariant
\r
1045 Sections" instead of saying which ones are invariant. If you
\r
1046 have no Front-Cover Texts, write "no Front-Cover Texts" instead of
\r
1047 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.</para>
\r
1049 <para>If your document contains nontrivial examples of program
\r
1050 code, we recommend releasing these examples in parallel under your
\r
1051 choice of free software license, such as the GNU General Public
\r
1052 License, to permit their use in free software.</para>
\r
1053 </sect3> </sect2> </sect1>
\r
1060 <!-- This document is dedicated to all my friends and to the Mono hackers.
\r
1064 Here goes the GFDL, GNU Free Documentation License. -->
\r
projects / mono.git / blob