From da0cb50a14a2376d99c4ef6b341482e72f208b7a Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 17 Jul 2012 13:08:30 +0000
Subject: [PATCH] Review comments from Bernhard Thalmayr
---
opendj-sdk/opendj3/src/main/docbkx/shared/man-dsconfig.xml | 18 ++++++++
opendj-sdk/opends/resource/man/man1/dsconfig.1 | 76 +++++++++++++++++++++++++++++++++++++-
opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-resource-limits.xml | 16 +++++++-
3 files changed, 105 insertions(+), 5 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-resource-limits.xml b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-resource-limits.xml
index 905e9a2..058ff15 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-resource-limits.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-resource-limits.xml
@@ -19,7 +19,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<chapter xml:id='chap-resource-limits'
@@ -71,7 +71,19 @@
<literal>time-limit</literal>, is 1 minute.</para>
<para>You can override the limit for a particular user by changing the
operational attribute, <literal>ds-rlim-time-limit</literal>, on
- the user's entry.</para>
+ the user's entry. Times for <literal>ds-rlim-time-limit</literal> are
+ expressed in seconds.</para>
+ </listitem>
+ <listitem>
+ <para>The <firstterm>idle time limit</firstterm> defines how long OpenDJ
+ allows idle connections to remain open.</para>
+ <para>No default idle time limit is set. You can set an idle time limit
+ by using the global server property
+ <literal>idle-time-limit</literal>.</para>
+ <para>You can override the limit for a particular user by changing the
+ operational attribute, <literal>ds-rlim-idle-time-limit</literal>, on
+ the user's entry. Times for <literal>ds-rlim-idle-time-limit</literal>
+ are expressed in seconds.</para>
</listitem>
<listitem>
<para>The maximum number of persistent searches can be set using the
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-dsconfig.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-dsconfig.xml
index 4b06170..4e7ac30 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-dsconfig.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-dsconfig.xml
@@ -386,7 +386,23 @@
multi-valued property using the <option>--add</option> option. You can reset
the values of the multi-valued property using the <option>--reset</option>
option.</para>
-
+
+ <itemizedlist>
+ <para>Some property values take a time duration. Durations are expressed
+ as numbers followed by units. For example <literal>1 s</literal> means
+ one second, and <literal>2 w</literal> means two weeks. Some durations
+ have minimum granularity or maximum units, so you cannot necessary specify
+ every duration in milliseconds or weeks for example. Some durations allow
+ you to use a special value to mean unlimited. Units are specified as
+ follows.</para>
+ <listitem><para><literal>ms</literal>: milliseconds</para></listitem>
+ <listitem><para><literal>s</literal>: seconds</para></listitem>
+ <listitem><para><literal>m</literal>: minutes</para></listitem>
+ <listitem><para><literal>h</literal>: hours</para></listitem>
+ <listitem><para><literal>d</literal>: days</para></listitem>
+ <listitem><para><literal>w</literal>: weeks</para></listitem>
+ </itemizedlist>
+
<!-- TODO: Automate generation of the following list of subcommands.
Currently, there's a secret setting in dsconfig to produce the content.
$ export OPENDS_JAVA_ARGS="-Dorg.forgerock.opendj.gendoc=true"
diff --git a/opendj-sdk/opends/resource/man/man1/dsconfig.1 b/opendj-sdk/opends/resource/man/man1/dsconfig.1
index d5c2673..978d104 100644
--- a/opendj-sdk/opends/resource/man/man1/dsconfig.1
+++ b/opendj-sdk/opends/resource/man/man1/dsconfig.1
@@ -2,12 +2,12 @@
.\" Title: dsconfig
.\" Author:
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 03/21/2012
+.\" Date: 07/17/2012
.\" Manual: Tools Reference
.\" Source: OpenDJ 2.5.0
.\" Language: English
.\"
-.TH "DSCONFIG" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
+.TH "DSCONFIG" "1" "07/17/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -371,6 +371,78 @@
option\&. You can reset the values of the multi\-valued property using the
\fB\-\-reset\fR
option\&.
+.PP
+Some property values take a time duration\&. Durations are expressed as numbers followed by units\&. For example
+1 s
+means one second, and
+2 w
+means two weeks\&. Some durations have minimum granularity or maximum units, so you cannot necessary specify every duration in milliseconds or weeks for example\&. Some durations allow you to use a special value to mean unlimited\&. Units are specified as follows\&.
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+ms: milliseconds
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+s: seconds
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+m: minutes
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+h: hours
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+d: days
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+w: weeks
+.RE
.SS "dsconfig create\-access\-log\-filtering\-criteria"
.PP
Creates Access Log Filtering Criteria
--
Gitblit v1.10.0