mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
MFB: Upgrade to the new-reference-structure
- Moved the intro from reference.xml to book.xml
- Change the intro ID to intro.<extname>
- Moved example into its own chapter
- Moved the installation, requirement, resources & config sections to setup.xml
- Added constants appendix
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248271 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson
parent
7fdee82b2a
commit
b995dd0dda
6 changed files with 206 additions and 87 deletions
54
reference/crack/book.xml
Normal file
54
reference/crack/book.xml
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- Purpose: mathcrypto.crypto -->
|
||||
<!-- Membership: pecl, external -->
|
||||
|
||||
<book xml:id="book.crack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<title>Crack</title>
|
||||
|
||||
<!-- {{{ preface -->
|
||||
<preface xml:id="intro.crack">
|
||||
&reftitle.intro;
|
||||
<para>
|
||||
These functions allow you to use the CrackLib library to test the
|
||||
'strength' of a password. The 'strength' of a password is tested by that
|
||||
checks length, use of upper and lower case and checked against the
|
||||
specified CrackLib dictionary. CrackLib will also give helpful diagnostic
|
||||
messages that will help 'strengthen' the password.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
&pecl.moved-ver;5.0.0.
|
||||
</para>
|
||||
</note>
|
||||
</preface>
|
||||
<!-- }}} -->
|
||||
|
||||
&reference.crack.setup;
|
||||
&reference.crack.constants;
|
||||
&reference.crack.examples;
|
||||
&reference.crack.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
|
||||
-->
|
||||
|
||||
29
reference/crack/constants.xml
Normal file
29
reference/crack/constants.xml
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
|
||||
<appendix xml:id="crack.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
|
||||
-->
|
||||
|
||||
60
reference/crack/examples.xml
Normal file
60
reference/crack/examples.xml
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
|
||||
<appendix xml:id="crack.examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
This example shows how to open a CrackLib dictionary, test a given
|
||||
password, retrieve any diagnostic messages, and close the dictionary.
|
||||
<example>
|
||||
<title>CrackLib example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
// Open CrackLib Dictionary
|
||||
$dictionary = crack_opendict('/usr/local/lib/pw_dict')
|
||||
or die('Unable to open CrackLib dictionary');
|
||||
|
||||
// Perform password check
|
||||
$check = crack_check($dictionary, 'gx9A2s0x');
|
||||
|
||||
// Retrieve messages
|
||||
$diag = crack_getlastmessage();
|
||||
echo $diag; // 'strong password'
|
||||
|
||||
// Close dictionary
|
||||
crack_closedict($dictionary);
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
If <function>crack_check</function> returns &true;,
|
||||
<function>crack_getlastmessage</function> will return 'strong password'.
|
||||
</para>
|
||||
</note>
|
||||
</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
|
||||
-->
|
||||
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<section xml:id="crack.configuration" xmlns="http://docbook.org/ns/docbook">
|
||||
&reftitle.runtime;
|
||||
&extension.runtime;
|
||||
|
|
|
|||
|
|
@ -1,94 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.14 $ -->
|
||||
<!-- Purpose: mathcrypto.crypto -->
|
||||
<!-- Membership: pecl, external -->
|
||||
<!-- $Revision: 1.15 $ -->
|
||||
|
||||
<reference xml:id="ref.crack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<title>Crack Functions</title>
|
||||
<titleabbrev>Crack</titleabbrev>
|
||||
<reference xml:id="ref.crack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<title>Crack &Functions;</title>
|
||||
|
||||
<partintro>
|
||||
<section xml:id="crack.intro">
|
||||
&reftitle.intro;
|
||||
<para>
|
||||
These functions allow you to use the CrackLib library to test the
|
||||
'strength' of a password. The 'strength' of a password is tested by that
|
||||
checks length, use of upper and lower case and checked against the
|
||||
specified CrackLib dictionary. CrackLib will also give helpful diagnostic
|
||||
messages that will help 'strengthen' the password.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
&pecl.moved-ver;5.0.0.
|
||||
</para>
|
||||
</note>
|
||||
</section>
|
||||
&reference.crack.entities.functions;
|
||||
|
||||
<section xml:id="crack.requirements">
|
||||
&reftitle.required;
|
||||
<para>
|
||||
More information regarding CrackLib along with the library can be found at
|
||||
<link xlink:href="&url.crack;">&url.crack;</link>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
&reference.crack.configure;
|
||||
</reference>
|
||||
|
||||
&reference.crack.ini;
|
||||
|
||||
<section xml:id="crack.resources">
|
||||
&reftitle.resources;
|
||||
<para>
|
||||
The CrackLib extension defines a dictionary resource identifier returned
|
||||
by <function>crack_opendict</function>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section xml:id="crack.constants">
|
||||
&reftitle.constants;
|
||||
&no.constants;
|
||||
</section>
|
||||
|
||||
<section xml:id="crack.examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
This example shows how to open a CrackLib dictionary, test a given
|
||||
password, retrieve any diagnostic messages, and close the dictionary.
|
||||
<example>
|
||||
<title>CrackLib example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
// Open CrackLib Dictionary
|
||||
$dictionary = crack_opendict('/usr/local/lib/pw_dict')
|
||||
or die('Unable to open CrackLib dictionary');
|
||||
|
||||
// Perform password check
|
||||
$check = crack_check($dictionary, 'gx9A2s0x');
|
||||
|
||||
// Retrieve messages
|
||||
$diag = crack_getlastmessage();
|
||||
echo $diag; // 'strong password'
|
||||
|
||||
// Close dictionary
|
||||
crack_closedict($dictionary);
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
If <function>crack_check</function> returns &true;,
|
||||
<function>crack_getlastmessage</function> will return 'strong password'.
|
||||
</para>
|
||||
</note>
|
||||
</section>
|
||||
</partintro>
|
||||
|
||||
&reference.crack.entities.functions;
|
||||
|
||||
</reference>
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
57
reference/crack/setup.xml
Normal file
57
reference/crack/setup.xml
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
|
||||
<chapter xml:id="crack.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
&reftitle.setup;
|
||||
|
||||
<!-- {{{ Requirements -->
|
||||
<section xml:id="crack.requirements">
|
||||
&reftitle.required;
|
||||
<para>
|
||||
More information regarding CrackLib along with the library can be found at
|
||||
<link xlink:href="&url.crack;">&url.crack;</link>.
|
||||
</para>
|
||||
</section>
|
||||
<!-- }}} -->
|
||||
|
||||
<!-- {{{ Installation -->
|
||||
&reference.crack.configure;
|
||||
<!-- }}} -->
|
||||
|
||||
<!-- {{{ Configuration -->
|
||||
&reference.crack.ini;
|
||||
<!-- }}} -->
|
||||
|
||||
<!-- {{{ Resources -->
|
||||
<section xml:id="crack.resources">
|
||||
&reftitle.resources;
|
||||
<para>
|
||||
The CrackLib extension defines a dictionary resource identifier returned
|
||||
by <function>crack_opendict</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
|
||||
-->
|
||||
|
||||
Loading…
Reference in a new issue