php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

rrd : fix XML by converting para to simpara tags via script

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-25 15:08:40 +00:00
parent 37e7d05578
commit 0f2a5f5ddb
30 changed files with 214 additions and 273 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
reference/rrd/book.xml
View File

@@ -1,21 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.rrd" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.rrd">
<?phpdoc extension-membership="pecl" ?>
<title>RRDtool</title>
<titleabbrev>RRD</titleabbrev>
<preface xml:id="intro.rrd">
&reftitle.intro;
<para>
<simpara>
The PECL/rrd extension provides bindings to the RRDtool C library.
RRDtool is the open source industry standard, high performance data
logging and graphing system for time series data.
</para>
<para>
</simpara>
<simpara>
The RRDtool homepage is <link xlink:href="&url.rrd;">&url.rrd;</link>.
</para>
</simpara>
</preface>
&reference.rrd.setup;
@@ -26,7 +25,6 @@
&reference.rrd.rrdgraph;
&reference.rrd.rrdupdater;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

8
reference/rrd/configure.xml
View File

@@ -1,16 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="rrd.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrd.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;rrd">&url.pecl.package;rrd</link>
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/rrd/functions/rrd-create.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-create">
<refnamediv>
<refname>rrd_create</refname>
<refpurpose>Creates rrd database file</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Creates the rdd database file.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,18 +24,18 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
Filename for newly created rrd file.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
Options for rrd create - list of strings. See man page of rrd create
for whole list of options.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,12 +43,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/rrd/functions/rrd-error.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-error" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-error">
<refnamediv>
<refname>rrd_error</refname>
<refpurpose>Gets latest error message</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>rrd_error</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns latest global rrd error message.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,13 +24,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Latest error message.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/rrd/functions/rrd-fetch.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-fetch" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-fetch">
<refnamediv>
<refname>rrd_fetch</refname>
<refpurpose>Fetch the data for graph as array</refpurpose>
@@ -14,11 +13,11 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets data for graph output from RRD database file as array. This function
has same result as <function>rrd_graph</function>, but fetched data are
returned as array, no image file is created.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,17 +26,17 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
RRD database file name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
Array of options for resolution specification.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,13 +44,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns information about retrieved graph data.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/rrd/functions/rrd-first.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-first" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-first">
<refnamediv>
<refname>rrd_first</refname>
<refpurpose>Gets the timestamp of the first sample from rrd file</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>string</type><parameter>file</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>raaindex</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns the first data sample from the specified RRA of the RRD file.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,17 +24,17 @@
<varlistentry>
<term><parameter>file</parameter></term>
<listitem>
<para>
<simpara>
RRD database file name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>raaindex</parameter></term>
<listitem>
<para>
<simpara>
The index number of the RRA that is to be examined. Default value is 0.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,13 +42,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Integer number of unix timestamp,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/rrd/functions/rrd-graph.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-graph" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-graph">
<refnamediv>
<refname>rrd_graph</refname>
<refpurpose>Creates image from a data</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Creates image for a particular data from RRD file.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,21 +24,21 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
The filename to output the graph to. This will generally end in either
<literal>.png</literal>, <literal>.svg</literal> or
<literal>.eps</literal>, depending on the format you want to output.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
Options for generating image. See man page of rrd graph for all
possible options. All options (data definitions, variable definitions, etc.)
are allowed.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,12 +46,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Array with information about generated image is returned,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/rrd/functions/rrd-info.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-info" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-info">
<refnamediv>
<refname>rrd_info</refname>
<refpurpose>Gets information about rrd file</refpurpose>
@@ -13,9 +12,9 @@
<type>array</type><methodname>rrd_info</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns information about particular RRD database file.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +23,9 @@
<varlistentry>
<term><parameter>file</parameter></term>
<listitem>
<para>
<simpara>
RRD database file name.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,14 +33,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Array with information about requested RRD file,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/rrd/functions/rrd-last.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-last" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-last">
<refnamediv>
<refname>rrd_last</refname>
<refpurpose>Gets unix timestamp of the last sample</refpurpose>
@@ -13,9 +12,9 @@
<type>int</type><methodname>rrd_last</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns the UNIX timestamp of the most recent update of the RRD database.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +23,9 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
RRD database file name.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,13 +33,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Integer as unix timestamp of the most recent data from the RRD database.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/rrd/functions/rrd-lastupdate.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-lastupdate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-lastupdate">
<refnamediv>
<refname>rrd_lastupdate</refname>
<refpurpose>Gets information about last updated data</refpurpose>
@@ -13,10 +12,10 @@
<type>array</type><methodname>rrd_lastupdate</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets array of the UNIX timestamp and the values stored for each date in the
most recent update of the RRD database file.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>file</parameter></term>
<listitem>
<para>
<simpara>
RRD database file name.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,12 +34,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Array of information about last update,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/rrd/functions/rrd-restore.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-restore" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-restore">
<refnamediv>
<refname>rrd_restore</refname>
<refpurpose>Restores the RRD file from XML dump</refpurpose>
@@ -15,9 +14,9 @@
<methodparam><type>string</type><parameter>rrd_file</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Restores the RRD file from the XML dump.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,25 +25,25 @@
<varlistentry>
<term><parameter>xml_file</parameter></term>
<listitem>
<para>
<simpara>
XML filename with the dump of the original RRD database file.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rrd_file</parameter></term>
<listitem>
<para>
<simpara>
Restored RRD database file name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
Array of options for restoring. See man page for rrd restore.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,12 +51,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/rrd/functions/rrd-tune.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-tune" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-tune">
<refnamediv>
<refname>rrd_tune</refname>
<refpurpose>Tunes some RRD database file header options</refpurpose>
@@ -14,10 +13,10 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Change some options in the RRD dabase header file. E.g. renames the source for
the data etc.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,18 +25,18 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
RRD database file name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
Options with RRD database file properties which will be changed. See
rrd tune man page for details.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,13 +44,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/rrd/functions/rrd-update.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-update" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-update">
<refnamediv>
<refname>rrd_update</refname>
<refpurpose>Updates the RRD database</refpurpose>
@@ -14,10 +13,10 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Updates the RRD database file. The input data is time interpolated according to the
properties of the RRD database file.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,18 +25,18 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
RRD database file name. This database will be updated.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
Options for updating the RRD database. This is list of strings. See man page of rrd update
for whole list of options.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,12 +44,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/rrd/functions/rrd-version.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-version" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-version">
<refnamediv>
<refname>rrd_version</refname>
<refpurpose>Gets information about underlying rrdtool library</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>rrd_version</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns information about underlying rrdtool library.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,13 +24,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
String with rrdtool version number e.g. "1.4.3".
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/rrd/functions/rrd-xport.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrd-xport" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrd-xport">
<refnamediv>
<refname>rrd_xport</refname>
<refpurpose>Exports the information about RRD database</refpurpose>
@@ -13,11 +12,11 @@
<type>array</type><methodname>rrd_xport</methodname>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Exports the information about RRD database file. This data can be converted
to XML file via user space PHP script and then restored back as RRD database
file.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +25,9 @@
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
Array of options for the export, see rrd xport man page.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,13 +35,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Array with information about RRD database file,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/rrd/functions/rrdc-disconnect.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rrdc-disconnect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rrdc-disconnect">
<refnamediv>
<refname>rrdc_disconnect</refname>
<refpurpose>Close any outstanding connection to rrd caching daemon</refpurpose>
@@ -11,20 +10,20 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>rrdc_disconnect</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Close any outstanding connection to rrd caching daemon.
</para>
<para>
</simpara>
<simpara>
This function is automatically called when the whole PHP process is terminated.
It depends on used SAPI. For example, it's called automatically at the end
of command line script.
</para>
<para>
</simpara>
<simpara>
It's up user whether he wants to call this function at the end of every request
or otherwise.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,13 +33,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

