git.sur5r.net Git - openldap/blob - doc/man/man1/ldapmodrdn.1

   1 .TH LDAPMODRDN 1 "10 November 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 ldapmodrdn \- ldap modify entry RDN tool
   4 .SH SYNOPSIS
   5 .B ldapmodrdn
   6 .B [\-r]
   7 .B [\-n]
   8 .B [\-v]
   9 .B [\-k]
  10 .B [\-K]
  11 .B [\-c]
  12 .B [\-d debuglevel]
  13 .B [\-D binddn]
  14 .B [\-w passwd]
  15 .B [\-h ldaphost]
  16 .B [\-p ldapport]
  17 .B [\-f file] [dn rdn]
  18 .SH DESCRIPTION
  19 .B ldapmodrdn
  20 is a shell-accessible interface to the
  21 .BR ldap_modrdn2 (3)
  22 library call.
  23 .LP
  24 .B ldapmodrdn
  25 opens a connection to an LDAP server, binds, and modifies the RDN of entries.
  26 The entry information is read from standard input, from \fIfile\fP through
  27 the use of the
  28 .RI \- f
  29 option, or from the command-line pair \fIdn\fP and
  30 \fIrdn\fP.
  31 .SH OPTIONS
  32 .TP
  33 .B \-r
  34 Remove old RDN values from the entry.  Default is to keep old values.
  35 .TP
  36 .B \-n
  37 Show what would be done, but don't actually change entries.  Useful for
  38 debugging in conjunction with -v.
  39 .TP
  40 .B \-v
  41 Use verbose mode, with many diagnostics written to standard output.
  42 .TP
  43 .B \-k
  44 Use Kerberos authentication instead of simple authentication.  It is
  45 assumed that you already have a valid ticket granting ticket.
  46 .B ldapmodrdn
  47 must be compiled with KERBEROS defined for this option to have effect.
  48 .TP
  49 .B \-K
  50 Same as \-k, but only does step 1 of the kerberos bind.  This is useful
  51 when connecting to a slapd and there is no x500dsa.hostname principal
  52 registered with your kerberos servers.
  53 .TP
  54 .B \-c
  55 Continuous operation mode.  Errors  are  reported,  but ldapmodify
  56 will  continue  with  modifications.   The default is to exit after
  57 reporting an error.
  58 .TP
  59 .B \-d debuglevel
  60 Set the LDAP debugging level to \fIdebuglevel\fP.
  61 .B ldapmodrdn
  62 must be
  63 compiled with LDAP_DEBUG defined for this option to have any effect.
  64 .TP
  65 .B \-f file
  66 Read the entry modification information from \fIfile\fP instead of from
  67 standard input or the command-line.
  68 .TP
  69 .B \-D binddn
  70 Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be
  71 a string-represented DN as defined in RFC 1779.
  72 .TP
  73 .B \-w passwd
  74 Use \fIpasswd\fP as the password for simple authentication.
  75 .TP
  76 .B \-h ldaphost
  77 Specify an alternate host on which the ldap server is running.
  78 .TP
  79 .B \-p ldapport
  80 Specify an alternate TCP port where the ldap server is listening.
  81 .SH INPUT FORMAT
  82 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
  83 will replace the RDN of the entry specified by the DN, \fIdn\fP.
  84 .LP
  85 Otherwise, the contents of \fIfile\fP (or standard input if
  86 no
  87 .RI \- f
  88 flag is given) should consist of one or more entries.
  89 .LP
  90 .nf
  91     Distinguished Name (DN)
  92     Relative Distinguished Name (RDN)
  93 .fi
  94 .LP
  95 One or more blank lines may be used to separate each DN/RDN pair.
  96 .SH EXAMPLE
  97 Assuming that the file
  98 .B /tmp/entrymods
  99 exists and has the contents:
 100 .LP
 101 .nf
 102     cn=Modify Me, o=University of Michigan, c=US
 103     cn=The New Me
 104 .fi
 105 .LP
 106 the command:
 107 .LP
 108 .nf
 109     ldapmodify -r -f /tmp/entrymods
 110 .fi
 111 .LP
 112 will change the RDN of the "Modify Me" entry from "Modify Me" to
 113 "The New Me" and the old cn, "Modify Me" will be removed.
 114 .LP
 115 .SH DIAGNOSTICS
 116 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
 117 status and a diagnostic message being written to standard error.
 118 .SH "SEE ALSO"
 119 .BR ldapadd (1),
 120 .BR ldapdelete (1),
 121 .BR ldapmodify (1),
 122 .BR ldapsearch (1),
 123 .BR ldap.conf (5),
 124 .BR ldap (3),
 125 .BR ldap_modrdn2 (3)
 126 .LP
 127 Kille, S.,
 128 .IR "A String Representation of Distinguished Names",
 129 .SM RFC
 130 1779,
 131 ISODE Consortium, March 1995.
 132 .SH BUGS
 133 There is no interactive mode, but there probably should be.
 134 .SH ACKNOWLEDGEMENTS
 135 .B      OpenLDAP
 136 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 137 .B      OpenLDAP
 138 is derived from University of Michigan LDAP 3.3 Release.