mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
86e6094e86
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351133 c90b9560-bf6c-de11-be94-00142212c4b1
518 lines
18 KiB
XML
518 lines
18 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<section xml:id="wincache.configuration" xmlns="http://docbook.org/ns/docbook">
|
|
&reftitle.runtime;
|
|
&extension.runtime;
|
|
<para>
|
|
The following table lists and explains the configuration settings
|
|
provided by the WinCache extension:
|
|
</para>
|
|
<para>
|
|
<table>
|
|
<title>WinCache configuration options</title>
|
|
<tgroup cols="6">
|
|
<thead>
|
|
<row>
|
|
<entry>&Name;</entry>
|
|
<entry>&Default;</entry>
|
|
<entry>Minimum</entry>
|
|
<entry>Maximum</entry>
|
|
<entry>&Changeable;</entry>
|
|
<entry>&Changelog;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.fcenabled">wincache.fcenabled</link></entry>
|
|
<entry>"1"</entry>
|
|
<entry>"0"</entry>
|
|
<entry>"1"</entry>
|
|
<entry>PHP_INI_ALL</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.fcenabledfilter">wincache.fcenabledfilter</link></entry>
|
|
<entry>"NULL"</entry>
|
|
<entry>"NULL"</entry>
|
|
<entry>"NULL"</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.fcachesize">wincache.fcachesize</link></entry>
|
|
<entry>"24"</entry>
|
|
<entry>"5"</entry>
|
|
<entry>"255"</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.fcndetect">wincache.fcndetect</link></entry>
|
|
<entry>"1"</entry>
|
|
<entry>"0"</entry>
|
|
<entry>"1"</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.1.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.maxfilesize">wincache.maxfilesize</link></entry>
|
|
<entry>"256"</entry>
|
|
<entry>"10"</entry>
|
|
<entry>"2048"</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.ocenabled">wincache.ocenabled</link></entry>
|
|
<entry>"1"</entry>
|
|
<entry>"0"</entry>
|
|
<entry>"1"</entry>
|
|
<entry>PHP_INI_ALL</entry>
|
|
<entry>Available as of WinCache 1.0.0. Removed as of 2.0.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.ocenabledfilter">wincache.ocenabledfilter</link></entry>
|
|
<entry>"NULL"</entry>
|
|
<entry>"NULL"</entry>
|
|
<entry>"NULL"</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0. Removed as of 2.0.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.ocachesize">wincache.ocachesize</link></entry>
|
|
<entry>"96"</entry>
|
|
<entry>"15"</entry>
|
|
<entry>"255"</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0. Removed as of 2.0.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.filecount">wincache.filecount</link></entry>
|
|
<entry>"4096"</entry>
|
|
<entry>"1024"</entry>
|
|
<entry>"16384"</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.chkinterval">wincache.chkinterval</link></entry>
|
|
<entry>"30"</entry>
|
|
<entry>"0"</entry>
|
|
<entry>"300"</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.ttlmax">wincache.ttlmax</link></entry>
|
|
<entry>"1200"</entry>
|
|
<entry>"0"</entry>
|
|
<entry>"7200"</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.enablecli">wincache.enablecli</link></entry>
|
|
<entry>0</entry>
|
|
<entry>0</entry>
|
|
<entry>1</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.ignorelist">wincache.ignorelist</link></entry>
|
|
<entry>NULL</entry>
|
|
<entry>NULL</entry>
|
|
<entry>NULL</entry>
|
|
<entry>PHP_INI_ALL</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.namesalt">wincache.namesalt</link></entry>
|
|
<entry>NULL</entry>
|
|
<entry>NULL</entry>
|
|
<entry>NULL</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.ucenabled">wincache.ucenabled</link></entry>
|
|
<entry>1</entry>
|
|
<entry>0</entry>
|
|
<entry>1</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.1.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.ucachesize">wincache.ucachesize</link></entry>
|
|
<entry>8</entry>
|
|
<entry>5</entry>
|
|
<entry>85</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.1.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.scachesize">wincache.scachesize</link></entry>
|
|
<entry>8</entry>
|
|
<entry>5</entry>
|
|
<entry>85</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.1.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.rerouteini">wincache.rerouteini</link></entry>
|
|
<entry>NULL</entry>
|
|
<entry>NULL</entry>
|
|
<entry>NULL</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.2.0. Removed as of 1.3.7</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.reroute_enabled">wincache.reroute_enabled</link></entry>
|
|
<entry>1</entry>
|
|
<entry>0</entry>
|
|
<entry>1</entry>
|
|
<entry>PHP_INI_SYSTEM | PHP_INI_PERDIR</entry>
|
|
<entry>Available as of WinCache 1.3.7</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.srwlocks">wincache.srwlocks</link></entry>
|
|
<entry>1</entry>
|
|
<entry>0</entry>
|
|
<entry>1</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.3.6.3. Removed as of 2.0.0.0</entry>
|
|
</row>
|
|
<row>
|
|
<entry><link linkend="ini.wincache.filemapdir">wincache.filemapdir</link></entry>
|
|
<entry>NULL</entry>
|
|
<entry>NULL</entry>
|
|
<entry>NULL</entry>
|
|
<entry>PHP_INI_SYSTEM</entry>
|
|
<entry>Available as of WinCache 1.3.7.4</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
&ini.php.constants;
|
|
</para>
|
|
|
|
&ini.descriptions.title;
|
|
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry xml:id="ini.wincache.fcenabled">
|
|
<term>
|
|
<parameter>wincache.fcenabled</parameter>
|
|
<type>bool</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>Enables or disables the file cache functionality.</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.fcenabledfilter">
|
|
<term>
|
|
<parameter>wincache.fcenabledfilter</parameter>
|
|
<type>string</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines a comma-separated list of IIS web site identifiers where file
|
|
cache should be enabled or disabled. This setting works in conjunction
|
|
with <literal>wincache.fcenabled</literal>: if <literal>wincache.fcenabled</literal>
|
|
is set to 1, then the sites listed in the <literal>wincache.fcenabledfilter</literal>
|
|
will have the file cache turned off; if <literal>wincache.fcenabled</literal>
|
|
is set to 0, then the sites listed in the <literal>wincache.fcenabledfilter</literal>
|
|
will have the file cache turned on.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.fcachesize">
|
|
<term>
|
|
<parameter>wincache.fcachesize</parameter>
|
|
<type>int</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines the maximum memory size (in megabytes) that is allocated for the file cache.
|
|
If the total size of all the cached files exceeds the value specified in this setting,
|
|
then most stale files will be removed from the file cache.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.fcndetect">
|
|
<term>
|
|
<parameter>wincache.fcndetect</parameter>
|
|
<type>bool</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Enables or disables the file change notification detection functionality. If file change
|
|
notification is supported then it will be used to refresh the opcode and file cache entries
|
|
as soon as the corresponding files are modified on a file system. If file change notification
|
|
is not supported, for example when using network file shares, then wincache will poll for
|
|
file changes at regular time intervals specified by <literal>wincache.chkinterval</literal>.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.maxfilesize">
|
|
<term>
|
|
<parameter>wincache.maxfilesize</parameter>
|
|
<type>int</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines the maximum allowed size (in kilobytes) for a single file to be cached.
|
|
If a file size exceeds the specified value, the file will not be cached.
|
|
This setting applies to the file cache only.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.ocenabled">
|
|
<term>
|
|
<parameter>wincache.ocenabled</parameter>
|
|
<type>bool</type>
|
|
</term>
|
|
<listitem>
|
|
<warning xmlns="http://docbook.org/ns/docbook"><simpara>This option has been <emphasis>REMOVED</emphasis> as of 2.0.0.0</simpara></warning>
|
|
<simpara>Enables or disables the opcode cache functionality</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.ocenabledfilter">
|
|
<term>
|
|
<parameter>wincache.ocenabledfilter</parameter>
|
|
<type>string</type>
|
|
</term>
|
|
<listitem>
|
|
<warning xmlns="http://docbook.org/ns/docbook"><simpara>This option has been <emphasis>REMOVED</emphasis> as of 2.0.0.0</simpara></warning>
|
|
<simpara>
|
|
Defines a comma-separated list of IIS web site identifiers where opcode
|
|
cache should be enabled or disabled. This setting works in conjunction
|
|
with <literal>wincache.ocenabled</literal>: if <literal>wincache.ocenabled</literal>
|
|
is set to 1, then the sites listed in the <literal>wincache.ocenabledfilter</literal>
|
|
will have the opcode cache turned off; if <literal>wincache.ocenabled</literal>
|
|
is set to 0, then the sites listed in the <literal>wincache.ocenabledfilter</literal>
|
|
will have the opcode cache turned on.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.ocachesize">
|
|
<term>
|
|
<parameter>wincache.ocachesize</parameter>
|
|
<type>int</type>
|
|
</term>
|
|
<listitem>
|
|
<warning xmlns="http://docbook.org/ns/docbook"><simpara>This option has been <emphasis>REMOVED</emphasis> as of 2.0.0.0</simpara></warning>
|
|
<simpara>
|
|
Defines the maximum memory size (in megabytes) that is allocated for the
|
|
opcode cache. If the cached opcode size exceeds the specified value,
|
|
then most stale opcode will be removed from the cache. Note that the opcode
|
|
cache size must be at least 3 times bigger than file cache size.
|
|
If that is not the case the opcode cache size will be automatically increased.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.filecount">
|
|
<term>
|
|
<parameter>wincache.filecount</parameter>
|
|
<type>int</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines how many files are expected to be cached by the extension, so that appropriate
|
|
memory size is allocated at the startup time. If the number of files exceeds the specified
|
|
value, the WinCache will re-allocate more memory as needed.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.chkinterval">
|
|
<term>
|
|
<parameter>wincache.chkinterval</parameter>
|
|
<type>int</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines how often (in seconds) the extension checks for file changes in order
|
|
to refresh the cache. Setting it to 0 will disable the refreshing of the cache.
|
|
The file changes will not be reflected in the cache unless the cache entry for
|
|
that file is removed by scavenger or IIS application pool is recycled or
|
|
wincache_refresh_if_changed function is called.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.ttlmax">
|
|
<term>
|
|
<parameter>wincache.ttlmax</parameter>
|
|
<type>int</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines the maximum time to live (in seconds) for a cached entry without being used.
|
|
Setting it to 0 will disable the cache scavenger, so the cached entries will never
|
|
be removed from the cache during the lifetime of the IIS worker process.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.enablecli">
|
|
<term>
|
|
<parameter>wincache.enablecli</parameter>
|
|
<type>bool</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines if caching is enabled when PHP is running in command line (CLI) mode.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.ignorelist">
|
|
<term>
|
|
<parameter>wincache.ignorelist</parameter>
|
|
<type>string</type>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Defines a list of files that should not be cached by the extension.
|
|
The files list is specified by using file names only, separated by
|
|
the pipe symbol - "|".
|
|
<example>
|
|
<title><literal>wincache.ignorelist</literal> example</title>
|
|
<programlisting role="ini">
|
|
<![CDATA[
|
|
wincache.ignorelist = "index.php|misc.php|admin.php"
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.namesalt">
|
|
<term>
|
|
<parameter>wincache.namesalt</parameter>
|
|
<type>string</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines a string that will be used when naming the extension
|
|
specific objects that are stored in shared memory. This is used
|
|
to avoid conflicts that may be caused if other applications within
|
|
an IIS worker process tries to access shared memory. The length of
|
|
the namesalt string cannot exceed 8 characters.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.ucenabled">
|
|
<term>
|
|
<parameter>wincache.ucenabled</parameter>
|
|
<type>bool</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Enables or disables the user cache functionality.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.ucachesize">
|
|
<term>
|
|
<parameter>wincache.ucachesize</parameter>
|
|
<type>int</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines the maximum memory size in megabytes that is allocated for the user cache. If the total
|
|
size of variables stored in the user cache exceeds the specified value, then the most stale variables
|
|
will be removed from the cache.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.scachesize">
|
|
<term>
|
|
<parameter>wincache.scachesize</parameter>
|
|
<type>int</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Defines the maximum memory size in megabytes that is allocated for the session cache. If the total
|
|
size of data stored in the session cache exceeds the specified value, then the most stale data
|
|
will be removed from the cache.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.rerouteini">
|
|
<term>
|
|
<parameter>wincache.rerouteini</parameter>
|
|
<type>string</type>
|
|
</term>
|
|
<listitem>
|
|
<warning xmlns="http://docbook.org/ns/docbook"><simpara>
|
|
This option has been <emphasis>REMOVED</emphasis> as of 1.3.7. See <literal>wincache.reroute_enabled</literal> for similar functionality as of 1.3.7.
|
|
</simpara></warning>
|
|
<simpara>
|
|
Specifies an absolute or a relateve path to the reroute.ini file that contains the list of PHP functions
|
|
whose implementation should be replaced with the WinCache function equivalents. If a relative path is specified
|
|
then it is assumed to be relative to the location of php-cgi.exe file.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.reroute_enabled">
|
|
<term>
|
|
<parameter>wincache.reroute_enabled</parameter>
|
|
<type>bool</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Enables or disables the rerouting of certain file I/O functions through the file cache.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.srwlocks">
|
|
<term>
|
|
<parameter>wincache.srwlocks</parameter>
|
|
<type>bool</type>
|
|
</term>
|
|
<listitem>
|
|
<warning xmlns="http://docbook.org/ns/docbook"><simpara>This option has been <emphasis>REMOVED</emphasis> as of 2.0.0.0</simpara></warning>
|
|
<simpara>
|
|
Enables or disables the use of shared reader/writer locks. Disabling is useful when troubleshooting deadlock conditions in WinCache.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ini.wincache.filemapdir">
|
|
<term>
|
|
<parameter>wincache.filemapdir</parameter>
|
|
<type>string</type>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Specifies an absolute path to a directory where WinCache will store the temporary files used for shared memory segments.
|
|
</simpara>
|
|
<simpara>
|
|
This directory must be on the local machine and not on a networked file system.
|
|
</simpara>
|
|
<simpara>
|
|
If the directory is not specified, WinCache will use the Windows System Page File for all shared memory segments.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</section>
|
|
|
|
<!-- 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
|
|
-->
|