← Back to branch summary

~ttx/openldap/lucid-gssapi-495418

« back to all changes in this revision

Viewing changes to doc/man/man8/slapcat.8

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2009-07-28 10:17:15 UTC
  • mto: (0.3.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 16.
  • Revision ID: james.westby@ubuntu.com-20090728101715-g0isvetelfeqm48k
Tags: upstream-2.4.17
Import upstream version 2.4.17

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man8/slapcat.8
1
1
.TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
2
2
.\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.
3
3
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
4
 
.\" $OpenLDAP: pkg/ldap/doc/man/man8/slapcat.8,v 1.28.2.10 2009/01/30 19:47:21 quanah Exp $
 
4
.\" $OpenLDAP: pkg/ldap/doc/man/man8/slapcat.8,v 1.28.2.11 2009/06/03 01:42:01 quanah Exp $
5
5
.SH NAME
6
6
slapcat \- SLAPD database to LDIF utility
7
7
.SH SYNOPSIS
8
8
.B SBINDIR/slapcat
9
 
.B [\-a filter]
10
 
.B [\-b suffix]
11
 
.B [\-c]
12
 
.B [\-d level]
13
 
.B [\-f slapd.conf]
14
 
.B [\-F confdir]
15
 
.B [\-g]
16
 
.B [\-l ldif-file]
17
 
.B [\-n dbnum]
18
 
.B [\-o name[=value]]
19
 
.B [\-s subtree-dn]
20
 
.B [\-v]
21
 
.B 
 
9
[\c
 
10
.BI \-a filter\fR]
 
11
[\c
 
12
.BI \-b suffix\fR]
 
13
[\c
 
14
.BR \-c ]
 
15
[\c
 
16
.BI \-d debug-level\fR]
 
17
[\c
 
18
.BI \-f slapd.conf\fR]
 
19
[\c
 
20
.BI \-F confdir\fR]
 
21
[\c
 
22
.BR \-g ]
 
23
[\c
 
24
.BI \-l ldif-file\fR]
 
25
[\c
 
26
.BI \-n dbnum\fR]
 
27
[\c
 
28
.BI \-o option\fR[ = value\fR]]
 
29
[\c
 
30
.BI \-s subtree-dn\fR]
 
31
[\c
 
32
.BR \-v ]
22
33
.LP
23
34
.SH DESCRIPTION
24
35
.LP
32
43
the specified file.
33
44
Databases configured as
34
45
.B subordinate
35
 
of this one are also output, unless \fB-g\fP is specified.
 
46
of this one are also output, unless \fB\-g\fP is specified.
36
47
.LP
37
48
The entry records are presented in database order, not superior first
38
49
order.  The entry records will include all (user and operational)
49
60
operational attributes.
50
61
.SH OPTIONS
51
62
.TP
52
 
.BI \-a " filter"
 
63
.BI \-a \ filter
53
64
Only dump entries matching the asserted filter.
54
65
For example
55
66
 
56
 
slapcat -a \\
 
67
slapcat \-a \\
57
68
    "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))"
58
69
 
59
70
will dump all but the "ou=People,dc=example,dc=com" subtree
60
71
of the "dc=example,dc=com" database.
61
72
.TP
62
 
.BI \-b " suffix" 
 
73
.BI \-b \ suffix 
63
74
Use the specified \fIsuffix\fR to determine which database to
64
 
generate output for.  The \-b cannot be used in conjunction
 
75
generate output for.  The \fB\-b\fP cannot be used in conjunction
65
76
with the
66
77
.B \-n
67
78
option.
69
80
.B \-c
70
81
Enable continue (ignore errors) mode.
71
82
.TP
72
 
.BI \-d " level"
 
83
.BI \-d \ debug-level
73
84
Enable debugging messages as defined by the specified
74
 
.IR level ;
 
85
.IR debug-level ;
75
86
see
76
87
.BR slapd (8)
77
88
for details.
78
89
.TP
79
 
.BI \-f " slapd.conf"
 
90
.BI \-f \ slapd.conf
80
91
Specify an alternative
81
92
.BR slapd.conf (5)
82
93
file.
83
94
.TP
84
 
.BI \-F " confdir"
 
95
.BI \-F \ confdir
85
96
specify a config directory.
86
97
If both
87
 
.B -f
 
98
.B \-f
88
99
and
89
 
.B -F
 
100
.B \-F
90
101
are specified, the config file will be read and converted to
91
102
config directory format and written to the specified directory.
92
103
If neither option is specified, an attempt to read the
98
109
disable subordinate gluing.  Only the specified database will be
99
110
processed, and not its glued subordinates (if any).
100
111
.TP
101
 
.BI \-l " ldif-file"
 
112
.BI \-l \ ldif-file
102
113
Write LDIF to specified file instead of standard output.
103
114
.TP
104
 
.BI \-n " dbnum"
105
 
Generate output for the \fIdbnum\fR\-th database listed in the
 
115
.BI \-n \ dbnum
 
116
Generate output for the \fIdbnum\fR-th database listed in the
106
117
configuration file. The config database
107
 
.BR slapd-config (5),
 
118
.BR slapd\-config (5),
108
119
is always the first database, so use
109
120
.B \-n 0
110
121
 
114
125
.B \-b
115
126
option.
116
127
.TP
117
 
.BI \-o " option[=value]"
 
128
.BI \-o \ option\fR[ = value\fR]
118
129
Specify an
119
 
.BR option
 
130
.I option
120
131
with a(n optional)
121
 
.BR value .
 
132
.IR value .
122
133
Possible generic options/values are:
123
134
.LP
124
135
.nf
125
136
              syslog=<subsystems>  (see `\-s' in slapd(8))
126
 
              syslog-level=<level> (see `\-S' in slapd(8))
127
 
              syslog-user=<user>   (see `\-l' in slapd(8))
 
137
              syslog\-level=<level> (see `\-S' in slapd(8))
 
138
              syslog\-user=<user>   (see `\-l' in slapd(8))
128
139
 
129
140
.fi
130
141
.TP
131
 
.BI \-s " subtree-dn"
 
142
.BI \-s \ subtree-dn
132
143
Only dump entries in the subtree specified by this DN.
133
 
Implies `-b subtree-dn' if no
 
144
Implies \fB\-b\fP \fIsubtree-dn\fP if no
134
145
.B \-b
135
146
or
136
147
.B \-n
146
157
always safe to run 
147
158
.B slapcat
148
159
with the
149
 
.BR slapd-bdb (5),
150
 
.BR slapd-hdb (5),
 
160
.BR slapd\-bdb (5),
 
161
.BR slapd\-hdb (5),
151
162
and
152
 
.BR slapd-null (5)
 
163
.BR slapd\-null (5)
153
164
backends.
154
165
.SH EXAMPLES
155
166
To make a text backup of your SLAPD database and put it in a file called
158
169
.LP
159
170
.nf
160
171
.ft tt
161
 
        SBINDIR/slapcat -l ldif
 
172
        SBINDIR/slapcat \-l ldif
162
173
.ft
163
174
.fi
164
175
.SH "SEE ALSO"