cvs: phpdoc /en/reference/dbm reference.xml

betz Mon Apr 29 08:07:49 2002 EDT Modified files: /phpdoc/en/reference/dbm reference.xml Log: new structure, some text ito sections added. Index: phpdoc/en/reference/dbm/reference.xml diff -u phpdoc/en/reference/dbm/reference.xml:1.2 phpdoc/en/reference/dbm/reference.xml:1.3 --- phpdoc/en/reference/dbm/reference.xml:1.2 Mon Apr 15 14:56:32 2002 +++ phpdoc/en/reference/dbm/reference.xml Mon Apr 29 08:07:49 2002 @@ -1,17 +1,68 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <reference id="ref.dbm"> <title>DBM Functions</title> <titleabbrev>DBM</titleabbrev> <partintro> - <simpara> - These functions allow you to store records stored in a dbm-style - database. This type of database (supported by the Berkeley DB, - GDBM, and some system libraries, as well as a built-in flatfile - library) stores key/value pairs (as opposed to the full-blown - records supported by relational databases). - </simpara> + <section id="dbm.intro"> + &reftitle.intro; + <para> + These functions allow you to store records stored in a dbm-style + database. This type of database (supported by the Berkeley DB, + <ulink url="&url.gdbm;">GDBM</ulink>, and some system libraries, + as well as a built-in flatfile library) stores key/value pairs + (as opposed to the full-blown records supported by relational + databases). + </para> + <note> + <para> + However, dbm support is deprecated and you are encourged to use the + <link linkend="ref.dba">Database (dbm-style) abstraction layer functions</link> + instead. + </para> + </note> + </section> + + <section id="dbm.required"> + &reftitle.required; + <para> + To use this functions you have to compile PHP with support for an + underlying database. See the + <link linkend="dba.requirements">list</link> of supported Databases. + </para> + </section> + + <section id="dbm.installation"> + &reftitle.install; + <para> + In order to use these functions, you must compile PHP with dbm support + by using the <option role="configure">--with-db</option> option. In + addtion you must ensure <link linkend="dba.installation">support</link> + for an underlying database or you can use some sytem libraries. + </para> + </section> + + <section id="dbm.runtime"> + &reftitle.runtime; + &no.config; + </section> + + <section id="dbm.resources"> + &reftitle.resources; + <para> + The function <function>dbmopen</function> returns an database identifier + which is used by the other dbm-functions. + </para> + </section> + + <section id="dbm.constants"> + &reftitle.constants; + &no.constants; + </section> + + <section id="dbm.examples"> + &reftitle.examples; <para> <example> <title>DBM example</title> @@ -30,11 +81,35 @@ </programlisting> </example> </para> + </section> </partintro> &reference.dbm.functions; </reference> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +indent-tabs-mode:nil +sgml-parent-document:nil +sgml-default-dtd-file:"../../../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +vim600: syn=xml fen fdm=syntax fdl=2 si +vim: et tw=78 syn=sgml +vi: ts=1 sw=1 +--> + + + <!-- Keep this comment at the end of the file Local variables: mode: sgml