Diff for /doc/man/man8/slapcat.8 between versions 1.28.2.17 and 1.29

version 1.28.2.17, 2011/01/04 23:49:51 version 1.29, 2006/05/03 14:51:45
Line 1 Line 1
 .TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"  .TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved.  .\" $OpenLDAP: pkg/ldap/doc/man/man8/slapcat.8,v 1.28 2006/01/03 22:12:05 kurt Exp $
   .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.  .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP: pkg/ldap/doc/man/man8/slapcat.8,v 1.28.2.16 2011/01/04 18:57:26 quanah Exp $  
 .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
 [\c  .B [\-v]
 .BI \-a filter\fR]  .B [\-c]
 [\c  .B [\-g]
 .BI \-b suffix\fR]  .B [\-d level]
 [\c  .B [\-b suffix]
 .BR \-c ]  .B [\-n dbnum]
 [\c  .B [\-a filter]
 .BI \-d debug-level\fR]  .B [\-s subtree-dn]
 [\c  .B [\-f slapd.conf]
 .BI \-f slapd.conf\fR]  .B [\-F confdir]
 [\c  .B [\-l ldif-file]
 .BI \-F confdir\fR]  .B 
 [\c  
 .BR \-g ]  
 [\c  
 .BI \-H URI\fR]  
 [\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 45  suffix and writes the corresponding LDIF Line 31  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 entry records are presented in database order, not superior first  The entry records are presented in database order, not superior first
 order.  The entry records will include all (user and operational)  order.  The entry records will include all (user and operational)
Line 62  into superior first order and removing n Line 48  into superior first order and removing n
 operational attributes.  operational attributes.
 .SH OPTIONS  .SH OPTIONS
 .TP  .TP
 .BI \-a \ filter  .B \-v
   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.
 Deprecated; use \fB-H\fP \fIldap:///???(filter)\fP instead.  
 .TP  .TP
 .BI \-b \ suffix   .BI \-s " subtree-dn"
 Use the specified \fIsuffix\fR to determine which database to  Only dump entries in the subtree specified by this DN.
 generate output for.  The \fB\-b\fP cannot be used in conjunction  Implies `-b subtree-dn' if no
 with the  .B \-b
   or
 .B \-n  .B \-n
 option.  option is given.
 .TP  
 .B \-c  
 Enable continue (ignore errors) mode.  
 Multiple occorrences of  
 .B \-c  
 make  
 .BR slapcat (8)  
 try harder.  
 .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 113  default config directory will be made be Line 113  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
 .B \-g  .BI \-l " ldif-file"
 disable subordinate gluing.  Only the specified database will be  
 processed, and not its glued subordinates (if any).  
 .TP  
 .B \-H \ URI  
 use dn, scope and filter from URI to only handle matching entries.  
 .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  
 to select it.  
   
 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))  
   
               ldif-wrap={no|<n>}  
   
 .in  
 \fIn\fP is the number of columns allowed for the LDIF output  
 (\fIn\fP equal to \fI0\fP uses the default, corresponding to 76).  
 Use \fIno\fP for no wrap.  
 .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.  
 Deprecated; use \fB-H\fP \fIldap:///subtree-dn\fP instead.  
 .TP  
 .B \-v  
 Enable verbose mode.  
 .SH LIMITATIONS  .SH LIMITATIONS
 For some backend types, your  In general, 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. It is  mode) when you do this to ensure consistency of the database.
 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 187  give the command: Line 127  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 199  give the command: Line 139  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
 .so ../Project  .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.  

Removed from v.1.28.2.17  
changed lines
  Added in v.1.29


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