Diff for /doc/man/man8/slapcat.8 between versions 1.23 and 1.28.2.12

version 1.23, 2005/08/31 20:27:56 version 1.28.2.12, 2009/09/29 19:05:44
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.22 2005/08/17 15:39:34 ando Exp $  .\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.
 .\" Copyright 1998-2005 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 [\-d level]  [\c
 .B [\-b suffix]  .BI \-b suffix\fR]
 .B [\-n dbnum]  [\c
 .B [\-a filter]  .BR \-c ]
 .B [\-s subtree-dn]  [\c
 .B [\-f slapd.conf]  .BI \-d debug-level\fR]
 .B [\-l ldif-file]  [\c
 .B   .BI \-f slapd.conf\fR]
   [\c
   .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 27  database. Line 41  database.
 It opens the given database determined by the database number or  It opens the given database determined by the database number or
 suffix and writes the corresponding LDIF to standard output or  suffix and writes the corresponding LDIF to standard output or
 the specified file.  the specified file.
 Subordinate databases glued with  Databases configured as
 .BR slapo-glue (5)  .B subordinate
 are also output.  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.  Only dump entries matching the asserted filter.
   For example
   
   slapcat \-a \\
       "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))"
   
   will dump all but the "ou=People,dc=example,dc=com" subtree
   of the "dc=example,dc=com" database.
   .TP
   .BI \-b \ suffix 
   Use the specified \fIsuffix\fR to determine which database to
   generate output for.  The \fB\-b\fP cannot be used in conjunction
   with the
   .B \-n
   option.
 .TP  .TP
 .B \-c  .B \-c
 Enable continue (ignore errors) mode.  Enable continue (ignore errors) mode.
 .TP  .TP
 .BI \-d " level"  .BI \-d \ debug-level
 Enable debugging messages as defined by the specified  Enable debugging messages as defined by the specified
 .IR level .  .IR debug-level ;
   see
   .BR slapd (8)
   for details.
 .TP  .TP
 .BI \-b " suffix"   .BI \-f \ slapd.conf
 Use the specified \fIsuffix\fR to determine which database to  Specify an alternative
 generate output for.  The \-b cannot be used in conjunction  .BR slapd.conf (5)
 with the  file.
 .B \-n  .TP
 option.  .BI \-F \ confdir
   specify a config directory.
   If both
   .B \-f
   and
   .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
   default config directory will be made before trying to use the default
   config file. If a valid config directory exists then the
   default config file is ignored.
   .TP
   .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.
 .TP  .TP
 .BI \-n " dbnum"  .BI \-n \ dbnum
 Generate output for the \fIdbnum\fR\-th database listed in the  Generate output for the \fIdbnum\fR-th database listed in the
 configuration file.  The  configuration file. The config database
   .BR slapd\-config (5),
   is always the first database, so use
   .B \-n 0
   to select it.
   
   The
 .B \-n  .B \-n
 cannot be used in conjunction with the  cannot be used in conjunction with the
 .B \-b  .B \-b
 option.  option.
 .TP  .TP
 .BI \-a " filter"  .BI \-o \ option\fR[ = value\fR]
 Only dump entries matching the asserted filter.  Specify an
 For example  .I option
   with a(n optional)
 slapcat -a \\  .IR value .
     "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))"  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))
   
 will dump all but the "ou=People,dc=example,dc=com" subtree  .fi
 of the "dc=example,dc=com" database.  
 .TP  .TP
 .BI \-s " subtree-dn"  .BI \-s \ subtree-dn
 Only dump entries in the subtree specified by this DN.  Only dump 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  .B \-b
 or  or
 .B \-n  .B \-n
 option is given.  option is given.
 .TP  .TP
 .BI \-f " slapd.conf"  .B \-v
 Specify an alternative  Enable verbose mode.
 .BR slapd.conf (5)  
 file.  
 .TP  
 .BI \-l " ldif-file"  
 Write LDIF to specified file instead of standard output.  
 .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 101  give the command: Line 170  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 113  give the command: Line 182  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.23  
changed lines
  Added in v.1.28.2.12


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