mirror/openldap
2
0
Fork 0
mirror of https://git.openldap.org/openldap/openldap.git synced 2024-12-21 03:10:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clean up RFC references

Browse Source
This commit is contained in:
Kurt Zeilenga 2000-08-20 06:21:38 +00:00
parent 2683cd6fe6
commit 26fc5be75b
5 changed files with 70 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/man/man1/ldapdelete.1
View File

@ -62,9 +62,10 @@ library call.
.LP .LP
.B ldapdelete .B ldapdelete
opens a connection to an LDAP server, binds, and deletes one or more opens a connection to an LDAP server, binds, and deletes one or more
entries. If one or more \fIdn\fP arguments are provided, entries with entries. If one or more \fIDN\fP arguments are provided, entries with
those Distinguished Names are deleted. Each \fIdn\fP should be a those Distinguished Names are deleted. Each \fIDN\fP should be provided
string-represented DN as defined in RFC 1779. If no \fIdn\fP arguments using the LDAPv3 string representation as defined in RFC 2253.
If no \fIdn\fP arguments
are provided, a list of DNs is read from standard input (or from are provided, a list of DNs is read from standard input (or from
\fIfile\fP if the -f flag is used). \fIfile\fP if the -f flag is used).
.SH OPTIONS .SH OPTIONS
@ -117,8 +118,7 @@ replaced with a line from \fIfile\fP.
Use simple authentication instead of SASL. Use simple authentication instead of SASL.
.TP .TP
.BI \-D \ binddn .BI \-D \ binddn
Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
a string-represented DN as defined in RFC 1779.
.TP .TP
.B \-W .B \-W
Prompt for simple authentication. Prompt for simple authentication.
@ -196,12 +196,6 @@ status and a diagnostic message being written to standard error.
.BR ldapsearch (1), .BR ldapsearch (1),
.BR ldap (3), .BR ldap (3),
.BR ldap_delete (3) .BR ldap_delete (3)
.LP
Kille, S.,
.IR "A String Representation of Distinguished Names",
.SM RFC
1779,
ISODE Consortium, March 1995.
.SH BUGS .SH BUGS
There is no interactive mode, but there probably should be. There is no interactive mode, but there probably should be.
.SH AUTHOR .SH AUTHOR

9
doc/man/man1/ldapmodify.1
View File

@ -188,8 +188,7 @@ standard input.
Use simple authentication instead of SASL. Use simple authentication instead of SASL.
.TP .TP
.BI \-D \ binddn .BI \-D \ binddn
Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
a string-represented DN as defined in RFC 1779.
.TP .TP
.B \-W .B \-W
Prompt for simple authentication. Prompt for simple authentication.
@ -416,12 +415,6 @@ status and a diagnostic message being written to standard error.
.BR ldap_modify (3), .BR ldap_modify (3),
.BR ldap_modrdn (3), .BR ldap_modrdn (3),
.BR slapd.replog (5) .BR slapd.replog (5)
.LP
Kille, S.,
.IR "A String Representation of Distinguished Names",
.SM RFC
1779,
ISODE Consortium, March 1995.
.SH BUGS .SH BUGS
There is no interactive mode, but there probably should be. There is no interactive mode, but there probably should be.
.SH AUTHOR .SH AUTHOR

9
doc/man/man1/ldapmodrdn.1
View File

@ -119,8 +119,7 @@ standard input or the command-line.
Use simple authentication instead of SASL. Use simple authentication instead of SASL.
.TP .TP
.B \-D binddn .B \-D binddn
Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
a string-represented DN as defined in RFC 1779.
.TP .TP
.B \-W .B \-W
Prompt for simple authentication. Prompt for simple authentication.
@ -215,12 +214,6 @@ status and a diagnostic message being written to standard error.
.BR ldap.conf (5), .BR ldap.conf (5),
.BR ldap (3), .BR ldap (3),
.BR ldap_modrdn2 (3) .BR ldap_modrdn2 (3)
.LP
Kille, S.,
.IR "A String Representation of Distinguished Names",
.SM RFC
1779,
ISODE Consortium, March 1995.
.SH BUGS .SH BUGS
There is no interactive mode, but there probably should be. There is no interactive mode, but there probably should be.
.SH AUTHOR .SH AUTHOR

3
doc/man/man1/ldappasswd.1
View File

