~ttx/openldap/lucid-gssapi-495418

« back to all changes in this revision

Viewing changes to doc/man/man1/ldapmodrdn.1

  • 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:
1
1
.TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
2
 
.\" $OpenLDAP: pkg/ldap/doc/man/man1/ldapmodrdn.1,v 1.38.2.6 2009/01/22 00:00:48 kurt Exp $
 
2
.\" $OpenLDAP: pkg/ldap/doc/man/man1/ldapmodrdn.1,v 1.38.2.8 2009/06/08 18:23:33 quanah Exp $
3
3
.\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.
4
4
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
5
5
.SH NAME
17
17
[\c
18
18
.BR \-c ]
19
19
[\c
20
 
.BR \-M[M] ]
 
20
.BR \-M [ M ]]
21
21
[\c
22
22
.BI \-d \ debuglevel\fR]
23
23
[\c
35
35
[\c
36
36
.BI \-p \ ldapport\fR]
37
37
[\c
38
 
.BI \-P \ 2\fR\||\|\fI3\fR]
39
 
[\c
40
 
.BR \-O \ security-properties ]
 
38
.BR \-P \ { 2 \||\| 3 }]
 
39
[\c
 
40
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
 
41
[\c
 
42
.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
 
43
[\c
 
44
.BI \-O \ security-properties\fR]
41
45
[\c
42
46
.BR \-I ]
43
47
[\c
53
57
[\c
54
58
.BI \-Y \ mech\fR]
55
59
[\c
56
 
.BR \-Z[Z] ]
 
60
.BR \-Z [ Z ]]
57
61
[\c
58
62
.BI \-f \ file\fR]
59
63
[\c
82
86
.TP
83
87
.B \-n
84
88
Show what would be done, but don't actually change entries.  Useful for
85
 
debugging in conjunction with -v.
 
89
debugging in conjunction with \fB\-v\fP.
86
90
.TP
87
91
.B \-v
88
92
Use verbose mode, with many diagnostics written to standard output.
92
96
will  continue  with  modifications.   The default is to exit after
93
97
reporting an error.
94
98
.TP
95
 
.B \-M[M]
 
99
.BR \-M [ M ]
96
100
Enable manage DSA IT control.
97
101
.B \-MM
98
102
makes control critical.
99
103
.TP
100
 
.B \-d debuglevel
 
104
.BI \-d \ debuglevel
101
105
Set the LDAP debugging level to \fIdebuglevel\fP.
102
106
.B ldapmodrdn
103
107
must be
104
108
compiled with LDAP_DEBUG defined for this option to have any effect.
105
109
.TP
106
 
.B \-f file
 
110
.BI \-f \ file
107
111
Read the entry modification information from \fIfile\fP instead of from
108
112
standard input or the command-line.
109
113
.TP
110
114
.B \-x 
111
115
Use simple authentication instead of SASL.
112
116
.TP
113
 
.B \-D binddn
 
117
.BI \-D \ binddn
114
118
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
115
 
For SASL Binds, the server is expected to ignore this value.
 
119
For SASL binds, the server is expected to ignore this value.
116
120
.TP
117
121
.B \-W
118
122
Prompt for simple authentication.
119
123
This is used instead of specifying the password on the command line.
120
124
.TP
121
 
.B \-w passwd
 
125
.BI \-w \ passwd
122
126
Use \fIpasswd\fP as the password for simple authentication.
123
127
.TP
124
128
.BI \-y \ passwdfile
132
136
.TP
133
137
.BI \-h \ ldaphost
134
138
Specify an alternate host on which the ldap server is running.
135
 
Deprecated in favor of -H.
 
139
Deprecated in favor of \fB\-H\fP.
136
140
.TP
137
141
.BI \-p \ ldapport
138
142
Specify an alternate TCP port where the ldap server is listening.
139
 
Deprecated in favor of -H.
 
143
Deprecated in favor of \fB\-H\fP.
140
144
.TP
141
 
.BI \-P \ 2\fR\||\|\fI3
 
145
.BR \-P \ { 2 \||\| 3 }
142
146
Specify the LDAP protocol version to use.
143
147
.TP
144
148
.BI \-O \ security-properties
145
149
Specify SASL security properties.
146
150
.TP
 
151
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 
152
.TP
 
153
.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 
154
 
 
155
Specify general extensions with \fB\-e\fP and search extensions with \fB\-E\fP.
 
156
\'\fB!\fP\' indicates criticality.
 
157
 
 
158
General extensions:
 
159
.nf
 
160
  [!]assert=<filter>   (an RFC 4515 Filter)
 
161
  [!]authzid=<authzid> ("dn:<dn>" or "u:<user>")
 
162
  [!]manageDSAit
 
163
  [!]noop
 
164
  ppolicy
 
165
  [!]postread[=<attrs>]        (a comma-separated attribute list)
 
166
  [!]preread[=<attrs>] (a comma-separated attribute list)
 
167
  abandon, cancel (SIGINT sends abandon/cancel; not really controls)
 
168
.fi
 
169
 
 
170
Search extensions:
 
171
.nf
 
172
  [!]domainScope                               (domain scope)
 
173
  [!]mv=<filter>                               (matched values filter)
 
174
  [!]pr=<size>[/prompt|noprompt]       (paged results/prompt)
 
175
  [!]sss=[\-]<attr[:OID]>[/[\-]<attr[:OID]>...]  (server side sorting)
 
176
  [!]subentries[=true|false]           (subentries)
 
177
  [!]sync=ro[/<cookie>]                        (LDAP Sync refreshOnly)
 
178
          rp[/<cookie>][/<slimit>]     (LDAP Sync refreshAndPersist)
 
179
.fi
 
180
.TP
147
181
.B \-I
148
182
Enable SASL Interactive mode.  Always prompt.  Default is to prompt
149
183
only as needed.
163
197
Specify the requested authorization ID for SASL bind.
164
198
.I authzid
165
199
must be one of the following formats:
166
 
.B dn:\c
167
 
.I <distinguished name>
 
200
.BI dn: "<distinguished name>"
168
201
or
169
 
.B u:\c
170
 
.I <username>
 
202
.BI u: <username>
171
203
.TP
172
204
.BI \-Y \ mech
173
205
Specify the SASL mechanism to be used for authentication. If it's not
174
206
specified, the program will choose the best mechanism the server knows.
175
207
.TP
176
 
.B \-Z[Z]
 
208
.BR \-Z [ Z ]
177
209
Issue StartTLS (Transport Layer Security) extended operation. If you use
178
 
.B \-ZZ\c
179
 
, the command will require the operation to be successful.
 
210
\fB\-ZZ\fP, the command will require the operation to be successful.
180
211
.SH INPUT FORMAT
181
212
If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
182
213
will replace the RDN of the entry specified by the DN, \fIdn\fP.
183
214
.LP
184
215
Otherwise, the contents of \fIfile\fP (or standard input if
185
 
no
186
 
.RI \- f
187
 
flag is given) should consist of one or more entries.
 
216
no \fB\-f\fP flag is given) should consist of one or more entries.
188
217
.LP
189
218
.nf
190
219
    Distinguished Name (DN)
205
234
the command:
206
235
.LP
207
236
.nf
208
 
    ldapmodrdn -r -f /tmp/entrymods
 
237
    ldapmodrdn \-r \-f /tmp/entrymods
209
238
.fi
210
239
.LP
211
240
will change the RDN of the "Modify Me" entry from "Modify Me" to