This manual describes version 0.2 of Quarry.
Copyright © 2004 Paul Pogonyshev
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 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” or in the file COPYING-DOCS distributed with this manual.
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE WITH THE FURTHER UNDERSTANDING THAT:
DOCUMENT IS PROVIDED ON AN “AS IS” BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER; AND
UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, INITIAL WRITER, ANY CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR LOSSES ARISING OUT OF OR RELATING TO USE OF THE DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES.
Feedback
To report a bug or make a suggestion regarding the Quarry application or this manual, either send a message to <quarry-dev@gna.org> or use Quarry bug tracker.
| Revision History | |
|---|---|
| Revision Quarry Manual V0.2 | October 2004 |
|
Paul Pogonyshev <pogonyshev@gmx.net> | |
Table of Contents
The Quarry application enables you to play the board games of Go, Amazons and Othello. You can play with computer programs or with another human, and save, view and edit game records.
Quarry provides the following features:
Nice resizeable board.
Support for GTP (Game Text Protocol) as an interface to game-playing programs. In particular, you can play with GNU Go.
Game records are stored in widely supported SGF FF[4] file format. Quarry has an extremely fast SGF parser, which is important if you have very large SGF files.
Note
Quarry itself can play neither Go, nor Amazons, nor Othello. To have a computer opponent, you need to find a program (i.e. GNU Go mentioned above) that supports GTP and register it in Quarry.
Simply type quarry in command line and press Return.
You can also have Quarry open one or more game records immediatly after you start it. Just type
quarry file1.sgf file2.sgf ...
in command line and press Return. Quarry will start with specified file(s) open.
Note
Filenames don't have to end in .sgf, but names of SGF files typically do have this suffix.
When you start Quarry, Control Center window is displayed:
The Control Center window consists of the following elements:
- New Game button
This button allows you to start a new game. It will pop up the New Game dialog where you can select the game (Go, Amazons or Othello), opponents and game-specific rules.
- Open Game Record button
This button allows you to select a game record for viewing and/or editing. Opening a game record this way does the same as specifying its filename on the command line.
- Preferences button
This button opens the Quarry Preferences dialog
To start a new game, click New Game button in the Quarry Control Center window. The New Game dialog will appear, where you can choose the kind of game you want and the opponents.
If you want to play against a computer program, you need to register it in Quarry first (once only, of course.) To do this, click the Manage Engine List button in the dialog.
For more information, see detailed description of New Game dialog.
You can open a game record in one of three ways:
Click the Open Game Record button in the Control Center window. Quarry will display the Open SGF File dialog. Select the file with the game record you want to open and click OK.
Choose File->Open menu item or simply press Ctrl+O in any opened Board window. Similarly to the previous case, Quarry will display the Open SGF File dialog.
When starting Quarry, specify the name of file (or several names at once) at the command line:
quarry file1.sgf file2.sgf ...
The specified file(s) will be opened automatically.
To save a game record, choose File->Save menu item in its Board window (or simply press Ctrl+S.) If the file does not yet have a filename, Quarry will display the Save As dialog. Enter the name for the file, then click OK.
If you want to save a game record under a different filename, chose File->Save As menu item. Enter a name for the file in the Save As dialog and click OK.
Note
Currently, Quarry displays a warning when overwriting a game record file. It is temporary and will be removed when Quarry is more mature. Meahwhile, you should not overwrite files created with other SGF editors as there is a small chance that some data will be lost.
To register a game-playing program in Quarry, first open the Preferences dialog and select GTP Engines category in its left pane. (You can also click the Manage Engine List button in the New Game dialog, which immediatly displays the GTP Engines category.)
Then click the Add button and, in the appeared dialog, enter the command line required to launch the program in GTP mode. You should consult the program's manual to find out how the command line should look like. For instance, command line for GNU Go should look this way (note the double hyphens):
gnugo --mode gtp --quiet
Other programs may require different options or no options at all.
The New Game dialog consists of two pages, Game & Players and Game Rules. When you open the dialog, the first page appears. When you click Next button, the second page is displayed, which is specific for each of three games—Go, Amazons and Othello.
On this page you can select one of three available games and the opponents. You can make selections in arbitrary order—first choose the game and then the opponents or the other way round. At any time, all playable combinations of games and computer players are marked with “Yes” icons, while all unplayable combinations are marked with “No” icons. The Next button is sensitive only when a playable combination of game and opponents is selected.
Note
Before playing against a computer program (i.e. GNU Go, you need to register it in Quarry. See GTP Engines section for how to do this.
Game & Players page conists of the following controls:
- Game section
Here you can select the game you want to play, either Go, Amazons or Othello (also known as Reversi). Note that most programs can play only one game.
- White Player and Black Player sections
This set of controls determines the opponents. Each opponent can be either a human or a computer program. For a human player you can specify her name (defaults to your name as reported by the system.) Computer opponent should be selected from the drop-down list. If the list does not contain the program you want to play against, click the Manage Engine List at the end of the dialog to register the program in Quarry.
Which player is to move first depends on the game. In Go and Othello black moves first, while in Amazons white has the first turn. You can always change sides with the Swap button to the right.
- Swap button
This button allows you to easily swap players' sides. It does nothing else but copying settings from White Player section to Black Player section and vice versa.
- Manage Engine List button
This button opens Quarry Preferences dialog at the GTP Engines page. A convenient way to register new program and/or modify parameters of the already registered ones just before starting a new game.
- Next button
When you are done with this page, click the Next button to tweak game specific rules on the next page.
On this page you can select the rules for the game. The page has two parts. The upper part is different for each of Go, Amazons and Othello games and contains game-specific rules. The lower part contains time limit settings controls and is the same for all three games. It is described last.
When you have selected the rules you want, click the Play button to start the game.
Go has many different rule sets that differ in scoring details, treating of some special positions etc. Currently, Quarry doesn't make any difference between them. However, existing rule controls should be enough in most cases.
- Board Size spin button
Choose the size of board for the game here. Go is traditionally played on 19×19 board. 9×9 and 13×13 boards are also common. Quarry doesn't limit you to these—choose any size between 5×5 and 25×25 inclusive.
- Handicap controls
When one of the players is weaker, it is common practice in Go to give him handicap stones. This gives her better chances to win and makes the game more challenging (and thus more interesting) for the stronger player. The weaker player is traditionally playing as black.
Quarry supports both fixed (also known as Japanese) and free (Chinese) handicaps. In the first case, handicap stones are placed following a traditional pattern, at hoshi points. Maximal fixed handicap is 9 stones. With free handicap, on the other hand, black player actively places the handicap stones at any intersections on the board. Free handicap is practically not limited.
Note
Quarry treats free handicap as non-obligatory: it allows black to place fewer handicap stones than specified in game rules (but not less than two.)
If you want an “even” game, simply set the handicap to zero.
- Komi spin button
Komi is the compensation to the white player for playing second. It is usually non-integer to make draws impossible. The currently suggested komi for “even” game on 19×19 board is 6.5 points. Smaller (or even negative) komi gives some advantage to black player and can be used in addition to handicap.
See also time limit settings description.
At present, Amazons rules in Quarry are limited to board size and common time limit settings. Standard board size for Amazons is 10×10, but you can choose anything from 5×5 to 25×25 inclusive.
Othello rules in Quarry are limited to board size and time limit settings described just below this section. Standard board size for Othello is 8×8; 10×10 board is not uncommon too. In Quarry you can select any even board size from 6×6 to 24×24 inclusive.
Quarry allows to play games with limited time for both players. This also applies to computer program players—they have to honor the alloted time or lose. Of course the programs are properly notified about the time limit settings and the remaining time.
Note
Computer opponents use CPU time to generate moves. This means that they usually need less time on faster machines and more on slower machines. Also, if you run a computationally intensive task while playing, your computer opponents may become slower. Finally, certain computer programs may also “think” on opponent's time.
Note
At present, player who runs out of time doesn't lose automatically. This will be fixed before Quarry 0.2 is released.
Quarry has four types of time control:
- No limit
Both opponents can take as much time as they like on each move, there are no limits. In this mode you can choose to select “Keep track of total time” option. Then Quarry will display the total time spent on move pondering by each player. This is purely for your information and serves no other purpose.
- Limited time for entire game
Each player has limited time to play the whole game. If a player fails to finish the game in the alloted time, she loses. Note that time limit doesn't depend on the number of moves in the game.
- Limited time per move
Each move has to be played in fixed time. Time not used is not stored and not added to available time on next moves. When using this mode, keep in mind that in most games there are “difficult” positions that require more pondering time.
- Canadian overtime (also known as Canadian byo-yomi)
This time control is often used in Go, but has nothing Go-specific, so it can be used in any other move-based game. Canadian overtime has the advantage of imposing certain speed of play, but, at the same time, allowing to occasionally spend more time on important moves.
Canadian overtime has three parameters: main time, overtime period length and moves per overtime. Both players begin game in their main time. During main time they can play any number of moves at any speed. When main time for a player is up, first overtime period begins. During each overtime period a player has to play the specified number of moves (moves per overtime.) If she fails to do so, she loses on time. Otherwise, next overtime (of the very same length) begins and the player has to play the same number of moves this before the time is up again. The number of overtimes is unlimited and they are completely equal to each other: time not used in one overtime period is not stored and not added to other overtime periods.
Board windows are the main part of Quarry. They are used to play games and view and edit game records. To the left in a window is the game board itself. The exact appearance of the board depends on the current game (Go, Amazons or Othello) and can be configured. On the right side of the window there is information pane (to the top) and the comment window.
To configure Quarry either click the Preferences button in the Control Center window or choose Edit->Preferences menu item.
The Preferences dialog is displayed. It consists of the following categories:
- GTP
- Game Records (SGF)
- Board Appearance
At this page, all game-playing programs registered in Quarry are shown. You can register new programs and modify information in existing entries.
All registered programs are shown in the list labeled List of GTP engines. When you select one of them, some information about it is shown in the lower part of the dialog. This inlcudes program name, version, supported game(s) and command line. The command line is exactly what you specified while registering the program, while the rest of information is reported by the program itself. All programs listed here are also shown in the New Game dialog as available computer opponents.
There are also five buttons on this page:
- Add and Modify buttons
These two buttons allow you to register another program, or modify information about an already registered one, correspondingly. They both pop up the GTP Engine Information dialog.
- Remove button
This button removes a game-playing program from the list of registered programs. The unregistered program will not appear in the New Game dialog as an available opponent. Of course, the program itself is not touched and you can re-register it in Quarry later.
- Move Up and Move Down buttons
Using these two buttons you can rearrange registered programs. Computer opponents in the New Game dialog are listed in exactly the same order as on this page, so you may want to place more frequently used programs on the top. Another way to reorder GTP programs is to drag-and-drop their names in the list.
This dialog is shown whenever you want to register a game-playing program in Quarry or modify information about an already registered one. Depending on the situation, it can be titled either New GTP Engine or Modify GTP Engine Information. After you fill in the dialog, press the Add or OK button. Quarry will launch the program to check if it works and ask it for some information.
Note
If the message “Querying engine's name, version and known commands...” appears and persists for too long (more than a few seconds), this most likely indicates that the command line you specify starts the program in non-GTP mode or starts a wrong program to begin with. If you don't expect the program to be very slow on initialization, then click the Cancel button and fix the command line.
The dialog has two text entry fields:
- Command line
The command line to start the program should be entered here. You can use the Browse button to select the program, but normally just specifying program filename is enough. (More exactly, it is enough if the program is installed in a directory that is in your $PATH environment variable.) In any case, you should enter program-specific options after its filename. To find out which options should be used, see the manual of the program in question.
For GNU Go, the command line should look like this (note the double hyphens):
gnugo --mode gtp --quiet
You may also want to specify additional options. See GNU Go documentation for more information.
- Screen name
In this field you can specify the way Quarry will display the name of the program. You can enter the full name or use special symbols “%n” and “%v”. They will be replaced with the name and version of the program as it reports them itself. In most cases the default value of “%n %v” is what you want, but sometimes it makes sense to alter it. For instance, you can specify “%n %v level 5” here if you fixed program's level in the command line. If, for some reason, you need the percent sign in the name, type it in as “%%” (the percent sign is used as escape symbol in this field.)
A. GNU Free Documentation License
Version 1.2, November 2002
Copyright © 2000, 2001, 2002 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.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful 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.
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.
1. 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, LaTeX 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.
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.
2. 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.
3. 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.
4. 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:
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.
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.
State on the Title page the name of the publisher of the Modified Version, as the publisher.
Preserve all the copyright notices of the Document.
Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
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.
Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
Include an unaltered copy of this License.
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.
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.
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.
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.
Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
Preserve any Warranty Disclaimers.
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.
5. 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.”
6. 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.
7. 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.
8. 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.
9. TERMINATION
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 Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
10. 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 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.
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:
Copyright © YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 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”.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this:
with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
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.