File: proc-nice.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (86 lines) | stat: -rw-r--r-- 2,425 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id='function.proc-nice' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>proc_nice</refname>
  <refpurpose>Change the priority of the current process</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>proc_nice</methodname>
   <methodparam><type>int</type><parameter>increment</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>proc_nice</function> changes the priority of the current
   process by the amount specified in <parameter>increment</parameter>. A
   positive <parameter>increment</parameter> will lower the priority of the
   current process, whereas a negative <parameter>increment</parameter>
   will raise the priority.
  </para>
  <para>
   <function>proc_nice</function> is not related to
   <function>proc_open</function> and its associated functions in any way.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>increment</parameter></term>
     <listitem>
      <para>
       The increment value of the priority change.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
   If an error occurs, like the user lacks permission to change the priority, 
   an error of level <constant>E_WARNING</constant> is also generated.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Availability</title>
   <para>
    <function>proc_nice</function> will only exist if your system has 'nice'
    capabilities. 'nice' conforms to: SVr4, SVID EXT, AT&amp;T, X/OPEN, BSD
    4.3. This means that <function>proc_nice</function> is not available
    on Windows.
   </para>
  </note>
 </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
-->