From 77e4ccfb1561da18cee4d1f2e06f03ce5fc4b0c9 Mon Sep 17 00:00:00 2001 From: Howard Chu Date: Wed, 3 Jun 2009 01:02:29 +0000 Subject: [PATCH] More for slapschema --- doc/man/man8/slapd.8 | 6 ++- doc/man/man8/slapschema.8 | 89 ++++++++++++++++++++++----------------- 2 files changed, 54 insertions(+), 41 deletions(-) diff --git a/doc/man/man8/slapd.8 b/doc/man/man8/slapd.8 index 28f91254a8..70411cdd80 100644 --- a/doc/man/man8/slapd.8 +++ b/doc/man/man8/slapd.8 @@ -9,7 +9,7 @@ slapd \- Stand-alone LDAP Daemon [\c .BR \-4 | \-6 ] [\c -.BR \-T \ { acl \||\| a [ dd ]\||\| auth \||\| c [ at ]\||\| d [ n ]\||\| i [ ndex ]\||\| p [ asswd ]\||\| t [ est ]}] +.BR \-T \ { acl \||\| a [ dd ]\||\| auth \||\| c [ at ]\||\| d [ n ]\||\| i [ ndex ]\||\| p [ asswd ]\||\| s [ chema ]\||\| t [ est ]}] [\c .BI \-d \ debug-level\fR] [\c @@ -73,13 +73,14 @@ Listen on IPv4 addresses only. .B \-6 Listen on IPv6 addresses only. .TP -.BR \-T \ { acl \||\| a [ dd ]\||\| auth \||\| c [ at ]\||\| d [ n ]\||\| i [ ndex ]\||\| p [ asswd ]\||\| t [ est ]} +.BR \-T \ { acl \||\| a [ dd ]\||\| auth \||\| c [ at ]\||\| d [ n ]\||\| i [ ndex ]\||\| p [ asswd ]\||\| s [ chema ]\||\| t [ est ]} Run in Tool mode. The additional argument selects whether to run as .IR slapadd , .IR slapcat , .IR slapdn , .IR slapindex , .IR slappasswd , +.IR slapschema , or .I slaptest (\fIslapacl\fP and \fIslapauth\fP need the entire \fBacl\fP and \fBauth\fP @@ -334,6 +335,7 @@ To test whether the configuration file is correct or not, type: .BR slapdn (8), .BR slapindex (8), .BR slappasswd (8), +.BR slapschema (8), .BR slaptest (8). .LP "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/) diff --git a/doc/man/man8/slapschema.8 b/doc/man/man8/slapschema.8 index 26ca7c73b7..040be52269 100644 --- a/doc/man/man8/slapschema.8 +++ b/doc/man/man8/slapschema.8 @@ -6,19 +6,30 @@ slapschema \- SLAPD in-database schema checking utility .SH SYNOPSIS .B SBINDIR/slapschema -.B [\-a filter] -.B [\-b suffix] -.B [\-c] -.B [\-d level] -.B [\-f slapd.conf] -.B [\-F confdir] -.B [\-g] -.B [\-l error-file] -.B [\-n dbnum] -.B [\-o name[=value]] -.B [\-s subtree-dn] -.B [\-v] -.B +[\c +.BI \-a filter\fR] +[\c +.BI \-b suffix\fR] +[\c +.BR \-c ] +[\c +.BI \-d debug-level\fR] +[\c +.BI \-f slapd.conf\fR] +[\c +.BI \-F confdir\fR] +[\c +.BR \-g ] +[\c +.BI \-l error-file\fR] +[\c +.BI \-n dbnum\fR] +[\c +.BI \-o option\fR[ = value\FR]] +[\c +.BI \-s subtree-dn\fR] +[\c +.BR \-v ] .LP .SH DESCRIPTION .LP @@ -31,7 +42,7 @@ suffix and checks the compliance of its contents with the corresponding schema. Errors are written to standard output or the specified file. Databases configured as .B subordinate -of this one are also output, unless \fB-g\fP is specified. +of this one are also output, unless \fB\-g\fP is specified. .LP Administrators may need to modify existing schema items, including adding new required attributes to objectClasses, @@ -41,7 +52,7 @@ or any other change that may result in making perfectly valid entries no longer compliant with the modified schema. The execution of the .B slapschema tool after modifying the schema can point out -inconsistencies that would otherwise surface only as soon as +inconsistencies that would otherwise surface only when inconsistent entries need to be modified. .LP @@ -52,19 +63,19 @@ Dynamically generated attributes (such as subschemaSubentry) will not be considered. .SH OPTIONS .TP -.BI \-a " filter" +.BI \-a \ filter Only check entries matching the asserted filter. For example -slapschema -a \\ +slapschema \-a \\ "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))" will check all but the "ou=People,dc=example,dc=com" subtree of the "dc=example,dc=com" database. .TP -.BI \-b " suffix" +.BI \-b \ suffix Use the specified \fIsuffix\fR to determine which database to -check. The \-b cannot be used in conjunction +check. The \fB\-b\fP cannot be used in conjunction with the .B \-n option. @@ -72,24 +83,24 @@ option. .B \-c Enable continue (ignore errors) mode. .TP -.BI \-d " level" +.BI \-d \ debug-level Enable debugging messages as defined by the specified -.IR level ; +.IR debug-level ; see .BR slapd (8) for details. .TP -.BI \-f " slapd.conf" +.BI \-f \ slapd.conf Specify an alternative .BR slapd.conf (5) file. .TP -.BI \-F " confdir" +.BI \-F \ confdir specify a config directory. If both -.B -f +.B \-f and -.B -F +.B \-F are specified, the config file will be read and converted to config directory format and written to the specified directory. If neither option is specified, an attempt to read the @@ -101,13 +112,13 @@ default config file is ignored. disable subordinate gluing. Only the specified database will be processed, and not its glued subordinates (if any). .TP -.BI \-l " error-file" +.BI \-l \ error-file Write errors to specified file instead of standard output. .TP -.BI \-n " dbnum" +.BI \-n \ dbnum Check the \fIdbnum\fR\-th database listed in the configuration file. The config database -.BR slapd-config (5), +.BR slapd\-config (5), is always the first database, so use .B \-n 0 @@ -117,23 +128,23 @@ cannot be used in conjunction with the .B \-b option. .TP -.BI \-o " option[=value]" +.BI \-o \ option\fR[ = value\fR] Specify an -.BR option +.I option with a(n optional) -.BR value . +.IR value . Possible generic options/values are: .LP .nf syslog= (see `\-s' in slapd(8)) - syslog-level= (see `\-S' in slapd(8)) - syslog-user= (see `\-l' in slapd(8)) + syslog\-level= (see `\-S' in slapd(8)) + syslog\-user= (see `\-l' in slapd(8)) .fi .TP -.BI \-s " subtree-dn" +.BI \-s \ subtree-dn Only check entries in the subtree specified by this DN. -Implies `-b subtree-dn' if no +Implies \fB\-b\fP \fIsubtree-dn\fP if no .B \-b nor .B \-n @@ -149,10 +160,10 @@ mode) when you do this to ensure consistency of the database. It is always safe to run .B slapschema with the -.BR slapd-bdb (5), -.BR slapd-hdb (5), +.BR slapd\-bdb (5), +.BR slapd\-hdb (5), and -.BR slapd-null (5) +.BR slapd\-null (5) backends. .SH EXAMPLES To check the schema compliance of your SLAPD database after modifications @@ -162,7 +173,7 @@ give the command: .LP .nf .ft tt - SBINDIR/slapcat -l errors.ldif + SBINDIR/slapcat \-l errors.ldif .ft .fi .SH "SEE ALSO" -- 2.39.5