Removed the deprecated muscat extension from phpdoc/en

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@255554 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2008-03-20 02:44:08 +00:00
parent c738284f59
commit 6476ee645b
11 changed files with 1 additions and 591 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.35 $ -->
<!-- $Revision: 1.36 $ -->
<!--
DO NOT TRANSLATE THIS FILE! All the content that is displayed
on the extension categorization page in your translated manual
@ -168,7 +168,6 @@
<listitem><para><xref linkend="book.msession"/></para></listitem>
<listitem><para><xref linkend="book.msql"/></para></listitem>
<listitem><para><xref linkend="book.mssql"/></para></listitem>
<listitem><para><xref linkend="book.muscat"/></para></listitem>
<listitem><para><xref linkend="book.mysql"/></para></listitem>
<listitem><para><xref linkend="book.mysqli"/></para></listitem>
<listitem><para><xref linkend="book.ncurses"/></para></listitem>
@ -265,7 +264,6 @@
<listitem><para><xref linkend="book.memcache"/></para></listitem>
<listitem><para><xref linkend="book.mnogosearch"/></para></listitem>
<listitem><para><xref linkend="book.msession"/></para></listitem>
<listitem><para><xref linkend="book.muscat"/></para></listitem>
<listitem><para><xref linkend="book.ncurses"/></para></listitem>
<listitem><para><xref linkend="book.net-gopher"/></para></listitem>
<listitem><para><xref linkend="book.newt"/></para></listitem>
@ -351,7 +349,6 @@
<listitem><para><xref linkend="book.imagick"/></para></listitem>
<listitem><para><xref linkend="book.java"/></para></listitem>
<listitem><para><xref linkend="book.ming"/></para></listitem>
<listitem><para><xref linkend="book.muscat"/></para></listitem>
<listitem><para><xref linkend="book.ncurses"/></para></listitem>
<listitem><para><xref linkend="book.newt"/></para></listitem>
<listitem><para><xref linkend="book.notes"/></para></listitem>

View file

@ -1,48 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- Purpose: basic.session -->
<!-- Membership: pecl, external -->
<!-- State: experimental -->
<book xml:id="book.muscat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>muscat Functions</title>
<titleabbrev>muscat</titleabbrev>
<preface xml:id="intro.muscat">
&reftitle.intro;
<para>
This extension provides an interface to the Muscat 3.6 search system.
Muscat doesn't exist anymore, but the <link
xlink:href="&url.muscat.xapian;">Xapian</link> project may provide you with a
good alternative.
</para>
&warn.experimental;
</preface>
&reference.muscat.setup;
&reference.muscat.constants;
&reference.muscat.reference;
</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

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<section xml:id="muscat.installation" xmlns="http://docbook.org/ns/docbook">
&reftitle.install;
<para xml:id="muscat.configure">
These functions are only available if PHP was
configured with <option role="configure">--with-muscat[=DIR]</option>.
</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

@ -1,29 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<appendix xml:id="muscat.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&no.constants;
</appendix>
<!-- 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

@ -1,77 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.muscat-close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>muscat_close</refname>
<refpurpose>Shuts down the muscat session</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>muscat_close</methodname>
<methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Shuts down the muscat session and releases any memory back to PHP.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>muscat_handle</parameter></term>
<listitem>
<para>
A muscat session handler, returned by
<function>muscat_setup</function> or
<function>muscat_setup_net</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>muscat_setup</function></member>
<member><function>muscat_setup_net</function></member>
</simplelist>
</para>
</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:"../../../../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

@ -1,77 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.muscat-get" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>muscat_get</refname>
<refpurpose>Gets a line back from the core muscat API</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>muscat_get</methodname>
<methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Gets a line back from the core muscat API.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>muscat_handle</parameter></term>
<listitem>
<para>
A muscat session handler, returned by
<function>muscat_setup</function> or
<function>muscat_setup_net</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the muscat response, as a string.
</para>
&return.falseproblem;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>muscat_give</function></member>
</simplelist>
</para>
</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:"../../../../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

@ -1,85 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.muscat-give" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>muscat_give</refname>
<refpurpose>Sends string to the core muscat API</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>muscat_give</methodname>
<methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sends a <parameter>string</parameter> to the core muscat API.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>muscat_handle</parameter></term>
<listitem>
<para>
A muscat session handler, returned by
<function>muscat_setup</function> or
<function>muscat_setup_net</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
The string to be sent
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>muscat_get</function></member>
</simplelist>
</para>
</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:"../../../../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

@ -1,75 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.muscat-setup-net">
<refnamediv>
<refname>muscat_setup_net</refname>
<refpurpose>Creates a new muscat session</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>muscat_setup_net</methodname>
<methodparam><type>resource</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Creates a new muscat session.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>socket</parameter></term>
<listitem>
<para>
Socket handle
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a session handler or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>muscat_setup</function></member>
<member><function>muscat_close</function></member>
</simplelist>
</para>
</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:"../../../../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

@ -1,85 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.muscat-setup" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>muscat_setup</refname>
<refpurpose>Creates a new local muscat session</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>muscat_setup</methodname>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>muscat_dir</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Creates a new local muscat session.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The amount of memory in bytes to allocate for muscat
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>muscat_dir</parameter></term>
<listitem>
<para>
The muscat installation dir e.g. "/usr/local/empower", it defaults to
the compile time muscat directory.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a session handler or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>muscat_setup_net</function></member>
<member><function>muscat_close</function></member>
</simplelist>
</para>
</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:"../../../../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

@ -1,31 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<reference xml:id="ref.muscat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>muscat &Functions;</title>
&reference.muscat.entities.functions;
</reference>
<!-- 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

@ -1,50 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="muscat.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<section xml:id="muscat.requirements">
&reftitle.required;
&no.requirement;
</section>
&reference.muscat.configure;
<section xml:id="muscat.configuration">
&reftitle.runtime;
&no.config;
</section>
<section xml:id="muscat.resources">
&reftitle.resources;
<para>
This extension defines a Muscat session handler returned by
<function>muscat_setup_net</function> and
<function>muscat_setup</function>.
</para>
</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
-->