Diff for /doc/man/man8/slapcat.8 between versions 1.19.2.7 and 1.28.2.11

version 1.19.2.7, 2006/01/03 22:16:06 version 1.28.2.11, 2009/06/03 01:42:01
Line 1 Line 1
 .TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"  .TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP: pkg/ldap/doc/man/man8/slapcat.8,v 1.19.2.6 2005/11/14 18:06:05 kurt Exp $  .\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.
 .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.  
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.  .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   .\" $OpenLDAP$
 .SH NAME  .SH NAME
 slapcat \- SLAPD database to LDIF utility  slapcat \- SLAPD database to LDIF utility
 .SH SYNOPSIS  .SH SYNOPSIS
 .B SBINDIR/slapcat  .B SBINDIR/slapcat
 .B [\-v]  [\c
 .B [\-c]  .BI \-a filter\fR]
 .B [\-g]  [\c
 .B [\-d level]  .BI \-b suffix\fR]
 .B [\-b suffix]  [\c
 .B [\-n dbnum]  .BR \-c ]
 .B [\-a filter]  [\c
 .B [\-s subtree-dn]  .BI \-d debug-level\fR]
 .B [\-f slapd.conf]  [\c
 .B [\-F confdir]  .BI \-f slapd.conf\fR]
 .B [\-l ldif-file]  [\c
 .B   .BI \-F confdir\fR]
   [\c
   .BR \-g ]
   [\c
   .BI \-l ldif-file\fR]
   [\c
   .BI \-n dbnum\fR]
   [\c
   .BI \-o option\fR[ = value\fR]]
   [\c
   .BI \-s subtree-dn\fR]
   [\c
   .BR \-v ]
 .LP  .LP
 .SH DESCRIPTION  .SH DESCRIPTION
 .LP  .LP
