diff --git a/Documentation/DBusKit.texi b/Documentation/DBusKit.texi new file mode 100644 index 0000000..8a0c19f --- /dev/null +++ b/Documentation/DBusKit.texi @@ -0,0 +1,66 @@ +\input texinfo @c -*-texinfo-*- + +@c %**start of header +@setfilename DBusKit.info +@settitle GNUstep D-Bus Programming Manual +@c %**end of header + +@ifinfo +@format +INFO-DIR-SECTION GNUstep +START-INFO-DIR-ENTRY +* DBusKit: (DBusKit). DBusKit library and D-Bus Programming Manual +END-INFO-DIR-ENTRY +@end format +@end ifinfo + +@ifinfo +Copyright @copyright{} 2010 Free Software Foundation + +Permission is granted to copy, distribute and/or modify this +document under the terms of the GNU Free Documentation License, +Version 1.3 or any later version published by the Free Software +Foundation; with no Invariant Sections, no Front-Cover Texts and +no Back-Cover Texts. A copy of the license is included in the +section entitled ``GNU Free Documentation License''. +@end ifinfo + +@setchapternewpage odd +@titlepage + +@title GNUstep +@title DBusKit and D-Bus +@title Programming Manual + +@author Niels Grewe + +@page +@vskip 0pt plus 1filll +Copyright @copyright{} 2010 Free Software Foundation + +Permission is granted to copy, distribute and/or modify this +document under the terms of the GNU Free Documentation License, +Version 1.3 or any later version published by the Free Software +Foundation; with no Invariant Sections, no Front-Cover Texts and +no Back-Cover Texts. A copy of the license is included in the +section entitled ``GNU Free Documentation License''. +@end titlepage + +@contents + +@ifinfo +@node Top +@top GNUstep D-Bus Programming Manual +@menu +* Introduction:: An introduction to the Distributed Objects and D-Bus IPC mechanisms +* GNU Free Documentation License::The license terms of this document +@end menu +@end ifinfo +@c Chapter 1: Introduction +@include Introduction.texi +@c Appendix A: GNU Free Documentation License +@include fdl-1.3.texi + +@unnumbered Concept Index +@printindex cp +@bye diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile new file mode 100644 index 0000000..bbd228c --- /dev/null +++ b/Documentation/GNUmakefile @@ -0,0 +1,11 @@ +include $(GNUSTEP_MAKEFILES)/common.make + +DOCUMENT_NAME = DBusKit + +DBusKit_TEXI_FILES = DBusKit.texi \ + Introduction.texi \ + fdl-1.3.texi + +AppKit_DOC_INSTALL_DIR = Developer/DBusKit/ProgrammingManual + +include $(GNUSTEP_MAKEFILES)/documentation.make diff --git a/Documentation/Introduction.texi b/Documentation/Introduction.texi new file mode 100644 index 0000000..2e5d63e --- /dev/null +++ b/Documentation/Introduction.texi @@ -0,0 +1,165 @@ +@c This file is part of the GNUstep DBusKit and D-Bus Programming Manual +@c Copyright (C) 2010 +@c Free Software Foundation, Inc. +@c See the file DBusKit.texi for copying conditions. + +@paragraphindent 0 +@node Introduction +@chapter Introduction + +The aim of this manual is to familiarise the reader with the concepts +and tools necessary to successfully integrate a GNUstep application into +a desktop environment based around message exchange through the D-Bus +messaging bus facilities. It tries to give succinct explanation of the +concepts involved, providing illustrative examples whenever possibles. + +This manual will be most useful to a reader who has basic working +knowledge of the Objective-C programming language and the OpenStep APIs +(either from the GNUstep implementation or from Apple's Cocoa). In depth +knowledge of the Distributed Objects system or D-Bus is also beneficial, +but not required. + +@section An IPC primer +@cindex IPC +@cindex inter-process communication +A typical modern computer system executes multiple units of computation +at the same time. Even with a single-core CPU, the operating system will +constantly switch between different units of computation by employing +different multitasking strategies. This approach has a number of +advantages, e.g.: +@itemize @bullet +@item +It makes it easy to isolate processes from one another: A +malignant process cannot easily modify the memory of other processes on +the system. +@item +It allows privilege separation: It is not necessary that a +web-browser has the same rights as a partitioning utility. Running both +in different processes allows the operating system to assign different +privileges to both. +@item +It increases modularity: You can easily change one part of the +software on your computer without disturbing the other parts. +@item + If the computer has more than one CPU, computation can be sped up +by running more than one process (or thread) in parallel. +@end itemize +To leverage these advantages effectively, different processes or +applications need a mechanism for inter-process communication (IPC) that +allows them to exchange information (and ensure synchronisation if +needed). + +@cindex Message passing +One way to implement an IPC mechanism is by use of the message passing +paradigm. Entities in a message passing system communicate by exchanging +messages with each other, which makes it a natural fit for object +oriented languages, where the basic abstraction is the object. + +The message passing paradigm is also used in Objective-C (actually +Objective-C inherited it from Smalltalk), where you interact with +objects by sending messages to them. E.g. the intended meaning of +@example +[alice greet]; +@end example +would be sending the @code{-greet} message to the @code{alice} object, +which is referred to as the @emph{receiver} of the message. This idiom +can be quite easily extended beyond the single process case, which the +NeXT did by including the @emph{Distributed Objects} system in the +OpenStep specification that GNUstep implements. The message passing +paradigm is also employed by D-Bus an we will look at the similarities +and differences of both systems in the following sections. + +@section Distributed Objects +@cindex Distributed Objects +@cindex DO + +The GNUstep Distributed Objects (DO) System is designed to go out of a +programmer's way. Since ordinary (intra-process) usage Objective-C +already has message passing semantics, Distributed Objects simply +extends these semantics to objects in other processes. + +This works by usage of the proxy design pattern. A proxy is a stand-in +object that receives messages @emph{in lieu} of another object and +forwards them (most likely after processing them as it sees fit). In the +case of Distributed Objects, the proxy will take the message that is +being sent to the remote object, encode it an @code{NSInvocation} +object and send a serialised version of the invocation to the remote +process where it is invoked on the receiver it was initially intended +for. + +Establishing a connection to a remote object using DO is thus a simple +three step process: +@enumerate +@item Look up a process that exposes ('vends', in DO parlance) an object. +@item Establish a communications channel to the process. +@item Create a proxy object to send messages to the remote object. +@end enumerate +Afterwards, the generated proxy can be used just like any in-process +object. + +Task 1. involves the @code{NSPortNameServer} class which can be used to +obtain a communication endpoint (@code{NSPort}) to a service with a +specific name: +@example +NSPort *sendPort = [[NSPortNameServer systemDefaultPortNameServer] + portForName: @@"MyService"]; +@end example +Task 2. involves @code{NSPort} and @code{NSConnection}. While the former +is concerned with the low-level details of encoding messages to a wire +format, the latter manages sending messages over ports. A connection to +the above @code{MyService} using the created @code{sendPort} could be +obtained like this: +@example +NSConnection *c = [NSConnection connectionWithReceivePort: [NSPort port] + sendPort: sendPort]; +@end example + +3. is done by calling @code{-rootProxy} on the @code{NSConnection} +object. This will return an instance of @code{NSDistantObject}: A proxy +that will use @code{NSConnection} and @code{NSPort} to forward messages +to the remote object. +@example +id *remoteObject = [c rootProxy]; +@end example + +The DO mode of operation has a few notable advantages: +@itemize @bullet +@item Usual message passing semantics apply. +@item The native Objective-C type system is used in both processes. No +type conversion is necessary. +@item New objects can be vended implicitly by returning them from the +root proxy. New proxies will be created automatically for them. +@item DO can make intelligent decisions about the remote objects: If +process @emph{A} has vended object @emph{O} to process @emph{B} +(yielding the proxy @emph{P(O)}, and @emph{B} latter vends +@emph{P(O)} to @emph{A}, @emph{A} will not use @emph{P(P(O))}, but its +local reference to @emph{O}. +@end itemize +It goes without saying that DO is pretty useful and GNUstep uses it in +many places. It drives, for example, the services architecture, the pasteboard +server, or the distributed notification system. For further information +about DO, please consult the +@uref{../../Base/ProgrammingManual/manual_7.html, Objective-C GNUstep +Base Programming Manual}. We will now turn our attention to the D-Bus +IPC system. + +@section D-Bus +@cindex D-Bus + +Distributed Objects has already been part of NeXT's OpenStep +Specification, which appeared in 1994 and thus predates the D-Bus IPC +system for quite some time. But while DO is only useful in an +Objective-C context, D-Bus was created to suit the needs of desktop +environments such as KDE or GNOME, which are (among others) using C or +C++ as their core programming languages. +@subsection Message Busses +One core concept of D-Bus is that of the message bus, which manages +name resolution and message exchange between applications. On a standard +desktop system, there usually are two message busses active, dubbed the +@emph{well-known busses}. One is the @emph{system bus}, to which +system-wide services connect, the other is the @emph{session bus} which +is started per user session and allows applications on the user's +desktop to communicate. +@subsection Services +@subsection Object Paths +@subsection Interfaces diff --git a/Documentation/fdl-1.3.texi b/Documentation/fdl-1.3.texi new file mode 100644 index 0000000..dd8297d --- /dev/null +++ b/Documentation/fdl-1.3.texi @@ -0,0 +1,508 @@ +@node GNU Free Documentation License +@appendix The GNU Free Documentation License +@c The GNU Free Documentation License. +@center Version 1.3, 3 November 2008 + +@c This file is intended to be included within another document, +@c hence no sectioning command or @node. + +@display +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +@uref{http://fsf.org/} + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +@end display + +@enumerate 0 +@item +PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document @dfn{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. + +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. + +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. + +@item +APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The ``Document'', below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as ``you''. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +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. + +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. (Thus, 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. + +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. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +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. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A ``Transparent'' copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +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, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not ``Transparent'' is called ``Opaque''. + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include 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, +PostScript or PDF produced by some word processors for +output purposes only. + +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. + +The ``publisher'' means any person or entity that distributes copies +of the Document to the public. + +A section ``Entitled XYZ'' means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as ``Acknowledgements'', +``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' +of such a section when you modify the Document means that it remains a +section ``Entitled XYZ'' according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +@item +VERBATIM COPYING + +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. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + +@item +COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) 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. + +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. + +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 computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +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. + +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. + +@item +MODIFICATIONS + +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: + +@enumerate A +@item +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. + +@item +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 fewer than five), +unless they release you from this requirement. + +@item +State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +@item +Preserve all the copyright notices of the Document. + +@item +Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +@item +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. + +@item +Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document's license notice. + +@item +Include an unaltered copy of this License. + +@item +Preserve the section Entitled ``History'', Preserve 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. + +@item +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. + +@item +For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +@item +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. + +@item +Delete any section Entitled ``Endorsements''. Such a section +may not be included in the Modified Version. + +@item +Do not retitle any existing section to be Entitled ``Endorsements'' or +to conflict in title with any Invariant Section. + +@item +Preserve any Warranty Disclaimers. +@end enumerate + +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. + +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. + +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. + +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. + +@item +COMBINING DOCUMENTS + +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, and that you preserve all their Warranty Disclaimers. + +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. + +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.'' + +@item +COLLECTIONS OF DOCUMENTS + +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. + +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. + +@item +AGGREGATION WITH INDEPENDENT WORKS + +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, is called an ``aggregate'' if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + +@item +TRANSLATION + +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, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled ``Acknowledgements'', +``Dedications'', or ``History'', the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + +@item +TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + +@item +FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +@uref{http://www.gnu.org/copyleft/}. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License ``or any later version'' applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +@item +RELICENSING + +``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the +site means any set of copyrightable works thus published on the MMC +site. + +``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +``Incorporate'' means to publish or republish a Document, in whole or +in part, as part of another Document. + +An MMC is ``eligible for relicensing'' if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + +@end enumerate + +@page +@heading ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + +@smallexample +@group + Copyright (C) @var{year} @var{your name}. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. +@end group +@end smallexample + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the ``with@dots{}Texts.'' line with this: + +@smallexample +@group + with the Invariant Sections being @var{list their titles}, with + the Front-Cover Texts being @var{list}, and with the Back-Cover Texts + being @var{list}. +@end group +@end smallexample + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. + +@c Local Variables: +@c ispell-local-pdict: "ispell-dict" +@c End: +