turck-mmcache - Precompiler and cache to improve performance of PHP scripts

This manual page documents briefly the turck-mmcache package. This manual page was written for the Debian distribution because the original program does not have a manual page.

turck-mmcache is a PHP Accelerator, Optimizer, Encoder and Dynamic Content Cache. It increases performance of PHP scripts by caching them in a compiled state so that the overhead of compiling is almost completely eliminated. It also uses some optimizations for speedup of PHP script execution. Turck MMCache typically reduces server load and increases the speed of PHP code by 1-10 times.

turck-mmcache is loaded into PHP as an extension, and stores compiled PHP scripts in shared memory and executes code directly from it.

turck-mmcache is compatible with Zend Optimizer's loader. Zend Optimizer must be installed after Turck MMCache in php.ini. If you don't use scripts encoded with Zend Encoder then it is not recommend you install Zend Optimizer with Turck MMCache.

turck-mmcache must be loaded into PHP as either a Zend or PHP extension. A number settings must be placed in your php.ini file to instruct PHP to load turck-mmcache and to configure the cache options. These options are:

mmcache.shm_size

The amount of shared memory (in megabytes) that Turck MMCache will use. "0" means OS default. Default value is "0".

mmcache.cache_dir

The directory that is used for disk cache. Turck MMCache stores precompiled code, session data, content and user entries here. The same data can be stored in shared memory also (for more quick access). Default value is "/tmp/mmcache".

mmcache.enable

Enables or disables Turck MMCache. Should be "1" for enabling or "0" for disabling. Default value is "1".

mmcache.optimizer

Enables or disables internal peephole optimizer which may speed up code execution. Should be "1" for enabling or "0" for disabling. Default value is "1".

mmcache.debug

Enables or disables debug logging. Should be "1" for enabling or "0" for disabling. Default value is "0".

mmcache.check_mtime

Enables or disables PHP file modification checking. Should be "1" for enabling or "0" for disabling. You should set it to "1" if you want to recompile PHP files after modification. Default value is "1".

mmcache.filter

Determine which PHP files must be cached. You may specify the number of patterns (for example "*.php *.phtml") which specifies to cache or not to cache. If pattern starts with the character "!", it means to ignore files which are matched by the following pattern. Default value is "" that means - all PHP scripts will be cached.

mmcache.shm_max

Disables putting large values into shared memory by "mmcache_put()" function. It indicates the largest allowed size in bytes (10240, 10K, 1M). The "0" disables the limit. Default value is "0".

mmcache.shm_ttl

When MMCache fails to get shared memory for new script it removes all scripts which were not accessed at last "shm_ttl" seconds from shared memory. Default value is "0" that means - don't remove any files from shared memory.

mmcache.shm_prune_period

When MMCache fails to get shared memory for new script it tryes to remove old script if the previous try was made more then "shm_prune_period" seconds ago. Default value is "0" that means - don't try to remove any files from shared memory.

mmcache.shm_only

Enables or disables caching of compiled scripts on disk. It has no effect on session data and content caching. Default value is "0" that means - use disk and shared memory for caching.

mmcache.compress

Enables or disables cached content compression. Default value is "1" that means enable compression.

mmcache.keys, mmcache.sessions, mmcache.content

Determine where keys, session data and content will be cached. The possible values are: "shm_and_disk" - cache data in shared memory and on disk (default value) "shm" - cache data in shared memory or on disk if shared memory is full or data size greater than "mmcache.shm_max" "shm_only" - cache data in shared memory "disk_only" - cache data on disk "none" - don't cache data

More information is available online at the following sites:

http://www.turckware.ru/en/e_mmc.htm

http://sourceforge.net/projects/turck-mmcache/

turck-encode(1).

This manual page was written by Jonathan Oxer <jon@debian.org>, for the Debian project (but may be used by others).