From 62bd7c4ad5fe8166524ca45bc619b0768958802e Mon Sep 17 00:00:00 2001
From: Matthew Swift <matthew.swift@forgerock.com>
Date: Mon, 09 Jan 2012 00:06:48 +0000
Subject: [PATCH] Fix OPENDJ-128: Improve usage information provided with xxxrate tools

---
 opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties |   23 +++++++++++++++--------
 1 files changed, 15 insertions(+), 8 deletions(-)

diff --git a/opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties b/opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
index bb49818..49e6c80 100755
--- a/opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
+++ b/opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
@@ -119,7 +119,7 @@
 INFO_TIME_IN_DAYS_HOURS_MINUTES_SECONDS=%d days, %d hours, %d minutes, %d \
  seconds
 INFO_ARGPARSER_USAGE=Usage:
-INFO_SUBCMDPARSER_WHERE_OPTIONS_INCLUDE=Where {options} include:
+INFO_SUBCMDPARSER_WHERE_OPTIONS_INCLUDE=Command options:
 ERR_MENU_BAD_CHOICE_SINGLE=Invalid response. Please enter a valid \
 menu option
 INFO_MENU_PROMPT_SINGLE=Enter choice:
@@ -376,9 +376,9 @@
   property values used for command line arguments
 INFO_DESCRIPTION_NO_PROP_FILE=No properties file will be \
   used to get default command line argument values
-INFO_DESCRIPTION_GENERAL_ARGS=General Options
-INFO_DESCRIPTION_IO_ARGS=Utility Input/Output Options
-INFO_DESCRIPTION_LDAP_CONNECTION_ARGS=LDAP Connection Options
+INFO_DESCRIPTION_GENERAL_ARGS=General options:
+INFO_DESCRIPTION_IO_ARGS=Utility input/output options:
+INFO_DESCRIPTION_LDAP_CONNECTION_ARGS=LDAP connection options:
 INFO_FILE_PLACEHOLDER={file}
 INFO_KEYSTOREPATH_PLACEHOLDER={keyStorePath}
 INFO_TRUSTSTOREPATH_PLACEHOLDER={trustStorePath}
@@ -428,19 +428,26 @@
 ERR_DECODE_CONTROL_FAILURE=# %s
 INFO_SEARCHRATE_TOOL_DESCRIPTION=This utility can be used to measure \
   search throughput and response time of a directory service using \
-  user-defined searches
+  user-defined searches.\n\n\
+  Example:\n\n\ \ searchrate -p 1389 -b "dc=example,dc=com" \\\n\
+  \ \ \ \ -g "rand(names.txt)" "(uid=%%s)" -A -F -c 4 -t 4
 INFO_SEARCHRATE_TOOL_DESCRIPTION_BASEDN=Base DN format string.
 INFO_MODRATE_TOOL_DESCRIPTION=This utility can be used to measure \
   modify throughput and response time of a directory service using \
-  user-defined modifications
+  user-defined modifications.\n\n\
+  Example:\n\n\ \ modrate -p 1389 -D "cn=directory manager" -w password \\\n\
+  \ \ \ \ -b "uid=%%s,ou=people,dc=example,dc=com" -g "rand(names.txt)" \\\n\
+  \ \ \ \ 'description:%%2$s' -g "randstr(16)" -A -F -c 4 -t 4
 INFO_MODRATE_TOOL_DESCRIPTION_TARGETDN=Target entry DN format string
 INFO_AUTHRATE_TOOL_DESCRIPTION=This utility can be used to measure \
   bind throughput and response time of a directory service using \
-  user-defined bind or search-then-bind operations. Format strings may be \
+  user-defined bind or search-then-bind operations.\n\nFormat strings may be \
   used in the bind DN option as well as the authid and authzid SASL bind \
   options. A search operation may be used to retrieve the bind DN by \
   specifying the base DN and a filter. The retrieved entry DN will be appended \
-  as the last argument in the argument list when evaluating format strings.
+  as the last argument in the argument list when evaluating format strings.\n\n\
+  Example:\n\n\ \ authrate -p 1389 -D "uid=%%s,ou=people,dc=example,dc=com" \\\n\
+  \ \ \ \ -w password -g "rand(names.txt)" -c 10 -f
 INFO_OUTPUT_LDIF_FILE_PLACEHOLDER={file}
 INFO_LDIFMODIFY_DESCRIPTION_OUTPUT_FILENAME=Write updated entries to %s \
  instead of stdout

--
Gitblit v1.10.0