didou Sat Jan 29 21:11:52 2005 EDT
Modified files:
/phpdoc/en/reference/tcpwrap/functions tcpwrap-check.xml
Log:
Migrate docs to the new style
http://cvs.php.net/diff.php/phpdoc/en/reference/tcpwrap/functions/tcpwrap-check.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/tcpwrap/functions/tcpwrap-check.xml
diff -u phpdoc/en/reference/tcpwrap/functions/tcpwrap-check.xml:1.2
phpdoc/en/reference/tcpwrap/functions/tcpwrap-check.xml:1.3
--- phpdoc/en/reference/tcpwrap/functions/tcpwrap-check.xml:1.2 Wed Aug 18
17:00:46 2004
+++ phpdoc/en/reference/tcpwrap/functions/tcpwrap-check.xml Sat Jan 29
21:11:51 2005
@@ -1,15 +1,12 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc.
-->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.tcpwrap-check">
<refnamediv>
<refname>tcpwrap_check</refname>
- <refpurpose>
- tcpwrap check
- </refpurpose>
+ <refpurpose>Performs a tcpwrap check</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tcpwrap_check</methodname>
<methodparam><type>string</type><parameter>daemon</parameter></methodparam>
@@ -18,27 +15,62 @@
<methodparam
choice="opt"><type>bool</type><parameter>nodns</parameter></methodparam>
</methodsynopsis>
<para>
- This function consults /etc/hosts.allow and /etc/hosts.deny files to
- check if access to service <parameter>daemon</parameter> should be
- granted or denied for client with remote address
- <parameter>address</parameter> (and optional username
- <parameter>user</parameter>). <parameter>address</parameter> can be
- either IP address or domain name. <parameter>user</parameter> can be
- &null;.
- </para>
- <para>
- If <parameter>address</parameter> looks like domain name then DNS is
- used to resolve it to IP address; set <parameter>nodns</parameter> to
- &true; to avoid this.
+ This function consults the <filename>/etc/hosts.allow</filename> and
+ <filename>/etc/hosts.deny</filename> files to check if access to service
+ <parameter>daemon</parameter> should be granted or denied for a client.
</para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- For more details please consult hosts_access(3) man page.
+ <variablelist>
+ <varlistentry>
+ <term><parameter>daemon</parameter></term>
+ <listitem>
+ <para>
+ The service name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>address</parameter></term>
+ <listitem>
+ <para>
+ The client remote address. Can be either an IP address or a domain
name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user</parameter></term>
+ <listitem>
+ <para>
+ An optional user name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>nodns</parameter></term>
+ <listitem>
+ <para>
+ If <parameter>address</parameter> looks like domain name then DNS is
+ used to resolve it to IP address; set <parameter>nodns</parameter> to
+ &true; to avoid this.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
This function returns &true; if access should be granted, &false;
otherwise.
</para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
<example>
- <title><function>tcpwrap_check</function> example</title>
+ <title>Deny all connections from localhost</title>
<para>
If your /etc/hosts.deny file contains:
</para>
@@ -59,11 +91,14 @@
?>
]]>
</programlisting>
- <para>
- Then above code will deny all connections from localhost.
- </para>
</example>
</refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ For more details please consult hosts_access(3) man page.
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
