cvs: phpdoc /en/reference/kadm5/functions kadm5-chpass-principal.xml kadm5-create-principal.xml kadm5-delete-principal.xml kadm5-destroy.xml
kadm5-flush.xml kadm5-get-policies.xml kadm5-get-principal.xml kadm5-get-principals.xml kadm5-init-with-password.xml kadm5-modify-principal.xml
| From: | Mehdi Achour | Date: | Sun, 30 Dec 2007 14:28:36 +0000 |
| Subject: | cvs: phpdoc /en/reference/kadm5/functions kadm5-chpass-principal.xml kadm5-create-principal.xml kadm5-delete-principal.xml kadm5-destroy.xml kadm5-flush.xml kadm5-get-policies.xml kadm5-get-principal.xml kadm5-get-principals.xml kadm5-init-with-password.xml kadm5-modify-principal.xml |
||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-938@lists.php.net to get a copy of this message | ||
didou Sun Dec 30 14:28:36 2007 UTC
Modified files:
/phpdoc/en/reference/kadm5/functions kadm5-chpass-principal.xml
kadm5-create-principal.xml
kadm5-delete-principal.xml
kadm5-destroy.xml
kadm5-flush.xml
kadm5-get-policies.xml
kadm5-get-principal.xml
kadm5-get-principals.xml
kadm5-init-with-password.xml
kadm5-modify-principal.xml
Log:
Add missing refsect1
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> <refentry xml:id="function.kadm5-chpass-principal" xmlns="http://docbook.org/ns/docbook"> <refnamediv> @@ -21,6 +21,38 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The new password. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.kadm5-create-principal" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_create_principal</refname> @@ -17,17 +16,58 @@ <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_create_principal</function> creates a - <parameter>principal</parameter> with the given - <parameter>password</parameter>. If <parameter>password</parameter> - is omitted or is &null;, a random key will be generated. + Creates a <parameter>principal</parameter> with the given + <parameter>password</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - It is possible to specify several optional parameters within the - array <parameter>options</parameter>. Allowed are the following options: - KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, - KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY, KADM5_CLEARPOLICY, - KADM5_MAX_RLIFE. + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + If <parameter>password</parameter> is omitted or is &null;, a random + key will be generated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + It is possible to specify several optional parameters within the + array <parameter>options</parameter>. Allowed are the following options: + <constant>KADM5_PRINC_EXPIRE_TIME</constant>, + <constant>KADM5_PW_EXPIRATION</constant>, + <constant>KADM5_ATTRIBUTES</constant>, + <constant>KADM5_MAX_LIFE</constant>, + <constant>KADM5_KVNO</constant>, + <constant>KADM5_POLICY</constant>, + <constant>KADM5_CLEARPOLICY</constant>, + <constant>KADM5_MAX_RLIFE</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -63,6 +103,17 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_modify_principal</function></member> + <member><function>kadm5_delete_principal</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml:1.4 phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml:1.5 --- phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml:1.4 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.kadm5-delete-principal" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_delete_principal</refname> @@ -15,8 +14,31 @@ <methodparam><type>string</type><parameter>principal</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_delete_principal</function> remove the - <parameter>principal</parameter> from the Kerberos database. + Removes the <parameter>principal</parameter> from the Kerberos database. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The removed principal. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -47,6 +69,17 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_modify_principal</function></member> + <member><function>kadm5_create_principal</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.kadm5-destroy" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_destroy</refname> @@ -13,6 +12,26 @@ <type>bool</type><methodname>kadm5_destroy</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> </methodsynopsis> + <para> + Closes the connection to the admin server and releases all related + resources. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> @@ -21,6 +40,16 @@ &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_init_with_password</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-flush.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-flush.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-flush.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-flush.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-flush.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-flush.xml Sun Dec 30 14:28:35 2007 @@ -1,12 +1,10 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.kadm5-flush" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_flush</refname> - <refpurpose>Flush all changes to the Kerberos database, leaving the connection - to the Kerberos admin server open</refpurpose> - </refnamediv> + <refpurpose>Flush all changes to the Kerberos database</refpurpose> + </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -14,6 +12,26 @@ <type>bool</type><methodname>kadm5_flush</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> </methodsynopsis> + <para> + Flush all changes to the Kerberos database, leaving the connection to the + Kerberos admin server open. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml:1.6 phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml:1.7 --- phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml:1.6 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.kadm5-get-policies" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_get_policies</refname> @@ -14,8 +13,23 @@ <methodparam><type>resource</type><parameter>handle</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_get_policies</function> returns an array containing the - policies's names. + Gets an array containing the policies's names. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml:1.5 phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml:1.6 --- phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml:1.5 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.kadm5-get-principal" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_get_principal</refname> @@ -15,18 +14,42 @@ <methodparam><type>string</type><parameter>principal</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_get_principal</function> returns an associative array - containing the following keys: KADM5_PRINCIPAL, KADM5_PRINC_EXPIRE_TIME, - KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, KADM5_MAX_LIFE, KADM5_MOD_NAME, - KADM5_MOD_TIME, KADM5_KVNO, KADM5_POLICY, KADM5_MAX_RLIFE, - KADM5_LAST_SUCCESS, KADM5_LAST_FAILED, KADM5_FAIL_AUTH_COUNT. + Gets the principal's entries from the Kerberos database. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns array of options on success, or &false; on failure. + Returns array of options containing the following keys: KADM5_PRINCIPAL, + KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, + KADM5_MAX_LIFE, KADM5_MOD_NAME, KADM5_MOD_TIME, KADM5_KVNO, KADM5_POLICY, + KADM5_MAX_RLIFE, KADM5_LAST_SUCCESS, KADM5_LAST_FAILED, + KADM5_FAIL_AUTH_COUNT on success, or &false; on failure. </para> </refsect1> @@ -55,6 +78,16 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_get_principals</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml:1.6 phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml:1.7 --- phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml:1.6 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.kadm5-get-principals" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_get_principals</refname> @@ -19,6 +18,22 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -48,6 +63,16 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_get_principal</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml Sun Dec 30 14:28:35 2007 @@ -1,11 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.kadm5-init-with-password" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_init_with_password</refname> - <refpurpose>Opens a connection to the KADM5 library and initializes any - neccessary state information</refpurpose> + <refpurpose>Opens a connection to the KADM5 library</refpurpose> </refnamediv> <refsect1 role="description"> @@ -18,12 +16,51 @@ <methodparam><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_init_with_password</function> opens a connection with the - KADM5 library using the <parameter>principal</parameter> and the given + Opens a connection with the KADM5 library using the + <parameter>principal</parameter> and the given <parameter>password</parameter> to obtain initial credentials from the - <parameter>admin_server</parameter>. The parameter - <parameter>realm</parameter> defines the authentication domain for the - connection. + <parameter>admin_server</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>admin_server</parameter></term> + <listitem> + <para> + The server. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>realm</parameter></term> + <listitem> + <para> + Defines the authentication domain for the connection. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + If <parameter>password</parameter> is omitted or is &null;, a random + key will be generated. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -78,6 +115,7 @@ </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml:1.5 phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml:1.6 --- phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml:1.5 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,11 +1,10 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> - <refentry xml:id="function.kadm5-modify-principal" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>kadm5_modify_principal</refname> - <refpurpose>Modifies a kerberos principal with the given parameters</refpurpose> - </refnamediv> +<!-- $Revision: 1.6 $ --> +<refentry xml:id="function.kadm5-modify-principal" xmlns="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>kadm5_modify_principal</refname> + <refpurpose>Modifies a kerberos principal with the given parameters</refpurpose> + </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -16,12 +15,50 @@ <methodparam><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_modify_principal</function> - modifies a <parameter>principal</parameter> according to the given - <parameter>options</parameter>. Allowed are the following options: - KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, - KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY, KADM5_CLEARPOLICY, - KADM5_MAX_RLIFE, KADM5_FAIL_AUTH_COUNT. + Modifies a <parameter>principal</parameter> according to the given + <parameter>options</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + It is possible to specify several optional parameters within the + array <parameter>options</parameter>. Allowed are the following options: + <constant>KADM5_PRINC_EXPIRE_TIME</constant>, + <constant>KADM5_PW_EXPIRATION</constant>, + <constant>KADM5_ATTRIBUTES</constant>, + <constant>KADM5_MAX_LIFE</constant>, + <constant>KADM5_KVNO</constant>, + <constant>KADM5_POLICY</constant>, + <constant>KADM5_CLEARPOLICY</constant>, + <constant>KADM5_MAX_RLIFE</constant>. + <constant>KADM5_FAIL_AUTH_COUNT</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -58,6 +95,16 @@ </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_create_principal</function></member> + <member><function>kadm5_delete_principal</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> <refentry xml:id="function.kadm5-chpass-principal" xmlns="http://docbook.org/ns/docbook"> <refnamediv> @@ -21,6 +21,38 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The new password. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.kadm5-create-principal" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_create_principal</refname> @@ -17,17 +16,58 @@ <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_create_principal</function> creates a - <parameter>principal</parameter> with the given - <parameter>password</parameter>. If <parameter>password</parameter> - is omitted or is &null;, a random key will be generated. + Creates a <parameter>principal</parameter> with the given + <parameter>password</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - It is possible to specify several optional parameters within the - array <parameter>options</parameter>. Allowed are the following options: - KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, - KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY, KADM5_CLEARPOLICY, - KADM5_MAX_RLIFE. + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + If <parameter>password</parameter> is omitted or is &null;, a random + key will be generated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + It is possible to specify several optional parameters within the + array <parameter>options</parameter>. Allowed are the following options: + <constant>KADM5_PRINC_EXPIRE_TIME</constant>, + <constant>KADM5_PW_EXPIRATION</constant>, + <constant>KADM5_ATTRIBUTES</constant>, + <constant>KADM5_MAX_LIFE</constant>, + <constant>KADM5_KVNO</constant>, + <constant>KADM5_POLICY</constant>, + <constant>KADM5_CLEARPOLICY</constant>, + <constant>KADM5_MAX_RLIFE</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -63,6 +103,17 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_modify_principal</function></member> + <member><function>kadm5_delete_principal</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml:1.4 phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml:1.5 --- phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml:1.4 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.kadm5-delete-principal" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_delete_principal</refname> @@ -15,8 +14,31 @@ <methodparam><type>string</type><parameter>principal</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_delete_principal</function> remove the - <parameter>principal</parameter> from the Kerberos database. + Removes the <parameter>principal</parameter> from the Kerberos database. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The removed principal. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -47,6 +69,17 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_modify_principal</function></member> + <member><function>kadm5_create_principal</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.kadm5-destroy" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_destroy</refname> @@ -13,6 +12,26 @@ <type>bool</type><methodname>kadm5_destroy</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> </methodsynopsis> + <para> + Closes the connection to the admin server and releases all related + resources. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> @@ -21,6 +40,16 @@ &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_init_with_password</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-flush.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-flush.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-flush.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-flush.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-flush.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-flush.xml Sun Dec 30 14:28:35 2007 @@ -1,12 +1,10 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.kadm5-flush" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_flush</refname> - <refpurpose>Flush all changes to the Kerberos database, leaving the connection - to the Kerberos admin server open</refpurpose> - </refnamediv> + <refpurpose>Flush all changes to the Kerberos database</refpurpose> + </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -14,6 +12,26 @@ <type>bool</type><methodname>kadm5_flush</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> </methodsynopsis> + <para> + Flush all changes to the Kerberos database, leaving the connection to the + Kerberos admin server open. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml:1.6 phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml:1.7 --- phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml:1.6 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.kadm5-get-policies" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_get_policies</refname> @@ -14,8 +13,23 @@ <methodparam><type>resource</type><parameter>handle</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_get_policies</function> returns an array containing the - policies's names. + Gets an array containing the policies's names. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml:1.5 phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml:1.6 --- phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml:1.5 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.kadm5-get-principal" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_get_principal</refname> @@ -15,18 +14,42 @@ <methodparam><type>string</type><parameter>principal</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_get_principal</function> returns an associative array - containing the following keys: KADM5_PRINCIPAL, KADM5_PRINC_EXPIRE_TIME, - KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, KADM5_MAX_LIFE, KADM5_MOD_NAME, - KADM5_MOD_TIME, KADM5_KVNO, KADM5_POLICY, KADM5_MAX_RLIFE, - KADM5_LAST_SUCCESS, KADM5_LAST_FAILED, KADM5_FAIL_AUTH_COUNT. + Gets the principal's entries from the Kerberos database. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns array of options on success, or &false; on failure. + Returns array of options containing the following keys: KADM5_PRINCIPAL, + KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, + KADM5_MAX_LIFE, KADM5_MOD_NAME, KADM5_MOD_TIME, KADM5_KVNO, KADM5_POLICY, + KADM5_MAX_RLIFE, KADM5_LAST_SUCCESS, KADM5_LAST_FAILED, + KADM5_FAIL_AUTH_COUNT on success, or &false; on failure. </para> </refsect1> @@ -55,6 +78,16 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_get_principals</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml:1.6 phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml:1.7 --- phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml:1.6 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml Sun Dec 30 14:28:35 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.kadm5-get-principals" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_get_principals</refname> @@ -19,6 +18,22 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -48,6 +63,16 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_get_principal</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml:1.3 phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml:1.4 --- phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml:1.3 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml Sun Dec 30 14:28:35 2007 @@ -1,11 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.kadm5-init-with-password" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>kadm5_init_with_password</refname> - <refpurpose>Opens a connection to the KADM5 library and initializes any - neccessary state information</refpurpose> + <refpurpose>Opens a connection to the KADM5 library</refpurpose> </refnamediv> <refsect1 role="description"> @@ -18,12 +16,51 @@ <methodparam><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_init_with_password</function> opens a connection with the - KADM5 library using the <parameter>principal</parameter> and the given + Opens a connection with the KADM5 library using the + <parameter>principal</parameter> and the given <parameter>password</parameter> to obtain initial credentials from the - <parameter>admin_server</parameter>. The parameter - <parameter>realm</parameter> defines the authentication domain for the - connection. + <parameter>admin_server</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>admin_server</parameter></term> + <listitem> + <para> + The server. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>realm</parameter></term> + <listitem> + <para> + Defines the authentication domain for the connection. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + If <parameter>password</parameter> is omitted or is &null;, a random + key will be generated. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -78,6 +115,7 @@ </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml diff -u phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml:1.5 phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml:1.6 --- phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml:1.5 Wed Jun 20 22:24:48 2007 +++ phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml Sun Dec 30 14:28:35 2007 @@ -1,11 +1,10 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 --> - <refentry xml:id="function.kadm5-modify-principal" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>kadm5_modify_principal</refname> - <refpurpose>Modifies a kerberos principal with the given parameters</refpurpose> - </refnamediv> +<!-- $Revision: 1.6 $ --> +<refentry xml:id="function.kadm5-modify-principal" xmlns="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>kadm5_modify_principal</refname> + <refpurpose>Modifies a kerberos principal with the given parameters</refpurpose> + </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -16,12 +15,50 @@ <methodparam><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - <function>kadm5_modify_principal</function> - modifies a <parameter>principal</parameter> according to the given - <parameter>options</parameter>. Allowed are the following options: - KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, - KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY, KADM5_CLEARPOLICY, - KADM5_MAX_RLIFE, KADM5_FAIL_AUTH_COUNT. + Modifies a <parameter>principal</parameter> according to the given + <parameter>options</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + A KADM5 handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>principal</parameter></term> + <listitem> + <para> + The principal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + It is possible to specify several optional parameters within the + array <parameter>options</parameter>. Allowed are the following options: + <constant>KADM5_PRINC_EXPIRE_TIME</constant>, + <constant>KADM5_PW_EXPIRATION</constant>, + <constant>KADM5_ATTRIBUTES</constant>, + <constant>KADM5_MAX_LIFE</constant>, + <constant>KADM5_KVNO</constant>, + <constant>KADM5_POLICY</constant>, + <constant>KADM5_CLEARPOLICY</constant>, + <constant>KADM5_MAX_RLIFE</constant>. + <constant>KADM5_FAIL_AUTH_COUNT</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> @@ -58,6 +95,16 @@ </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>kadm5_create_principal</function></member> + <member><function>kadm5_delete_principal</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file