eschmid Thu Sep 13 16:40:46 2001 EDT
Modified files:
/phpdoc/en/functions dbplus.xml
Log:
Indentation, capitalised some title words, and the rest are whitespace fixes.
Index: phpdoc/en/functions/dbplus.xml
diff -u phpdoc/en/functions/dbplus.xml:1.11 phpdoc/en/functions/dbplus.xml:1.12
--- phpdoc/en/functions/dbplus.xml:1.11 Wed Sep 12 18:37:51 2001
+++ phpdoc/en/functions/dbplus.xml Thu Sep 13 16:40:46 2001
@@ -1,39 +1,40 @@
<?xml encoding="iso-8859-1"?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
<reference id="ref.dbplus">
- <title>DB++ functions</title>
- <titleabbrev></titleabbrev>
+ <title>DB++ Functions</title>
+ <titleabbrev>DB++</titleabbrev>
<partintro>
&warn.experimental;
<section id="dbplus.intro">
- <title>db++ database functions</title>
+ <title>DB++ Database Functions</title>
<para>
- db++, made by the german company
- <ulink url="&url.dbplus.company;">Concept asa</ulink>,
- is a relational database system with high performance and low
- memory and disk usage in mind. While providing SQL as an
- additional language interface it is not really a SQL database in
- the first place but provides its own AQL query language which is
- much more influenced by the relational algebra then SQL is.
- </para>
- <para>
- Concept asa always had an interest in supporting open source
- languages, db++ has had Perl and Tcl call interfaces for years
- now and uses Tcl as its internal stored procedure language.
- </para>
+ db++, made by the german company <ulink
+ url="&url.dbplus.company;">Concept asa</ulink>, is a relational
+ database system with high performance and low memory and disk
+ usage in mind. While providing SQL as an additional language
+ interface it is not really a SQL database in the first place but
+ provides its own AQL query language which is much more influenced
+ by the relational algebra then SQL is.
+ </para>
+ <para>
+ Concept asa always had an interest in supporting open source
+ languages, db++ has had Perl and Tcl call interfaces for years
+ now and uses Tcl as its internal stored procedure language.
+ </para>
</section>
<section id="dbplus.requirenments">
- <title>Requirenments</title>
+ <title>Requirements</title>
<para>
- You need the developement libraries and header files included in
- every db++ installaion archive.
- <ulink url="&url.dbplus.company;">Concept asa</ulink> provides
- additional <ulink
url="&url.dbplus.documentation;">documentation</ulink>
- and <ulink url="&url.dbplus.download;">Demo versions</ulink> of
- db++ for Linux, some other UNIX versions and Windows95/NT.
+ You need the developement libraries and header files included in
+ every db++ installaion archive. <ulink
+ url="&url.dbplus.company;">Concept asa</ulink> provides
+ additional <ulink
+ url="&url.dbplus.documentation;">documentation</ulink> and <ulink
+ url="&url.dbplus.download;">Demo versions</ulink> of db++ for
+ Linux, some other UNIX versions and Windows95/NT.
</para>
</section>
@@ -42,33 +43,32 @@
<para>
Creation and installation of this extension requires the db++
client libraries and header files to be installed on your system.
- You have to run <command>configure</command>
- with option <option>--with-dbplus</option> to build this
- extension.
+ You have to run <command>configure</command> with option
+ <option>--with-dbplus</option> to build this extension.
</para>
<para>
<command>configure</command> looks for the client libraries and
- header files under the default pathes
- <filename>/usr/dbplus</filename>,
- <filename>/usr/local/dbplus</filename> and
- <filename>/opt/dblus</filename>. If you have installed db++ in a
- different place you have add the installation path to the
- <command>configure</command> option like this:
- <option>--with-dbplus=/your/installation/path</option>.
+ header files under the default pathes
+ <filename>/usr/dbplus</filename>,
+ <filename>/usr/local/dbplus</filename> and
+ <filename>/opt/dblus</filename>. If you have installed db++ in a
+ different place you have add the installation path to the
+ <command>configure</command> option like this:
+ <option>--with-dbplus=/your/installation/path</option>.
</para>
</section>
<section id="dbplus.errorcodes">
<title>db++ error codes</title>
<para>
<table>
- <title>db++ error codes</title>
+ <title>DB++ Error Codes</title>
<tgroup cols="3">
<thead>
- <row>
- <entry>PHP Constant</entry>
- <entry>db++ constant</entry>
- <entry>meaning</entry>
- </row>
+ <row>
+ <entry>PHP Constant</entry>
+ <entry>db++ constant</entry>
+ <entry>meaning</entry>
+ </row>
</thead>
<tbody>
<row>
@@ -124,7 +124,7 @@
<row>
<entry>DBPLUS_ERR_CREATE</entry>
<entry>ERR_CREATE</entry>
- <entry>Creat() system call failed</entry>
+ <entry>Create() system call failed</entry>
</row>
<row>
<entry>DBPLUS_ERR_LSEEK</entry>
@@ -316,18 +316,16 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_aql</function></funcdef>
- <paramdef>string <parameter>query</parameter></paramdef>
- <paramdef>string
- <parameter><optional>server</optional></parameter>
- </paramdef>
- <paramdef>string
- <parameter><optional>dbpath</optional></parameter>
- </paramdef>
+ <paramdef>string <parameter>query</parameter></paramdef>
+ <paramdef>string
+ <parameter><optional>server</optional></parameter>
+ </paramdef>
+ <paramdef>string
+ <parameter><optional>dbpath</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- </para>
</refsect1>
</refentry>
@@ -341,12 +339,12 @@
<funcsynopsis>
<funcprototype>
<funcdef>string <function>dbplus_chdir</function></funcdef>
- <paramdef>string
- <parameter><optional>newdir</optional></parameter>
- </paramdef>
+ <paramdef>string
+ <parameter><optional>newdir</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
- &warn.experimental.func;
+ &warn.experimental.func;
<para>
<function>dbplus_chdir</function> will change the virtual current
directory where relation files will be looked for by
@@ -370,7 +368,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_close</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -391,8 +389,8 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_curr</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
- <paramdef>array <parameter>tuple</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -452,7 +450,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_errno</function></funcdef>
- <void/>
+ <void/>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -518,8 +516,8 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_first</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
- <paramdef>array <parameter>tuple</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -554,7 +552,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_flush</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -720,14 +718,12 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_info</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
- <paramdef>string <parameter>key</parameter></paramdef>
- <paramdef>array <parameter></parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>string <parameter>key</parameter></paramdef>
+ <paramdef>array <parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- </para>
</refsect1>
</refentry>
@@ -741,8 +737,8 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_last</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
- <paramdef>array <parameter>tuple</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -777,7 +773,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_lockrel</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -786,8 +782,6 @@
on the given relation. Other clients may still query the
relation, but can't alter it while it is locked.
</para>
- <para>
- </para>
</refsect1>
</refentry>
@@ -801,8 +795,8 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_next</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
- <paramdef>array <parameter></parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>array <parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -929,9 +923,9 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_rcreate</function></funcdef>
- <paramdef>string <parameter>name</parameter></paramdef>
- <paramdef>string <parameter>domlist</parameter></paramdef>
- <paramdef>int <parameter>flag</parameter></paramdef>
+ <paramdef>string <parameter>name</parameter></paramdef>
+ <paramdef>string <parameter>domlist</parameter></paramdef>
+ <paramdef>int <parameter>flag</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -1049,13 +1043,11 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_restorepos</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
- <paramdef>array <parameter>tuple</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- </para>
</refsect1>
</refentry>
@@ -1069,12 +1061,10 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_ropen</function></funcdef>
- <paramdef>string <parameter>name</parameter></paramdef>
+ <paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- </para>
</refsect1>
</refentry>
@@ -1092,8 +1082,6 @@
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- </para>
</refsect1>
</refentry>
@@ -1121,8 +1109,10 @@
<refentry id="function.dbplus-rsecindex">
<refnamediv>
- <refname>dbplus_rsecindex</refname>
- <refpurpose>Create a new secondary index for a relation</refpurpose>
+ <refname>dbplus_rsecindex</refname>
+ <refpurpose>
+ Create a new secondary index for a relation
+ </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -1138,8 +1128,8 @@
<para>
<function>dbplus_rsecindex</function> will create a new secondary
index for <parameter>relation</parameter> with consists of the
- domains specified by <parameter>domlist</parameter> and is of type
- <parameter>type</parameter>
+ domains specified by <parameter>domlist</parameter> and is of
+ type <parameter>type</parameter>
</para>
<para>
<parameter>domlist</parameter> may be passed as an array of
@@ -1159,12 +1149,13 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_runlink</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
<para>
- <function>dbplus_unlink</function> will close and remove the
<parameter>relation</parameter>.
+ <function>dbplus_unlink</function> will close and remove the
+ <parameter>relation</parameter>.
</para>
</refsect1>
</refentry>
@@ -1179,7 +1170,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_rzap</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -1200,12 +1191,10 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_savepos</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- </para>
</refsect1>
</refentry>
@@ -1219,13 +1208,11 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_setindex</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
- <paramdef>string <parameter>idx_name</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>string <parameter>idx_name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- </para>
</refsect1>
</refentry>
@@ -1238,14 +1225,14 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_setindexbynumber</function></funcdef>
+ <funcdef>int
+ <function>dbplus_setindexbynumber</function>
+ </funcdef>
<paramdef>int <parameter>relation</parameter></paramdef>
- <paramdef>int <parameter>idx_number</parameter></paramdef>
+ <paramdef>int <parameter>idx_number</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- </para>
</refsect1>
</refentry>
@@ -1265,8 +1252,6 @@
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- </para>
</refsect1>
</refentry>
@@ -1293,11 +1278,11 @@
client/server data transfers and context switches.
</para>
<para>
- <function>dbplus_tcl</function> needs to pass the client connection
- id the TCL <parameter>script</parameter> code should be executed
- by. <function>dbplus_resolve</function> will provide this
- connection id. The function will return whatever the TCL code
- returns or a TCL error message if the TCL code fails.
+ <function>dbplus_tcl</function> needs to pass the client
+ connection id the TCL <parameter>script</parameter> code should
+ be executed by. <function>dbplus_resolve</function> will provide
+ this connection id. The function will return whatever the TCL
+ code returns or a TCL error message if the TCL code fails.
</para>
<para>
See also <function>dbplus_resolve</function>.
@@ -1315,8 +1300,8 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_tremove</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
- <paramdef>array <parameter>tuple</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>array <parameter>tuple</parameter></paramdef>
<paramdef>array
<parameter><optional>current</optional></parameter>
</paramdef>
@@ -1328,7 +1313,8 @@
<parameter>tuple</parameter> from <parameter>relation</parameter>
if it perfectly matches a tuple within the
relation. <parameter>current</parameter>, if given, will contain
- the data of the new current tuple after calling
<function>dbplus_tremove</function>.
+ the data of the new current tuple after calling
+ <function>dbplus_tremove</function>.
</para>
</refsect1>
</refentry>
@@ -1343,7 +1329,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_undo</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -1381,7 +1367,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_unlockrel</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>int <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -1481,7 +1467,8 @@
&warn.experimental.func;
<para>
<function>dbplus_xunlockrel</function> will release an exclusive
- lock on <parameter>relation</parameter> previously obtained by
<function>dbplus_xlockrel</function>.
+ lock on <parameter>relation</parameter> previously obtained by
+ <function>dbplus_xlockrel</function>.
</para>
</refsect1>
</refentry>