@ -78,8 +78,7 @@ Automatically chase referrals.
Use simple authentication instead of SASL. Use simple authentication instead of SASL.
.TP .TP
.BI \-D \ binddn .BI \-D \ binddn
Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
be a string-represented DN as defined in RFC 2253.
This flag is not optional. The user DN will be used if the This flag is not optional. The user DN will be used if the
bind DN is not provided. bind DN is not provided.
.TP .TP

131
doc/man/man1/ldapsearch.1
View File

@ -80,7 +80,7 @@ library call.
.B ldapsearch .B ldapsearch
opens a connection to an LDAP server, binds, and performs a search opens a connection to an LDAP server, binds, and performs a search
using the filter \fIfilter\fP. The \fIfilter\fP should conform to using the filter \fIfilter\fP. The \fIfilter\fP should conform to
the string representation for LDAP filters as defined in RFC 1558. the string representation for search filters as defined in RFC 2254.
.LP .LP
If If
.B ldapsearch .B ldapsearch
@ -97,21 +97,22 @@ Show what would be done, but don't actually perform the search. Useful for
debugging in conjunction with -v. debugging in conjunction with -v.
.TP .TP
.B \-u .B \-u
Include the User Friendly form of the Distinguished Name (DN) in the output Include the User Friendly Name form of the Distinguished Name (DN)
in the output.
.TP .TP
.B \-v .B \-v
Run in verbose mode, with many diagnostics written to standard output Run in verbose mode, with many diagnostics written to standard output.
.TP .TP
.B \-k .B \-k
Use Kerberos authentication instead of simple authentication. It is Use Kerberos authentication instead of simple authentication. It is
assumed that you already have a valid ticket granting ticket. assumed that you already have a valid ticket granting ticket.
.B ldapsearch .B ldapsearch
must be compiled with KERBEROS defined for this option to have any effect. must be compiled with Kerberos for this option to have any effect.
.TP .TP
.B \-K .B \-K
Same as \-k, but only does step 1 of the kerberos bind. This is useful Same as \-k, but only does step 1 of the Kerberos bind. This is useful
when connecting to a slapd and there is no x500dsa.hostname principal when connecting to a slapd and there is no x500dsa.hostname principal
registered with your kerberos servers. registered with your Kerberos servers.
.TP .TP
.B \-t .B \-t
Write retrieved values to a set of temporary files. This is useful for Write retrieved values to a set of temporary files. This is useful for
@ -165,8 +166,7 @@ character, then the lines are read from standard input.
Use simple authentication instead of SASL. Use simple authentication instead of SASL.
.TP .TP
.BI \-D \ binddn .BI \-D \ binddn
Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
a string-represented DN as defined in RFC 1779.
.TP .TP
.B \-W .B \-W
Prompt for simple authentication. Prompt for simple authentication.
@ -263,20 +263,22 @@ Issue StartTLS (Transport Layer Security) extended operation. If you use
.B \-ZZ\c .B \-ZZ\c
, the command will require the operation to be successful. , the command will require the operation to be successful.
.SH OUTPUT FORMAT .SH OUTPUT FORMAT
If one or more entries are found, each entry is written to standard output If one or more entries are found, each entry is written to standard
in the form: output in LDAP Interchange Data Format or
.BR ldif (5):
.LP .LP
.nf .nf
Distinguished Name (DN) dn: uid=bjensen, dc=example, dc=net
User Friendly Name (this line present only if the -u option is used) objectClass: person
attributename=value objectClass: dcObject
attributename=value uid: bjensen
attributename=value cn: Barbara Jensen
sn: Jensen
... ...
.fi .fi
.LP .LP
Multiple entries are separated with a single blank line. Multiple entries are separated with a single blank line.
If the -t option is used, the name of a temporary file If the -t option is used, the URI of a temporary file
is used in place of the actual value. If the -A option is used in place of the actual value. If the -A option
is given, only the "attributename" part is written. is given, only the "attributename" part is written.
.SH EXAMPLE .SH EXAMPLE
@ -286,28 +288,30 @@ The following command:
ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber
.fi .fi
.LP .LP
will perform a subtree search (using the default search base) for will perform a subtree search (using the default search base defined
entries with a surname (sn) of smith. The common name (cn), surname in
.BR ldap.conf (5))
for entries with a surname (sn) of smith. The common name (cn), surname
(sn) and telephoneNumber values will be retrieved and printed to (sn) and telephoneNumber values will be retrieved and printed to
standard output. standard output.
The output might look something like this if two entries are found: The output might look something like this if two entries are found:
.LP .LP
.nf .nf
dn: uid=jts, ou=Volunteers, ou=People, dc=OpenLDAP, dc=org dn: uid=jts, dc=example, dc=com
cn: John Smith cn: John Smith
cn: John T. Smith cn: John T. Smith
sn: Smith sn: Smith
sn;lang-en: Smith sn;lang-en: Smith
sn;lang-de: Schmidt sn;lang-de: Schmidt
telephoneNumber: 1 555 123-4567 telephoneNumber: 1 555 123-4567
dn: uid=sss, ou=Staff, ou=People, dc=OpenLDAP, dc=org dn: uid=sss, dc=example, dc=com
cn: Steve Smith cn: Steve Smith
cn: Steve S. Smith cn: Steve S. Smith
sn: Smith sn: Smith
sn;lang-en: Smith sn;lang-en: Smith
sn;lang-de: Schmidt sn;lang-de: Schmidt
telephoneNumber: 1 555 765-4321 telephoneNumber: 1 555 765-4321
.fi .fi
.LP .LP
The command: The command:
@ -324,10 +328,10 @@ output might look like this if one entry with one value for each of the
requested attributes is found: requested attributes is found:
.LP .LP
.nf .nf
dn: uid=xyz, ou=Staff, ou=People, dc=OpenLDAP, dc=org dn: uid=xyz, dc=example, dc=com
ufn: xyz, Staff, People, OpenLDAP, org ufn: xyz, example, com
audio:< file::/tmp/ldapsearch-audio-a19924 audio:< file::/tmp/ldapsearch-audio-a19924
jpegPhoto:< file::=/tmp/ldapsearch-jpegPhoto-a19924 jpegPhoto:< file::=/tmp/ldapsearch-jpegPhoto-a19924
.fi .fi
.LP .LP
This command: This command:
@ -337,34 +341,34 @@ This command:
.fi .fi
.LP .LP
will perform a one-level search at the c=US level for all entries will perform a one-level search at the c=US level for all entries
whose organizationName (o) begins begins with \fBUniversity\fP. whose organization name (o) begins begins with \fBUniversity\fP.
The organizationName and description attribute values will be retrieved The organization name and description attribute values will be retrieved
and printed to standard output, resulting in output similar to this: and printed to standard output, resulting in output similar to this:
.LP .LP
.nf .nf
dn: o=University of Alaska Fairbanks, c=US dn: o=University of Alaska Fairbanks, c=US
o: University of Alaska Fairbanks o: University of Alaska Fairbanks
description: Preparing Alaska for a brave new yesterday description: Preparing Alaska for a brave new yesterday
description: leaf node only description: leaf node only
dn: o=University of Colorado at Boulder, c=US dn: o=University of Colorado at Boulder, c=US
o: University of Colorado at Boulder o: University of Colorado at Boulder
description: No personnel information description: No personnel information
description: Institution of education and research description: Institution of education and research
dn: o=University of Colorado at Denver, c=US dn: o=University of Colorado at Denver, c=US
o: University of Colorado at Denver o: University of Colorado at Denver
o: UCD o: UCD
o: CU/Denver o: CU/Denver
o: CU-Denver o: CU-Denver
description: Institute for Higher Learning and Research description: Institute for Higher Learning and Research
dn: o=University of Florida, c=US dn: o=University of Florida, c=US
o: University of Florida o: University of Florida
o: UFl o: UFl
description: Warper of young minds description: Warper of young minds
etc.... etc....
.fi .fi
.SH DIAGNOSTICS .SH DIAGNOSTICS
Exit status is 0 if no errors occur. Errors result in a non-zero exit Exit status is 0 if no errors occur. Errors result in a non-zero exit
@ -375,20 +379,9 @@ status and a diagnostic message being written to standard error.
.BR ldapmodify (1), .BR ldapmodify (1),
.BR ldapmodrdn (1), .BR ldapmodrdn (1),
.BR ldap.conf (5), .BR ldap.conf (5),
.BR ldif (5),
.BR ldap (3), .BR ldap (3),
.BR ldap_search (3) .BR ldap_search (3)
.LP
Kille, S.,
.IR "A String Representation of Distinguished Names",
.SM RFC
1779,
ISODE Consortium, March 1995.
.LP
Howes, T.,
.IR "A String Representation of LDAP Search Filters",
.SM RFC
1558,
University of Michigan, December 1993.
.SH AUTHOR .SH AUTHOR
The OpenLDAP Project <http://www.openldap.org/> The OpenLDAP Project <http://www.openldap.org/>
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS