.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
.TH LDAPVI "1" "May 2007" "ldapvi 1.7" "User Commands"
.SH NAME
ldapvi \- LDAP client
.SH SYNOPSIS
.B ldapvi
[\fIOPTION\fR]... [\fIFILTER\fR] [\fIAD\fR]...
.SH DESCRIPTION
.SS "Quickstart:"
.IP
ldapvi \fB\-\-discover\fR \fB\-\-host\fR HOSTNAME
.PP
Perform an LDAP search and update results using a text editor.
.SS "Other usage:"
.TP
ldapvi \fB\-\-out\fR [OPTION]... [FILTER] [AD]...
Print entries
.TP
ldapvi \fB\-\-in\fR [OPTION]... [FILENAME]
Load change records
.TP
ldapvi \fB\-\-delete\fR [OPTION]... DN...
Edit a delete record
.TP
ldapvi \fB\-\-rename\fR [OPTION]... DN1 DN2
Edit a rename record
.SS "Connection options:"
.TP
\fB\-h\fR, \fB\-\-host\fR URL
Server.
.TP
\fB\-D\fR, \fB\-\-user\fR USER
Search filter or DN: User to bind as.     [1]
Sets \fB\-\-bind\fR simple.
.TP
\fB\-w\fR, \fB\-\-password\fR SECRET
Password (also valid for SASL).
.TP
\fB\-\-bind\fR [simple,sasl]
Disable or enable SASL.
.TP
\fB\-\-bind\-dialog\fR [never,auto,always]
Interactive login dialog.
.SS "SASL options (these parameters set \-\-bind sasl):"
.HP
\fB\-I\fR, \fB\-\-sasl\-interactive\fR Set \fB\-\-bind\-dialog\fR always.
.TP
\fB\-O\fR, \fB\-\-sasl\-secprops\fR P
SASL security properties.
.TP
\fB\-Q\fR, \fB\-\-sasl\-quiet\fR
Set \fB\-\-bind\-dialog\fR never.
.TP
\fB\-R\fR, \fB\-\-sasl\-realm\fR
R  SASL realm.
.TP
\fB\-U\fR, \fB\-\-sasl\-authcid\fR AC
SASL authentication identity.
.TP
\fB\-X\fR, \fB\-\-sasl\-authzid\fR AZ
SASL authorization identity.
.TP
\fB\-Y\fR, \fB\-\-sasl\-mech\fR
MECH  SASL mechanism.
.SS "Search parameters:"
.TP
\fB\-b\fR, \fB\-\-base\fR DN
Search base.
.TP
\fB\-s\fR, \fB\-\-scope\fR SCOPE
Search scope.  One of base|one|sub.
.TP
\fB\-S\fR, \fB\-\-sort\fR KEYS
Sort control (critical).
.SS "Miscellaneous options:"
.TP
\fB\-\-add\fR
(Only with \fB\-\-in\fR, \fB\-\-ldapmodify\fR:)
Treat attrval records as new entries to add.
.TP
\fB\-o\fR, \fB\-\-class\fR OBJCLASS
Class to add.  Can be repeated.  Implies \fB\-A\fR.
.TP
\fB\-\-config\fR
Print parameters in ldap.conf syntax.
.TP
\fB\-c\fR  \fB\-\-continue\fR
Ignore LDAP errors and continue processing.
.TP
\fB\-\-deleteoldrdn\fR
(Only with \fB\-\-rename\fR:) Delete the old RDN.
.TP
\fB\-a\fR, \fB\-\-deref\fR
never|searching|finding|always
.TP
\fB\-d\fR, \fB\-\-discover\fR
Auto\-detect naming contexts.              [2]
.TP
\fB\-A\fR, \fB\-\-empty\fR
Don't search, start with empty file.  See \fB\-o\fR.
.TP
\fB\-\-encoding\fR [ASCII|UTF\-8|binary]
The encoding to allow.  Default is UTF\-8.
.TP
\fB\-H\fR, \fB\-\-help\fR
This help.
.TP
\fB\-\-ldap\-conf\fR
Always read libldap configuration.
.TP
\fB\-m\fR, \fB\-\-may\fR
Show missing optional attributes as comments.
.TP
\fB\-M\fR, \fB\-\-managedsait\fR
manageDsaIT control (critical).
.TP
\fB\-\-noquestions\fR
Commit without asking for confirmation.
.TP
\-!, \fB\-\-noninteractive\fR
Never ask any questions.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Disable progress output.
.TP
\fB\-R\fR, \fB\-\-read\fR DN
Same as \fB\-b\fR DN \fB\-s\fR base '(objectclass=*)' + *
.TP
\fB\-Z\fR, \fB\-\-starttls\fR
Require startTLS.
.TP
\fB\-\-tls\fR [never|allow|try|strict]
Level of TLS strictess.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Note every update.
.SS "Shortcuts:"
.TP
\fB\-\-ldapsearch\fR
Short for \fB\-\-quiet\fR \fB\-\-out\fR
.TP
\fB\-\-ldapmodify\fR
Short for \fB\-\-noninteractive\fR \fB\-\-in\fR
.TP
\fB\-\-ldapdelete\fR
Short for \fB\-\-noninteractive\fR \fB\-\-delete\fR
.TP
\fB\-\-ldapmoddn\fR
Short for \fB\-\-noninteractive\fR \fB\-\-rename\fR
.PP
Environment variables: VISUAL, EDITOR, PAGER.
.SS "[1] User names can be specified as distinguished names:"
.IP
uid=foo,ou=bar,dc=acme,dc=com
.IP
or search filters:
.IP
(uid=foo)
.IP
Note the use of parenthesis, which can be omitted from search
filters usually but are required here.  For this searching bind to
work, your client library must be configured with appropriate
default search parameters.
.PP
[2] Repeat the search for each naming context found and present the
.TP
concatenation of all search results.
Conflicts with \fB\-\-base\fR.
.IP
With \fB\-\-config\fR, show a BASE configuration line for each context.
.PP
A special (offline) option is \fB\-\-diff\fR, which compares two files
and writes any changes to standard output in LDIF format.
.SH "REPORTING BUGS"
Report bugs to "ldapvi@lists.askja.de".
.SH GETTING STARTED
Assuming a suitably configured LDAP library, run ldapvi without arguments
to see all entries available. 

Otherwise, try `ldapvi \-h HOSTNAME \-\-discover' to query the ROOT DSE for
available naming contexts.

Once that works, run `ldapvi \-h HOSTNAME \-\-discover \-\-config' to
generate sample configuration that can be pasted into ~/.ldaprc or
/etc/ldap/ldap.conf.

.SH FILE FORMAT
ldapvi uses an LDIF-like syntax, but not standard LDIF.  Please refer to
http://www.lichteblau.com/ldapvi/manual.xml#syntax

.SH BUGS
Please report bugs to <ldapvi@lists.askja.de>.

.SH SEE ALSO
http://www.lichteblau.com/ldapvi/manual.xml

.SH AUTHOR
David Lichteblau <david@lichteblau.com>