ok, Sterling, you asked for it ;)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@64790 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2001-12-12 09:00:11 +00:00
parent 9559a49a01
commit aaf707e3e7
2 changed files with 370 additions and 0 deletions

170
functions/cyrus.xml Normal file
View file

@ -0,0 +1,170 @@
<reference id="ref.">
<title>Cyrus IMAP administration functions</title>
<titleabbrev>Cyradm functions</titleabbrev>
<partintro>
<para>
undocumented -> blame Sterling ;)
</para>
</partintro>
<refentry id="function.cyrus-connect">
<refnamediv>
<refname>cyrus_connect</refname>
<refpurpose>Connect to a Cyrus IMAP server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>resource <function>cyrus_connect</function></funcdef>
<paramdef>string
<parameter><optional>host</optional></parameter>
</paramdef>
<paramdef>string
<parameter><optional>port</optional></parameter>
</paramdef>
<paramdef>int
<parameter><optional>flags</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-authenticate">
<refnamediv>
<refname>cyrus_authenticate</refname>
<refpurpose>Authenticate agaings a Cyrus IMAP server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>cyrus_authenticate</function></funcdef>
<paramdef>resource <parameter>connection</parameter></paramdef>
<paramdef>string
<parameter><optional>mechlist</optional></parameter>
</paramdef>
<paramdef>string
<parameter><optional>service</optional></parameter>
</paramdef>
<paramdef>string
<parameter><optional>user</optional></parameter>
</paramdef>
<paramdef>int
<parameter><optional>minssf</optional></parameter>
</paramdef>
<paramdef>int
<parameter><optional>maxssf</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-bind">
<refnamediv>
<refname>cyrus_bind</refname>
<refpurpose>Bind callbacks to a Cyrus IMAP connection </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>cyrus_bind</function></funcdef>
<paramdef>resource <parameter>connection</parameter></paramdef>
<paramdef>array <parameter>callbacks</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-unbind">
<refnamediv>
<refname>cyrus_unbind</refname>
<refpurpose>Unbind ... </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>cyrus_unbind</function></funcdef>
<paramdef>resource <parameter>connection</parameter></paramdef>
<paramdef>string <parameter>trigger_name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-query">
<refnamediv>
<refname>cyrus_query</refname>
<refpurpose>Send a query to a Cyrus IMAP server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>cyrus_query</function></funcdef>
<paramdef>resource <parameter>connection</parameter></paramdef>
<paramdef>string <parameter>query</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-close">
<refnamediv>
<refname>cyrus_close</refname>
<refpurpose>Close connection to a cyrus server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>cyrus_close</function></funcdef>
<paramdef>resource <parameter>connection</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
</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
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->

200
functions/dio.xml Normal file
View file

@ -0,0 +1,200 @@
<reference id="ref.dio">
<title>Direct IO functions</title>
<titleabbrev>DIO functions</titleabbrev>
<partintro>
<para>
Undocumented - blame Sterling ;)
</para>
</partintro>
<refentry id="function.dio-open">
<refnamediv>
<refname>dio_open</refname>
<refpurpose>Open a new filename with specified permissions of flags and creation permissions of mode </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>resource <function>dio_open</function></funcdef>
<paramdef>string <parameter>filename</parameter></paramdef>
<paramdef>int <parameter>flags</parameter></paramdef>
<paramdef>int
<parameter><optional>mode</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.dio-read">
<refnamediv>
<refname>dio_read</refname>
<refpurpose>Read n bytes from fd and return them, if n is not specified, read 1k </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>dio_read</function></funcdef>
<paramdef>resource <parameter>fd</parameter></paramdef>
<paramdef>int
<parameter><optional>n</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.dio-write">
<refnamediv>
<refname>dio_write</refname>
<refpurpose>Write data to fd with optional truncation at length </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dio_write</function></funcdef>
<paramdef>resource <parameter>fd</parameter></paramdef>
<paramdef>string <parameter>data</parameter></paramdef>
<paramdef>int
<parameter><optional>len</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.dio-truncate">
<refnamediv>
<refname>dio_truncate</refname>
<refpurpose>Truncate file descriptor fd to offset bytes </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>dio_truncate</function></funcdef>
<paramdef>resource <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>offset</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.dio-stat">
<refnamediv>
<refname>dio_stat</refname>
<refpurpose>Get stat information about the file descriptor fd </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>array <function>dio_stat</function></funcdef>
<paramdef>resource <parameter>fd</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.dio-seek">
<refnamediv>
<refname>dio_seek</refname>
<refpurpose>Seek to pos on fd from whence </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dio_seek</function></funcdef>
<paramdef>resource <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>pos</parameter></paramdef>
<paramdef>int <parameter>whence</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.dio-fcntl">
<refnamediv>
<refname>dio_fcntl</refname>
<refpurpose>Perform a c library fcntl on fd </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>mixed <function>dio_fcntl</function></funcdef>
<paramdef>resource <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>cmd</parameter></paramdef>
<paramdef>mixed
<parameter><optional>arg</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
<refentry id="function.dio-close">
<refnamediv>
<refname>dio_close</refname>
<refpurpose>Close the file descriptor given by fd </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>dio_close</function></funcdef>
<paramdef>resource <parameter>fd</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented -> blame Sterling ;)
</para>
</refsect1>
</refentry>
</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
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->