sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Flesh out the cli_get_process_title() and cli_set_process_title() documentation.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330581 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Adam Harvey 2013-06-21 00:19:01 +00:00
parent 9826ef1ad3
commit 43e6946a85
2 changed files with 48 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
reference/info/functions/cli-get-process-title.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="function.cli-get-process-title" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>cli_get_process_title</refname>
<refpurpose>Return current process title</refpurpose>
<refpurpose>Returns the current process title</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -14,10 +14,16 @@
<void />
</methodsynopsis>
<para>
Available only in <link linkend="features.commandline">CLI</link>.
Returns the current process title, as set by
<function>cli_set_process_title</function>. Note that this may not exactly
match what is shown in <command>ps</command> or <command>top</command>,
depending on your operating system.
</para>
&warn.undocumented.func;
<para>
This function is available only in
<link linkend="features.commandline">CLI</link> mode.
</para>
</refsect1>
@ -33,7 +39,23 @@
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
An <constant>E_WARNING</constant> will be generated if the operating system
is unsupported.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>cli_set_process_title</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

29
reference/info/functions/cli-set-process-title.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="function.cli-set-process-title" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>cli_set_process_title</refname>
<refpurpose>Change process title</refpurpose>
<refpurpose>Sets the process title</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -13,11 +13,12 @@
<type>bool</type><methodname>cli_set_process_title</methodname>
<methodparam><type>string</type><parameter>title</parameter></methodparam>
</methodsynopsis>
<para>
Available only in <link linkend="features.commandline">CLI</link>.
</para>
&warn.undocumented.func;
<para>
Sets the process title visible in tools such as <command>top</command> and
<command>ps</command>. This function is available only in
<link linkend="features.commandline">CLI</link> mode.
</para>
</refsect1>
@ -28,7 +29,7 @@
<term><parameter>title</parameter></term>
<listitem>
<para>
The new title.
</para>
</listitem>
</varlistentry>
@ -42,7 +43,23 @@
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
An <constant>E_WARNING</constant> will be generated if the operating system
is unsupported.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>cli_get_process_title</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file