- initial doc for htscanner

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@276785 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Pierre Joye 2009-03-05 02:13:26 +00:00
parent ef4e5befd0
commit 3238e983f7
4 changed files with 255 additions and 0 deletions

View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- Purpose: basic.php -->
<!-- Membership: pecl -->
<book xml:id="book.htscanner" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>htaccess-like support for all SAPIs</title>
<titleabbrev>htscanner</titleabbrev>
<preface xml:id="intro.htscanner">
&reftitle.intro;
<para>
The htscanner extension gives the possibility to use htaccess-like file to configure PHP
per directory, just like apache's htaccess. It is especially useful with fastcgi
(ISS5/6/7, lighttpd, etc.).
</para>
</preface>
&reference.htscanner.setup;
</book>
<!-- 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:"../../../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
-->

View file

@ -0,0 +1,38 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<section xml:id="htscanner.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;htscanner">&url.pecl.package;htscanner</link>
</para>
<para>
The latest PECL/htscanner Win32 DLL is available here:
<link xlink:href="&url.pecl.win.ext;php_htscanner.dll">php_htscanner.dll</link>
</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:"../../../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
-->

130
reference/htscanner/ini.xml Normal file
View file

@ -0,0 +1,130 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<section xml:id="htscanner.configuration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>htscanner &ConfigureOptions;</title>
<tgroup cols="4">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>&Changeable;</entry>
<entry>Changelog</entry>
</row>
</thead>
<tbody>
<row>
<entry><link linkend="ini.htscanner.config_file">htscanner.config_file</link></entry>
<entry>".htscanner"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry></entry>
</row>
<row>
<entry><link linkend="ini.htscanner.default_docroot">htscanner.default_docroot</link></entry>
<entry>"/"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry></entry>
</row>
<row>
<entry><link linkend="ini.htscanner.default_ttl">htscanner.default_ttl</link></entry>
<entry>"300"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry></entry>
</row>
<row>
<entry><link linkend="ini.htscanner.stop_on_error">htscanner."stop_on_error"</link></entry>
<entry>"Off"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
&ini.php.constants;
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.htscanner.config_file">
<term>
<parameter>htscanner.config_file</parameter>
<type>string</type>
</term>
<listitem>
<para>
Filename to use as configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.htscanner.default_docroot">
<term>
<parameter>htscanner.default_docroot</parameter>
<type>string</type>
</term>
<listitem>
<para>
Default document root.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.htscanner.default_ttl">
<term>
<parameter>htscanner.default_ttl</parameter>
<type>int</type>
</term>
<listitem>
<para>
Cache time out for the configuration data, in seconds.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.htscanner.stop_on_error">
<term>
<parameter>htscanner.stop_on_error</parameter>
<type>int</type>
</term>
<listitem>
<para>
Stop on error (parse error, cannot set an ini setting).
</para>
</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:"../../../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
-->

View file

@ -0,0 +1,44 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<chapter xml:id="htscanner.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<section xml:id="htscanner.requirements">
&reftitle.required;
<para>
PHP version 5.2.0 or greater.
</para>
</section>
&reference.htscanner.configure;
&reference.htscanner.ini;
<section xml:id="htscanner.resources">
&reftitle.resources;
&no.resource;
</section>
</chapter>
<!-- 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:"../../../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
-->