From: Zhanna Tsitkov Date: Mon, 16 Jul 2012 19:15:52 +0000 (-0400) Subject: Document references to date-time formats X-Git-Tag: krb5-1.11-alpha1~397 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0168656dd60798af399ff0bc0376e34b1a2855c5;p=thirdparty%2Fkrb5.git Document references to date-time formats --- diff --git a/doc/rst_source/krb_admins/conf_files/kdc_conf.rst b/doc/rst_source/krb_admins/conf_files/kdc_conf.rst index bcb5e7c248..596c395f3d 100644 --- a/doc/rst_source/krb_admins/conf_files/kdc_conf.rst +++ b/doc/rst_source/krb_admins/conf_files/kdc_conf.rst @@ -87,7 +87,7 @@ subsection: |kdcdir|\ ``/principal``. **default_principal_expiration** - (Absolute time string.) Specifies the default expiration date of + (:ref:`abstime` string.) Specifies the default expiration date of principals created in this realm. The default value is 0, which means no expiration date. @@ -253,14 +253,14 @@ subsection: values, see :ref:`Encryption_and_salt_types`. **max_life** - (Delta time string.) Specifies the maximum time period for which - a ticket may be valid in this realm. The default value is 24 - hours. + (:ref:`duration` string.) Specifies the maximum time period for + which a ticket may be valid in this realm. The default value is + 24 hours. **max_renewable_life** - (Delta time string.) Specifies the maximum time period during - which a valid ticket may be renewed in this realm. The default - value is 0. + (:ref:`duration` string.) Specifies the maximum time period + during which a valid ticket may be renewed in this realm. + The default value is 0. **no_host_referral** (Whitespace- or comma-separated list.) Lists services to block diff --git a/doc/rst_source/krb_admins/conf_files/krb5_conf.rst b/doc/rst_source/krb_admins/conf_files/krb5_conf.rst index e37581211e..b595a6dce8 100644 --- a/doc/rst_source/krb_admins/conf_files/krb5_conf.rst +++ b/doc/rst_source/krb_admins/conf_files/krb5_conf.rst @@ -296,8 +296,8 @@ The libdefaults section may contain any of the following relations: set. The default is not to search domain components. **renew_lifetime** - Sets the default renewable lifetime for initial ticket requests. - The default value is 0. + (:ref:`duration` string.) Sets the default renewable lifetime + for initial ticket requests. The default value is 0. **safe_checksum_type** An integer which specifies the type of checksum to use for the @@ -309,8 +309,8 @@ The libdefaults section may contain any of the following relations: configuration option for the possible values and their meanings. **ticket_lifetime** - Sets the default lifetime for initial ticket requests. The - default value is 1 day. + (:ref:`duration` string.) Sets the default lifetime for initial + ticket requests. The default value is 1 day. **udp_preference_limit** When sending a message to the KDC, the library will try using TCP diff --git a/doc/rst_source/krb_basic/date_format.rst b/doc/rst_source/krb_basic/date_format.rst index a19810dabc..d2ab7b9820 100644 --- a/doc/rst_source/krb_basic/date_format.rst +++ b/doc/rst_source/krb_basic/date_format.rst @@ -1,12 +1,12 @@ .. _datetime: -Supported date and time formats. -================================ +Supported date and time formats +=============================== .. _duration: -Duration ("deltat") -------------------- +Time duration +------------- This format is used to express a time duration in the Kerberos configuration files and user commands. The allowed formats are: @@ -100,9 +100,9 @@ following ways: +------------------------+----------------------+ | | dd-month-yyyy:hh:mm:ss | 31-Dec-2014:23:59:00 | | +------------------------+----------------------+--------------+ - | hh:mm:ss | 20:30:00 | 8 o'clock in | + | hh:mm:ss | 20:00:00 | 8 o'clock in | +------------------------+----------------------+ the evening | - | hhmmss | 203000 | | + | hhmmss | 200000 | | +------------------------+----------------------+--------------+ (See :ref:`abbreviation`.) diff --git a/doc/rst_source/krb_users/user_commands/kinit.rst b/doc/rst_source/krb_users/user_commands/kinit.rst index 783bd77699..3636106fc5 100644 --- a/doc/rst_source/krb_users/user_commands/kinit.rst +++ b/doc/rst_source/krb_users/user_commands/kinit.rst @@ -42,23 +42,8 @@ OPTIONS display verbose output. **-l** *lifetime* - requests a ticket with the lifetime *lifetime*. The valid formats - for *lifetime* are: - - :: - - h:m:s - NdNhNmNs - - where - - :: - - s seconds - m minutes - h hours - d days - N number + (:ref:`duration` string.) Requests a ticket with the lifetime + *lifetime*. For example, ``kinit -l 5:30`` or ``kinit -l 5h30m``. @@ -68,17 +53,16 @@ OPTIONS will not override the configured maximum ticket lifetime. **-s** *start_time* - requests a postdated ticket. Postdated tickets are issued with the - **invalid** flag set, and need to be resubmitted to the KDC for - validation before use. + (:ref:`duration` string.) Requests a postdated ticket. Postdated + tickets are issued with the **invalid** flag set, and need to be + resubmitted to the KDC for validation before use. *start_time* specifies the duration of the delay before the ticket - can become valid using the same time format as the **-l** option. + can become valid. **-r** *renewable_life* - requests renewable tickets, with a total lifetime of - *renewable_life*. The duration is in the same format as the - **-l** option. + (:ref:`duration` string.) Requests renewable tickets, with a total + lifetime of *renewable_life*. **-f** requests forwardable tickets. diff --git a/doc/rst_source/krb_users/user_commands/ksu.rst b/doc/rst_source/krb_users/user_commands/ksu.rst index 5c548d1413..aa22c18a3c 100644 --- a/doc/rst_source/krb_users/user_commands/ksu.rst +++ b/doc/rst_source/krb_users/user_commands/ksu.rst @@ -259,29 +259,14 @@ Ticket granting ticket options: when getting a ticket granting ticket from the Kerberos server. **-l** *lifetime* - specifies the lifetime to be requested for the ticket; if this - option is not specified, the default ticket lifetime (12 hours) - is used instead. The valid formats for *lifetime* are: - - :: - - h:m:s - NdNhNmNs - - where - - :: - - s seconds - m minutes - h hours - d days - N number + (:ref:`duration` string.) Specifies the lifetime to be requested + for the ticket; if this option is not specified, the default ticket + lifetime (12 hours) is used instead. **-r** *time* - specifies that the **renewable** option should be requested for - the ticket, and specifies the desired total lifetime of the - ticket using the same time format as the **-l** option. + (:ref:`duration` string.) Specifies that the **renewable** option + should be requested for the ticket, and specifies the desired + total lifetime of the ticket. **-p** specifies that the **proxiable** option should be requested for