From patchwork Mon Nov 28 17:33:31 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chuck Lever X-Patchwork-Id: 128026 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from rcsinet15.oracle.com (rcsinet15.oracle.com [148.87.113.117]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client CN "rcsinet15.oracle.com", Issuer "VeriSign Class 3 International Server CA - G3" (verified OK)) by ozlabs.org (Postfix) with ESMTPS id 74226B6F7C for ; Tue, 29 Nov 2011 04:33:46 +1100 (EST) Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by rcsinet15.oracle.com (Switch-3.4.4/Switch-3.4.4) with ESMTP id pASHXgDk005310 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Mon, 28 Nov 2011 17:33:43 GMT Received: from oss.oracle.com (oss.oracle.com [141.146.12.120]) by ucsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id pASHXfZH018143 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Mon, 28 Nov 2011 17:33:42 GMT Received: from localhost ([127.0.0.1] helo=oss.oracle.com) by oss.oracle.com with esmtp (Exim 4.63) (envelope-from ) id 1RV55E-0000Rl-P3; Mon, 28 Nov 2011 09:33:36 -0800 Received: from acsinet13.oracle.com ([141.146.126.235]) by oss.oracle.com with esmtp (Exim 4.63) (envelope-from ) id 1RV55D-0000Re-4N for fedfs-utils-devel@oss.oracle.com; Mon, 28 Nov 2011 09:33:35 -0800 Received: from mail-iy0-f171.google.com (mail-iy0-f171.google.com [209.85.210.171]) by acsinet13.oracle.com (Switch-3.4.4/Switch-3.4.4) with ESMTP id pASHXXJc022680 (version=TLSv1/SSLv3 cipher=RC4-SHA bits=128 verify=FAIL) for ; Mon, 28 Nov 2011 17:33:34 GMT Received: by iaby12 with SMTP id y12so10949330iab.2 for ; Mon, 28 Nov 2011 09:33:32 -0800 (PST) Received: by 10.231.67.6 with SMTP id p6mr3090640ibi.24.1322501612795; Mon, 28 Nov 2011 09:33:32 -0800 (PST) Received: from degas.1015granger.net (adsl-99-26-161-222.dsl.sfldmi.sbcglobal.net. [99.26.161.222]) by mx.google.com with ESMTPS id bu33sm48212655ibb.11.2011.11.28.09.33.31 (version=TLSv1/SSLv3 cipher=OTHER); Mon, 28 Nov 2011 09:33:32 -0800 (PST) From: Chuck Lever To: fedfs-utils-devel@oss.oracle.com Date: Mon, 28 Nov 2011 12:33:31 -0500 Message-ID: <20111128173330.1136.49866.stgit@degas.1015granger.net> In-Reply-To: <20111128172546.1136.92618.stgit@degas.1015granger.net> References: <20111128172546.1136.92618.stgit@degas.1015granger.net> User-Agent: StGIT/0.14.3 MIME-Version: 1.0 X-Flow-Control-Info: class=ISPs ip=209.85.210.171 ct-class=G1 ct-vol1=0 ct-vol2=0 ct-vol3=0 ct-risk=0 ct-spam1=0 ct-spam2=0 ct-bulk=0 rcpts=1 size=4780 Subject: [fedfs-utils] [PATCH 3/9] man: nsdb-list and nsdb-nces man page updates X-BeenThere: fedfs-utils-devel@oss.oracle.com X-Mailman-Version: 2.1.9 Precedence: list Reply-To: fedfs-utils Developers List-Id: fedfs-utils Developers List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: fedfs-utils-devel-bounces@oss.oracle.com Errors-To: fedfs-utils-devel-bounces@oss.oracle.com X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-CT-RefId: str=0001.0A090202.4ED3C5F7.00C8:SCFSTAT3865452, ss=1, re=-4.000, fgs=0 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 --- doc/man/nsdb-list.8 | 23 ++++++++++++----------- doc/man/nsdb-nces.8 | 18 +++++++++--------- 2 files changed, 21 insertions(+), 20 deletions(-) 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.