didou Mon Jan 31 07:35:38 2005 EDT
Modified files:
/phpdoc/en/reference/dba/functions dba-fetch.xml dba-key-split.xml
dba-list.xml dba-open.xml
dba-popen.xml
Log:
Switch to the new structure
http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-fetch.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/reference/dba/functions/dba-fetch.xml
diff -u phpdoc/en/reference/dba/functions/dba-fetch.xml:1.7
phpdoc/en/reference/dba/functions/dba-fetch.xml:1.8
--- phpdoc/en/reference/dba/functions/dba-fetch.xml:1.7 Mon May 10 11:00:23 2004
+++ phpdoc/en/reference/dba/functions/dba-fetch.xml Mon Jan 31 07:35:36 2005
@@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
-<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.8 $ -->
<refentry id="function.dba-fetch">
<refnamediv>
<refname>dba_fetch</refname>
<refpurpose>Fetch data specified by key</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>dba_fetch</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
@@ -24,44 +23,89 @@
<parameter>key</parameter> from the database specified with
<parameter>handle</parameter>.
</para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- <parameter>Key</parameter> is the key the data is specified by.
- </para>
- <para>
- <parameter>Skip</parameter> is the number of key-value pairs to
- ignore when using cdb databases. This value is ignored for all other
- databases which do not support multiple keys with the same name.
- </para>
- <para>
- <parameter>Handle</parameter> is a database handle returned by
- <function>dba_open</function>.
- </para>
-
- <para>
- <function>dba_fetch</function> returns the associated string or &false;,
if
- the key/data pair is found or not found, respectively.
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key the data is specified by.
+ </para>
+ <note>
+ <para>
+ When working with inifiles this function accepts arrays as keys
+ where index 0 is the group and index 1 is the value name. See:
+ <function>dba_key_split</function>.
+ </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>skip</parameter></term>
+ <listitem>
+ <para>
+ The number of key-value pairs to ignore when using cdb databases.
+ This value is ignored for all other databases which do not support
+ multiple keys with the same name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>handle</parameter></term>
+ <listitem>
+ <para>
+ The database handler, returned by <function>dba_open</function> or
+ <function>dba_popen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- <note>
- <simpara>
- The skip parameter is available since PHP 4.3 to support cdb's
- capability of multiple keys having the same name.
- </simpara>
- </note>
+ Returns the associated string if the key/data pair is found, &false;
+ otherwise.
</para>
+ </refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
<para>
- <note>
- <simpara>
- When working with inifiles this function accepts arrays as keys
- where index 0 is the group and index 1 is the value name. See:
- <function>dba_key_split</function>.
- </simpara>
- </note>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>4.3</entry>
+ <entry>
+ The <parameter>skip</parameter> parameter is available to support
+ cdb's capability of multiple keys having the same name.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>dba_exists</function>,
- <function>dba_delete</function>, <function>dba_insert</function>,
- <function>dba_replace</function> and <function>dba_key_split</function>.
+ <simplelist>
+ <member><function>dba_exists</function></member>
+ <member><function>dba_delete</function></member>
+ <member><function>dba_insert</function></member>
+ <member><function>dba_replace</function></member>
+ <member><function>dba_key_split</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-key-split.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/dba/functions/dba-key-split.xml
diff -u phpdoc/en/reference/dba/functions/dba-key-split.xml:1.4
phpdoc/en/reference/dba/functions/dba-key-split.xml:1.5
--- phpdoc/en/reference/dba/functions/dba-key-split.xml:1.4 Mon May 10
11:00:23 2004
+++ phpdoc/en/reference/dba/functions/dba-key-split.xml Mon Jan 31 07:35:36 2005
@@ -1,30 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.dba-key-split">
<refnamediv>
<refname>dba_key_split</refname>
<refpurpose>Splits a key in string representation into array
representation</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>dba_key_split</methodname>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
- <function>dba_key_split</function> returns an array of the form
- array(0=>group,1=>value_name). This function will return &false;
- if <parameter>key</parameter> is &null; or &false;.
+ <function>dba_key_split</function> splits a key (string representation)
+ into an array representation.
</para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The key in string representation.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- <parameter>key</parameter> is the key in string representation.
+ Returns an array of the form <literal>array(0 => group, 1 =>
+ value_name)</literal>. This function will return &false; if
+ <parameter>key</parameter> is &null; or &false;.
</para>
- <para>
- See also
- <function>dba_firstkey</function>,
- <function>dba_nextkey</function>, and
- <function>dba_fetch</function>.
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>dba_firstkey</function></member>
+ <member><function>dba_nextkey</function></member>
+ <member><function>dba_fetch</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-list.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/dba/functions/dba-list.xml
diff -u phpdoc/en/reference/dba/functions/dba-list.xml:1.2
phpdoc/en/reference/dba/functions/dba-list.xml:1.3
--- phpdoc/en/reference/dba/functions/dba-list.xml:1.2 Wed Nov 6 02:26:02 2002
+++ phpdoc/en/reference/dba/functions/dba-list.xml Mon Jan 31 07:35:36 2005
@@ -1,21 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.dba-list">
<refnamediv>
<refname>dba_list</refname>
<refpurpose>List all open database files</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>array</type><methodname>dba_list</methodname>
<void/>
</methodsynopsis>
<para>
- <function>dba_list</function> returns an associative array with all
- open database files. This array is in the form:
- <literal>resourceid=>filename</literal>.
+ <function>dba_list</function> list all open database files.
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ An associative array, in the form <literal>resourceid =>
filename</literal>.
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-open.xml?r1=1.12&r2=1.13&ty=u
Index: phpdoc/en/reference/dba/functions/dba-open.xml
diff -u phpdoc/en/reference/dba/functions/dba-open.xml:1.12
phpdoc/en/reference/dba/functions/dba-open.xml:1.13
--- phpdoc/en/reference/dba/functions/dba-open.xml:1.12 Thu Aug 12 21:00:45 2004
+++ phpdoc/en/reference/dba/functions/dba-open.xml Mon Jan 31 07:35:36 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.12 $ -->
+<!-- $Revision: 1.13 $ -->
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
<refentry id="function.dba-open">
<refnamediv>
@@ -20,153 +20,207 @@
<parameter>path</parameter> with <parameter>mode</parameter> using
<parameter>handler</parameter>.
</para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- <parameter>path</parameter> is commonly a regular path in your filesystem.
- </para>
- <para>
- <parameter>mode</parameter> is "r" for read access, "w" for read/write
- access to an already existing database, "c" for read/write access
- and database creation if it doesn't currently exist, and "n" for
- create, truncate and read/write access. Additional you can set the
database
- lock method with the next char. Use "l" to lock the database with an
- <filename>.lck</filename>
- file or "d" to lock the databasefile itself. It is important that all of
- your applications do this consistently. If you want to test the access
and
- do not want to wait for the lock you can add "t" as third character. When
- you are absolutely sure that you do not require database locking you can
do
- so by using "-" instead of "l" or "d". When none of "d", "l" or "-" is
used
- dba will lock on the database file as it would with "d".
+ <variablelist>
+ <varlistentry>
+ <term><parameter>path</parameter></term>
+ <listitem>
+ <para>
+ Commonly a regular path in your filesystem.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ It is <literal>r</literal> for read access, <literal>w</literal> for
+ read/write access to an already existing database,
<literal>c</literal>
+ for read/write access and database creation if it doesn't currently
exist,
+ and <literal>n</literal> for create, truncate and read/write access.
+ </para>
+ <para>
+ Additionally you can set the database lock method with the next char.
+ Use <literal>l</literal> to lock the database with a
<filename>.lck</filename>
+ file or <literal>d</literal> to lock the databasefile itself. It is
+ important that all of your applications do this consistently.
+ </para>
+ <para>
+ If you want to test the access and do not want to wait for the lock
+ you can add <literal>t</literal> as third character. When you are
+ absolutely sure that you do not require database locking you can do
+ so by using <literal>-</literal> instead of <literal>l</literal> or
+ <literal>d</literal>. When none of <literal>d</literal>,
+ <literal>l</literal> or <literal>-</literal> is used, dba will lock
+ on the database file as it would with <literal>d</literal>.
+ </para>
+ <note>
+ <para>
+ There can only be one writer for one database file. When you use dba
on
+ a webserver and more than one request requires write operations they
can
+ only be done one after another. Also read during write is not
allowed.
+ The dba extension uses locks to prevent this. See the following
table:
+ <table>
+ <title>DBA locking</title>
+ <tgroup cols="9">
+ <thead>
+ <row>
+ <entry>already open</entry>
+ <entry><parameter>mode</parameter> = "rl"</entry>
+ <entry><parameter>mode</parameter> = "rlt"</entry>
+ <entry><parameter>mode</parameter> = "wl"</entry>
+ <entry><parameter>mode</parameter> = "wlt"</entry>
+ <entry><parameter>mode</parameter> = "rd"</entry>
+ <entry><parameter>mode</parameter> = "rdt"</entry>
+ <entry><parameter>mode</parameter> = "wd"</entry>
+ <entry><parameter>mode</parameter> = "wdt"</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>not open</entry>
+ <entry>ok</entry>
+ <entry>ok</entry>
+ <entry>ok</entry>
+ <entry>ok</entry>
+ <entry>ok</entry>
+ <entry>ok</entry>
+ <entry>ok</entry>
+ <entry>ok</entry>
+ </row>
+ <row>
+ <entry><parameter>mode</parameter> = "rl"</entry>
+ <entry>ok</entry>
+ <entry>ok</entry>
+ <entry>wait</entry>
+ <entry>false</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ </row>
+ <row>
+ <entry><parameter>mode</parameter> = "wl"</entry>
+ <entry>wait</entry>
+ <entry>false</entry>
+ <entry>wait</entry>
+ <entry>false</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ </row>
+ <row>
+ <entry><parameter>mode</parameter> = "rd"</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>ok</entry>
+ <entry>ok</entry>
+ <entry>wait</entry>
+ <entry>false</entry>
+ </row>
+ <row>
+ <entry><parameter>mode</parameter> = "wd"</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>illegal</entry>
+ <entry>wait</entry>
+ <entry>false</entry>
+ <entry>wait</entry>
+ <entry>false</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <simplelist>
+ <member>ok: the second call will be successfull.</member>
+ <member>wait: the second call waits until
<function>dba_close</function> is called for the first.</member>
+ <member>false: the second call returns false.</member>
+ <member>illegal: you must not mix "l" and "d" modifiers for
<parameter>mode</parameter> parameter.</member>
+ </simplelist>
+ </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>handler</parameter></term>
+ <listitem>
+ <para>
+ The name of the <link linkend="dba.requirements">handler</link> which
+ shall be used for accessing <parameter>path</parameter>. It is passed
+ all optional parameters given to <function>dba_popen</function> and
+ can act on behalf of them.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- <parameter>handler</parameter> is the <link
linkend="dba.requirements">name
- of the handler</link> which shall be
- used for accessing <parameter>path</parameter>. It is passed all optional
- parameters given to <function>dba_open</function> and can act on behalf of
- them.
+ Returns a positive handle on success, or &false; on failure.
</para>
+ </refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
<para>
- <function>dba_open</function> returns a positive handle or &false;, in
- the case the database was opened successfull or fails, respectively.
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>4.3.0</entry>
+ <entry>
+ It's possible to open database files over network connection. However
+ in cases a socket connection will be used (as with http or ftp) the
+ connection will be locked instead of the resource itself. This is
important
+ to know since in such cases locking is simply ignored on the
resource
+ and other solutions have to be found.
+ </entry>
+ </row>
+ <row>
+ <entry>4.3.0</entry>
+ <entry>
+ Locking and the <parameter>mode</parameter> modifiers "l", "d", "-"
+ and "t" were added.
+ In previous PHP versions, you must use semaphores to guard against
+ simultaneous database access for any database handler with the
exception
+ of GDBM. See <link linkend="ref.sem">System V semaphore
support</link>.
+ </entry>
+ </row>
+ <row>
+ <entry>before 4.3.5</entry>
+ <entry>
+ open mode 'c' is broken for several internal handlers and truncates
+ the database instead of appending data to an existent database.
+ Also dbm and ndbm fail on mode 'c' in typical configurations (this
+ cannot be fixed).
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</para>
- <note>
- <para>
- There can only be one writer for one database file. When you use dba on
- a webserver and more than one request requires write operations they can
- only be done one after another. Also read during write is not allowed.
- The dba extension uses locks to prevent this. See the following table:
- <table>
- <title>DBA locking</title>
- <tgroup cols="9">
- <thead>
- <row>
- <entry>already open</entry>
- <entry><parameter>mode</parameter> = "rl"</entry>
- <entry><parameter>mode</parameter> = "rlt"</entry>
- <entry><parameter>mode</parameter> = "wl"</entry>
- <entry><parameter>mode</parameter> = "wlt"</entry>
- <entry><parameter>mode</parameter> = "rd"</entry>
- <entry><parameter>mode</parameter> = "rdt"</entry>
- <entry><parameter>mode</parameter> = "wd"</entry>
- <entry><parameter>mode</parameter> = "wdt"</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>not open</entry>
- <entry>ok</entry>
- <entry>ok</entry>
- <entry>ok</entry>
- <entry>ok</entry>
- <entry>ok</entry>
- <entry>ok</entry>
- <entry>ok</entry>
- <entry>ok</entry>
- </row>
- <row>
- <entry><parameter>mode</parameter> = "rl"</entry>
- <entry>ok</entry>
- <entry>ok</entry>
- <entry>wait</entry>
- <entry>false</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- </row>
- <row>
- <entry><parameter>mode</parameter> = "wl"</entry>
- <entry>wait</entry>
- <entry>false</entry>
- <entry>wait</entry>
- <entry>false</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- </row>
- <row>
- <entry><parameter>mode</parameter> = "rd"</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>ok</entry>
- <entry>ok</entry>
- <entry>wait</entry>
- <entry>false</entry>
- </row>
- <row>
- <entry><parameter>mode</parameter> = "wd"</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>illegal</entry>
- <entry>wait</entry>
- <entry>false</entry>
- <entry>wait</entry>
- <entry>false</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <simplelist>
- <member>ok: the second call will be successfull.</member>
- <member>wait: the second call waits until
<function>dba_close</function> is called for the first.</member>
- <member>false: the second call returns false.</member>
- <member>illegal: you must not mix "l" and "d" modifiers for
<parameter>mode</parameter> parameter.</member>
- </simplelist>
- </para>
- </note>
- <note>
- <para>
- Since PHP 4.3.0 it is possible to open database files over network
connection.
- However in cases a socket connection will be used (as with http or ftp)
the
- connection will be locked instead of the resource itself. This is
important to
- know since in such cases locking is simply ignored on the resource and
other
- solutions have to be found.
- </para>
- </note>
- <note>
- <para>
- Locking and the <parameter>mode</parameter> modifiers "l", "d", "-" and
"t" were
- added in PHP 4.3.0.
- In PHP versions before PHP 4.3.0 you must use semaphores to guard against
- simultaneous database access for any database handler with the exception
of
- GDBM. See <link linkend="ref.sem">System V semaphore support</link>.
- </para>
- </note>
- <note>
- <para>
- Up to PHP 4.3.5 open mode 'c' is broken for several internal handlers
and
- truncates the database instead of appending data to an existent
database.
- Also dbm and ndbm fail on mode 'c' in typical configurations (this
cannot
- be fixed).
- </para>
- </note>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also
- <function>dba_popen</function>, and
- <function>dba_close</function>
+ <simplelist>
+ <member><function>dba_popen</function></member>
+ <member><function>dba_close</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-popen.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/dba/functions/dba-popen.xml
diff -u phpdoc/en/reference/dba/functions/dba-popen.xml:1.3
phpdoc/en/reference/dba/functions/dba-popen.xml:1.4
--- phpdoc/en/reference/dba/functions/dba-popen.xml:1.3 Thu Apr 25 17:45:45 2002
+++ phpdoc/en/reference/dba/functions/dba-popen.xml Mon Jan 31 07:35:36 2005
@@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.dba-popen">
<refnamediv>
<refname>dba_popen</refname>
<refpurpose>Open database persistently</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>dba_popen</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
@@ -15,36 +14,62 @@
<methodparam><type>string</type><parameter>handler</parameter></methodparam>
<methodparam choice="opt"><parameter>...</parameter></methodparam>
</methodsynopsis>
-
<para>
<function>dba_popen</function> establishes a persistent database instance
for <parameter>path</parameter> with <parameter>mode</parameter> using
<parameter>handler</parameter>.
</para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- <parameter>path</parameter> is commonly a regular path in your filesystem.
- </para>
- <para>
- <parameter>mode</parameter> is "r" for read access, "w" for read/write
- access to an already existing database, "c" for read/write access
- and database creation if it doesn't currently exist, and "n" for
- create, truncate and read/write access.
- </para>
- <para>
- <parameter>handler</parameter> is the <link
linkend="dba.requirements">name
- of the handler</link> which shall be
- used for accessing <parameter>path</parameter>. It is passed all optional
- parameters given to <function>dba_popen</function> and can act on behalf
- of them.
+ <variablelist>
+ <varlistentry>
+ <term><parameter>path</parameter></term>
+ <listitem>
+ <para>
+ Commonly a regular path in your filesystem.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ It is <literal>r</literal> for read access, <literal>w</literal> for
+ read/write access to an already existing database,
<literal>c</literal>
+ for read/write access and database creation if it doesn't currently
exist,
+ and <literal>n</literal> for create, truncate and read/write access.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>handler</parameter></term>
+ <listitem>
+ <para>
+ The name of the <link linkend="dba.requirements">handler</link> which
+ shall be used for accessing <parameter>path</parameter>. It is passed
+ all optional parameters given to <function>dba_popen</function> and
+ can act on behalf of them.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- <function>dba_popen</function> returns a positive handle or &false;, in
- the case the open is successful or fails, respectively.
+ Returns a positive handle on success, or &false; on failure.
</para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also:
- <function>dba_open</function>
- <function>dba_close</function>
+ <simplelist>
+ <member><function>dba_open</function></member>
+ <member><function>dba_close</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
