2006-09-11 Raul Mateos <raulofpandora@gmail.com>
* New pandora_doc directory for documents in docbook format. Very Beta :-D git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@160 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
raulmateos
parent
89d744ed8f
commit
aa90c2debb
|
|
@ -1,3 +1,12 @@
|
|||
2006-09-11 Raul Mateos <raulofpandora@gmail.com>
|
||||
|
||||
* New pandora_doc directory for documents in docbook format.
|
||||
Very Beta :-D
|
||||
|
||||
2006-09-11 Raul Mateos <raulofpandora@gmail.com>
|
||||
|
||||
* Massive upload of several help files to update text.
|
||||
|
||||
2006-09-10 Raul Mateos <raulofpandora@gmail.com>
|
||||
|
||||
* Massive upload several files, to reflect changes in help,
|
||||
|
|
|
|||
|
|
@ -0,0 +1,671 @@
|
|||
<!--
|
||||
The GNU Free Documentation License 1.1 in DocBook
|
||||
Markup by Eric Baudais <baudais@okstate.edu>
|
||||
Maintained by the GNOME Documentation Project
|
||||
http://developer.gnome.org/projects/gdp
|
||||
Version: 1.0.1
|
||||
Last Modified: Nov 16, 2000
|
||||
-->
|
||||
<?xml version='1.0' encoding='ISO-8859-1'?>
|
||||
<appendix id="fdl">
|
||||
<appendixinfo>
|
||||
<releaseinfo>
|
||||
Version 1.1, March 2000
|
||||
</releaseinfo>
|
||||
<copyright>
|
||||
<year>2000</year><holder>Free Software Foundation, Inc.</holder>
|
||||
</copyright>
|
||||
<legalnotice id="fdl-legalnotice">
|
||||
<para>
|
||||
<address>Free Software Foundation, Inc. <street>59 Temple Place,
|
||||
Suite 330</street>, <city>Boston</city>, <state>MA</state>
|
||||
<postcode>02111-1307</postcode> <country>USA</country></address>
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
</para>
|
||||
</legalnotice>
|
||||
</appendixinfo>
|
||||
<title>GNU Free Documentation License</title>
|
||||
|
||||
<sect1 id="fdl-preamble">
|
||||
<title>0. PREAMBLE</title>
|
||||
<para>
|
||||
The purpose of this License is to make a manual, textbook, or
|
||||
other written document <quote>free</quote> 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This License is a kind of <quote>copyleft</quote>, 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
</sect1>
|
||||
<sect1 id="fdl-section1">
|
||||
<title>1. APPLICABILITY AND DEFINITIONS</title>
|
||||
<para id="fdl-document">
|
||||
This License applies to any manual or other work that contains a
|
||||
notice placed by the copyright holder saying it can be
|
||||
distributed under the terms of this License. The
|
||||
<quote>Document</quote>, below, refers to any such manual or
|
||||
work. Any member of the public is a licensee, and is addressed
|
||||
as <quote>you</quote>.
|
||||
</para>
|
||||
|
||||
<para id="fdl-modified">
|
||||
A <quote>Modified Version</quote> 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.
|
||||
</para>
|
||||
|
||||
<para id="fdl-secondary">
|
||||
A <quote>Secondary Section</quote> is a named appendix or a
|
||||
front-matter section of the <link
|
||||
linkend="fdl-document">Document</link> 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. (For example, 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.
|
||||
</para>
|
||||
|
||||
<para id="fdl-invariant">
|
||||
The <quote>Invariant Sections</quote> are certain <link
|
||||
linkend="fdl-secondary"> Secondary Sections</link> whose titles
|
||||
are designated, as being those of Invariant Sections, in the
|
||||
notice that says that the <link
|
||||
linkend="fdl-document">Document</link> is released under this
|
||||
License.
|
||||
</para>
|
||||
|
||||
<para id="fdl-cover-texts">
|
||||
The <quote>Cover Texts</quote> are certain short passages of
|
||||
text that are listed, as Front-Cover Texts or Back-Cover Texts,
|
||||
in the notice that says that the <link
|
||||
linkend="fdl-document">Document</link> is released under this
|
||||
License.
|
||||
</para>
|
||||
|
||||
<para id="fdl-transparent">
|
||||
A <quote>Transparent</quote> copy of the <link
|
||||
linkend="fdl-document"> Document</link> means a machine-readable
|
||||
copy, represented in a format whose specification is available
|
||||
to the general public, whose contents can be viewed and edited
|
||||
directly and 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 has been designed to thwart or discourage
|
||||
subsequent modification by readers is not Transparent. A copy
|
||||
that is not <quote>Transparent</quote> is called
|
||||
<quote>Opaque</quote>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
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 designed for human
|
||||
modification. Opaque formats include PostScript, PDF,
|
||||
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 produced by some word processors for
|
||||
output purposes only.
|
||||
</para>
|
||||
|
||||
<para id="fdl-title-page">
|
||||
The <quote>Title Page</quote> 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, <quote>Title Page</quote> means the text near the
|
||||
most prominent appearance of the work's title, preceding the
|
||||
beginning of the body of the text.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-section2">
|
||||
<title>2. VERBATIM COPYING</title>
|
||||
<para>
|
||||
You may copy and distribute the <link
|
||||
linkend="fdl-document">Document</link> 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 <link
|
||||
linkend="fdl-section3">section 3</link>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You may also lend copies, under the same conditions stated
|
||||
above, and you may publicly display copies.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-section3">
|
||||
<title>3. COPYING IN QUANTITY</title>
|
||||
<para>
|
||||
If you publish printed copies of the <link
|
||||
linkend="fdl-document">Document</link> numbering more than 100,
|
||||
and the Document's license notice requires <link
|
||||
linkend="fdl-cover-texts">Cover Texts</link>, 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
|
||||
<link linkend="fdl-document">Document</link> and satisfy these
|
||||
conditions, can be treated as verbatim copying in other
|
||||
respects.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you publish or distribute <link
|
||||
linkend="fdl-transparent">Opaque</link> copies of the <link
|
||||
linkend="fdl-document">Document</link> numbering more than 100,
|
||||
you must either include a machine-readable <link
|
||||
linkend="fdl-transparent">Transparent</link> copy along with
|
||||
each Opaque copy, or state in or with each Opaque copy a
|
||||
publicly-accessible computer-network location containing a
|
||||
complete Transparent copy of the Document, free of added
|
||||
material, which the general network-using public has access to
|
||||
download anonymously at no charge using public-standard network
|
||||
protocols. 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
It is requested, but not required, that you contact the authors
|
||||
of the <link linkend="fdl-document">Document</link> well before
|
||||
redistributing any large number of copies, to give them a chance
|
||||
to provide you with an updated version of the Document.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-section4">
|
||||
<title>4. MODIFICATIONS</title>
|
||||
<para>
|
||||
You may copy and distribute a <link
|
||||
linkend="fdl-modified">Modified Version</link> of the <link
|
||||
linkend="fdl-document">Document</link> under the conditions of
|
||||
sections <link linkend="fdl-section2">2</link> and <link
|
||||
linkend="fdl-section3">3</link> 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:
|
||||
</para>
|
||||
|
||||
<itemizedlist mark="opencircle">
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>A</title>
|
||||
<para>
|
||||
Use in the <link linkend="fdl-title-page">Title
|
||||
Page</link> (and on the covers, if any) a title distinct
|
||||
from that of the <link
|
||||
linkend="fdl-document">Document</link>, 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.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>B</title>
|
||||
<para>
|
||||
List on the <link linkend="fdl-title-page">Title
|
||||
Page</link>, as authors, one or more persons or entities
|
||||
responsible for authorship of the modifications in the
|
||||
<link linkend="fdl-modified">Modified Version</link>,
|
||||
together with at least five of the principal authors of
|
||||
the <link linkend="fdl-document">Document</link> (all of
|
||||
its principal authors, if it has less than five).
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>C</title>
|
||||
<para>
|
||||
State on the <link linkend="fdl-title-page">Title
|
||||
Page</link> the name of the publisher of the <link
|
||||
linkend="fdl-modified">Modified Version</link>, as the
|
||||
publisher.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>D</title>
|
||||
<para>
|
||||
Preserve all the copyright notices of the <link
|
||||
linkend="fdl-document">Document</link>.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>E</title>
|
||||
<para>
|
||||
Add an appropriate copyright notice for your modifications
|
||||
adjacent to the other copyright notices.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>F</title>
|
||||
<para>
|
||||
Include, immediately after the copyright notices, a
|
||||
license notice giving the public permission to use the
|
||||
<link linkend="fdl-modified">Modified Version</link> under
|
||||
the terms of this License, in the form shown in the
|
||||
Addendum below.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>G</title>
|
||||
<para>
|
||||
Preserve in that license notice the full lists of <link
|
||||
linkend="fdl-invariant"> Invariant Sections</link> and
|
||||
required <link linkend="fdl-cover-texts">Cover
|
||||
Texts</link> given in the <link
|
||||
linkend="fdl-document">Document's</link> license notice.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>H</title>
|
||||
<para>
|
||||
Include an unaltered copy of this License.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>I</title>
|
||||
<para>
|
||||
Preserve the section entitled <quote>History</quote>, and
|
||||
its title, and add to it an item stating at least the
|
||||
title, year, new authors, and publisher of the <link
|
||||
linkend="fdl-modified">Modified Version </link>as given on
|
||||
the <link linkend="fdl-title-page">Title Page</link>. If
|
||||
there is no section entitled <quote>History</quote> in the
|
||||
<link linkend="fdl-document">Document</link>, 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.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>J</title>
|
||||
<para>
|
||||
Preserve the network location, if any, given in the <link
|
||||
linkend="fdl-document">Document</link> for public access
|
||||
to a <link linkend="fdl-transparent">Transparent</link>
|
||||
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 <quote>History</quote>
|
||||
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.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>K</title>
|
||||
<para>
|
||||
In any section entitled <quote>Acknowledgements</quote> or
|
||||
<quote>Dedications</quote>, preserve the section's title,
|
||||
and preserve in the section all the substance and tone of
|
||||
each of the contributor acknowledgements and/or
|
||||
dedications given therein.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>L</title>
|
||||
<para>
|
||||
Preserve all the <link linkend="fdl-invariant">Invariant
|
||||
Sections</link> of the <link
|
||||
linkend="fdl-document">Document</link>, unaltered in their
|
||||
text and in their titles. Section numbers or the
|
||||
equivalent are not considered part of the section titles.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>M</title>
|
||||
<para>
|
||||
Delete any section entitled
|
||||
<quote>Endorsements</quote>. Such a section may not be
|
||||
included in the <link linkend="fdl-modified">Modified
|
||||
Version</link>.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>N</title>
|
||||
<para>
|
||||
Do not retitle any existing section as
|
||||
<quote>Endorsements</quote> or to conflict in title with
|
||||
any <link linkend="fdl-invariant">Invariant
|
||||
Section</link>.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
If the <link linkend="fdl-modified">Modified Version</link>
|
||||
includes new front-matter sections or appendices that qualify as
|
||||
<link linkend="fdl-secondary">Secondary Sections</link> 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 <link
|
||||
linkend="fdl-invariant">Invariant Sections</link> in the
|
||||
Modified Version's license notice. These titles must be
|
||||
distinct from any other section titles.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You may add a section entitled <quote>Endorsements</quote>,
|
||||
provided it contains nothing but endorsements of your <link
|
||||
linkend="fdl-modified">Modified Version</link> 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You may add a passage of up to five words as a <link
|
||||
linkend="fdl-cover-texts">Front-Cover Text</link>, and a passage
|
||||
of up to 25 words as a <link
|
||||
linkend="fdl-cover-texts">Back-Cover Text</link>, to the end of
|
||||
the list of <link linkend="fdl-cover-texts">Cover Texts</link>
|
||||
in the <link linkend="fdl-modified">Modified Version</link>.
|
||||
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 <link linkend="fdl-document">Document</link>
|
||||
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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The author(s) and publisher(s) of the <link
|
||||
linkend="fdl-document">Document</link> do not by this License
|
||||
give permission to use their names for publicity for or to
|
||||
assert or imply endorsement of any <link
|
||||
linkend="fdl-modified">Modified Version </link>.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-section5">
|
||||
<title>5. COMBINING DOCUMENTS</title>
|
||||
<para>
|
||||
You may combine the <link linkend="fdl-document">Document</link>
|
||||
with other documents released under this License, under the
|
||||
terms defined in <link linkend="fdl-section4">section 4</link>
|
||||
above for modified versions, provided that you include in the
|
||||
combination all of the <link linkend="fdl-invariant">Invariant
|
||||
Sections</link> of all of the original documents, unmodified,
|
||||
and list them all as Invariant Sections of your combined work in
|
||||
its license notice.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The combined work need only contain one copy of this License,
|
||||
and multiple identical <link linkend="fdl-invariant">Invariant
|
||||
Sections</link> 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
In the combination, you must combine any sections entitled
|
||||
<quote>History</quote> in the various original documents,
|
||||
forming one section entitled <quote>History</quote>; likewise
|
||||
combine any sections entitled <quote>Acknowledgements</quote>,
|
||||
and any sections entitled <quote>Dedications</quote>. You must
|
||||
delete all sections entitled <quote>Endorsements.</quote>
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-section6">
|
||||
<title>6. COLLECTIONS OF DOCUMENTS</title>
|
||||
<para>
|
||||
You may make a collection consisting of the <link
|
||||
linkend="fdl-document">Document</link> 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You may extract a single document from such a collection, and
|
||||
dispbibute 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.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-section7">
|
||||
<title>7. AGGREGATION WITH INDEPENDENT WORKS</title>
|
||||
<para>
|
||||
A compilation of the <link
|
||||
linkend="fdl-document">Document</link> or its derivatives with
|
||||
other separate and independent documents or works, in or on a
|
||||
volume of a storage or distribution medium, does not as a whole
|
||||
count as a <link linkend="fdl-modified">Modified Version</link>
|
||||
of the Document, provided no compilation copyright is claimed
|
||||
for the compilation. Such a compilation is called an
|
||||
<quote>aggregate</quote>, and this License does not apply to the
|
||||
other self-contained works thus compiled with the Document , on
|
||||
account of their being thus compiled, if they are not themselves
|
||||
derivative works of the Document. If the <link
|
||||
linkend="fdl-cover-texts">Cover Text</link> requirement of <link
|
||||
linkend="fdl-section3">section 3</link> is applicable to these
|
||||
copies of the Document, then if the Document is less than one
|
||||
quarter of the entire aggregate, the Document's Cover Texts may
|
||||
be placed on covers that surround only the Document within the
|
||||
aggregate. Otherwise they must appear on covers around the whole
|
||||
aggregate.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-section8">
|
||||
<title>8. TRANSLATION</title>
|
||||
<para>
|
||||
Translation is considered a kind of modification, so you may
|
||||
distribute translations of the <link
|
||||
linkend="fdl-document">Document</link> under the terms of <link
|
||||
linkend="fdl-section4">section 4</link>. Replacing <link
|
||||
linkend="fdl-invariant"> Invariant Sections</link> 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 provided that you also include the original English
|
||||
version of this License. In case of a disagreement between the
|
||||
translation and the original English version of this License,
|
||||
the original English version will prevail.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-section9">
|
||||
<title>9. TERMINATION</title>
|
||||
<para>
|
||||
You may not copy, modify, sublicense, or distribute the <link
|
||||
linkend="fdl-document">Document</link> 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.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-section10">
|
||||
<title>10. FUTURE REVISIONS OF THIS LICENSE</title>
|
||||
<para>
|
||||
The <ulink type="http"
|
||||
url="http://www.gnu.org/fsf/fsf.html">Free Software
|
||||
Foundation</ulink> 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 <ulink
|
||||
type="http"
|
||||
url="http://www.gnu.org/copyleft">http://www.gnu.org/copyleft/</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Each version of the License is given a distinguishing version
|
||||
number. If the <link linkend="fdl-document">Document</link>
|
||||
specifies that a particular numbered version of this License
|
||||
<quote>or any later version</quote> 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.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="fdl-using">
|
||||
<title>Addendum</title>
|
||||
<para>
|
||||
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:
|
||||
</para>
|
||||
|
||||
<blockquote>
|
||||
<para>
|
||||
Copyright © YEAR YOUR NAME.
|
||||
</para>
|
||||
<para>
|
||||
Permission is granted to copy, distribute and/or modify this
|
||||
document under the terms of the GNU Free Documentation
|
||||
License, Version 1.1 or any later version published by the
|
||||
Free Software Foundation; with the <link
|
||||
linkend="fdl-invariant">Invariant Sections</link> being LIST
|
||||
THEIR TITLES, with the <link
|
||||
linkend="fdl-cover-texts">Front-Cover Texts</link> being LIST,
|
||||
and with the <link linkend="fdl-cover-texts">Back-Cover
|
||||
Texts</link> being LIST. A copy of the license is included in
|
||||
the section entitled <quote>GNU Free Documentation
|
||||
License</quote>.
|
||||
</para>
|
||||
</blockquote>
|
||||
|
||||
<para>
|
||||
If you have no <link linkend="fdl-invariant">Invariant
|
||||
Sections</link>, write <quote>with no Invariant Sections</quote>
|
||||
instead of saying which ones are invariant. If you have no
|
||||
<link linkend="fdl-cover-texts">Front-Cover Texts</link>, write
|
||||
<quote>no Front-Cover Texts</quote> instead of
|
||||
<quote>Front-Cover Texts being LIST</quote>; likewise for <link
|
||||
linkend="fdl-cover-texts">Back-Cover Texts</link>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
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 <ulink type="http"
|
||||
url="http://www.gnu.org/copyleft/gpl.html"> GNU General Public
|
||||
License</ulink>, to permit their use in free software.
|
||||
</para>
|
||||
</sect1>
|
||||
</appendix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,381 @@
|
|||
<?xml version='1.0' encoding='ISO-8859-1'?>
|
||||
<appendix id="gpl">
|
||||
<appendixinfo>
|
||||
<title>GNU General Public License</title>
|
||||
<pubdate>Version 2, June 1991</pubdate>
|
||||
<copyright>
|
||||
<year>1989, 1991</year>
|
||||
<holder>Free Software Foundation, Inc.</holder>
|
||||
</copyright>
|
||||
<legalnotice id="gpl-legalnotice">
|
||||
<para>
|
||||
<address>Free Software Foundation, Inc.
|
||||
<street>51 Franklin Street, Fifth Floor</street>,
|
||||
<city>Boston</city>,
|
||||
<state>MA</state>
|
||||
<postcode>02110-1301</postcode>
|
||||
<country>USA</country>
|
||||
</address>
|
||||
</para>
|
||||
<para>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
</para>
|
||||
</legalnotice>
|
||||
<releaseinfo>Version 2, June 1991</releaseinfo>
|
||||
</appendixinfo>
|
||||
<title>GNU General Public License</title>
|
||||
<section id="gpl-1">
|
||||
<title>Preamble</title>
|
||||
<para>
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General
|
||||
Public License is intended to guarantee your freedom to share
|
||||
and change free software - to make sure the software is free for
|
||||
all its users. This General Public License applies to most of
|
||||
the Free Software Foundation's software and to any other
|
||||
program whose authors commit to using it. (Some other Free
|
||||
Software Foundation software is covered by the GNU Library
|
||||
General Public License instead.) You can apply it to your
|
||||
programs, too.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure
|
||||
that you have the freedom to distribute copies of free software
|
||||
(and charge for this service if you wish), that you receive
|
||||
source code or can get it if you want it, that you can change
|
||||
the software or use pieces of it in new free programs; and that
|
||||
you know you can do these things.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the
|
||||
rights. These restrictions translate to certain responsibilities
|
||||
for you if you distribute copies of the software, or if you
|
||||
modify it.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights
|
||||
that you have. You must make sure that they, too, receive or can
|
||||
get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
</para>
|
||||
|
||||
<para>We protect your rights with two steps:
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>copyright the software, and</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</para>
|
||||
|
||||
<para>Also, for each author's protection and ours, we want to make certain that
|
||||
everyone understands that there is no warranty for this free software. If
|
||||
the software is modified by someone else and passed on, we want its
|
||||
recipients to know that what they have is not the original, so that any
|
||||
problems introduced by others will not reflect on the original authors'
|
||||
reputations.</para>
|
||||
|
||||
<para>Finally, any free program is threatened constantly by software patents.
|
||||
We wish to avoid the danger that redistributors of a free program will
|
||||
individually obtain patent licenses, in effect making the program
|
||||
proprietary. To prevent this, we have made it clear that any patent must be
|
||||
licensed for everyone's free use or not licensed at all.</para>
|
||||
|
||||
<para>The precise terms and conditions for copying, distribution and modification
|
||||
follow.</para>
|
||||
</section>
|
||||
<section id="gpl-2">
|
||||
<title>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</title>
|
||||
<section id="gpl-2-0">
|
||||
<title>Section 0</title>
|
||||
<para>This License applies to any program or other work which contains a notice
|
||||
placed by the copyright holder saying it may be distributed under the terms
|
||||
of this General Public License. The <quote>Program</quote>, below, refers to any such
|
||||
program or work, and a
|
||||
<quote>work based on the Program</quote> means either
|
||||
the Program or any derivative work under copyright law: that is to say, a
|
||||
work containing the Program or a portion of it, either verbatim or with
|
||||
modifications and/or translated into another language. (Hereinafter, translation
|
||||
is included without limitation in the term
|
||||
<quote>modification</quote>.) Each licensee is addressed as <quote>you</quote>.</para>
|
||||
|
||||
<para>Activities other than copying, distribution and modification are not covered by
|
||||
this License; they are outside its scope. The act of running the Program is not
|
||||
restricted, and the output from the Program is covered only if its contents
|
||||
constitute a work based on the Program (independent of having been made by running
|
||||
the Program). Whether that is true depends on what the Program does.</para>
|
||||
</section>
|
||||
<section id="gpl-2-1">
|
||||
<title>Section 1</title>
|
||||
<para>You may copy and distribute verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and appropriately
|
||||
publish on each copy an appropriate copyright notice and disclaimer of warranty;
|
||||
keep intact all the notices that refer to this License and to the absence of any
|
||||
warranty; and give any other recipients of the Program a copy of this License
|
||||
along with the Program.</para>
|
||||
|
||||
<para>You may charge a fee for the physical act of transferring a copy, and you may at
|
||||
your option offer warranty protection in exchange for a fee.</para>
|
||||
</section>
|
||||
<section id="gpl-2-2">
|
||||
<title>Section 2</title>
|
||||
<para>You may modify your copy or copies of the Program or any portion of it, thus
|
||||
forming a work based on the Program, and copy and distribute such modifications
|
||||
or work under the terms of
|
||||
<link linkend="gpl-2-1">Section 1</link> above, provided
|
||||
that you also meet all of these conditions:
|
||||
<orderedlist numeration="loweralpha">
|
||||
<listitem>
|
||||
<para>You must cause the modified files to carry prominent notices stating that
|
||||
you changed the files and the date of any change.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>You must cause any work that you distribute or publish, that in whole or
|
||||
in part contains or is derived from the Program or any part thereof, to be
|
||||
licensed as a whole at no charge to all third parties under the terms of
|
||||
this License.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>If the modified program normally reads commands interactively when run, you
|
||||
must cause it, when started running for such interactive use in the most
|
||||
ordinary way, to print or display an announcement including an appropriate
|
||||
copyright notice and a notice that there is no warranty (or else, saying
|
||||
that you provide a warranty) and that users may redistribute the program
|
||||
under these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: If the Program itself is interactive but does not
|
||||
normally print such an announcement, your work based on the Program is not
|
||||
required to print an announcement.)</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</para>
|
||||
|
||||
<para>These requirements apply to the modified work as a whole. If identifiable sections
|
||||
of that work are not derived from the Program, and can be reasonably considered
|
||||
independent and separate works in themselves, then this License, and its terms,
|
||||
do not apply to those sections when you distribute them as separate works. But when
|
||||
you distribute the same sections as part of a whole which is a work based on the
|
||||
Program, the distribution of the whole must be on the terms of this License, whose
|
||||
permissions for other licensees extend to the entire whole, and thus to each and
|
||||
every part regardless of who wrote it.</para>
|
||||
|
||||
<para>Thus, it is not the intent of this section to claim rights or contest your rights
|
||||
to work written entirely by you; rather, the intent is to exercise the right to control
|
||||
the distribution of derivative or collective works based on the Program.</para>
|
||||
|
||||
<para>In addition, mere aggregation of another work not based on the Program with the Program
|
||||
(or with a work based on the Program) on a volume of a storage or distribution medium
|
||||
does not bring the other work under the scope of this License.</para>
|
||||
</section>
|
||||
<section id="gpl-2-3">
|
||||
<title>Section 3</title>
|
||||
<para>You may copy and distribute the Program (or a work based on it, under
|
||||
<link linkend="gpl-2-2">Section 2</link> in object code or executable form under the terms of
|
||||
<link linkend="gpl-2-1">Sections 1</link> and
|
||||
<link linkend="gpl-2-2">2</link> above provided that you also do one of the following:
|
||||
<orderedlist numeration="loweralpha">
|
||||
<listitem>
|
||||
<para>Accompany it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Accompany it with a written offer, valid for at least three years, to give any
|
||||
third party, for a charge no more than your cost of physically performing source
|
||||
distribution, a complete machine-readable copy of the corresponding source code,
|
||||
to be distributed under the terms of Sections 1 and 2 above on a medium customarily
|
||||
used for software interchange; or,</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Accompany it with the information you received as to the offer to distribute
|
||||
corresponding source code. (This alternative is allowed only for noncommercial
|
||||
distribution and only if you received the program in object code or executable form
|
||||
with such an offer, in accord with Subsection b above.)</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</para>
|
||||
|
||||
<para>The source code for a work means the preferred form of the work for making modifications
|
||||
to it. For an executable work, complete source code means all the source code for all modules
|
||||
it contains, plus any associated interface definition files, plus the scripts used to control
|
||||
compilation and installation of the executable. However, as a special exception, the source
|
||||
code distributed need not include anything that is normally distributed (in either source or
|
||||
binary form) with the major components (compiler, kernel, and so on) of the operating system
|
||||
on which the executable runs, unless that component itself accompanies the executable.</para>
|
||||
|
||||
<para>If distribution of executable or object code is made by offering access to copy from a
|
||||
designated place, then offering equivalent access to copy the source code from the same place
|
||||
counts as distribution of the source code, even though third parties are not compelled to
|
||||
copy the source along with the object code.</para>
|
||||
</section>
|
||||
<section id="gpl-2-4">
|
||||
<title>Section 4</title>
|
||||
<para>You may not copy, modify, sublicense, or distribute the Program except as expressly provided
|
||||
under this License. Any attempt otherwise to copy, modify, sublicense or distribute the
|
||||
Program 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.</para>
|
||||
</section>
|
||||
<section id="gpl-2-5">
|
||||
<title>Section 5</title>
|
||||
<para>You are not required to accept this License, since you have not signed it. However, nothing
|
||||
else grants you permission to modify or distribute the Program or its derivative works.
|
||||
These actions are prohibited by law if you do not accept this License. Therefore, by modifying
|
||||
or distributing the Program (or any work based on the Program), you indicate your acceptance
|
||||
of this License to do so, and all its terms and conditions for copying, distributing or
|
||||
modifying the Program or works based on it.</para>
|
||||
</section>
|
||||
<section id="gpl-2-6">
|
||||
<title>Section 6</title>
|
||||
<para>Each time you redistribute the Program (or any work based on the Program), the recipient
|
||||
automatically receives a license from the original licensor to copy, distribute or modify
|
||||
the Program subject to these terms and conditions. You may not impose any further restrictions
|
||||
on the recipients' exercise of the rights granted herein. You are not responsible for enforcing
|
||||
compliance by third parties to this License.</para>
|
||||
</section>
|
||||
<section id="gpl-2-7">
|
||||
<title>Section 7</title>
|
||||
<para>If, as a consequence of a court judgment or allegation of patent infringement or for any other
|
||||
reason (not limited to patent issues), conditions are imposed on you (whether by court order,
|
||||
agreement or otherwise) that contradict the conditions of this License, they do not excuse you
|
||||
from the conditions of this License. If you cannot distribute so as to satisfy simultaneously
|
||||
your obligations under this License and any other pertinent obligations, then as a consequence
|
||||
you may not distribute the Program at all. For example, if a patent license would not permit
|
||||
royalty-free redistribution of the Program by all those who receive copies directly or
|
||||
indirectly through you, then the only way you could satisfy both it and this License would be
|
||||
to refrain entirely from distribution of the Program.</para>
|
||||
|
||||
<para>If any portion of this section is held invalid or unenforceable under any particular circumstance,
|
||||
the balance of the section is intended to apply and the section as a whole is intended to apply
|
||||
in other circumstances.</para>
|
||||
|
||||
<para>It is not the purpose of this section to induce you to infringe any patents or other property
|
||||
right claims or to contest validity of any such claims; this section has the sole purpose of
|
||||
protecting the integrity of the free software distribution system, which is implemented by public
|
||||
license practices. Many people have made generous contributions to the wide range of software
|
||||
distributed through that system in reliance on consistent application of that system; it is up
|
||||
to the author/donor to decide if he or she is willing to distribute software through any other
|
||||
system and a licensee cannot impose that choice.</para>
|
||||
|
||||
<para>This section is intended to make thoroughly clear what is believed to be a consequence of the
|
||||
rest of this License.</para>
|
||||
</section>
|
||||
<section id="gpl-2-8">
|
||||
<title>Section 8</title>
|
||||
<para>If the distribution and/or use of the Program is restricted in certain countries either by patents
|
||||
or by copyrighted interfaces, the original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding those countries, so that
|
||||
distribution is permitted only in or among countries not thus excluded. In such case, this License
|
||||
incorporates the limitation as if written in the body of this License.</para>
|
||||
</section>
|
||||
<section id="gpl-2-9">
|
||||
<title>Section 9</title>
|
||||
<para>The Free Software Foundation may publish revised and/or new versions of the General Public 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.</para>
|
||||
|
||||
<para>Each version is given a distinguishing version number. If the Program specifies a version number of
|
||||
this License which applies to it and <quote>any later version</quote>, you have the option of following the terms
|
||||
and conditions either of that version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of this License, you may choose any
|
||||
version ever published by the Free Software Foundation.</para>
|
||||
</section>
|
||||
<section id="gpl-2-10">
|
||||
<title>Section 10</title>
|
||||
<para>If you wish to incorporate parts of the Program into other free programs whose distribution
|
||||
conditions are different, write to the author to ask for permission. For software which is copyrighted
|
||||
by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions
|
||||
for this. Our decision will be guided by the two goals of preserving the free status of all
|
||||
derivatives of our free software and of promoting the sharing and reuse of software generally.</para>
|
||||
</section>
|
||||
<section id="gpl-2-11">
|
||||
<title>NO WARRANTY Section 11</title>
|
||||
<para>BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT
|
||||
PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE PROGRAM <quote>AS IS</quote> WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
|
||||
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</para>
|
||||
</section>
|
||||
<section id="gpl-2-12">
|
||||
<title>Section 12</title>
|
||||
<para>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
|
||||
ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
|
||||
INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH
|
||||
ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.</para>
|
||||
|
||||
<para>END OF TERMS AND CONDITIONS</para>
|
||||
</section>
|
||||
</section>
|
||||
<section id="gpl-3">
|
||||
<title>How to Apply These Terms to Your New Programs</title>
|
||||
<para>If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.</para>
|
||||
|
||||
<para>To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the <quote>copyright</quote> line and a pointer to where the full notice is found.</para>
|
||||
|
||||
<para><one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author></para>
|
||||
|
||||
<para>This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.</para>
|
||||
|
||||
<para>This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.</para>
|
||||
|
||||
<para>You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</para>
|
||||
|
||||
<para>Also add information on how to contact you by electronic and paper mail.</para>
|
||||
|
||||
<para>If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:</para>
|
||||
|
||||
<para>Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type <quote>show w</quote>.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type <quote>show c</quote> for details.</para>
|
||||
|
||||
<para>The hypothetical commands <quote>show w</quote> and <quote>show c</quote> should
|
||||
show the appropriate parts of the General Public License. Of course, the commands you
|
||||
use may be called something other than <quote>show w</quote> and <quote>show c</quote>;
|
||||
they could even be mouse-clicks or menu items--whatever suits your program.</para>
|
||||
|
||||
<para>You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a <quote>copyright disclaimer</quote> for the program, if
|
||||
necessary. Here is a sample; alter the names:</para>
|
||||
|
||||
<para>Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
<quote>Gnomovision</quote> (which makes passes at compilers) written by James Hacker.</para>
|
||||
|
||||
<para><signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice</para>
|
||||
|
||||
<para>This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Library General
|
||||
Public License instead of this License.</para>
|
||||
</section>
|
||||
</appendix>
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 124 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.7 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 53 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.0 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 4.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 9.7 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 9.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.7 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
|
|
@ -0,0 +1,73 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15" standalone="no" ?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
|
||||
"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
|
||||
<!ENTITY pandora_version "v1.2">
|
||||
<!ENTITY pandora "<emphasis>Pandora</emphasis>">
|
||||
<!ENTITY include_fdl SYSTEM "fdl.xml">
|
||||
<!ENTITY include_gpl SYSTEM "gpl.xml">
|
||||
<!ENTITY include_pandora_chapter1 SYSTEM "pandora_chapter1.xml">
|
||||
<!ENTITY include_pandora_chapter2 SYSTEM "pandora_chapter2.xml">
|
||||
<!ENTITY include_pandora_chapter3 SYSTEM "pandora_chapter3.xml">
|
||||
<!ENTITY include_pandora_chapter4 SYSTEM "pandora_chapter4.xml">
|
||||
<!ENTITY include_pandora_chapter5 SYSTEM "pandora_chapter5.xml">
|
||||
<!ENTITY include_pandora_chapter6 SYSTEM "pandora_chapter6.xml">
|
||||
<!ENTITY include_pandora_chapter7 SYSTEM "pandora_chapter7.xml">
|
||||
<!ENTITY include_pandora_chapter8 SYSTEM "pandora_chapter8.xml">
|
||||
<!ENTITY include_pandora_chapter9 SYSTEM "pandora_chapter9.xml">
|
||||
]>
|
||||
|
||||
<book lang="en">
|
||||
<bookinfo>
|
||||
<title>&pandora; &pandora_version;</title>
|
||||
<graphic fileref="./img/pandora_logo.jpg" valign="bottom" align="center"/>
|
||||
<copyright>
|
||||
<year>2006</year>
|
||||
<holder>
|
||||
Ártica Soluciones Tecnológicas S.L, Sancho Lerena, Esteban Sánchez y otros.
|
||||
</holder>
|
||||
</copyright>
|
||||
<date>11/09/2006</date>
|
||||
<releaseinfo>&pandora_version;</releaseinfo>
|
||||
<edition>First Edition(&pandora_version;)</edition>
|
||||
<pubdate>
|
||||
September 11th, 2006</pubdate>
|
||||
<keywordset>
|
||||
<keyword>pandora user manual</keyword>
|
||||
</keywordset>
|
||||
<legalnotice>
|
||||
<para>
|
||||
Permission is granted to copy, distribute and/or modify this
|
||||
document under the terms of the GNU Free Documentation
|
||||
License, Version 1.1 or any later version published by the
|
||||
Free Software Foundation. A copy of the license is included
|
||||
in the section entitled <quote>GNU Free Documentation
|
||||
License</quote>.
|
||||
</para>
|
||||
</legalnotice>
|
||||
<revhistory>
|
||||
<revision>
|
||||
<revnumber>1.0</revnumber>
|
||||
<date>11 Sept 2006</date>
|
||||
<revremark>Submitted.</revremark>
|
||||
</revision>
|
||||
<revision>
|
||||
<revnumber>0.1</revnumber>
|
||||
<date>11 Sept 2006</date>
|
||||
<revremark>First draft for review.</revremark>
|
||||
</revision>
|
||||
</revhistory>
|
||||
</bookinfo>
|
||||
|
||||
&include_pandora_chapter1;
|
||||
&include_pandora_chapter2;
|
||||
&include_pandora_chapter3;
|
||||
&include_pandora_chapter4;
|
||||
&include_pandora_chapter5;
|
||||
&include_pandora_chapter6;
|
||||
&include_pandora_chapter7;
|
||||
&include_pandora_chapter8;
|
||||
&include_pandora_chapter9;
|
||||
&include_fdl;
|
||||
&include_gpl;
|
||||
|
||||
</book>
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15"?>
|
||||
<chapter>
|
||||
<title>Introduction</title>
|
||||
<sect1>
|
||||
<title>Pandora Administration</title>
|
||||
|
||||
<para>The web console is the tool used to administrate Pandora.
|
||||
It is written in PHP and doesn't need any third party software
|
||||
to work –neither FLASH, JAVA, nor ActiveX plug-ins.
|
||||
The Web console can be run over any web browser supporting HTML and
|
||||
CSS (IE5+ or Mozilla 4+).</para>
|
||||
|
||||
<graphic fileref="images/image001.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>Pandora administration is divided in the following main elements:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Pandora users</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Agents</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Alerts</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Incidents</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Server configuration</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Database maintenance</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
@ -0,0 +1,165 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15"?>
|
||||
|
||||
<chapter>
|
||||
<title>Users</title>
|
||||
|
||||
<para>The definition of a user is based on the user's
|
||||
daily activity. One or more profiles can be assigned to a single user</para>
|
||||
|
||||
<para>A profile is a list of actions a user can or
|
||||
cannot perform on a given group, e.g. "view incidents",
|
||||
"database management", etc
|
||||
</para>
|
||||
|
||||
<para>Each user is given a number of groups of agents
|
||||
he/she has permission to access, as well as the administrative profile
|
||||
he/she will have in each group. Each user can belong to one or more
|
||||
groups, with an assigned profile for each of them.</para>
|
||||
|
||||
<para>Agent belongs to a group and only one, sharing
|
||||
the group with agents of similar characteristics. Groups also contain
|
||||
incidents.</para>
|
||||
|
||||
<para>Summarizing: User profiles in Pandora define which users can access
|
||||
Pandora as well as what each user can do. Groups define elements in common
|
||||
among various users. Each user could be in one or more groups at any one
|
||||
time. Each group has user profiles which are defined and attached to it.
|
||||
A profile is a list of things a user can do, such as view incidents,
|
||||
manage database or other.</para>
|
||||
|
||||
<sect1>
|
||||
<title>Profile manager</title>
|
||||
|
||||
<para>Pandora's profile manager is used to assign specific profiles
|
||||
to each user. A hierarchy of users is so created, structured by the
|
||||
user's profile within the company. With this system different security
|
||||
levels can be implemented: read-only users, agent group coordinators
|
||||
or system administrators.</para>
|
||||
|
||||
<para>A profile is created from the Profile Manager tool in the
|
||||
Administration menu. There are five predefined profiles:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Operator (Read)</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Operator (Write)</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Chief Operator</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Group coordinator</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Pandora Administrator</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>To create a new profile click on "Manage Profiles">
|
||||
"Create Profile" in the Administration Menu</para>
|
||||
|
||||
<graphic fileref="images/image002.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>Any of the following roles can be assigned to a new profile:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>View incidents (IR)</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Edit incidents (IW)</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Manage incidents (IM)</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>View agents (AR). To view agents as well as the events
|
||||
generated by them</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Edit agents (AW). To modify then agent's modules</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Edit alerts (LW). To modify the alerts assigned to an agent</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Manage users (UM). To modify users and their roles</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Manage DB (DM). To modify the configuration and data
|
||||
of the database (Global)</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Manage alerts (LM). To define new alerts (Global)</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Manage Pandora (PM). To modify general system settings</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Adding a user</title>
|
||||
|
||||
<para>A user is added clicking on "Manage Users">"Create user"
|
||||
in the Administration Menu</para>
|
||||
|
||||
<para>To create a new user it is necessary to, at
|
||||
least, fill in the user ID, the password (twice) and Pandora's global profile.</para>
|
||||
|
||||
<para>A global profile for a user maybe Administrator or Standard User.</para>
|
||||
|
||||
<para>A user with an "Administrator" profile will have the highest
|
||||
security privileges in Pandora.</para>
|
||||
|
||||
<graphic fileref="images/image003.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>Profiles must be assigned for each of the groups a new
|
||||
"standard" profile user can access, once the user is created
|
||||
and his configuration updated.</para>
|
||||
|
||||
<graphic fileref="images/image004.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>A user profile is deleted by clicking on the delete icon
|
||||
<graphic fileref="../../images/cancel.gif"/> on the right hand side
|
||||
of the profile.</para>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Deleting a user</title>
|
||||
|
||||
<para>A user is deleted by clicking on the delete icon
|
||||
<graphic fileref="../../images/cancel.gif"/> on the right hand
|
||||
side of the user. The list of users is accessed through the
|
||||
"Manage Users" option in the Administration menu.</para>
|
||||
|
||||
<graphic fileref="images/image005.png" valign="bottom" align="center"/>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Statistics</title>
|
||||
|
||||
<para>The user activity statistics show a graph with the activity
|
||||
of the user, being the number of events the audit has generated
|
||||
for each user. The number of events of
|
||||
a user usually reflects the user's activity.</para>
|
||||
|
||||
<para>Click on "View Users">"Statistics" in the Operation menu to show
|
||||
this graph:</para>
|
||||
|
||||
<graphic fileref="images/image006.png" valign="bottom" align="center"/>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Messages to users</title>
|
||||
|
||||
<para>To create a new message to other user, go to "Messages" section
|
||||
in the Operation menu. You can also read the received messages,
|
||||
but the sent messages are not stored.</para>
|
||||
|
||||
<sect2>
|
||||
<title>Messages to groups</title>
|
||||
<para>From "Messages">"Messages to groups" section in the
|
||||
Operation menu you can send messages to groups of users.
|
||||
The sent messages will not be stores.</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
@ -0,0 +1,682 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15"?>
|
||||
|
||||
<chapter>
|
||||
<title>Agents</title>
|
||||
|
||||
<para>The agents collect information. The public key
|
||||
of the machine to be monitored needs to be copied onto Pandora and the agent
|
||||
executed. Pandora's server starts now receiving and processing the data
|
||||
collected by the agent. The data collected from the agents are called "modules".</para>
|
||||
|
||||
<para>The value of each module it is the value of one
|
||||
monitored variable. The agent must be activated in Pandora's server and a group
|
||||
assigned to the agent. The data starts then been consolidated in the database
|
||||
and can be accessed.</para>
|
||||
|
||||
<para>The user can:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>View the agent status</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Access to the collected information</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Access the monitored values and its evolution in time</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>View graphic reports</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Configure Alerts</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<sect1>
|
||||
<title>Group Manager</title>
|
||||
|
||||
<para>Groups are added in "Manage Profiles" > "Manage Groups",
|
||||
Administration menu.</para>
|
||||
|
||||
<graphic fileref="images/image007.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>There are nine default groups on this screen.</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><b>Applications</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Comms</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Databases</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Firewall</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>IDS</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Others</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Servers</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Workstations</b></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>A group is added by clicking "Create group" and assigning
|
||||
a name to it.</para>
|
||||
<para>A group is deleted by clicking the delete icon
|
||||
<graphic fileref="../../images/cancel.gif"/>
|
||||
in the right hand side of each group.</para>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Adding an agent</title>
|
||||
|
||||
<para>Before an agent is added, the public key of the
|
||||
machine to be monitored needs to be copied. The agent is then executed, and
|
||||
added through the web console. The data starts now being consolidated in the
|
||||
Database and can be accessed.</para>
|
||||
|
||||
<para>An agent is added in "Manage Agents" > "Create agent" in the Administration menu.</para>
|
||||
|
||||
<graphic fileref="images/image008.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>To add a new agent the following parameters must be configured:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><b>Agent Name:</b> Name of the agent. This and the "agent name" parameter in Pandora's agent.conf file <b>must have the same value</b>. If this variable is commented out in the code, the name used will be the name of the Host (to obtain this, execute the <i>hostname</i> command).</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>IP Address:</b> IP address of an agent. An agent can share its IP address with other agents.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Group:</b> Pandora's group the agent belongs.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Interval:</b> Execution interval of an agent. It is the time elapsed between two executions.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>OS:</b> The Operating System to be monitored. The supported Operating Systems are: AIX, BeOS,
|
||||
BSD, Cisco, HPUX, Linux, MacOS, Other, Solaris, Windows.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Description:</b> Brief description of an agent.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Module definition:</b> There are two modes for a module:</para>
|
||||
</listitem>
|
||||
<para>- <i><b>Learning mode:</b></i> All the modules sent by the agent are accepted. They are automatically defined by the system. It is recommended to activate the agents in this mode and change it once the user is familiar with the system.</para>
|
||||
<para>- <i><b>Normal mode:</b></i> The modules in this mode must be configured manually. The self – definition of the modules is not allowed in this mode.</para>
|
||||
<listitem>
|
||||
<para><b>Disabled:</b> This parameter shows if the agent is activated and
|
||||
ready to send data or deactivated. The deactivated agents don't appear in the
|
||||
user views.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<sect2>
|
||||
<title>Assigning modules</title>
|
||||
|
||||
<para>Pandora's agents use the operating system own commands to monitor a device. Pandora's server will store and process the output generated by those commands. The commandos are called "modules".</para>
|
||||
|
||||
<para>If the agent had been added in "normal mode", the modules to be monitored should have been assigned. Those modules must be configured in the agent configuration file.</para>
|
||||
|
||||
<para>The modules to be processed by Pandora's server are assigned in the "Manage Agents" option, Administration menu. A list with all the agents in Pandora will be shown here.</para>
|
||||
|
||||
<para>You'll get a form with all the agent's settings when the agent name is clicked. In the same screen there is a section to assign modules.</para>
|
||||
|
||||
<graphic fileref="images/image009.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The following fields must be filled to create a module:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><b>Module type:</b> This is the type of data the module will process. There are five types of data:</para>
|
||||
</listitem>
|
||||
<para>
|
||||
- <b><code>generic_data</code></b>, Integer data type
|
||||
- <b><code>generic_data_inc</code></b>, Incremental integer data type
|
||||
- <b><code>generic_data_proc</code></b>, Boolean data type: 0 False, >0 True
|
||||
- <b><code>generic_data_string</code></b>, Alphanumeric data type (text string, max. 255 characters)
|
||||
</para>
|
||||
<listitem>
|
||||
<para><b>Module name:</b> The name of the module</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Maximum:</b> Upper threshold for the value in the module. Any value above this threshold will be taken as invalid and the whole module will be discarded.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Maximum:</b> Lower threshold for the value in the module. Any value below this threshold will be taken as invalid and the whole module will be discarded.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Comments:</b> Comments added to the module.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>All the modules to be monitored by an agent can be reviewed by accessing the agent in the "Manage Agents" option, Administration menu.</para>
|
||||
|
||||
<graphic fileref="images/image010.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>In this screen the modules can be:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Deleted by clicking <graphic fileref="../../images/cancel.gif"/></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Edited by clicking <graphic fileref="../../images/config.gif"/></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>However, the type of data of the module can't be modified.</para>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Alerts</title>
|
||||
|
||||
<para>An alert is Pandora's reaction to an out of range module value. The Alert can
|
||||
consist in sending and e-mail or SMS to the administrator, sending a SNMP trap,
|
||||
write the incident into the system syslog or Pandora log file, etc. And
|
||||
basically anything that can be triggered by a script configured in Pandora's
|
||||
Operating System.</para>
|
||||
<sect3>
|
||||
<title>Adding an Alert</title>
|
||||
|
||||
<para>The existing Alerts are accessed by clicking on the "Manage Alerts" option, Administration menu.</para>
|
||||
<para>There are 6 default types of Alerts:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><b>eMail</b>. Sends an e-mail from Pandora's Server</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Internal audit</b>. Writes the incident in Pandora's internal audit system</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>LogFile</b>. Writes the incident in the log file</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>SMS Text</b>. Sends an SMS to a given mobile phone</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>SNMP Trap</b>. Sends a SNMP Trap</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Syslog</b>. Sends an alert to the Syslog</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<graphic fileref="images/image011.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>An Alert is deleted by clicking on the delete icon <graphic fileref="../../images/cancel.gif"/> placed on the right hand side of the Alert. A new customised Alert can be created clicking in "Create Alert".</para>
|
||||
|
||||
<para>The values "<code>_field1_</code>", "<code>_field2_</code>" and "<code>_field3_</code>" in the customised Alerts are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode.</para>
|
||||
|
||||
<graphic fileref="images/image012.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>When a new Alert is created the following field must be filled in:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><b>Alert name:</b> The name of the Alert</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Command:</b> Command the Alert will trigger</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Description:</b> Description of the Alert</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>In 'Command' data field these variables are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode, replacing at runtime:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><code><b>_field1_</b></code>: Field #1, usually assigned as username, e-mail destination or single identification for this event</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><code><b>_field2_</b></code>: Field #2, usually assigned as short description of events, as subject line in e-mail</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><code><b>_field3_</b></code>: Field #3, a full text explanation for the event</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><code><b>_agent_</b></code>: Agent name</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><code><b>_timestamp_</b></code>: A standard representation of date and time. Replaced automatically when the event has been fired</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><code><b>_data_</b></code>: The data value that triggered the alert</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect3>
|
||||
<sect3>
|
||||
<title>Assigning Alerts</title>
|
||||
|
||||
<para>The next step after an Agent has been added, its modules have been configurated and the alerts have been defined, it is time to assign those Alerts to the agent.</para>
|
||||
|
||||
<para>This is done by clicking on the Agent to be configured on the "Manage Agents" option, Administration menu. The Alert Assignation form is placed at the bottom of that page.</para>
|
||||
|
||||
<graphic fileref="images/image013.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>To assign an Alert the next fields must be filled in:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><b>Alert type:</b> This can be selected from the list of alerts that have been previously generated.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Maximum Value:</b> Defines the maximum value for a module. Any value above that threshold will trigger the Alert.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Minimum Value:</b> Defines the minimum value for a module. Any value below that will trigger the Alert.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Description:</b> Describes the function of the Alert, and it is useful to identify the Alert amongst the others in the Alert General View.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Field #1 (Alias, name):</b> Define the used value for the "_field1_" variable.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Field #2 (Single Line):</b> Define the used value for the "_field2_" variable.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Field #3 (Full Text):</b> Define the used value for the "_field3_" variable.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Time threshold:</b> Minimum duration between the firing of two consecutive alerts, in seconds.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Max Alerts Fired:</b> Maximun number of alerts that can be sent consecutively.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Assigned module:</b> Module to be motitorized by the alert.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>All the alerts of an agent can be seen through "Manage Agents"
|
||||
in the Adminitration menu and selecting the agent.</para>
|
||||
</sect3>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Agent module and agent's alert management</title>
|
||||
|
||||
<para>It might happen that the user finds that modules and alerts
|
||||
configured for an agent would be repeated in a new agent.</para>
|
||||
|
||||
<para>In order to simplify the administrator's job Pandora offers
|
||||
the option of copying modules and alerts defined in an agent to be
|
||||
assigned to another.</para>
|
||||
|
||||
<para>The screen is accessed through "Manage Agents">
|
||||
"Manage Config.", in the Administration menu:</para>
|
||||
|
||||
<graphic fileref="images/image014.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The Source Agent menu permits the selection of the agent
|
||||
where the needed modules and/or alerts reside. The "Get Info"
|
||||
button shows the modules for that agent in the Modules list box.
|
||||
</para>
|
||||
|
||||
<para><b><i>The copy process</i></b> is performed to copy
|
||||
the module and/or alert configuration from the selected source
|
||||
agents to the selected destination agents. Several agents can be
|
||||
selected, pressing CTRL and the mouse right button simultaneously.
|
||||
The two tick boxes at the top of the form will be used to specify
|
||||
if the configuration to copy is from modules and/or from alerts.
|
||||
</para>
|
||||
|
||||
<para><b><i>The delete process</i></b> is performed to delete the
|
||||
configuration of the destination agents, in the multiple selection
|
||||
list box. Several agents can be selected at a time, and the tick
|
||||
boxes at the top of the form indicate whether it is the modules
|
||||
or the alerts configuration what is to be deleted. The
|
||||
application will prompt to confirm the deletion, as once
|
||||
deletion is performed, the data associated to them will also be
|
||||
deleted.</para>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Agents group detail</title>
|
||||
|
||||
<para>Once you have configured your groups and agents, you can
|
||||
see the status of the groups of agents through "View Agents",
|
||||
in the Operation Menu.</para>
|
||||
|
||||
<para>If you pass the mouse over any group image, you'll see
|
||||
the number of agents of that group as well the number of monitors,
|
||||
organized by status.</para>
|
||||
|
||||
<para>By pressing the icon
|
||||
<graphic fileref="../../images/target.gif"/>
|
||||
at the right of any group image, you will update the info of
|
||||
that group.</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Agent monitoring </title>
|
||||
|
||||
<para>When the agents start the data transmission to the server,
|
||||
and it is added in the Web console, Pandora processes and inserts
|
||||
the data in the Database. The data are consolidated and can be
|
||||
accessed from the Web console, either as row data or as graphs.</para>
|
||||
|
||||
<sect2>
|
||||
<title>Agent view</title>
|
||||
|
||||
<para>All the Agents can be accessed from the Operation menu.
|
||||
From here the status of the agents can be quickly reviewed thanks
|
||||
to a simple system of bulbs and coloured circles.</para>
|
||||
|
||||
<graphic fileref="images/image015.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The list of agents shows all the relevant the information
|
||||
in the following columns:</para>
|
||||
|
||||
<para><b>Agent:</b> Shows the agent's name.</para>
|
||||
<para><b>SO:</b> Displays an icon that represents the
|
||||
Operating System.</para>
|
||||
<para><b>Interval:</b> Shows the time interval (seconds)
|
||||
in which the agent sends data to the server.</para>
|
||||
<para><b>Group:</b> This is the group the agent belongs to.</para>
|
||||
<para><b>Modules:</b> Under normal circumstances this field
|
||||
shows the values representing the number of modules and
|
||||
the number of monitors, both in black. If the status of a monitor
|
||||
changes to "incorrect", one additional number is shown: the number
|
||||
of modules, the number of monitors and the number of monitors with
|
||||
"incorrect" status, all in black save the last one.</para>
|
||||
<para><b>Status:</b> Shows the "general" status of the agent
|
||||
through the following icons:</para>
|
||||
<para>
|
||||
<graphic fileref="../../images/b_green.gif"/>
|
||||
All the monitors OK. It's the ideal status.
|
||||
<graphic fileref="../../images/b_white.gif"/>
|
||||
No defined monitors. Sometimes nothing is monitored
|
||||
that could be right or wrong, and only numeric or
|
||||
text data is reported.
|
||||
<graphic fileref="../../images/b_red.gif"/>
|
||||
At least one of the monitors is failing. Usually we
|
||||
want to avoid this, and keep our systems in a healthy
|
||||
green colour.
|
||||
<graphic fileref="../../images/b_blue.gif"/> The agent
|
||||
doesn't have <u>any</u> data. New agents with an empty data
|
||||
package can have this status.
|
||||
<graphic fileref="../../images/b_yellow.gif"/> Colour
|
||||
shifting from green to red. This icon indicates
|
||||
that the agent has just changed its status, from
|
||||
'All OK' to 'we have a problem'.
|
||||
<graphic fileref="../../images/b_down.gif"/> When an agent
|
||||
is down or there is no news from it for 2 times the Interval
|
||||
value in seconds. Usually it is due to a communication issue
|
||||
or a crashed remote system.>
|
||||
</para>
|
||||
<para><b>Alerts:</b> Shows if any alerts have been sent
|
||||
through the following icons:</para>
|
||||
<para>
|
||||
<graphic fileref="../../images/dot_green.gif"/>
|
||||
No alerts have been sent.
|
||||
<graphic fileref="../../images/dot_red.gif"/>
|
||||
When at least one alert has been sent within
|
||||
the time threshold of the alert.
|
||||
</para>
|
||||
<para><b>Last contact:</b> Shows the time and date of the
|
||||
last data package sent by the agent, using a progress bar,
|
||||
according to value of the interval. If you see the image
|
||||
<graphic fileref="../../images/outof.gif"/>,
|
||||
the agent has not send data during the interval.
|
||||
Passing the mouse over the image will show you the last contact
|
||||
in time and date format.</para>
|
||||
|
||||
<para><b><u>Note:</u></b> The icon
|
||||
<graphic fileref="../../images/setup.gif" width="15"/>
|
||||
is only visible if you're and administrator and it's a link
|
||||
to the "Manage Agents" > "Update Agent" option in the
|
||||
Administration menu.
|
||||
</para>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Accessing the data of an agent</title>
|
||||
|
||||
<para>When an agent is accessed, by clicking on its name, all the
|
||||
information related to that agent is displayed.</para>
|
||||
<sect3>
|
||||
<title>Agent general info</title>
|
||||
|
||||
<para>This shows the data introduced when the agent was created
|
||||
and the total number a data packages the agent has sent.</para>
|
||||
|
||||
<graphic fileref="images/image016.png" valign="bottom" align="center"/>
|
||||
</sect3>
|
||||
<sect3>
|
||||
<title>Last data received</title>
|
||||
|
||||
<para>This is the description of all the agent modules
|
||||
been monitored.</para>
|
||||
|
||||
<graphic fileref="images/image017.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>In this list the module information is shown
|
||||
in the following columns:</para>
|
||||
|
||||
<para><b>Module name:</b> Name given to the module
|
||||
in the agent's config file.</para>
|
||||
<para><b>Module type:</b> Type of module as described
|
||||
in <a href="#321">section 3.2.1</a>.</para>
|
||||
<para><b>Description:</b> Description given to the module
|
||||
in the agent's config file.</para>
|
||||
<para><b>Data:</b> Last data sent by the agent.</para>
|
||||
<para><b>Graph:</b> Monthly(M), Weekly(W), Daily(D)
|
||||
and Hourly(H) graphs are generated with
|
||||
the data sent by the agent against time.</para>
|
||||
|
||||
<para>On the left hand side of the graph the newst
|
||||
data is represent, and on the right had side the oldest.</para>
|
||||
|
||||
<para>The generated graphs are:</para>
|
||||
<para> - <b>Hourly graph</b>
|
||||
(<graphic fileref="../../images/grafica_h.gif"/>)
|
||||
covers a 60 minute interval</para>
|
||||
<graphic fileref="images/image018.png" valign="bottom" align="center"/>
|
||||
|
||||
<para> - <b>Daily graph</b>
|
||||
(<graphic fileref="../../images/grafica_d.gif"/>)
|
||||
covers a 24 hour interval</para>
|
||||
<graphic fileref="images/image019.png" valign="bottom" align="center"/>
|
||||
|
||||
<para> - <b>Weekly graph</b>
|
||||
(<graphic fileref="../../images/grafica_w.gif"/>)
|
||||
covers a 7 day interval</para>
|
||||
<graphic fileref="images/image020.png" valign="bottom" align="center"/>
|
||||
|
||||
<para> - <b>Mothly graph</b>
|
||||
(<graphic fileref="../../images/grafica_m.gif"/>)
|
||||
covers a 30 day interval</para>
|
||||
<graphic fileref="images/image021.png" valign="bottom" align="center"/>
|
||||
|
||||
<para><b>Raw Data:</b> This is the raw data sent by the agent</para>
|
||||
|
||||
<para> - <graphic fileref="../../images/data_m.gif"/> Last month</para>
|
||||
<para> - <graphic fileref="../../images/data_w.gif"/> Last week</para>
|
||||
<para> - <graphic fileref="../../images/data_d.gif"/> Last day</para>
|
||||
</sect3>
|
||||
<sect3>
|
||||
<title>Complete list of monitors</title>
|
||||
|
||||
<para>This is the description of all the monitors defined by
|
||||
the agent</para>
|
||||
|
||||
<graphic fileref="images/image022.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The list shows the information about the monitors in the
|
||||
following columns:</para>
|
||||
|
||||
<para><b>Agent:</b> Agent where the monitor is defined.</para>
|
||||
<para><b>Type:</b> Data type of the monitor. For a monitor this
|
||||
value is always of the generic_proc type.</para>
|
||||
<para><b>Module name:</b> Name given to the module when it was
|
||||
created.</para>
|
||||
<para><b>Description:</b> Description given to the module
|
||||
in the agent's config file.</para>
|
||||
<para><b>Status:</b> The table shows the agent status through
|
||||
the following icons:</para>
|
||||
|
||||
<para><graphic fileref="../../images/b_green.gif"/>
|
||||
The monitor is OK</para>
|
||||
<para><graphic fileref="../../images/b_red.gif"/>
|
||||
The monitor is failing</para>
|
||||
|
||||
<para><b>Last contact:</b> Shows the time and date of
|
||||
the last data packaged received from the agent</para>
|
||||
|
||||
</sect3>
|
||||
<sect3>
|
||||
<title>Complete list of alerts</title>
|
||||
|
||||
<para>This is the description of all the alarms defined
|
||||
in the agent</para>
|
||||
|
||||
<graphic fileref="images/image023.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The monitor information is shown in the list
|
||||
divided in the following fields:</para>
|
||||
|
||||
<para><b>ID:</b> Agent were the alert has been defined.</para>
|
||||
<para><b>Type:</b> Type of alert.</para>
|
||||
<para><b>Description:</b> Description given to the alert when
|
||||
it was created.</para>
|
||||
<para><b>Last fired:</b> The last time the alert was
|
||||
executed.</para>
|
||||
<para><b>Times Fired:</b> Number of times the alert was
|
||||
launched.</para>
|
||||
<para><b>Status:</b> Shows if the alert has been sent through
|
||||
the following icon:</para>
|
||||
|
||||
<para><graphic fileref="../../images/dot_green.gif"/> No alerts
|
||||
have been sent</para>
|
||||
<para><graphic fileref="../../images/dot_red.gif"/> At least
|
||||
one alert has been sent</para>
|
||||
</sect3>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Group details</title>
|
||||
|
||||
<para>The groups configured in Pandora can be
|
||||
accessed through "View Agents">"Group detail" in the
|
||||
Operation menu. The group details can be reviewed quickly thanks
|
||||
to a system of coloured bulbs.</para>
|
||||
|
||||
<graphic fileref="images/image025.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The groups are displayed ordered by the following columns:</para>
|
||||
|
||||
<para><b>Groups:</b> Name of the group</para>
|
||||
<para><b>Agents:</b> Number of agents configured
|
||||
in the group.</para>
|
||||
<para><b>Monitors:</b> Number of monitors configured
|
||||
in the group.</para>
|
||||
<para><b>Status:</b> The status is described through
|
||||
the following icons:</para>
|
||||
|
||||
<para><graphic fileref="../../images/b_green.gif"/>
|
||||
All monitors are OK.</para>
|
||||
<para><graphic fileref="../../images/b_red.gif"/>
|
||||
At least one monitor has failed.</para>
|
||||
<para><graphic fileref="../../images/b_down.gif"/>
|
||||
At least one monitor is down and there is no contact
|
||||
with it.</para>
|
||||
<para><graphic fileref="../../images/b_white.gif"/>
|
||||
This Agent doesn't have any monitor defined.</para>
|
||||
|
||||
<para><b>OK:</b> Number of monitors that are OK.</para>
|
||||
<para><b>Failed:</b> Number of failing monitors.</para>
|
||||
<para><b>Down:</b> Number of down monitors.</para>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Monitors view</title>
|
||||
|
||||
<para>The description of all the monitors defined in the server
|
||||
can be viewed from the "View Agents">"Monitor detail"
|
||||
option in the Operation menu.</para>
|
||||
|
||||
<graphic fileref="images/image026.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>In this list all the monitors appear in a similar way as
|
||||
in the individual view, but now they are shown all together.
|
||||
This allows a deeper analisys of each monitor.</para>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Alert details</title>
|
||||
|
||||
<para>The description of all the alerts defined in the server
|
||||
can be viewed from the "View Agents">"Alert Details"
|
||||
option in Operation menu.</para>
|
||||
|
||||
<graphic fileref="images/image027.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>In this list all the alerts appear in a similar way
|
||||
as in the individual view, but now they are shown all together.
|
||||
This allows a deeper analisys of each alert.</para>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Data Export</title>
|
||||
|
||||
<para>The Data Export tool can be found in the "View Agents">"
|
||||
Export data" option in the Operation Menu.</para>
|
||||
|
||||
<para>Three parameters need to be configured for exporting data:
|
||||
the agent where data resides, the modules to be exported
|
||||
and the date interval of the data to be exported:</para>
|
||||
|
||||
<graphic fileref="images/image028.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The fields in the results of Exporting data are:</para>
|
||||
|
||||
<para><b>Module:</b> Module name.</para>
|
||||
<para><b>Data:</b> Data contained by the module.</para>
|
||||
<para><b>Timestamp:</b> Date and time of the the package
|
||||
was sent by the agent.</para>
|
||||
|
||||
<graphic fileref="images/image029.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>Selecting the CSV format for the output, a text
|
||||
file with extension <b>.csv</b> is be created. The data
|
||||
is qualified by single quotes
|
||||
and the fields separated by commas:</para>
|
||||
|
||||
<graphic fileref="images/image030.png" valign="bottom" align="center"/>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Statistics</title>
|
||||
|
||||
<para>Two kinds of graphical statistics are displayed from the
|
||||
"View Agents" >"Statistics" option, in the Operation menu:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>A graph with the number of modules configurated for each
|
||||
agent</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>A graph with number of packages sent by each Agent.
|
||||
A package is the number of values from the modules the agent
|
||||
sends after each time interval</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<graphic fileref="images/image031.png" valign="bottom" align="center"/>
|
||||
<graphic fileref="images/image032.png" valign="bottom" align="center"/>
|
||||
<graphic fileref="images/image033.png" valign="bottom" align="center"/>
|
||||
</sect2>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>SNMP Console</title>
|
||||
<para></para>
|
||||
<sect2>
|
||||
<title>SNMP Alerts</title>
|
||||
<para></para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
@ -0,0 +1,235 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15"?>
|
||||
|
||||
<chapter>
|
||||
<title>Incident management</title>
|
||||
|
||||
<para>The system monitoring process needs to follow up the incidents
|
||||
arising in the system besides receiving and processing the data to be
|
||||
monitored in each time interval</para>
|
||||
|
||||
<para>Pandora uses a tool called Incident Manager for this task, where
|
||||
each user can open an incident, where a description of what happened
|
||||
in the network is shown. This can be completed with comments and files
|
||||
when necessary.</para>
|
||||
|
||||
<para>This system is designed for group work. Different roles and
|
||||
workflow systems permit to move incidents from one group to another.
|
||||
The system allows different groups and different users to work on
|
||||
the same incident, sharing information and files.</para>
|
||||
|
||||
<para>Clicking on "Manage Incidents", in the Operation menu, a list
|
||||
showing all the incidents is displayed, ordered by the date-time they
|
||||
were last updated. Filters can be applied to display only those
|
||||
incidents the user is interested on.</para>
|
||||
|
||||
<graphic fileref="images/image034.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The filters that can be applied are:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><b>Incident status filter</b>. The user can display:
|
||||
<para>- All incidents</para>
|
||||
<para>- Active incidents</para>
|
||||
<para>- Closed incidents</para>
|
||||
<para>- Rejected incidents</para>
|
||||
<para>- Expired incidents</para>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<b>Property filter</b>. The incidents are shown by:
|
||||
<para>- All priorities</para>
|
||||
<para>- Informative priority</para>
|
||||
<para>- Low priority</para>
|
||||
<para>- Medium priority</para>
|
||||
<para>- High priority</para>
|
||||
<para>- Very high priority</para>
|
||||
<para>- Maintenance</para>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Group filter</b>. It can be selected to display just the
|
||||
incidents of a given Pandora group.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>The incident list is displayed showing information in the following
|
||||
columns:</para>
|
||||
|
||||
<para><b>ID:</b> ID of the incident.</para>
|
||||
<para><b>Status:</b> The incident status is represented by the following
|
||||
icons:</para>
|
||||
|
||||
<para><graphic fileref="../../images/dot_red.gif"/> Active incident</para>
|
||||
<para><graphic fileref="../../images/dot_yellow.gif"/> Active incident
|
||||
with comments</para>
|
||||
<para><graphic fileref="../../images/dot_blue.gif"/> Rejected incident</para>
|
||||
<para><graphic fileref="../../images/dot_green.gif"/> Closed incident</para>
|
||||
<para><graphic fileref="../../images/dot_white.gif"/> Expired incident</para>
|
||||
|
||||
<para><b>Incident name:</b> Name given to the incident</para>
|
||||
<para><b>Priority:</b> The incident assigned priority is represented
|
||||
by the following icons:</para>
|
||||
|
||||
<para><graphic fileref="../../images/dot_red.gif"/>
|
||||
<graphic fileref="../../images/dot_red.gif"/>
|
||||
<graphic fileref="../../images/dot_red.gif"/>
|
||||
Very high priority</para>
|
||||
<para><graphic fileref="../../images/dot_yellow.gif"/>
|
||||
<graphic fileref="../../images/dot_red.gif"/>
|
||||
<graphic fileref="../../images/dot_red.gif"/>
|
||||
High priority</para>
|
||||
<para><graphic fileref="../../images/dot_yellow.gif"/>
|
||||
<graphic fileref="../../images/dot_yellow.gif"/>
|
||||
<graphic fileref="../../images/dot_red.gif"/>
|
||||
Medium priority</para>
|
||||
<para><graphic fileref="../../images/dot_green.gif"/>
|
||||
<graphic fileref="../../images/dot_yellow.gif"/>
|
||||
<graphic fileref="../../images/dot_yellow.gif"/>
|
||||
Low priority</para>
|
||||
<para><graphic fileref="../../images/dot_green.gif"/>
|
||||
<graphic fileref="../../images/dot_green.gif"/>
|
||||
<graphic fileref="../../images/dot_yellow.gif"/>
|
||||
Informative priority</para>
|
||||
<para><graphic fileref="../../images/dot_green.gif"/>
|
||||
<graphic fileref="../../images/dot_green.gif"/>
|
||||
<graphic fileref="../../images/dot_green.gif"/> Maintenance priority</para>
|
||||
|
||||
<para><b>Group:</b> The name of the group the incident has been assigned
|
||||
to. One incident can only belong to a single group.</para>
|
||||
<para><b>Updated at:</b> This is the date/time the incident was updated
|
||||
for the last time.</para>
|
||||
<para><b>Source:</b> The source of the incident. The source is selected
|
||||
from a list stored
|
||||
in the data base. This list can only be modified by the database base
|
||||
administrator.</para>
|
||||
<para><b>Owner:</b> User to whom the incident has been assigned to.
|
||||
It doesn't coinced
|
||||
with the creator of the incident, as the incident may have been moved
|
||||
from one user to another. The incident can be assigned to another user
|
||||
by its owner, or by a user with management privileges over the group
|
||||
the incidents belong to.</para>
|
||||
<sect1>
|
||||
<title>Adding an incident</title>
|
||||
|
||||
<para>The creation of incidents is performed by clicking on
|
||||
"Manage Incidents" > "New incident", in the Operation menu</para>
|
||||
|
||||
<graphic fileref="images/image035.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The "Create Incident" form will come up, containing the necessary
|
||||
fields to define the incident. The process is completed by clicking
|
||||
on the "Create" button.</para>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Incident follow up</title>
|
||||
|
||||
<para>All the open incidents can be followed up. The tool is reached by
|
||||
clicking on the "Manage Incidents" option, in the Operation menu.</para>
|
||||
|
||||
<para>The indicent is selected by clicking on its name in the
|
||||
"Incident name" column.</para>
|
||||
|
||||
<para>The screen coming up shows us the configuration variables of
|
||||
the incident, its comments and attached files.</para>
|
||||
|
||||
<para>The first part of the screen contains the Incident configuration.</para>
|
||||
|
||||
<graphic fileref="images/image036.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>From this form the following values can be updated:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><b>Incident name</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Incident owner</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Incident status</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Incident source</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Group the indicent will belong to</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Indicent priority</b></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The indicent is updated by clicking on the "Update incident" button.</para>
|
||||
<sect2>
|
||||
<title>Adding comments to an incident</title>
|
||||
|
||||
<para> Comments about the incident can added clicking on "Add note". This will open up a screen with a text box in it.</para>
|
||||
|
||||
<graphic fileref="images/image037.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The comment is written in this box. The Comment will appear in the "Notes attached to incident" section after the button "Add" is pressed.</para>
|
||||
|
||||
<graphic fileref="images/image038.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>Only users with writting privilieges can add a comment, and only the owners of the incident or of the notes can delete them.</para>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Attaching files to an incident</title>
|
||||
|
||||
<para>Sometimes it is necessary to link an incident with an image, a configuration file, or any kind of file.</para>
|
||||
|
||||
<para>The files are attached in the "Attach file" section. Here the file can be searched for in the local machine and attached when the "Upload" button is pressed.</para>
|
||||
|
||||
<para>Only a user with writing privileges can attach a file, and only the owner of the incident or of the file can delete it.</para>
|
||||
|
||||
<graphic fileref="images/image039.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The incident follow up screen shows all the files attached to the incident in the "Attached files" section of the screen.</para>
|
||||
|
||||
<graphic fileref="images/image040.png" valign="bottom" align="center"/>
|
||||
</sect2>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Searching for an incident</title>
|
||||
|
||||
<para>A specific incident can be found amongst the
|
||||
incidents created in Pandora by either using a filter – as explained in the
|
||||
first section of this chapter - or by making a query using the "Manage Incidents">"Searh Incident" tool, in the Operation menu.</para>
|
||||
|
||||
<graphic fileref="images/image041.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>Any text string included as a sub-string in the
|
||||
incident can be searched for using this tool. This search engine looks for the
|
||||
string in the Incident title as well as in the text contained by the incident.
|
||||
The search engine will not search neither the Comments added to the agent nor
|
||||
the attached files. The search can be performed in addition to group, priority
|
||||
or status filters.</para>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Statistics</title>
|
||||
|
||||
<para>The incident statisticts are shown in the "Manage Incidents">"Statistics" option of the Operation menu. They can be of five different types:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><b>Incident status</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Incident priority</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Users with the incident opened</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Incidents by group</b></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><b>Incident source</b></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<graphic fileref="images/image042.png" valign="bottom" align="center"/>
|
||||
<graphic fileref="images/image043.png" valign="bottom" align="center"/>
|
||||
<graphic fileref="images/image044.png" valign="bottom" align="center"/>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15"?>
|
||||
|
||||
<chapter>
|
||||
<title>Events</title>
|
||||
|
||||
<para>An event in Pandora is any unusual change happend in an agent.</para>
|
||||
|
||||
<para>An event is registered when an agent is down or starts up, when a
|
||||
monitor fails or changes its status, or when an alarm is sent.</para>
|
||||
|
||||
<para>An event is usually preceded by an issue with
|
||||
the system being monitored. A validation and deletion system has been created
|
||||
to avoid leaving unanalised issues, so they can be easily validated or deleted
|
||||
if the problem can be ignored or it's been already solved.</para>
|
||||
|
||||
<para>The events appear ordered chronologically as they enter the system,
|
||||
and can be viewed by clicking the "View Events" option in the Operation menu.
|
||||
The newer events are placed at the top of the table.</para>
|
||||
|
||||
<graphic fileref="images/image045.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The event information list shows the data in the following columns:</para>
|
||||
|
||||
<para><b>Status:</b> The event status is represented by the icon bellow:</para>
|
||||
<graphic fileref="../../images/dot_green.gif"/> The event has been validated
|
||||
<graphic fileref="../../images/dot_red.gif"/> The event hasn't been validated
|
||||
<para><b>Event name:</b> Name assigned to the event by Pandora.</para>
|
||||
<para><b>Agent name:</b> Agent where the event happend.</para>
|
||||
<para><b>Group name:</b> Group of the agent where the event has happened.</para>
|
||||
<para><b>User ID: </b>User that validated the event.</para>
|
||||
<para><b>Timestamp:</b> Date and time when the event was raised or validated
|
||||
- if it has been validated.</para>
|
||||
<para><b>Action:</b> Action that can be executed over the event.</para>
|
||||
<graphic fileref="../../images/ok.gif"/> This icon will validate the event, disappearing the icon
|
||||
<graphic fileref="../../images/cancel.gif"/> This icon will delete the event
|
||||
|
||||
<para>The events can be also validated or deleted in groups by selecting
|
||||
the tick boxes on the last column of the event, and pressing "Validate" or
|
||||
"Delete" at the bottom of the list.</para>
|
||||
<sect1>
|
||||
<title>Statistics</title>
|
||||
|
||||
<para>Three different kinds of graphical statistic representation can be
|
||||
choosen from the "View Events">"Statistics" option in the Operation
|
||||
menu:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Total number of events divided by revised and not revised
|
||||
<graphic fileref="images/image046.png" valign="bottom" align="center"/>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Total events divided by the users who validated the events
|
||||
<graphic fileref="images/image047.png" valign="bottom" align="center"/>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Total events divided by the group the agent raising the event belongs to
|
||||
<graphic fileref="images/image048.png" valign="bottom" align="center"/>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15"?>
|
||||
|
||||
<chapter>
|
||||
<title>System audit</title>
|
||||
|
||||
<para>The Pandora's system audit shows all the actions performed by each user, as well as the failed logins.</para>
|
||||
|
||||
<para>In the actual version of Pandora the system
|
||||
audit includes actions that somehow try to by pass the security system:
|
||||
attempts to delete an incident by an unauthorised user, attemps to change user
|
||||
profiles by unauthoried users, etc. Its main function is, however, to trace the
|
||||
user connections (login/logout).</para>
|
||||
|
||||
<para>The audit Logs can be found in the System Audit option of the Administration menu, ordered chronologicly.</para>
|
||||
|
||||
<para>Filters can be applied to the Logs displayed to show only those of interest for the user, selected by the action the Log produces.</para>
|
||||
|
||||
<para>The selectable actions are those actions stored in the Data Base at that time.</para>
|
||||
|
||||
<graphic fileref="images/image049.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The following fields display the Audit Logs information:</para>
|
||||
|
||||
<para><b>User:</b> User that triggerd the event (SYSTEM isspecial user of the system).</para>
|
||||
<para><b>Action:</b> Action generated by the entry in the log.</para>
|
||||
<para><b>Date:</b> Date of the entry in the log.</para>
|
||||
<para><b>Source IP:</b> IP of the machine or the agent that provoked the entry.</para>
|
||||
<para><b>Comment:</b> Comment describing the entry</para>
|
||||
|
||||
<sect1>
|
||||
<title>Statistics</title>
|
||||
|
||||
<para>There isn't a special section to view system audit statistics. However, we could use a graph generated in the Users section to evaluate the actions of each user, as this graph would represent the total
|
||||
number of entries in the audit log for each one: the more active the user is the higher the number of entries.</para>
|
||||
|
||||
<para>The graph will also show entries of invalid users, i.e., those entries generated by failed attemps to log in.</para>
|
||||
|
||||
<graphic fileref="images/image050.png" valign="bottom" align="center"/>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15"?>
|
||||
|
||||
<chapter>
|
||||
<title>Pandora Servers</title>
|
||||
|
||||
<para>From "Manage Servers" section, in the Administration menu you can see a list of configured Pandora Servers and also can manage them.</para>
|
||||
|
||||
<para>From "Pandora Servers" in the Operation menu you can see a list of the Pandora Servers.</para>
|
||||
|
||||
</chapter>
|
||||
|
|
@ -0,0 +1,166 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15"?>
|
||||
|
||||
<chapter>
|
||||
<title>Database Maintenance</title>
|
||||
|
||||
<para>The core of Pandora's system is its Database. All the data collected by the monitored
|
||||
machines is stored in this data base, from the administrator's data, to the
|
||||
events, incidents and audit data generated in the system at any time.</para>
|
||||
|
||||
<para>It is obvious that the efficiency and reliability of this module is vital for the correct functioning of Pandora. A regular data base maintainance is needed. To do so the data base managers can
|
||||
use standard MySQL commands. Maintaining Pandora database in good condition is critital for Pandora to work properly.</para>
|
||||
|
||||
<para>As the database size will increase linearly, the data will be compacted to reduce the amount of stored data without loosing important information, specially the different graphs that are generated with
|
||||
the processed data.</para>
|
||||
|
||||
<para>Going to "DB Maintenance" from the Administration menu we will find the Database configuration defined in the "Pandora Setup" option of the Administration menu to compact and delete data.</para>
|
||||
|
||||
<graphic fileref="images/image054.png" valign="bottom" align="center"/>
|
||||
<sect1>
|
||||
<title>DB Information</title>
|
||||
|
||||
<para>The DB statistics are generated by Agent, on the "DB Maintenance">"DB Information" in the Administration menu, and are represented in two kinds of graphs:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Number of modules configured for each of the agents.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Number of packages sent by each agent. A package is the group of data linked to the module the agent sends in each interval of time.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<graphic fileref="images/image055.png" valign="bottom" align="center"/>
|
||||
<graphic fileref="images/image056.png" valign="bottom" align="center"/>
|
||||
<graphic fileref="images/image057.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>These graphs can be also viewed from
|
||||
"View Agents">"Statistics" in the Operation menu.</para>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Manual purge of the Datadase</title>
|
||||
|
||||
<para>Pandora counts with powerful tools for the
|
||||
Administrator to manually purge the majority of data stored in the Database.
|
||||
This includes data generated by both the agents and the own server.</para>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Agent's data purge</title>
|
||||
<sect2>
|
||||
<title>Debuging selected data from a module</title>
|
||||
|
||||
<para>The option of purging selected data from a module is used to eliminate those out of range entries, whatever the reason – agent failure, out of range values, testing, DB errors, etc. Eliminating erroneous, incorrect or unnecessary data makes the graphical representation more acuarate and shows the data without peaks or unreal scales.</para>
|
||||
|
||||
<para>From "DB Maintenance">"Database Debug" in the Administration menu any of the out of range data received from a agent's module can be deleted.</para>
|
||||
|
||||
<graphic fileref="images/image058.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>The purge settings are: agent, module, minimum and maximum data range. Any parameter out of this minimum/maximum range will be deleted.</para>
|
||||
|
||||
<para>For example, in a module registering the number of processes, if we are only interested in values between 0 and 100, any values above that number will be usually produced by errors, noise or abnormal
|
||||
circumstances. If we set to range between 0 and 100 all those values below and above - such as -1, 100 or 100000 - will be permanently deleted from the database.</para>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Purging all the agent's data</title>
|
||||
|
||||
<para>All the out of range data received by an agent can be deleted from the "DB Maintainance">"Database Purge" option in the Administration menu.</para>
|
||||
|
||||
<para>The data is deleted by the following parameters from the "Delete data" screen:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Purge all data</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge data over 90 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge data over 30 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge data over 14 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge data over 7 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge data over 3 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge data over 1 day</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<graphic fileref="images/image059.png" valign="bottom" align="center"/>
|
||||
</sect2>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Purging system data</title>
|
||||
<sect2>
|
||||
<title>Audit data purge</title>
|
||||
|
||||
<para>All the audit data generated by the system can be deleted from "DB Maintenance">"Database Audit", in the Administration menu</para>
|
||||
|
||||
<para>The data to be deleted is selected by setting the following parameters in the "Delete Data" screen</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Purge audit data over 90 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge audit data over 30 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge audit data over 14 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge audit data over 7 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge audit data over 3 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge audit data over 1 day</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge all audit data</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<graphic fileref="images/image060.png" valign="bottom" align="center"/>
|
||||
</sect2>
|
||||
<sect2>
|
||||
<title>Event data purge</title>
|
||||
|
||||
<para>All the event data generated by the system can be deleted from "DB Maintenance">"Database Event", in the Administration menu</para>
|
||||
|
||||
<para>The data to be deleted is selected by setting the following parameters in the "Delete Data" screen</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Purge event data over 90 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge event data over 30 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge event data over 14 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge event data over 7 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge event data over 3 days</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge event data over 1 day</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Purge all event data</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<graphic fileref="images/image061.png" valign="bottom" align="center"/>
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-15"?>
|
||||
|
||||
<chapter>
|
||||
<title>Pandora Configuration</title>
|
||||
|
||||
<para>All the configurable parameters in Pandora can be set in the "Pandora Setup" section, in the Administration menu.</para>
|
||||
|
||||
<graphic fileref="images/image051.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>These parameters are:</para>
|
||||
|
||||
<para><b>Language:</b> In following versions or revisions of the actual Pandora version will support more languages. At the moment version 1.2 supports English, Spanish, Bable, Italian, French, Catalan and Portuguese of Brazil.</para>
|
||||
<para><b>Page block size:</b> Maximum size of the lists in the event, incident and audit log sections.</para>
|
||||
<para><b>Max. days before compact data:</b> This parameter controls data compacting. From the
|
||||
number of days in this parameter the data starts getting compacted. For large
|
||||
amounts of data it is recommended to set this parameter to a number between 14
|
||||
and 28; for systems with less data load or very powerful systems, a number
|
||||
between 30 and 50 will be enough.</para>
|
||||
<para><b>Max. days before purge:</b> This parameter controls how long the data is kept
|
||||
before it is permanently deleted. The recommended value is 60. For systems with
|
||||
little resources or large work load the recommended value is between 40 and 50.</para>
|
||||
<para><b>Graphic resolution (1 low, 5 high):</b> This value represents the precision of the
|
||||
interpolation logarithm to generate the graphics.</para>
|
||||
<para><b>Compact interpolation (Hours: 1 fine, 10 medium, 20 bad):</b> This is the grade of compression used to compact the Data Base, being 1 the lowest compression rate and 20 the highest. A value above 12 means a considerable data loss. It's not recommended to use value above 6 if the data needs to be
|
||||
represented graphically in large time intervals.</para>
|
||||
<sect1>
|
||||
<title>Links</title>
|
||||
|
||||
<para>Links to different Internet or private network links can be
|
||||
configured in Pandora. These could be search engines, applications or
|
||||
company Intranets.</para>
|
||||
|
||||
<para>The links configured in Pandora can be edited through the
|
||||
"Pandora Setup">"Links" option in the Administration menu.</para>
|
||||
|
||||
<graphic fileref="images/image052.png" valign="bottom" align="center"/>
|
||||
|
||||
<para>A new link is created by clicking on "Create".
|
||||
The link can be then edited:</para>
|
||||
|
||||
<graphic fileref="images/image053.png" valign="bottom" align="center"/>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
<?xml version="1.0"?>
|
||||
<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
|
||||
<uri resource="pandora_chapter1.xml" typeId="DocBook"/>
|
||||
<uri resource="pandora_chapter2.xml" typeId="DocBook"/>
|
||||
<uri resource="pandora_chapter3.xml" typeId="DocBook"/>
|
||||
<uri resource="pandora_chapter4.xml" typeId="DocBook"/>
|
||||
<uri resource="pandora_chapter5.xml" typeId="DocBook"/>
|
||||
<uri resource="pandora_chapter6.xml" typeId="DocBook"/>
|
||||
<uri resource="pandora_chapter7.xml" typeId="DocBook"/>
|
||||
<uri resource="pandora_chapter8.xml" typeId="DocBook"/>
|
||||
<uri resource="pandora_chapter9.xml" typeId="DocBook"/>
|
||||
</locatingRules>
|
||||
Loading…
Reference in New Issue