Initial documentation for crack

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@66671 c90b9560-bf6c-de11-be94-00142212c4b1

functions/crack.xml

@@ -1,12 +1,20 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
  <reference id="ref.crack">
   <title>Crack functions</title>
   <titleabbrev>Crack functions</titleabbrev>
 
   <partintro>
-   <para>
-   </para>
+   <simpara>
+    These functions allow you to use the CrackLib library to test the 'strength'
+    of a password.  In order to use these functions, you must compile PHP with
+    Crack support by using the <option role="configure">--with-crack</option>
+    option.
+   </simpara>
+   <simpara>
+    More information regarding CrackLib along with the library can be found at
+    <ulink url="&url.crack;">&url.crack;</ulink>.
+   </simpara>
   </partintro>
 
 
@@ -19,13 +27,27 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
-      <funcdef>string <function>crack_opendict</function></funcdef>
+      <funcdef>resource <function>crack_opendict</function></funcdef>
        <paramdef>string <parameter>dictionary</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
+    <para> 
+     Returns a dictionary resource identifier on success, or &false; on failure.
+    </para>
      &warn.experimental.func;
     <para>
-     &warn.undocumented.func;
+     <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>
@@ -39,15 +61,21 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
-      <funcdef>string <function>crack_closedict</function></funcdef>
-      <paramdef>int
-       <parameter><optional>link_identifier</optional></parameter>
+      <funcdef>bool <function>crack_closedict</function></funcdef>
+      <paramdef>resource
+       <parameter><optional>dictionary</optional></parameter>
       </paramdef>
      </funcprototype>
     </funcsynopsis>
+    <para>
+     &return.success;
+    </para>
      &warn.experimental.func;
     <para>
-     &warn.undocumented.func;
+     <function>crack_closedict</function> closes the dictionary that is
+     associated with the specified <parameter>link_identifier</parameter>.
+     If <parameter>link_identifier</parameter> is not specified, the current
+     dictionary is closed.
     </para>
    </refsect1>
   </refentry>
@@ -62,7 +90,7 @@
     <funcsynopsis>
      <funcprototype>
       <funcdef>string <function>crack_check</function></funcdef>
-      <paramdef>int
+      <paramdef>resource
        <parameter><optional>dictionary</optional></parameter>
       </paramdef>
       <paramdef>string <parameter>password</parameter></paramdef>
@@ -70,7 +98,10 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     &warn.undocumented.func;
+     <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>
@@ -90,7 +121,8 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     &warn.undocumented.func;
+     <function>crack_getlastmessage</function> returns the message from the
+     last obscure check.
     </para>
    </refsect1>
   </refentry>
@@ -116,5 +148,4 @@
  vim600: syn=xml fen fdm=syntax fdl=2 si
  vim: et tw=78 syn=sgml
  vi: ts=1 sw=1
- -->
-
+ -->