From de9cecf0fb85b473dbf696c0def201d2974bf65d Mon Sep 17 00:00:00 2001
From: Hannes Magnusson <bjori@php.net>
Date: Thu, 28 Apr 2011 10:07:30 +0000
Subject: [PATCH] Document pecl/proctitle

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@310616 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/proctitle/book.xml                  | 42 ++++++++
 reference/proctitle/configure.xml             | 34 +++++++
 reference/proctitle/constants.xml             | 28 ++++++
 .../proctitle/functions/setproctitle.xml      | 99 +++++++++++++++++++
 .../proctitle/functions/setthreadtitle.xml    | 99 +++++++++++++++++++
 reference/proctitle/reference.xml             | 30 ++++++
 reference/proctitle/setup.xml                 | 53 ++++++++++
 reference/proctitle/versions.xml              | 32 ++++++
 8 files changed, 417 insertions(+)
 create mode 100644 reference/proctitle/book.xml
 create mode 100644 reference/proctitle/configure.xml
 create mode 100644 reference/proctitle/constants.xml
 create mode 100644 reference/proctitle/functions/setproctitle.xml
 create mode 100644 reference/proctitle/functions/setthreadtitle.xml
 create mode 100644 reference/proctitle/reference.xml
 create mode 100644 reference/proctitle/setup.xml
 create mode 100644 reference/proctitle/versions.xml

diff --git a/reference/proctitle/book.xml b/reference/proctitle/book.xml
new file mode 100644
index 0000000000..c29772ca65
--- /dev/null
+++ b/reference/proctitle/book.xml
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<book xml:id="book.proctitle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title>Proctitle</title>
+ <titleabbrev>Proctitle</titleabbrev>
+
+ <preface xml:id="intro.proctitle">
+  &reftitle.intro;
+  <para>
+   This extension allows changing the current process', and thread, name on Linux and *BSD
+   systems. This is useful when using <function>pcntl_fork</function> to identify running
+   processes in process list
+  </para>
+ </preface>
+
+ &reference.proctitle.setup;
+ &reference.proctitle.constants;
+ &reference.proctitle.reference;
+
+</book>
+
+<!-- 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:"~/.phpdoc/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
+-->
diff --git a/reference/proctitle/configure.xml b/reference/proctitle/configure.xml
new file mode 100644
index 0000000000..04280536cd
--- /dev/null
+++ b/reference/proctitle/configure.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<section xml:id="proctitle.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ &reftitle.install;
+
+ <para>
+  &pecl.info;
+  <link xlink:href="&url.pecl.package;proctitle">&url.pecl.package;proctitle</link>.
+ </para>
+
+</section>
+
+
+<!-- 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:"~/.phpdoc/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
+-->
diff --git a/reference/proctitle/constants.xml b/reference/proctitle/constants.xml
new file mode 100644
index 0000000000..69fd8f3822
--- /dev/null
+++ b/reference/proctitle/constants.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<appendix xml:id="proctitle.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ &reftitle.constants;
+ &no.constants;
+</appendix>
+
+<!-- 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:"~/.phpdoc/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
+-->
diff --git a/reference/proctitle/functions/setproctitle.xml b/reference/proctitle/functions/setproctitle.xml
new file mode 100644
index 0000000000..e303715eec
--- /dev/null
+++ b/reference/proctitle/functions/setproctitle.xml
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.setproctitle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>setproctitle</refname>
+  <refpurpose>Set the process title</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>void</type><methodname>setproctitle</methodname>
+   <methodparam><type>string</type><parameter>title</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Sets the process title of the current process.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>title</parameter></term>
+     <listitem>
+      <para>
+       The title to use as the process title.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples"><!-- {{{ -->
+  &reftitle.examples;
+  <example xml:id="setproctitle.example.basic"><!-- {{{ -->
+   <title><function>setproctitle</function> example</title>
+   <para>
+    Running the example below will change the process title (visible with
+    <literal>ps a</literal> for example).
+   </para>
+   <programlisting role="php">
+<![CDATA[
+<?php
+setproctitle("myscript");
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+$ ps a
+  PID TTY      STAT   TIME COMMAND
+ 1168 pts/3    S      0:00 myscript                                                                                                                         
+]]>
+   </screen>
+  </example><!-- }}} -->
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="seealso"><!-- {{{ -->
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>pcntl_fork</function></member>
+   <member><function>setthreadtitle</function></member>
+  </simplelist>
+ </refsect1><!-- }}} -->
+
+</refentry>
+
+<!-- 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:"~/.phpdoc/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
+-->
diff --git a/reference/proctitle/functions/setthreadtitle.xml b/reference/proctitle/functions/setthreadtitle.xml
new file mode 100644
index 0000000000..07929968c3
--- /dev/null
+++ b/reference/proctitle/functions/setthreadtitle.xml
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.setthreadtitle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>setthreadtitle</refname>
+  <refpurpose>Set the thread title</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>setthreadtitle</methodname>
+   <methodparam><type>string</type><parameter>title</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Sets the thread title.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>title</parameter></term>
+     <listitem>
+      <para>
+       The title to use as the thread title.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples"><!-- {{{ -->
+  &reftitle.examples;
+  <example xml:id="setthreadtitle.example.basic"><!-- {{{ -->
+   <title><function>setthreadtitle</function> example</title>
+   <para>
+    Running the example below will change the thread title (visible with
+    <literal>ps c</literal> for example).
+   </para>
+   <programlisting role="php">
+<![CDATA[
+<?php
+setthreadtitle("myscript");
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+$ ps c
+  PID TTY      STAT   TIME COMMAND
+ 1178 pts/3    S      0:00 myscript
+]]>
+   </screen>
+  </example><!-- }}} -->
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="seealso"><!-- {{{ -->
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>pcntl_fork</function></member>
+   <member><function>setproctitle</function></member>
+  </simplelist>
+ </refsect1><!-- }}} -->
+
+</refentry>
+
+<!-- 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:"~/.phpdoc/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
+-->
diff --git a/reference/proctitle/reference.xml b/reference/proctitle/reference.xml
new file mode 100644
index 0000000000..f7c6cef4cf
--- /dev/null
+++ b/reference/proctitle/reference.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<reference xml:id="ref.proctitle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title>Proctitle &Functions;</title>
+
+ &reference.proctitle.entities.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:"~/.phpdoc/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
+-->
diff --git a/reference/proctitle/setup.xml b/reference/proctitle/setup.xml
new file mode 100644
index 0000000000..5b878b2460
--- /dev/null
+++ b/reference/proctitle/setup.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<chapter xml:id="proctitle.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ &reftitle.setup;
+
+ <section xml:id="proctitle.requirements">
+  &reftitle.required;
+  <para>
+   Nothing special.
+  </para>
+ </section>
+
+ <section xml:id="proctitle.installation">
+  &reftitle.install;
+ <para>
+  &pecl.info;
+  <link xlink:href="&url.pecl.package;proctitle">&url.pecl.package;proctitle</link>.
+ </para>
+ </section>
+
+ <section xml:id="proctitle.configuration">
+  &reftitle.runtime;
+  &no.config;
+ </section>
+
+ <section xml:id="proctitle.resources">
+  &reftitle.resources;
+  &no.resource;
+ </section>
+
+</chapter>
+
+<!-- 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:"~/.phpdoc/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
+-->
diff --git a/reference/proctitle/versions.xml b/reference/proctitle/versions.xml
new file mode 100644
index 0000000000..db71c71e4e
--- /dev/null
+++ b/reference/proctitle/versions.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!--
+  Do NOT translate this file
+-->
+
+<versions>
+ <!-- Functions -->
+ <function name='setproctitle' from='PECL proctitle &gt;= 0.1.0'/>
+ <function name='setthreadtitle' from='PECL proctitle &gt;= 0.1.2'/>
+</versions>
+
+<!-- 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:"~/.phpdoc/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
+-->