cvs: phpdoc /en/reference/shmop reference.xml
| From: | Friedhelm Betz | Date: | Wed, 07 Aug 2002 10:04:48 +0000 |
| Subject: | cvs: phpdoc /en/reference/shmop reference.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969347867@lists.php.net to get a copy of this message | ||
betz Wed Aug 7 06:04:48 2002 EDT
Modified files:
/phpdoc/en/reference/shmop reference.xml
Log:
new structure applied
Index: phpdoc/en/reference/shmop/reference.xml
diff -u phpdoc/en/reference/shmop/reference.xml:1.3 phpdoc/en/reference/shmop/reference.xml:1.4
--- phpdoc/en/reference/shmop/reference.xml:1.3 Sat May 4 05:45:19 2002
+++ phpdoc/en/reference/shmop/reference.xml Wed Aug 7 06:04:48 2002
@@ -1,34 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<reference id="ref.shmop">
<title>Shared Memory Functions</title>
<titleabbrev>shmop</titleabbrev>
<partintro>
<para>
- Shmop is an easy to use set of functions that allows php to read,
- write, create and delete UNIX shared memory segments. The functions
- will not work on windows, as it does not support shared memory. To
+ To
use shmop you will need to compile php with the --enable-shmop parameter
in your configure line.
</para>
<note>
<simpara>
- In PHP 4.0.3, there functions were prefixed by <literal>shm</literal>
- rather than <literal>shmop</literal>.
+ In PHP 4.0.3, there functions were prefixed by <literal>shm</literal>
+ rather than <literal>shmop</literal>.
</simpara>
</note>
- <para>
- <example>
- <title>Shared Memory Operations Overview</title>
- <programlisting role="php">
+
+ <section id="shmop.intro">
+ &reftitle.intro;
+ <para>
+ Shmop is an easy to use set of functions that allows PHP to read,
+ write, create and delete UNIX shared memory segments. The functions
+ will not work on windows, as it does not support shared memory.
+ </para>
+ </section>
+
+ <section id="shmop.requirenments">
+ &reftitle.required;
+ &no.requirement;
+ </section>
+
+ <section id="shmop.installation">
+ &reftitle.install;
+ <para>
+ To use shmop you will need to compile php with the
+ <option role="configure">--enable-shmop</option> parameter in your
+ configure line.
+ </para>
+ </section>
+
+ <section id="shmop.configuration">
+ &reftitle.runtime;
+ &no.config;
+ </section>
+
+ <section id="shmop.resources">
+ &reftitle.resources;
+ <para>
+ </para>
+ </section>
+
+ <section id="shmop.constants">
+ &reftitle.constants;
+ &no.constants;
+ </section>
+
+ <section id="shmop.examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Shared Memory Operations Overview</title>
+ <programlisting role="php">
<![CDATA[
<?php
// Create 100 byte shared memory block with system id if 0xff3
$shm_id = shmop_open(0xff3, "c", 0644, 100);
if(!$shm_id) {
- echo "Couldn't create shared memory segment\n";
+ echo "Couldn't create shared memory segment\n";
}
// Get shared memory block's size
@@ -38,28 +78,29 @@
// Lets write a test string into shared memory
$shm_bytes_written = shmop_write($shm_id, "my shared memory block", 0);
if($shm_bytes_written != strlen("my shared memory block")) {
- echo "Couldn't write the entire length of data\n";
+ echo "Couldn't write the entire length of data\n";
}
// Now lets read the string back
$my_string = shmop_read($shm_id, 0, $shm_size);
if(!$my_string) {
- echo "Couldn't read from shared memory block\n";
+ echo "Couldn't read from shared memory block\n";
}
echo "The data inside shared memory was: ".$my_string."\n";
//Now lets delete the block and close the shared memory segment
if(!shmop_delete($shm_id)) {
- echo "Couldn't mark shared memory block for deletion.";
+ echo "Couldn't mark shared memory block for deletion.";
}
shmop_close($shm_id);
?>
]]>
- </programlisting>
- </example>
- </para>
- </partintro>
+ </programlisting>
+ </example>
+ </para>
+ </section>
+ </partintro>
&reference.shmop.functions;