Skip to content

Commit

Permalink
Document references to date-time formats
Browse files Browse the repository at this point in the history
  • Loading branch information
tsitkov committed Jul 16, 2012
1 parent 7801fcf commit 0168656
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 62 deletions.
14 changes: 7 additions & 7 deletions doc/rst_source/krb_admins/conf_files/kdc_conf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions doc/rst_source/krb_admins/conf_files/krb5_conf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
12 changes: 6 additions & 6 deletions doc/rst_source/krb_basic/date_format.rst
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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`.)
Expand Down
32 changes: 8 additions & 24 deletions doc/rst_source/krb_users/user_commands/kinit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``.

Expand All @@ -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.
Expand Down
27 changes: 6 additions & 21 deletions doc/rst_source/krb_users/user_commands/ksu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0168656

Please sign in to comment.