krb5 commit: Clarify date-time format in admin documentation
Zhanna A Tsitkova
tsitkova at MIT.EDU
Fri Jul 13 16:07:25 EDT 2012
https://github.com/krb5/krb5/commit/53c75eba43600bcb3f75ac4d20ba3c9f9155039d
commit 53c75eba43600bcb3f75ac4d20ba3c9f9155039d
Author: Zhanna Tsitkov <tsitkova at mit.edu>
Date: Fri Jul 13 16:09:39 2012 -0400
Clarify date-time format in admin documentation
.../krb_admins/admin_commands/kadmin_local.rst | 82 ++++----------------
.../krb_admins/admin_commands/kdb5_ldap_util.rst | 20 +++--
.../krb_admins/admin_commands/kdb5_util.rst | 3 +-
doc/rst_source/krb_admins/database.rst | 10 +--
4 files changed, 29 insertions(+), 86 deletions(-)
diff --git a/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst b/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
index c8a08eb..8e55b3f 100644
--- a/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
+++ b/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
@@ -161,60 +161,6 @@ OPTIONS
.. _kadmin_options_end:
-.. _date_format:
-
-DATE FORMAT
------------
-
-.. _date_format_start:
-
-Many of the kadmin commands take a duration or time as an
-argument. The date can appear in a wide variety of formats, such as:
-
- ::
-
- 1 month ago
- 2 hours ago
- 400000 seconds ago
- last year
- this Monday
- next Monday
- yesterday
- tomorrow
- now
- second Monday
- fortnight ago
- 3/31/92 10:00:07 PST
- January 23, 1987 10:05pm
- 22:00 GMT
-
-Dates which do not have the "ago" specifier default to being absolute
-dates, unless they appear in a field where a duration is expected. In
-that case the time specifier will be interpreted as relative.
-Specifying "ago" in a duration may result in unexpected behavior.
-
-The following is a list of all of the allowable keywords.
-
-========== ==========================================================
-Months january, jan, february, feb, march, mar, april, apr, may,
- june, jun, july, jul, august, aug, september, sep, sept,
- october, oct, november, nov, december, dec
-Days sunday, sun, monday, mon, tuesday, tues, tue, wednesday,
- wednes, wed, thursday, thurs, thur, thu, friday, fri,
- saturday, sat
-Units year, month, fortnight, week, day, hour, minute, min,
- second, sec
-Relative tomorrow, yesterday, today, now, last, this, next, first,
- second, third, fourth, fifth, sixth, seventh, eighth,
- ninth, tenth, eleventh, twelfth, ago
-Time Zones kadmin recognizes abbreviations for most of the world's
- time zones.
-Meridians am, pm
-========== ==========================================================
-
-.. _date_format_end:
-
-
COMMANDS
--------
@@ -243,16 +189,16 @@ Aliases: **addprinc**, **ank**
Options:
**-expire** *expdate*
- expiration date of the principal
+ (:ref:`getdate` string) expiration date of the principal
**-pwexpire** *pwexpdate*
- password expiration date
+ (:ref:`getdate` string) password expiration date
**-maxlife** *maxlife*
- maximum ticket life for the principal
+ (:ref:`getdate` string) maximum ticket life for the principal
**-maxrenewlife** *maxrenewlife*
- maximum renewable life of tickets for the principal
+ (:ref:`getdate` string) maximum renewable life of tickets for the principal
**-kvno** *kvno*
initial key version number
@@ -646,10 +592,10 @@ Alias: **addpol**
The following options are available:
**-maxlife** *time*
- sets the maximum lifetime of a password
+ (:ref:`getdate` string) sets the maximum lifetime of a password
**-minlife** *time*
- sets the minimum lifetime of a password
+ (:ref:`getdate` string) sets the minimum lifetime of a password
**-minlength** *length*
sets the minimum length of a password
@@ -669,16 +615,16 @@ The following options are available:
principals which require preauthentication.
**-failurecountinterval** *failuretime*
- sets the allowable time between authentication failures. If an
- authentication failure happens after *failuretime* has elapsed
- since the previous failure, the number of authentication failures
- is reset to 1.
+ (:ref:`getdate` string) sets the allowable time between
+ authentication failures. If an authentication failure happens
+ after *failuretime* has elapsed since the previous failure,
+ the number of authentication failures is reset to 1.
**-lockoutduration** *lockouttime*
- sets the duration for which the principal is locked from
- authenticating if too many authentication failures occur without
- the specified failure count interval elapsing. A duration of 0
- means forever.
+ (:ref:`getdate` string) sets the duration for which the principal
+ is locked from authenticating if too many authentication failures
+ occur without the specified failure count interval elapsing.
+ A duration of 0 means forever.
Example:
diff --git a/doc/rst_source/krb_admins/admin_commands/kdb5_ldap_util.rst b/doc/rst_source/krb_admins/admin_commands/kdb5_ldap_util.rst
index 2ff1a04..ce39110 100644
--- a/doc/rst_source/krb_admins/admin_commands/kdb5_ldap_util.rst
+++ b/doc/rst_source/krb_admins/admin_commands/kdb5_ldap_util.rst
@@ -112,11 +112,12 @@ Creates realm in directory. Options:
Specifies that the stash file is to be created.
**-maxtktlife** *max_ticket_life*
- Specifies maximum ticket life for principals in this realm.
+ (:ref:`getdate` string) Specifies maximum ticket life for
+ principals in this realm.
**-maxrenewlife** *max_renewable_ticket_life*
- Specifies maximum renewable life of tickets for principals in this
- realm.
+ (:ref:`getdate` string) Specifies maximum renewable life of
+ tickets for principals in this realm.
*ticket_flags*
Specifies global ticket flags for the realm. Allowable flags are
@@ -174,11 +175,12 @@ Modifies the attributes of a realm. Options:
Specifies the Kerberos realm of the database.
**-maxtktlife** *max_ticket_life*
- Specifies maximum ticket life for principals in this realm.
+ (:ref:`getdate` string) Specifies maximum ticket life for
+ principals in this realm.
**-maxrenewlife** *max_renewable_ticket_life*
- Specifies maximum renewable life of tickets for principals in this
- realm.
+ (:ref:`getdate` string) Specifies maximum renewable life of
+ tickets for principals in this realm.
*ticket_flags*
Specifies global ticket flags for the realm. Allowable flags are
@@ -328,10 +330,12 @@ Creates a ticket policy in the directory. Options:
Specifies the Kerberos realm of the database.
**-maxtktlife** *max_ticket_life*
- Specifies maximum ticket life for principals.
+ (:ref:`getdate` string) Specifies maximum ticket life for
+ principals.
**-maxrenewlife** *max_renewable_ticket_life*
- Specifies maximum renewable life of tickets for principals.
+ (:ref:`getdate` string) Specifies maximum renewable life of
+ tickets for principals.
*ticket_flags*
Specifies the ticket flags. If this option is not specified, by
diff --git a/doc/rst_source/krb_admins/admin_commands/kdb5_util.rst b/doc/rst_source/krb_admins/admin_commands/kdb5_util.rst
index e454a7c..3601b4d 100644
--- a/doc/rst_source/krb_admins/admin_commands/kdb5_util.rst
+++ b/doc/rst_source/krb_admins/admin_commands/kdb5_util.rst
@@ -281,8 +281,7 @@ Sets the activation time of the master key specified by *mkeyVNO*.
Once a master key becomes active, it will be used to encrypt newly
created principal keys. If no *time* argument is given, the current
time is used, causing the specified master key version to become
-active immediately. The format of *time* is specified in the
-:ref:`date_format` section of the :ref:`kadmin(1)` man page.
+active immediately. The format for *time* is :ref:`getdate` string.
After a new master key becomes active, the kdb5_util
**update_princ_encryption** command can be used to update all
diff --git a/doc/rst_source/krb_admins/database.rst b/doc/rst_source/krb_admins/database.rst
index 1b0defb..b92a99e 100644
--- a/doc/rst_source/krb_admins/database.rst
+++ b/doc/rst_source/krb_admins/database.rst
@@ -59,14 +59,8 @@ following options:
Date Format
-----------
-.. include:: admin_commands/kadmin_local.rst
- :start-after: _date_format_start:
- :end-before: _date_format_end:
-
-.. note:: If the date specification contains spaces, you must enclose
- it in double quotes. Note also that you cannot use a number
- without a unit. (I.e., ""60 seconds"" is correct, but "60"
- is incorrect.) All keywords are case-insensitive.
+For the supported date-time formats see :ref:`getdate` section
+in :ref:`datetime`.
Principals
More information about the cvs-krb5
mailing list