Switch ref.crack to the new structure

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@176280 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2005-01-02 11:50:33 +00:00
parent 0dd7f55a53
commit d82a016858
4 changed files with 191 additions and 104 deletions

View file

@ -1,34 +1,59 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/crack.xml, last change in rev 1.1 -->
<refentry id="function.crack-check">
<refnamediv>
<refname>crack_check</refname>
<refpurpose>Performs an obscure check with the given password</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>crack_check</methodname>
<methodparam><type>resource</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>crack_check</methodname>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Returns &true; if <parameter>password</parameter> is strong, or &false; otherwise.
</para>
&warn.experimental.func;
<para>
<function>crack_check</function> performs an obscure check with the given
<parameter>password</parameter> on the specified <parameter>dictionary
</parameter>. If <parameter>dictionary</parameter> is not specified,
the last opened dictionary is used.
</para>
</refsect1>
</refentry>
<refentry id="function.crack-check">
<refnamediv>
<refname>crack_check</refname>
<refpurpose>Performs an obscure check with the given password</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>crack_check</methodname>
<methodparam><type>resource</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>crack_check</methodname>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Performs an obscure check with the given password on the specified
dictionary.
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dictionary</parameter></term>
<listitem>
<para>
The crack lib dictionary. If not specified, the last opened dictionary
is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The tested password.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if <parameter>password</parameter> is strong, or &false; otherwise.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,29 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/crack.xml, last change in rev 1.1 -->
<refentry id="function.crack-closedict">
<refnamediv>
<refname>crack_closedict</refname>
<refpurpose>Closes an open CrackLib dictionary </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>crack_closedict</methodname>
<methodparam choice="opt"><type>resource</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
</para>
&warn.experimental.func;
<para>
<function>crack_closedict</function> closes the specified
<parameter>dictionary</parameter> identifier. If
<parameter>dictionary</parameter> is not specified, the current
dictionary is closed.
</para>
</refsect1>
</refentry>
<refentry id="function.crack-closedict">
<refnamediv>
<refname>crack_closedict</refname>
<refpurpose>Closes an open CrackLib dictionary </refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>crack_closedict</methodname>
<methodparam choice="opt"><type>resource</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
<function>crack_closedict</function> closes the specified
<parameter>dictionary</parameter> identifier.
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dictionary</parameter></term>
<listitem>
<para>
The dictionary to close. If not specified, the current directory is
closed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>crack_opendict</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,24 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/crack.xml, last change in rev 1.1 -->
<refentry id="function.crack-getlastmessage">
<refnamediv>
<refname>crack_getlastmessage</refname>
<refpurpose>Returns the message from the last obscure check</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>crack_getlastmessage</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>crack_getlastmessage</function> returns the message from the
last obscure check.
</para>
</refsect1>
</refentry>
<refentry id="function.crack-getlastmessage">
<refnamediv>
<refname>crack_getlastmessage</refname>
<refpurpose>Returns the message from the last obscure check</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>crack_getlastmessage</methodname>
<void/>
</methodsynopsis>
<para>
<function>crack_getlastmessage</function> returns the message from the
last obscure check.
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The message from the last obscure check.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>crack_check</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,37 +1,60 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/crack.xml, last change in rev 1.1 -->
<refentry id="function.crack-opendict">
<refnamediv>
<refname>crack_opendict</refname>
<refpurpose>Opens a new CrackLib dictionary</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>crack_opendict</methodname>
<methodparam><type>string</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
Returns a dictionary resource identifier on success, or &false; on failure.
</para>
&warn.experimental.func;
<para>
<function>crack_opendict</function> opens the specified CrackLib
<parameter>dictionary</parameter> for use with
<function>crack_check</function>.
</para>
<note>
<para>
Only one dictionary may be open at a time.
</para>
</note>
<para>
See also: <function>crack_check</function>, and
<function>crack_closedict</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.crack-opendict">
<refnamediv>
<refname>crack_opendict</refname>
<refpurpose>Opens a new CrackLib dictionary</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>crack_opendict</methodname>
<methodparam><type>string</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
<function>crack_opendict</function> opens the specified CrackLib
<parameter>dictionary</parameter> for use with
<function>crack_check</function>.
</para>
&warn.experimental.func;
<note>
<para>
Only one dictionary may be open at a time.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dictionary</parameter></term>
<listitem>
<para>
The path to the Cracklib dictionary.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a dictionary resource identifier on success, or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>crack_check</function></member>
<member><function>crack_closedict</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: