From d4088ba4faf28e4d5dbc03972ad819680bcd9c35 Mon Sep 17 00:00:00 2001
From: Damien Seguy <dams@php.net>
Date: Mon, 27 Jan 2003 02:50:41 +0000
Subject: [PATCH] entity usage

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@113554 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/filesystem/functions/fgetc.xml            | 10 +++++-----
 reference/filesystem/functions/file.xml             |  6 +++---
 reference/filesystem/functions/flock.xml            | 13 ++++++-------
 reference/filesystem/functions/fseek.xml            | 10 +++++-----
 reference/filesystem/functions/ftruncate.xml        |  5 ++---
 .../filesystem/functions/move-uploaded-file.xml     |  4 ++--
 reference/filesystem/functions/popen.xml            |  8 ++++----
 reference/filesystem/functions/rmdir.xml            | 10 +++++-----
 reference/filesystem/functions/umask.xml            |  4 ++--
 9 files changed, 34 insertions(+), 36 deletions(-)

diff --git a/reference/filesystem/functions/fgetc.xml b/reference/filesystem/functions/fgetc.xml
index fdbc70a7a9..8f2f1a0434 100644
--- a/reference/filesystem/functions/fgetc.xml
+++ b/reference/filesystem/functions/fgetc.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.fgetc">
    <refnamediv>
@@ -8,10 +8,10 @@
    </refnamediv>
    <refsect1>
     <title>Description</title>
-     <methodsynopsis>
-      <type>string</type><methodname>fgetc</methodname>
-      <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
-     </methodsynopsis>
+    <methodsynopsis>
+     <type>string</type><methodname>fgetc</methodname>
+     <methodparam><type>resource</type><parameter>fp</parameter></methodparam>
+    </methodsynopsis>
     <para>
      Returns a string containing a single character read from the
      file pointed to by <parameter>handle</parameter>.
diff --git a/reference/filesystem/functions/file.xml b/reference/filesystem/functions/file.xml
index 57d96133e2..4c4e9cbe74 100644
--- a/reference/filesystem/functions/file.xml
+++ b/reference/filesystem/functions/file.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.file">
    <refnamediv>
@@ -66,8 +66,8 @@ $html = implode ('', file ('http://www.example.com/'));
     &tip.fopen-wrapper;
     <para> 
      See also <function>readfile</function>,
-     <function>fopen</function>, <function>fsockopen</function>, and
-     <function>popen</function>, and <function>file_get_contents</function>,
+     <function>fopen</function>, <function>fsockopen</function>, 
+     <function>popen</function>, <function>file_get_contents</function>,
      and <function>include</function>.
     </para>
    </refsect1>
diff --git a/reference/filesystem/functions/flock.xml b/reference/filesystem/functions/flock.xml
index e8f5bbc685..e819e85f3b 100644
--- a/reference/filesystem/functions/flock.xml
+++ b/reference/filesystem/functions/flock.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.flock">
    <refnamediv>
@@ -30,28 +30,28 @@
       <listitem>
        <simpara>
          To acquire a shared lock (reader), set