Line 31  suffix and writes the corresponding LDIF Line 43  suffix and writes the corresponding LDIF
 the specified file.  the specified file.
 Databases configured as  Databases configured as
 .B subordinate  .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  .LP
 The LDIF generated by this tool is suitable for use with  The entry records are presented in database order, not superior first
   order.  The entry records will include all (user and operational)
   attributes stored in the database.  The entry records will not include
   dynamically generated attributes (such as subschemaSubentry).
   .LP
   The output of slapcat is intended to be used as input to
 .BR slapadd (8).  .BR slapadd (8).
 As the entries are in database order, not superior first order,  The output of slapcat cannot generally be used as input to
 they cannot be loaded with  
 .BR ldapadd (1)  .BR ldapadd (1)
 without first being reordered.  or other LDAP clients without first editing the output.
   This editing would normally include reordering the records
   into superior first order and removing no-user-modification
   operational attributes.
 .SH OPTIONS  .SH OPTIONS
 .TP  .TP
 .B \-v  .BI \-a \ filter
 Enable verbose mode.  
 .TP  
 .B \-c  
 Enable continue (ignore errors) mode.  
 .TP  
 .B \-g  
 disable subordinate gluing.  Only the specified database will be  
 processed, and not its glued subordinates (if any).  
 .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 \-a " filter"  
 Only dump entries matching the asserted filter.  Only dump entries matching the asserted filter.
 For example  For example
   
 slapcat -a \\  slapcat \-a \\
     "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))"      "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))"
   
 will dump all but the "ou=People,dc=example,dc=com" subtree  will dump all but the "ou=People,dc=example,dc=com" subtree
 of the "dc=example,dc=com" database.  of the "dc=example,dc=com" database.
 .TP  .TP
 .BI \-s " subtree-dn"  .BI \-b \ suffix 
 Only dump entries in the subtree specified by this DN.  Use the specified \fIsuffix\fR to determine which database to
 Implies `-b subtree-dn' if no  generate output for.  The \fB\-b\fP cannot be used in conjunction
 .B \-b  with the
 or  
 .B \-n  .B \-n
 option is given.  option.
   .TP
   .B \-c
   Enable continue (ignore errors) mode.
   .TP
   .BI \-d \ debug-level
   Enable debugging messages as defined by the specified
   .IR debug-level ;
   see
   .BR slapd (8)
   for details.
 .TP  .TP
 .BI \-f " slapd.conf"  .BI \-f \ slapd.conf
 Specify an alternative  Specify an alternative
 .BR slapd.conf (5)  .BR slapd.conf (5)
 file.  file.
 .TP  .TP
 .BI \-F " confdir"  .BI \-F \ confdir
 specify a config directory.  specify a config directory.
 If both  If both
 .B -f  .B \-f
 and  and
 .B -F  .B \-F
 are specified, the config file will be read and converted to  are specified, the config file will be read and converted to
 config directory format and written to the specified directory.  config directory format and written to the specified directory.
 If neither option is specified, an attempt to read the  If neither option is specified, an attempt to read the
Line 106  default config directory will be made be Line 105  default config directory will be made be
 config file. If a valid config directory exists then the  config file. If a valid config directory exists then the
 default config file is ignored.  default config file is ignored.
 .TP  .TP
 .BI \-l " ldif-file"  .B \-g
   disable subordinate gluing.  Only the specified database will be
   processed, and not its glued subordinates (if any).
   .TP
   .BI \-l \ ldif-file
 Write LDIF to specified file instead of standard output.  Write LDIF to specified file instead of standard output.
   .TP
   .BI \-n \ dbnum
   Generate output for the \fIdbnum\fR-th database listed in the
   configuration file. The config database
   .BR slapd\-config (5),
   is always the first database, so use
   .B \-n 0
   
   The
   .B \-n
   cannot be used in conjunction with the
   .B \-b
   option.
   .TP
   .BI \-o \ option\fR[ = value\fR]
   Specify an
   .I option
   with a(n optional)
   .IR value .
   Possible generic options/values are:
   .LP
   .nf
                 syslog=<subsystems>  (see `\-s' in slapd(8))
                 syslog\-level=<level> (see `\-S' in slapd(8))
                 syslog\-user=<user>   (see `\-l' in slapd(8))
   
   .fi
   .TP
   .BI \-s \ subtree-dn
   Only dump entries in the subtree specified by this DN.
   Implies \fB\-b\fP \fIsubtree-dn\fP if no
   .B \-b
   or
   .B \-n
   option is given.
   .TP
   .B \-v
   Enable verbose mode.
 .SH LIMITATIONS  .SH LIMITATIONS
 In general, your  For some backend types, your
 .BR slapd (8)  .BR slapd (8)
 should not be running (at least, not in read-write  should not be running (at least, not in read-write
 mode) when you do this to ensure consistency of the database.  mode) when you do this to ensure consistency of the database. It is
   always safe to run 
   .B slapcat
   with the
   .BR slapd\-bdb (5),
   .BR slapd\-hdb (5),
   and
   .BR slapd\-null (5)
   backends.
 .SH EXAMPLES  .SH EXAMPLES
 To make a text backup of your SLAPD database and put it in a file called  To make a text backup of your SLAPD database and put it in a file called
 .BR ldif ,  .BR ldif ,
Line 120  give the command: Line 169  give the command:
 .LP  .LP
 .nf  .nf
 .ft tt  .ft tt
         SBINDIR/slapcat -l ldif          SBINDIR/slapcat \-l ldif
 .ft  .ft
 .fi  .fi
 .SH "SEE ALSO"  .SH "SEE ALSO"
Line 132  give the command: Line 181  give the command:
 .LP  .LP
 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)  "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 .SH ACKNOWLEDGEMENTS  .SH ACKNOWLEDGEMENTS
 .B OpenLDAP  .so ../Project
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).  
 .B OpenLDAP  
 is derived from University of Michigan LDAP 3.3 Release.    

Removed from v.1.19.2.7  
changed lines
  Added in v.1.28.2.11


______________
© Copyright 1998-2020, OpenLDAP Foundation, info@OpenLDAP.org