mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
4becab9a7e
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336594 c90b9560-bf6c-de11-be94-00142212c4b1
110 lines
2.6 KiB
XML
110 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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>Sets the process title</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>cli_set_process_title</methodname>
|
|
<methodparam><type>string</type><parameter>title</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<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>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>title</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The new title.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</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="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>cli_set_process_title</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$title = "My Amazing PHP Script";
|
|
$pid = getmypid(); // you can use this to see your process title in ps
|
|
|
|
if (!cli_set_process_title($title)) {
|
|
echo "Unable to set process title for PID $pid...\n";
|
|
exit(1);
|
|
} else {
|
|
echo "The process title '$title' for PID $pid has been set for your process!\n";
|
|
sleep(5);
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>cli_get_process_title</function></member>
|
|
<member><function>setproctitle</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</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
|
|
-->
|