-         <parameter>operation</parameter> to LOCK_SH (set to 1 prior to
+         <parameter>operation</parameter> to<constant>LOCK_SH</constant> (set to 1 prior to
          PHP 4.0.1).
        </simpara>
       </listitem>
       <listitem>
        <simpara>
          To acquire an exclusive lock (writer), set
-         <parameter>operation</parameter> to LOCK_EX (set to 2 prior to
+         <parameter>operation</parameter> to <constant>LOCK_EX</constant> (set to 2 prior to
          PHP 4.0.1).
        </simpara>
       </listitem>
       <listitem>
        <simpara>
          To release a lock (shared or exclusive), set
-         <parameter>operation</parameter> to LOCK_UN (set to 3 prior to
+         <parameter>operation</parameter> to <constant>LOCK_UN</constant> (set to 3 prior to
          PHP 4.0.1).
        </simpara>
       </listitem>
       <listitem>
        <simpara>
          If you don't want <function>flock</function> to block while
-         locking, add LOCK_NB (4 prior to PHP 4.0.1) to
+         locking, add <constant>LOCK_NB</constant> (4 prior to PHP 4.0.1) to
          <parameter>operation</parameter>.
        </simpara>
       </listitem>
@@ -65,8 +65,7 @@
      errno condition)
     </simpara>
     <simpara>
-     <function>flock</function> returns &true; on success and &false; on
-     error (e.g. when a lock could not be acquired).
+      &return.success;
     </simpara>
     <note>
      <para>
diff --git a/reference/filesystem/functions/fseek.xml b/reference/filesystem/functions/fseek.xml
index f122753d3b..402fff4a33 100644
--- a/reference/filesystem/functions/fseek.xml
+++ b/reference/filesystem/functions/fseek.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.fseek">
    <refnamediv>
@@ -22,15 +22,15 @@
      <parameter>whence</parameter>, whose values are defined as
      follows:
      <simplelist>
-      <member>SEEK_SET - Set position equal to <parameter>offset</parameter> bytes.</member>
-      <member>SEEK_CUR - Set position to current location plus <parameter>offset</parameter>.</member>
-      <member>SEEK_END - Set position to end-of-file plus <parameter>offset</parameter>. 
+      <member><constant>SEEK_SET</constant> - Set position equal to <parameter>offset</parameter> bytes.</member>
+      <member><constant>SEEK_CUR</constant> - Set position to current location plus <parameter>offset</parameter>.</member>
+      <member><constant>SEEK_END</constant> - Set position to end-of-file plus <parameter>offset</parameter>. 
       (To move to a position before the end-of-file, you need to pass a negative 
       value in <parameter>offset</parameter>.)</member>
      </simplelist>
     </para>
     <para>If <parameter>whence</parameter> is not specified, it is assumed to be
-    SEEK_SET.
+    <constant>SEEK_SET</constant>.
     </para>
     <para>
      Upon success, returns 0; otherwise, returns -1. Note that seeking
diff --git a/reference/filesystem/functions/ftruncate.xml b/reference/filesystem/functions/ftruncate.xml
index f8ae8c4f8c..25d5229fa4 100644
--- a/reference/filesystem/functions/ftruncate.xml
+++ b/reference/filesystem/functions/ftruncate.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.14 -->
   <refentry id="function.ftruncate">
    <refnamediv>
@@ -15,8 +15,7 @@
      </methodsynopsis>
     <para>
      Takes the filepointer, <parameter>handle</parameter>, and truncates the file to 
-     length, <parameter>size</parameter>. This function returns &true; on 
-     success and &false; on failure.
+     length, <parameter>size</parameter>. &return.success;
     </para>
    </refsect1>
   </refentry>
diff --git a/reference/filesystem/functions/move-uploaded-file.xml b/reference/filesystem/functions/move-uploaded-file.xml
index 5793edce10..16ce6dc38e 100644
--- a/reference/filesystem/functions/move-uploaded-file.xml
+++ b/reference/filesystem/functions/move-uploaded-file.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.move-uploaded-file">
    <refnamediv>
@@ -42,7 +42,7 @@
      <note>
      <para>
       <function>move_uploaded_file</function> is not affected by the normal
-      safe-mode UID-restrictions. This is not unsafe because
+      &safemode; UID-restrictions. This is not unsafe because
       <function>move_uploaded_file</function> only operates on files uploaded
       via PHP.
      </para>
diff --git a/reference/filesystem/functions/popen.xml b/reference/filesystem/functions/popen.xml
index 28475bcd17..576e5175c8 100644
--- a/reference/filesystem/functions/popen.xml
+++ b/reference/filesystem/functions/popen.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.popen">
    <refnamediv>
@@ -35,15 +35,15 @@
      </para>
     </note>
     <para>
-     <informalexample>
-      <programlisting role="php">
+    <example>
+    <title><function>popen</function> examole</title>
 <![CDATA[
 <?php
 $handle = popen ("/bin/ls", "r");
 ?>
 ]]>
       </programlisting>
-     </informalexample>
+     </example>
     </para>
     <note>
      <para>
diff --git a/reference/filesystem/functions/rmdir.xml b/reference/filesystem/functions/rmdir.xml
index 615ff6a8a2..32ca6db6d8 100644
--- a/reference/filesystem/functions/rmdir.xml
+++ b/reference/filesystem/functions/rmdir.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.rmdir">
    <refnamediv>
@@ -8,10 +8,10 @@
    </refnamediv>
    <refsect1>
     <title>Description</title>
-     <methodsynopsis>
-      <type>bool</type><methodname>rmdir</methodname>
-      <methodparam><type>string</type><parameter>dirname</parameter></methodparam>
-     </methodsynopsis>
+    <methodsynopsis>
+     <type>int</type><methodname>rmdir</methodname>
+     <methodparam><type>string</type><parameter>dirname</parameter></methodparam>
+    </methodsynopsis>
     <para> 
      Attempts to remove the directory named by <parameter>dirname</parameter>.
      The directory must be empty, and the relevant permissions must permit this.
diff --git a/reference/filesystem/functions/umask.xml b/reference/filesystem/functions/umask.xml
index dc834835d8..061b50633e 100644
--- a/reference/filesystem/functions/umask.xml
+++ b/reference/filesystem/functions/umask.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.umask">
    <refnamediv>
@@ -10,7 +10,7 @@
     <title>Description</title>
      <methodsynopsis>
       <type>int</type><methodname>umask</methodname>
-      <methodparam choice='opt'><type>int</type><parameter>mask</parameter></methodparam>
+      <methodparam choice="opt"><type>int</type><parameter>mask</parameter></methodparam>
      </methodsynopsis>
     <para>
      <function>umask</function> sets PHP's umask to mask &amp; 0777 and