Patchwork [3/9] man: nsdb-list and nsdb-nces man page updates

login
register
mail settings
Submitter Chuck Lever
Date Nov. 28, 2011, 5:33 p.m.
Message ID <20111128173330.1136.49866.stgit@degas.1015granger.net>
Download mbox | patch
Permalink /patch/128026/
State Accepted
Headers show

Comments

Chuck Lever - Nov. 28, 2011, 5:33 p.m.
Update the man pages for the nsdb-list and nsdb-nces commands:

  o  "entry" -> "FedFS record"
  o  Use long option names throughout
  o  Various grammar and usage updates

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---

 doc/man/nsdb-list.8 |   23 ++++++++++++-----------
 doc/man/nsdb-nces.8 |   18 +++++++++---------
 2 files changed, 21 insertions(+), 20 deletions(-)

Patch

diff --git a/doc/man/nsdb-list.8 b/doc/man/nsdb-list.8
index 46cba42..4af0d24 100644
--- a/doc/man/nsdb-list.8
+++ b/doc/man/nsdb-list.8
@@ -58,10 +58,11 @@  about file sets contained in a FedFS domain name space.
 .SH DESCRIPTION
 The
 .BR nsdb-list (8)
-command is part of a collection of low-level single-use programs that are
-intended for testing the NSDB protocol or for use in scripts.
-It retrieves a list of file set name and location
-entries stored on an NSDB.
+command is part of a collection of low-level single-use programs
+that is intended for testing the NSDB protocol or for use in scripts.
+It retrieves the list of file set name and location records
+stored on an NSDB
+under one NSDB Container Entry.
 .SH OPTIONS
 .IP "\fB\-d, \-\-debug"
 Specifies that debugging messages be produced during operation.
@@ -74,29 +75,29 @@  then exits.
 .IP "\fB\-l, \-\-nsdbname=\fINSDB-hostname\fP"
 Specifies the hostname of the NSDB to enumerate.
 If the
-.B -l
+.B --nsdbname
 option is not specified,
 the value of the FEDFS_NSDB_HOST environment variable is consulted.
 If the variable is not set and the
-.B -l
+.B --nsdbname
 option is not specified, the
 .BR nsdb-list (8)
 command fails.
 .IP "\fB\-r, \-\-nsdbport=\fINSDB-port\fP"
 Specifies the IP port of the NSDB to enumerate.
 If the
-.B -r
+.B --nsdbport
 option is not specified,
 the value of the FEDFS_NSDB_PORT environment variable is consulted.
 The default value if the variable is not set is 389.
 .IP "\fB\-e, \-\-nce=\fINSDB-container-entry\fP"
-Limits the query to a particular NSDB container entry on the target NSDB.
+Limits the query to a particular NSDB Container Entry on the target NSDB.
 If the
-.B -e
+.B --nce
 option is not specified,
 the value of the FEDFS_NSDB_NCE environment variable is consulted.
 If the variable is not set and the
-.B -e
+.B --nce
 option is not specified,
 or the specified NCE does not exist on the target NSDB, the
 .BR nsdb-list (8)
@@ -220,7 +221,7 @@  The NSDB protocol draft standard requires that FedFS FSN and FSL
 records are readable by everyone.
 The
 .BR nsdb-list (8)
-command uses anonymous binding to perform LDAP queries.
+command uses anonymous binding when performing LDAP queries.
 .P
 The target LDAP server must be registered in the local NSDB connection
 parameter database.
diff --git a/doc/man/nsdb-nces.8 b/doc/man/nsdb-nces.8
index 69639af..7f022af 100644
--- a/doc/man/nsdb-nces.8
+++ b/doc/man/nsdb-nces.8
@@ -56,10 +56,10 @@  about file sets contained in a FedFS domain name space.
 .SH DESCRIPTION
 The
 .BR nsdb-nces (8)
-command is part of a collection of low-level single-use programs that are
-intended for testing the NSDB protocol or for use in scripts.
+command is part of a collection of low-level single-use programs
+that in intended for testing the NSDB protocol or for use in scripts.
 It queries an LDAP server for the existance of
-.IR "NSDB container entries" ,
+.IR "NSDB Container Entries" ,
 or
 .IR NCEs ,
 for short.
@@ -102,18 +102,18 @@  then exits.
 .IP "\fB\-l, \-\-nsdbname=\fINSDB-hostname\fP"
 Specifies the hostname of the NSDB to enumerate.
 If the
-.B -l
+.B --nsdbname
 option is not specified,
 the value of the FEDFS_NSDB_HOST environment variable is consulted.
 If the variable is not set and the
-.B -l
+.B --nsdbname
 option is not specified, the
 .BR nsdb-nces (8)
 command fails.
 .IP "\fB\-r, \-\-nsdbport=\fINSDB-port\fP"
 Specifies the IP port of the NSDB to enumerate.
 If the
-.B -r
+.B --nsdbport
 option is not specified,
 the value of the FEDFS_NSDB_PORT environment variable is consulted.
 The default value if the variable is not set is 389.
@@ -226,13 +226,13 @@  Host: ldap.example.net:389
 .sp
 .RE
 This shows there are three LDAP naming contexts on the target LDAP server.
-One of these is an NSDB container entry.
+One of these is an NSDB Container Entry.
 Thus the target LDAP server is an NSDB.
 .SH SECURITY
-LDAP naming contexts are typically readable by everyone.
 The
 .BR nsdb-nces (8)
-command uses anonymous binding to perform this query.
+command uses anonymous binding when performing LDAP queries.
+LDAP naming contexts are typically readable by everyone.
 .P
 The target LDAP server must be registered in the local NSDB connection
 parameter database.