<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Sets the process title</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.cli-get-process-title.html">cli_get_process_title</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.dl.html">dl</a></div>
<div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.cli-set-process-title" class="refentry">
<div class="refnamediv">
<h1 class="refname">cli_set_process_title</h1>
<p class="verinfo">(PHP 5 >= 5.5.0)</p><p class="refpurpose"><span class="refname">cli_set_process_title</span> — <span class="dc-title">Sets the process title</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.cli-set-process-title-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>cli_set_process_title</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$title</code></span>
)</div>
<p class="para rdfs-comment">
Sets the process title visible in tools such as <strong class="command">top</strong> and
<strong class="command">ps</strong>. This function is available only in
<a href="features.commandline.html" class="link">CLI</a> mode.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.cli-set-process-title-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">title</code></em></span>
<dd>
<p class="para">
The new title.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.cli-set-process-title-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.cli-set-process-title-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
An <strong><code>E_WARNING</code></strong> will be generated if the operating system
is unsupported.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.cli-set-process-title-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-481">
<p><strong>Example #1 <span class="function"><strong>cli_set_process_title()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$title </span><span style="color: #007700">= </span><span style="color: #DD0000">"My Amazing PHP Script"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$pid </span><span style="color: #007700">= </span><span style="color: #0000BB">getmypid</span><span style="color: #007700">(); </span><span style="color: #FF8000">// you can use this to see your process title in ps<br /><br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">cli_set_process_title</span><span style="color: #007700">(</span><span style="color: #0000BB">$title</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Unable to set process title for PID </span><span style="color: #0000BB">$pid</span><span style="color: #DD0000">...\n"</span><span style="color: #007700">;<br /> exit(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />} else {<br /> echo </span><span style="color: #DD0000">"The process title '</span><span style="color: #0000BB">$title</span><span style="color: #DD0000">' for PID </span><span style="color: #0000BB">$pid</span><span style="color: #DD0000"> has been set for your process!\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">sleep</span><span style="color: #007700">(</span><span style="color: #0000BB">5</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.cli-set-process-title-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.cli-get-process-title.html" class="function" rel="rdfs-seeAlso">cli_get_process_title()</a> - Returns the current process title</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.cli-get-process-title.html">cli_get_process_title</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.dl.html">dl</a></div>
<div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
