From: Kurt Zeilenga Date: Tue, 17 Aug 1999 20:04:35 +0000 (+0000) Subject: Add man pages for slapadd and slapcat (slapindex coming soon). X-Git-Tag: TWEB_OL_BASE~190 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=01235987ee4be28209eab1febc95bd9343c714c5;p=openldap Add man pages for slapadd and slapcat (slapindex coming soon). Remove man pages for old ldbm tools. --- diff --git a/doc/man/man8/ldbmcat.8 b/doc/man/man8/ldbmcat.8 deleted file mode 100644 index 96c9350309..0000000000 --- a/doc/man/man8/ldbmcat.8 +++ /dev/null @@ -1,66 +0,0 @@ -.TH LDBMCAT 8C "22 September 1998" "OpenLDAP LDVERSION" -.SH NAME -ldbmcat \- LDBM to LDIF database format conversion utility -.SH SYNOPSIS -.B SBINDIR/ldbmcat [\-n] id2entry\-file -.LP -.SH DESCRIPTION -.LP -This program is used to convert a -.BR slapd (8) -LDBM database to the text LDAP Directory Interchange Format (LDIF). -It opens the given -.I id2entry\-file -and writes the corresponding LDIF output to standard output. -.LP -See "The SLAPD and SLURPD Administrator's Guide" for more details on -using this program. -.SH OPTIONS -.TP -.B \-n -This option specifies that -.B ldbmcat -should not print entry IDs when it dumps out the database. Note -that the printing of entry IDs is essential if you are going to -use the LDIF format produced as input to -.B ldif2index, -for example, to create a new index file for use with an existing -database. -.SH EXAMPLES -To make a text backup of your LDBM database and put it in a file called -.BR ldif , -give the command: -.LP -.nf -.ft tt - SBINDIR/ldbmcat -n id2entry.dbb > ldif -.ft -.fi -.LP -To create a new index for the -.B mail -attribute, give these commands: -.LP -.nf -.ft tt - SBINDIR/ldbmcat id2entry.dbb > ldif - SBINDIR/ldif2index -i ldif -f slapd-config-file mail -.ft -.fi -.LP -Note that your -.B slapd (8) -should not be running (at least, not in read-write -mode) when you do this to ensure consistency of the database. -.SH "SEE ALSO" -.BR ldap (3), -.BR ldif (5), -.BR ldif2ldbm (8), -.BR slapd (8) -.LP -"The SLAPD and SLURPD Administrator's Guide" -.SH ACKNOWLEDGEMENTS -.B OpenLDAP -is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). -.B OpenLDAP -is derived from University of Michigan LDAP 3.3 Release. diff --git a/doc/man/man8/ldif2ldbm.8 b/doc/man/man8/ldif2ldbm.8 deleted file mode 100644 index 68df8b66b6..0000000000 --- a/doc/man/man8/ldif2ldbm.8 +++ /dev/null @@ -1,128 +0,0 @@ -.TH LDIF2LDBM 8C "22 September 1998" "OpenLDAP LDVERSION" -.SH NAME -ldif2ldbm, ldif2index, ldif2id2entry, ldif2id2children \- LDIF to LDBM database format conversion utilities -.SH SYNOPSIS -.B SBINDIR/ldif2ldbm -.B \-i ldif\-input\-file -.B [\-d debug\-level] [\-f slapd\-config\-file] -.B [\-j number\-of\-jobs] [\-n database#] [\-s sbindir] -.LP -.B SBINDIR/ldif2index -.B \-i ldif\-input\-file -.B [\-d debug\-level] [\-f slapd\-config\-file] [\-n database#] -.B attribute\-name -.LP -.B SBINDIR/ldif2id2entry -.B \-i ldif\-input\-file -.B [\-d debug\-level] [\-f slapd\-config\-file] [\-n database#] -.LP -.B SBINDIR/ldif2id2children -.B \-i ldif\-input\-file -.B [\-d debug\-level] [\-f slapd\-config\-file] [\-n database#] -.LP -.SH DESCRIPTION -.LP -These programs are used to convert a database in text LDIF LDAP -Directory Interchange Format (LDIF) to an LDBM database suitable -for use by -.BR slapd (8). -Normally, only -.B ldif2ldbm -is invoked by you. It will invoke the other programs as necessary. -Occasionally, it may be necessary to invoke them by hand. For -example, to create a new index file for an existing database, the -.B ldif2index -program can be invoked. The -.BR ldbmcat (8) -program is used to do the reverse conversion. -.LP -See "The SLAPD and SLURPD Administrator's Guide" for more details on -using these programs. -.SH OPTIONS -The first three options apply to all four programs. The -j option is -only for the -.B ldif2ldbm -program. -.TP -.BI \-i " ldif\-input\-file" -This option specifies the location of the LDIF input file containing -the database to convert. It is required. -.TP -.BI \-d " debug\-level" -Turn on debugging as defined by -.B debug\-level. -Some general operation and status messages are printed for any value of -\fIdebug\-level\fP. \fIdebug\-level\fP is taken as a bit string, with -each bit corresponding to a different kind of debugging information. -See for details. -.TP -.BI \-f " slapd\-config\-file" -This option specifies the -.B slapd -configuration file. The default is -.BR ETCDIR/slapd.conf . -.TP -.BI \-n " database#" -This option specifies the database number within -.B slapd -configuration file to build. The default is the 1, the first. -.TP -.BI \-s " sbindir" -This option specifies the location of dependent tools. The -default is SBINDIR. -.TP -.BI \-j " number\-of\-jobs" -This option only applies to the -.B ldif2ldbm -program. It specifies the level of parallelism to use when doing the -conversion. -.B ldif2ldbm -invokes several other programs during the conversion process, -most notably one invocation of -.B ldif2index -for each indexed attribute that appears in the LDIF input file. The -j -option tells -.B ldif2ldbm -how many of these other programs it should run in parallel. This can -speed up the conversion, but beware of starting too many processes -in parallel, all competing for disk, memory, and cpu resources. The -default is one. -.SH EXAMPLES -To convert the file -.BR ldif.input -into an LDBM database with indexes as described in the -.I slapd -config file -.BR ETCDIR/slapd.conf , -give the command: -.LP -.nf -.ft tt - SBINDIR/ldif2index -i ldif.input -f ETCDIR/slapd.conf -.ft -.fi -.LP -To build the second database listed in -.BR ETCDIR/slapd.conf , -and to use three conversion sub-processes at a time, -give this command: -.LP -.nf -.ft tt - SBINDIR/ldif2index -i ldif.input -f ETCDIR/slapd.conf -n 2 -j 3 -.ft -.fi -.LP -.SH "SEE ALSO" -.BR ldap (3), -.BR ldif (5), -.BR slapd.conf (5), -.BR ldbmcat (8), -.BR edb2ldif (8) -.LP -"The SLAPD and SLURPD Administrator's Guide" -.SH ACKNOWLEDGEMENTS -.B OpenLDAP -is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). -.B OpenLDAP -is derived from University of Michigan LDAP 3.3 Release. diff --git a/doc/man/man8/ldif2ldbm.8.links b/doc/man/man8/ldif2ldbm.8.links deleted file mode 100644 index 0906b6de4d..0000000000 --- a/doc/man/man8/ldif2ldbm.8.links +++ /dev/null @@ -1,3 +0,0 @@ -ldif2index.8 -ldif2id2entry.8 -ldif2id2children.8 diff --git a/doc/man/man8/slapadd.8 b/doc/man/man8/slapadd.8 new file mode 100644 index 0000000000..4dac92d900 --- /dev/null +++ b/doc/man/man8/slapadd.8 @@ -0,0 +1,92 @@ +.TH SLAPADD 8C "17 August 1999" "OpenLDAP LDVERSION" +.SH NAME +slapadd \- Add entries to a SLAPD database +.SH SYNOPSIS +.B SBINDIR/slapadd +.B [\-v] +.B [\-d level] +.B [\-b suffix] +.B [\-n dbnum] +.B [\-f slapd.conf] +.B [\-l ldif-file] +.B +.LP +.SH DESCRIPTION +.LP +.B Slapadd +is used to add entries specified in LDAP Directory Interchange Format +(LDIF) to a +.BR slapd (8) +database. +It opens the given database determined by the database number or +suffix and adds entries corresponding to the provided LDIF to +the database. The LDIF input is read from standard input or +the specified file. +.LP +The LDIF generated by this tool is suitable for use with +.BR slapcat (8). +.SH OPTIONS +.TP +.B \-v +enable verbose mode. +.TP +.BI \-d " level" +enable debugging messages as defined by the specified +.IR level . +.TP +.BI \-b " suffix" +Use the specified \fIsuffix\fR to determine which database to +add entries to. The \-b cannot be used in conjunction +with the +.B \-n +option. +.TP +.BI \-n " dbnum" +Add entries to the \fIdbnum\fR\-th database listed in the +configuration file. The +.B \-n +cannot be used in conjunction with the +.B \-b +option. +.TP +.BI \-f " slapd.conf" +specify an alternative +.BR slapd.conf (5) +file. +.TP +.BI \-l " ldif-file" +Read LDIF from the specified file instead of standard input. +.SH LIMITATIONS +Your +.BR slapd (8) +should not be running +when you do this to ensure consistency of the database. +.LP +.B slapadd +may not provide naming or schema checks. It is advisable to +use +.BR ldapadd (1) +when adding new entries into an existing directory. +.SH EXAMPLES +To import a entries specified in file +.B ldif +into your +.BR slapd (8) +database give the command: +.LP +.nf +.ft tt + SBINDIR/slapadd -l ldif +.ft +.fi +.SH "SEE ALSO" +.BR ldap (3), +.BR ldif (5), +.BR slapcat (8), +.BR ldapadd (1), +.BR slapd (8) +.SH ACKNOWLEDGEMENTS +.B OpenLDAP +is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). +.B OpenLDAP +is derived from University of Michigan LDAP 3.3 Release. diff --git a/doc/man/man8/slapcat.8 b/doc/man/man8/slapcat.8 new file mode 100644 index 0000000000..20e8369fa2 --- /dev/null +++ b/doc/man/man8/slapcat.8 @@ -0,0 +1,85 @@ +.TH SLAPCAT 8C "17 August 1999" "OpenLDAP LDVERSION" +.SH NAME +slapcat \- SLAPD database to LDIF utility +.SH SYNOPSIS +.B SBINDIR/slapcat +.B [\-v] +.B [\-d level] +.B [\-b suffix] +.B [\-n dbnum] +.B [\-f slapd.conf] +.B [\-l ldif-file] +.B +.LP +.SH DESCRIPTION +.LP +.B Slapcat +is used to generate an LDAP Directory Interchange Format +(LDIF) output based upon the contents of a +.BR slapd (8) +database. +It opens the given database determined by the database number or +suffix and and writes the corresponding LDIF to standard output or +the specified file. +.LP +The LDIF generated by this tool is suitable for use with +.BR ldapadd (1) +or +.BR slapadd (8). +.SH OPTIONS +.TP +.B \-v +enable verbose mode. +.TP +.BI \-d " level" +enable debugging messages as defined by the specified +.IR level . +.TP +.BI \-b " suffix" +Use the specified \fIsuffix\fR to determine which database to +generate output for. The \-b cannot be used in conjunction +with the +.B \-n +option. +.TP +.BI \-n " dbnum" +Generate output for the \fIdbnum\fR\-th database listed in the +configuration file. The +.B \-n +cannot be used in conjunction with the +.B \-b +option. +.TP +.BI \-f " slapd.conf" +specify an alternative +.BR slapd.conf (5) +file. +.TP +.BI \-l " ldif-file" +Write LDIF to specified file instead of standard output. +.SH Limitations +Your +.BR slapd (8) +should not be running (at least, not in read-write +mode) when you do this to ensure consistency of the database. +.SH EXAMPLES +To make a text backup of your SLAPD database and put it in a file called +.BR ldif , +give the command: +.LP +.nf +.ft tt + SBINDIR/slapcat -l ldif +.ft +.fi +.SH "SEE ALSO" +.BR ldap (3), +.BR ldif (5), +.BR slapadd (8), +.BR ldapadd (1), +.BR slapd (8) +.SH ACKNOWLEDGEMENTS +.B OpenLDAP +is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). +.B OpenLDAP +is derived from University of Michigan LDAP 3.3 Release.