8
reference/rrd/rrdcreator.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.rrdcreator" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.rrdcreator" role="class">
<title>The RRDCreator class</title>
<titleabbrev>RRDCreator</titleabbrev>
@@ -10,9 +9,9 @@
<!-- {{{ RRDCreator intro -->
<section xml:id="rrdcreator.intro">
&reftitle.intro;
<para>
<simpara>
Class for creation of RRD database file.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -48,7 +47,6 @@
&reference.rrd.entities.rrdcreator;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/rrd/rrdcreator/addarchive.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rrdcreator.addarchive" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrdcreator.addarchive">
<refnamediv>
<refname>RRDCreator::addArchive</refname>
<refpurpose>Adds RRA - archive of data values for each data source</refpurpose>
@@ -13,12 +12,12 @@
<modifier>public</modifier> <type>void</type><methodname>RRDCreator::addArchive</methodname>
<methodparam><type>string</type><parameter>description</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Adds RRA definition by description of archive. Archive consists of a
number of data values or statistics for each of the defined data-sources (DS).
Data sources are defined by method <methodname>RRDCreator::addDataSource</methodname>.
You need call this method for each requested archive.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,10 +26,10 @@
<varlistentry>
<term><parameter>description</parameter></term>
<listitem>
<para>
<simpara>
Definition of archive - RRA. This has same format as RRA definition in
rrd create command. See man page of rrd create for more details.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,12 +37,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/rrd/rrdcreator/adddatasource.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rrdcreator.adddatasource" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrdcreator.adddatasource">
<refnamediv>
<refname>RRDCreator::addDataSource</refname>
<refpurpose>Adds data source definition for RRD database</refpurpose>
@@ -13,11 +12,11 @@
<modifier>public</modifier> <type>void</type><methodname>RRDCreator::addDataSource</methodname>
<methodparam><type>string</type><parameter>description</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
RRD can accept input from several data sources (DS), e.g incoming and outgoing
traffic. This method adds data source by description. You need call
this method for each data source.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,10 +25,10 @@
<varlistentry>
<term><parameter>description</parameter></term>
<listitem>
<para>
<simpara>
Definition of data source - DS. This has same format as DS definition in
rrd create command. See man page of rrd create for more details.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,12 +36,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/rrd/rrdcreator/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rrdcreator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrdcreator.construct">
<refnamediv>
<refname>RRDCreator::__construct</refname>
<refpurpose>Creates new <classname>RRDCreator</classname> instance</refpurpose>
@@ -15,9 +14,9 @@
<methodparam choice="opt"><type>string</type><parameter>startTime</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>step</parameter><initializer>0</initializer></methodparam>
</constructorsynopsis>
<para>
<simpara>
Creates new <classname>RRDCreator</classname> instance.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,33 +25,32 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Path for newly created RRD database file.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>startTime</parameter></term>
<listitem>
<para>
<simpara>
Time for the first value in RRD database. Parameter supports all formats
which are supported by rrd create call.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>int<parameter>step</parameter></term>
<listitem>
<para>
<simpara>
Base interval in seconds with which data will be fed into the RRD database.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/rrd/rrdcreator/save.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rrdcreator.save" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrdcreator.save">
<refnamediv>
<refname>RRDCreator::save</refname>
<refpurpose>Saves the RRD database to a file</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RRDCreator::save</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Saves the RRD database into file, which name is defined by <methodname>RRDCreator::__construct</methodname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,12 +24,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

8
reference/rrd/rrdgraph.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.rrdgraph" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.rrdgraph" role="class">
<title>The RRDGraph class</title>
<titleabbrev>RRDGraph</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ RRDGraph intro -->
<section xml:id="rrdgraph.intro">
&reftitle.intro;
<para>
<simpara>
Class for exporting data from RRD database to image file.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -49,7 +48,6 @@
&reference.rrd.entities.rrdgraph;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/rrd/rrdgraph/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rrdgraph.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrdgraph.construct">
<refnamediv>
<refname>RRDGraph::__construct</refname>
<refpurpose>Creates new <classname>RRDGraph</classname> instance</refpurpose>
@@ -13,10 +12,10 @@
<modifier>public</modifier> <methodname>RRDGraph::__construct</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
Creates new <classname>RRDGraph</classname> instance. This instance is responsible for rendering
the result of RRD database query into image.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,16 +24,15 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Full path for the newly created image.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/rrd/rrdgraph/save.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rrdgraph.save" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrdgraph.save">
<refnamediv>
<refname>RRDGraph::save</refname>
<refpurpose>Saves the result of query into image</refpurpose>
@@ -11,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>RRDGraph::save</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Saves the result of RRD database query into image defined by
<methodname>RRDGraph::__construct</methodname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,12 +25,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns array with information about generated image,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/rrd/rrdgraph/saveverbose.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rrdgraph.saveverbose" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrdgraph.saveverbose">
<refnamediv>
<refname>RRDGraph::saveVerbose</refname>
<refpurpose>Saves the RRD database query into image and returns the verbose
@@ -13,13 +12,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>RRDGraph::saveVerbose</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Saves the RRD database query into image file defined by method <methodname>RRDGraph::__construct</methodname>
and returns the verbose information about generated graph, if "-" is used as image
filename, image data are also returned in result array.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,12 +28,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns array with detailed information about generated image,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

28
reference/rrd/rrdgraph/setoptions.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rrdgraph.setoptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrdgraph.setoptions">
<refnamediv>
<refname>RRDGraph::setOptions</refname>
<refpurpose>Sets the options for rrd graph export</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>void</type><methodname>RRDGraph::setOptions</methodname>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,11 +23,11 @@
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
List of options for the image generation from the RRD database file. It can
be list of strings or list of strings with keys for better readability. Read
the rrd graph man pages for list of available options.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,11 +35,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
<simpara>
&return.void;
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -81,10 +80,10 @@ $graphObj->setOptions(array(
?>
]]>
</programlisting>
<para>
<simpara>
Don't use key value syntax for same rrd option. It looks more readable, but
it doesn't work.
</para>
</simpara>
<programlisting role="php">
<![CDATA[
<?php
@@ -96,9 +95,9 @@ $graphObj->setOptions(array(
?>
]]>
</programlisting>
<para>
<simpara>
In nature of php it's same as
</para>
</simpara>
<programlisting role="php">
<![CDATA[
<?php
@@ -112,7 +111,6 @@ $graphObj->setOptions(array(
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

8
reference/rrd/rrdupdater.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.rrdupdater" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.rrdupdater" role="class">
<title>The RRDUpdater class</title>
<titleabbrev>RRDUpdater</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ RRDUpdater intro -->
<section xml:id="rrdupdater.intro">
&reftitle.intro;
<para>
<simpara>
Class for updating RDD database file.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -49,7 +48,6 @@
&reference.rrd.entities.rrdupdater;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/rrd/rrdupdater/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rrdupdater.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrdupdater.construct">
<refnamediv>
<refname>RRDUpdater::__construct</refname>
<refpurpose>Creates new <classname>RRDUpdater</classname> instance</refpurpose>
@@ -13,10 +12,10 @@
<modifier>public</modifier> <methodname>RRDUpdater::__construct</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
Creates new RRDUpdater instance. This instance is responsible for updating
the RRD database file.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,16 +24,15 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Filesystem path for RRD database file, which will be updated.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/rrd/rrdupdater/update.xml
View File

@@ -15,10 +15,10 @@
<initializer>time()</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Updates the RRD file defined via <methodname>RRDUpdater::__construct</methodname>.
The file is updated with a specific values.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,18 +27,18 @@
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
<simpara>
Data for update. Key is data source name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>time</parameter></term>
<listitem>
<para>
<simpara>
Time value for updating the RRD with a particular data. Default value
is current time.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,16 +46,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
Throws a <classname>Exception</classname> on error.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

19
reference/rrd/setup.xml
View File

@@ -1,39 +1,36 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="rrd.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rrd.setup">
&reftitle.setup;
<section xml:id="rrd.requirements">
&reftitle.required;
<para>
<simpara>
You need to install librrd first to be able to use PECL/rrd. Most common option
is using of librrd-dev package from your favourite Linux distro.
PECL/rrd is tested with librrd 1.4.3, older or newer versions might or might not
work for you.
</para>
</simpara>
<warning>
<para>
<simpara>
Librrd and hence extension itself aren't mostly thread safe. There are many
global and shared states in librrd. It can be dangerous use this extension
in multi threaded environments like Apache2 mpm worker.
If there are many parallel requests, one request can change some global
librrd state of other runnig requests.
</para>
</simpara>
</warning>
</section>
<section xml:id="rrd.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link
xlink:href="&url.pecl.package;rrd">&url.pecl.package;rrd</link>.
</para>
<link xlink:href="&url.pecl.package;rrd">&url.pecl.package;rrd</link>.
</simpara>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml