Analyzing System Metrics with Performance Co-Pilot
The Performance Co-Pilot (PCP) analysis toolkit collects, processes and analyzes system performance metrics, either in real time or from archived logs. SUSE Linux Enterprise Server provides PCP as regular packages, so you install and configure it like any other system service, without needing a container runtime. Use PCP to monitor a single system locally or to centralize monitoring of several remote systems on one host.
Prerequisites
A running, registered instance of SUSE Linux Enterprise Server
1 What is Performance Co-Pilot analysis toolkit? #
Performance data is collected by performance metrics domain
agents (PMDAs), one per subsystem such as the kernel, disks or
a database. Each PMDA passes its metrics to the
pmcd daemon, which is the single
point of contact for all other PCP tools. pmlogger
is the tool that turns those live metrics into an archive you can query
later, and pminfo queries them directly, without
logging anything.
2 Installing PCP #
This chapter covers installing pcp via Zypper in standard mode or via transactional-update in immutable mode.
2.1 Installing PCP in standard mode #
Install the pcp package with Zypper:
>sudozypper install pcp
Alternatively, install the pcp-zeroconf package
instead. It installs pcp as a dependency and
additionally enables and starts pmcd,
pmlogger and pmproxy automatically,
with a shorter, 10-second sampling interval. Use it if you want local
monitoring running immediately without configuring the services yourself,
as described in Section 3, “Enabling PCP services”:
>sudozypper install pcp-zeroconf
2.2 Installing PCP in immutable mode #
On the immutable mode of SLES, install either package
through transactional-update instead:
>sudotransactional-update pkg install pcp
Or, for the zero-configuration variant:
>sudotransactional-update pkg install pcp-zeroconf
Changes take effect only after a reboot:
>sudoreboot
3 Enabling PCP services #
Installing the pcp package installs several
systemd services, all disabled by default. PCP provides the following services:
pmcdThe Performance Metrics Collector Daemon. It coordinates the gathering and exporting of performance statistics in response to requests from PCP tools, and is required by every other PCP service. By default, it listens only on the local host, on port 44321.
pmloggerRecords the metrics exported by
pmcdto archive logs, by default under/var/log/pcp/pmlogger/HOSTNAME/.pmproxyExposes a REST API (PMWEBAPI) to access metrics remotely, on port 44322 by default. Unlike
pmcd, it listens on all interfaces by default.pmieThe inference engine. It evaluates the exported metrics against a set of rules and can trigger an action, for example, an alert, when a rule matches.
Enable and start the services you need with systemctl.
For example, to enable local metric collection and logging:
>sudosystemctl enable --now pmcd pmlogger
Add pmproxy or pmie to the same
command if you need the REST API or the inference engine.
By default, pmcd only accepts connections from the
local host, and firewalld does not open a port for either
pmcd or pmproxy. If you need
to reach either service from another system, open the corresponding port:
>sudofirewall-cmd --add-port=PORT/tcp --permanent>sudofirewall-cmd --reload
Use port 44321 for pmcd and
44322 for pmproxy. Allowing
remote connections to pmcd also requires changing
PMCD_LOCAL, as described in
Section 4, “Configuring pmcd and pmlogger”.
4 Configuring pmcd and pmlogger #
Every PCP service has a default configuration that might not suit your
needs. To customize a service, edit its configuration file directly and
restart the service. For example, to customize pmcd, run:
>sudovi /etc/sysconfig/pmcd>sudosystemctl restart pmcd
4.1 Configuring the pmcd daemon #
The pmcd daemon configuration is stored in the
/etc/sysconfig/pmcd file. The file stores
environment variables that modify the behavior of the
pmcd daemon.
You can add the following variables to the
/etc/sysconfig/pmcd file to configure the
pmcd daemon:
- PMCD_LOCAL
Defines whether a remote host can connect to the
pmcddaemon. If set to 0, remote connections to the daemon are allowed. If set to 1, the daemon listens only on the local host. The default value is 1.- PMCD_MAXPENDING
Defines the maximum count of pending connections to the agent. The default value is 5.
- PMCD_ROOT_AGENT
If the
pmdarootis enabled (the value is set to 1), adding a new PDMA does not trigger restarting of other PMDAs. Ifpmdarootis not enabled,pmcdwill require restarting all PMDAs when a new PMDA is added. The default value is 1.- PMCD_RESTART_AGENTS
If set to 1, the
pmcddaemon tries to restart any exited PMDA. Enable this option only if you have enabledpmdaroot, aspmcditself does not have privileges to restart PMDA. The default value is 1.- PMCD_WAIT_TIMEOUT
Defines the maximum time in seconds
pmcdcan wait to accept a connection. After this time, the connection is reported as failed. The default value is 60.- PCP_NSS_INIT_MODE
Defines the mode in which
pmcdinitializes the NSS certificate database when secured connections are used. The default value isreadonly. You can set the mode toreadwrite, but if the initialization fails, the default value is used as a fallback.
For example, to allow remote connections and increase the connection timeout, change only these two lines and leave the rest at their default:
PMCD_LOCAL=0 PMCD_WAIT_TIMEOUT=70
4.2 Setting pmlogger variables #
The custom configuration for the pmlogger is stored in
the following configuration files:
/etc/sysconfig/pmlogger/etc/pcp/pmlogger/control.d/local
4.2.1 The /etc/sysconfig/pmlogger file #
You can use the following attributes to configure the
pmlogger:
- PMLOGGER_LOCAL
Defines whether
pmloggerallows connections from remote hosts. If set to 1,pmloggerallows connections from a local host only. The default value is 1.- PMLOGGER_MAXPENDING
Defines the maximum count of pending connections. The default value is 5.
- PMLOGGER_INTERVAL
Defines the default sampling interval
pmloggeruses. The default value is 60 s, unless pcp-zeroconf is installed, in which case the default is 10 s. Thepmloggercommand line overrides this value.- PMLOGGER_CHECK_SKIP_LOGCONF
Setting this option to yes disables the regeneration and checking of the
pmloggerconfiguration if the configurationpmloggercomes frompmlogconf. The default behavior is to regenerate configuration files and check for changes every timepmloggeris started.- PMLOGGER_CHECK_SKIP_JANITOR
By default,
pmlogger_checkalso runspmlogger_janitorto detectpmloggerprocesses or files that became detached from the control files that used to manage them. Setting this option to yes disablespmlogger_janitor, which can be useful for QA or other special testing.
An example follows:
PMLOGGER_LOCAL=1 PMLOGGER_MAXPENDING=5 PMLOGGER_INTERVAL=10 PMLOGGER_CHECK_SKIP_LOGCONF=yes
4.2.2 The /etc/pcp/pmlogger/control.d/local file #
The file /etc/pcp/pmlogger/control.d/local stores
specifications of the host, which metrics should be logged, the logging
frequency (default is 24 hours), and pmlogger
options. For example:
# === VARIABLE ASSIGNMENTS === # # DO NOT REMOVE OR EDIT THE FOLLOWING LINE $version=1.1 # Uncomment one of the lines below to enable/disable compression behaviour # that is different to the pmlogger_daily default. # Value is days before compressing archives, 0 is immediate compression, # "never" or "forever" suppresses compression. # #$PCP_COMPRESSAFTER=0 #$PCP_COMPRESSAFTER=3 #$PCP_COMPRESSAFTER=never # === LOGGER CONTROL SPECIFICATIONS === # #Host P? S? directory args # local primary logger LOCALHOSTNAME y n PCP_ARCHIVE_DIR/LOCALHOSTNAME -r -T24h10m -c config.default -v 100Mb
The LOCALHOSTNAME entry shown above logs
metrics from the local host only. To collect metrics from a
remote client instead, see
Section 5.3, “Recording metrics from remote systems”.
5 Managing PCP metrics #
To check the local setup, use pminfo to list metrics and the pcp command. You can also collect metrics from remote systems on one central host.
5.1 Listing PCP metrics #
When pmcd is running, use the command
pminfo to list metrics. It requires no special
privileges. For example, to list all available performance metrics, run:
>pminfo
You can list a group of related metrics by specifying the metrics prefix:
>pminfoMETRIC_PREFIX
For example, to list all metrics related to disks, use:
>pminfodisk disk.dev.r_await disk.dm.await disk.dm.r_await disk.md.await disk.md.r_await ...
You can also specify additional strings to narrow down the list of metrics, for example:
>pminfodisk.dev disk.dev.read disk.dev.write disk.dev.total disk.dev.blkread disk.dev.blkwrite disk.dev.blktotal ...
To get online help text of a particular metric, use the -t
option followed by the metric, for example:
>pminfo-t kernel.cpu.util.user kernel.cpu.util.user [percentage of user time across all CPUs, including guest CPU time]
To display a description text of a particular metric, use the
-T option followed by the metric, for example:
>pminfo-T kernel.cpu.util.user Help: percentage of user time across all CPUs, including guest CPU time
5.2 Checking local metrics #
After you enable the PCP services, you can verify that metrics are being recorded properly by running the following command:
>sudopcpPerformance Co-Pilot configuration on node1: platform: Linux node1 6.12.0-160099.49-default #1 SMP PREEMPT_DYNAMIC Thu Aug 6 09:32:38 UTC 2026 (e38429b) x86_64 hardware: 2 cpus, 1 disk, 1 node, 3917MB RAM timezone: UTC services: pmcd pmproxy pmcd: Version 6.3.8-1, 9 agents, 1 client pmda: root pmcd proc pmproxy xfs linux mmv kvm jbd2 pmlogger: primary logger: /var/log/pcp/pmlogger/node1/20260607.09.24
Now check if the logs are written to a proper destination:
>lsPATH_TO_PMLOGGER_LOGS
where PATH_TO_PMLOGGER_LOGS should be
/var/log/pcp/pmlogger/HOSTNAME/,
with HOSTNAME being the machine's own host
name, the output of the hostname command—for
example, /var/log/pcp/pmlogger/node1/.
5.3 Recording metrics from remote systems #
You can collect metrics from several remote systems (clients) on a
central monitoring system. Each client needs only pmcd
running and reachable. pmlogger on the monitoring
system then pulls the metrics from every client and logs them locally.
On each client, install PCP as described in Section 2, “Installing PCP”, then allow remote connections and enable
pmcd:>sudosed -i 's/^PMCD_LOCAL=1/PMCD_LOCAL=0/' /etc/sysconfig/pmcd>sudosystemctl enable --now pmcdOn each client, open the
pmcdport infirewalld:>sudofirewall-cmd --add-port=44321/tcp --permanent>sudofirewall-cmd --reloadOn the monitoring system, create a
pmloggercontrol file for each client under/etc/pcp/pmlogger/control.d/, for example/etc/pcp/pmlogger/control.d/CLIENT, with the following content:$version=1.1 CLIENT_HOSTNAME n n PCP_ARCHIVE_DIR/CLIENT -N -r -T24h10m -c config.default -v 100Mb
CLIENT_HOSTNAME must be resolvable in DNS; you can use an IP address or a fully qualified domain name (FQDN) instead. For details about the control file format, see Section 4.2.2, “The
/etc/pcp/pmlogger/control.d/localfile”.Warning: Silent logging failure from a pre-created archive directoryLeave
PCP_ARCHIVE_DIR/CLIENT(by default,/var/log/pcp/pmlogger/CLIENT) forpmloggerto create itself, with the correct ownership. If it already exists and is owned byroot,pmlogger—which runs as thepcpuser—cannot write its lock file there, and logging fails without an obvious error.Trigger a check so
pmloggerapplies the new control file immediately, instead of waiting for the next scheduled run ofpmlogger_check.timer:>sudosystemctl start pmlogger_check.serviceConfirm that metrics are being collected from the client:
>ls-l /var/log/pcp/pmlogger/CLIENT/ total 288 -rw-r--r--. 1 pcp pcp 35032 Sep 3 16:07 20260903.16.07.0 -rw-r--r--. 1 pcp pcp 904 Sep 3 16:07 20260903.16.07.index -rw-r--r--. 1 pcp pcp 219161 Sep 3 16:07 20260903.16.07.meta -rw-r--r--. 1 pcp pcp 276 Sep 3 16:07 Latest -rw-r--r--. 1 pcp pcp 27174 Sep 3 16:07 pmlogger.log
6 For more information #
For more information about PCP, see the upstream documentation at https://pcp.readthedocs.io/en/latest/UAG/IntroductionToPcp.html.
To learn more about individual tools, see the man pages of
pmcd,pmloggerandpminfo.
7 Legal Notice #
Copyright© 2006– 2026 SUSE LLC and contributors. All rights reserved.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or (at your option) version 1.3; with the Invariant Section being this copyright notice and license. A copy of the license version 1.2 is included in the section entitled “GNU Free Documentation License”.
For SUSE trademarks, see https://www.suse.com/company/legal/. All other third-party trademarks are the property of their respective owners. Trademark symbols (®, ™ etc.) denote trademarks of SUSE and its affiliates. Asterisks (*) denote third-party trademarks.
All information found in this book has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither SUSE LLC, its affiliates, the authors, nor the translators shall be held liable for possible errors or the consequences thereof.
GNU Free Documentation License
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 non-commercially. 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 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 non-commercially, 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 https://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 #
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.