Functions reference
Setup
setPort($port='631')
Select port which IPP server listen. By default IANA assigned port.
Mandatory.
setHost($host='localhost')
Select host which is located IPP server (IP or resolvable hostname/FQDN).
Mandatory.
setPrinterUri($uri)
Select printer.
/* examples */
$ipp->setPrinterUri('/printers/epson');
$ipp->setPrinterUri('ipp://localhost:631/printers/epson')
Mandatory, automatically done by CupsPrintIPP if not set.
setData($data)
string to be printed or filename of a readable file.
Mandatory for printing operations PrintJob() & sendDocument().
setRawText()
Force data to be interpreted as raw text, and be sent directly to printer.
It prepends a "SYN" and postpend a "Form Feed" characters to the data or file.
Can be used only on dot-matrix and ink-jet printers.
unsetRawText()
Unset previous operation (setRawText()).
setBinary()
Alias for unsetRawText().
setFormFeed()
When rawText is set, forces a form feed after printing.
Automatically set at setRawText() call.
unsetFormFeed()
Causes not form feed in RawText mode.
Must be called after each occurence of setRawText.
setCharset($charset)
Set request's charset. Automatically setted to "us-ascii" if not set.
setLanguage($language)
Set request's natural language. Automatically setted to "en_us" if not set.
setMimeMediaType($mime_media_type='application/octet-stream')
Set type of document. By default: application/octet-stream ⇒ autodetection.
setCopies($nbrcopies=1)
Set number of copies.
setDocumentName($document_name)
Set document name (as for title page).
setJobName($jobname='(PHP)',$absolute=false)
Set job name. If $absolute is not 'true' (default), a count is automatically appended
(MMDDHHMMSScount).
setUserName($username='PHP-SERVER')
Set user name as displayed on server and title pages. Automatically set to "PHP-SERVER" if not.
setAuthentification($username,$password)
Set system user name and password when server needs authentification for operation.
(e.g. cancelJob() on CUPS with standard settings).
You need to install SASL to use authentification. See INSTALL
setSides($sides=2)
Set sides on printed document.
Possibles values are:
- 1: one-sided
- 2: two-sided-long-edge
- 2CE: two-sided-short-edge
setFidelity()
If printer can't respect all attributes, do not print.
unsetFidelity()
Print anyway (replace attributes as needed), after a call to setFidelity ().
setMessage($message)
Set message given to user, especially with CancelJob().
Cups does not reply this message
setPageRanges($page_ranges)
Set ranges of pages to be printed. $page_ranges == string,
e.g.:" 1-2 5-6 8-14".
an empty string resets page-ranges.
setAttribute($attribute,$value)
For attributes which have not dedicated function.
$attribute and $value are the correspondent text strings in RFC2911.
Returns false on failure.
unsetAttribute($attribute)
Unset given attribute for next jobs, for attributes which have not dedicated function.
Operations
printJob()
Print a single string or document, previously setted by setdata($data).
cancelJob($job_uri)
cancel job which have uri $uri, as which is given in $ipp->last_job or in array
$ipp->jobs_uri ⇒ (one key by operation).
getPrinterAttributes()
Get printer's attributes of printer setted by setPrinterUri($uri), fill object $ipp->printer_attributes.
see
response parsing.
validateJob()
Verify if the job can be printed with it's attributes before sending document.
Example:
<?php
[...]
$ipp->setMimeMediaType("application/x-foobar");
echo "Validate-Job: ".$ipp->validateJob()."<br />";
foreach ($ipp->job_attributes as $name => $job_attribute)
if ($job_attribute->_range == 'unsupported-attributes')
printf('%s "%s": unsupported attribute<br />',$name,$job_attribute->_value0);
reset($ipp->job_attributes);
?>
displays:
Validate-Job: client-error-document-format-not-supported
document_format "application/x-foobar": unsupported attribute
getJobAttributes($job_uri,subset="false",$attributes_group="all")
Get attributes from the job $job_uri. If ($subset), gives $attributes_group="all" by default,
or attributes_group = 'job-template' or 'job-description' if you fills third argument.
Example:
<?php
[...]
echo "Printing Job: ".$ipp->printJob()."<br />";
$ipp->getJobAttributes($ipp->last_job,false,'job-template');
$job_state = $ipp->job_attributes->job_state->_value0;
echo "Job-State: $job_state<br />";
$job_state_reasons = $ipp->job_attributes->job_state_reasons->_value0;
echo "Job-State-Reasons: $job_state_reasons<br />";
echo "<pre>";print_r($ipp->job_attributes); echo "</pre>";
?>
displays:
Job-State: processing
Job-State-Reasons: job-printing
(or whatever is the job's status)
stdClass Object
(
[attributes_charset] => stdClass Object
(
[_type] => charset
[_range] => start operation-attributes
[_value0] => utf-8
)
[attributes_natural_language] => stdClass Object
(
[_type] => naturalLanguage
[_range] => start operation-attributes
[_value0] => fr-fr
)
[job_uri] => stdClass Object
(
[_type] => uri
[_range] => start job-attributes
[_value0] => http://geekette:631/jobs/202
)
[...]
getJobs($my_jobs=true,$limit=0,$which_jobs="",$subset='true')
get Jobs attribute's, by default only your jobs, except if you set first argument to "false",
by default with no limit, except if you gives an integer (0 < x < 65535) in second argument,
by default not-completed, excpt if you gives 'completed' as third argument, by default only a
usefull subset of attributes, except if you gives 'false' as fourth argument.
Example:
<?php
echo "Getting Jobs: ".$ipp->getJobs($my_jobs=true,$limit=0,"completed",true)."<br />";
echo "Job 0 state: ".$ipp->jobs_attributes->job_0->job_state->_value0."<br />";
echo "Job 0 state-reasons: ".$ipp->jobs_attributes->job_0->job_state_reasons->_value0."<br />";
echo "<pre>";print_r($ipp->jobs_attributes); echo "</pre>";
?>
Displays:
Getting Jobs: successful-ok-ignored-or-substituted-attributes
Job 0 state: processing
Job 0 state-reasons: job-printing
stdClass Object
(
[job_0] => stdClass Object
(
[job_more_info] => stdClass Object
(
[_type] => uri
[_range] => start job-attributes
[_value0] => http://geekette:631/jobs/205
)
[job_uri] => stdClass Object
(
[_type] => uri
[_range] => start job-attributes
[_value0] => http://geekette:631/jobs/205
)
[job_printer_up_time] => stdClass Object
(
[_type] => integer
[_range] => start job-attributes
[_value0] => 1136224652
)
[job_name] => stdClass Object
(
[_type] => nameWithoutLanguage
[_range] => start job-attributes
[_value0] => test-utf8.txt
)
[job_state] => stdClass Object
(
[_type] => enum
[_range] => start job-attributes
[_value0] => processing
)
[job_state_reasons] => stdClass Object
(
[_type] => keyword
[_range] => start job-attributes
[_value0] => job-printing
)
)
[job_1] => stdClass Object
[...]
)
printURI($uri)
Implemented in ExtendedPrintIPP.
Print a single document, which uri is given in argument.
Not implemented in Cups server (OPTIONAL operation).
purgeJobs()
Function implemented in ExtendedPrintIPP
Purge jobs for printer designed by setPrinterUri($uri), for all printers if $uri is "/printers/".
Example:
<?php
/* purging jobs for a printer */
$IPP = new ExtendedPrintIPP();
$ipp->setUserName("test");
$ipp->setAuthentification("test","test"); // username & password
$ipp->setPrinterURI("ipp://localhost:631/printers/epson"); // Set printer URI here
echo "Purge-Jobs: ". $ipp->purgeJobs() ."<br />";
/* purging jobs for all printers */
$ipp->setPrinterURI("ipp://localhost:631/printers/"); // => all printers
echo "Purge-Jobs: ". $ipp->purgeJobs() ."<br />";
?>
createJob()
Function implemented in ExtendedPrintIPP.
IPP Create-Job operation, before sending multi-documents with sendDocument($job);
or sendURI($job,$uri).
See sendDocument example.
sendDocument($job_uri,$is_last=false)
Function implemented in ExtendedPrintIPP.
Example:
<?php
function __autoload($class_name) {
require_once $class_name . '.php';
}
$IPP = new ExtendedPrintIPP();
$ipp->debug_level = 3;
$ipp->setUserName("test");
$ipp->setCopies(2);
$ipp->setAuthentification("test","test"); // username & password. MANDATORY
echo "Create-Job: ".$ipp->createJob(). "<br />";
printf("Job is: %s<br />",$job = $ipp->last_job);
echo "<pre>";print_r($ipp->job_attributes);echo "</pre>\n";
$ipp->setDocumentName("test-utf8.txt");
$ipp->setData("./testfiles/test-utf8.txt");
echo "Sending document: " . $ipp->sendDocument($job) . "<br />\n";
$ipp->setDocumentName("text string");
$ipp->setData("This is the string of second document");
echo "Sending document: " . $ipp->sendDocument($job,$last=true) . "<br />\n";
// must be refused. Hem: CUPS is very smart, it accepts :)
echo "Sending document: " . $ipp->sendDocument($job,$last=true) . "<br />\n";
?>
getPrinters()
Function implemented in (NameOfVendor)PrintIPP.
Get availables printers, fill array $ipp->available_printers with printers's uris.
Example:
<?php
function __autoload($class_name) {
require_once $class_name . '.php';
}
$ipp = new CupsPrintIPP;
$ipp->getPrinters();
$uri = $ipp->available_printers[0];
$ipp->setPrinterUri($uri);
?>
Logging / debugging
setLog($log_destination,$destination_type='file',$level=2)
$destination_type can be "file", "logger", "e-mail".
$log_destination is a (new) writeable file in a writeable directory,
or e-mail.
$level is
- 0 ⇒ quiet;
- 1 to 3 ⇒ less to more verbose.
printDebug()
Display debugging informations.
Verbosity setted from 0 to 3 in $ipp->debug_level.
getDebug()
Returns debugging informations.
Verbosity setted from 0 to 3 in $ipp->debug_level.
Copyright / Distribution of this document
Copyright © 2005-2006 Thomas Harding.
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".
Copyright for examples of code
Copyright © 2005-2006 Thomas Harding.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
Neither the name of its Author nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
GNU Free Documentation License
GNU Free Documentation License
Version 1.2, November 2002
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 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:
A. 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.
B. 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.
C. State on the Title page the name of the publisher of the
Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
F. 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.
G. Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
H. Include an unaltered copy of this License.
I. 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.
J. 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.
K. 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.
L. 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.
M. Delete any section Entitled "Endorsements". Such a section
may not be included in the Modified Version.
N. Do not retitle any existing section to be Entitled "Endorsements"
or to conflict in title with any Invariant Section.
O. 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 (c) 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.