php-doc-en/reference/proctitle/functions/setthreadtitle.xml
Yannick Torres ea1983a43d Fix svn keywords
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@310684 c90b9560-bf6c-de11-be94-00142212c4b1
2011-05-01 08:07:08 +00:00

99 lines
2.3 KiB
XML

<?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
-->