Commit 7af319a5 authored by Howard Chu's avatar Howard Chu
Browse files

ITS#6023 minor formatting tweaks

parent 2be7cb3b
......@@ -13,7 +13,7 @@ ldapcompare \- LDAP compare tool
[\c
.BR \-z ]
[\c
.BR \-M[M] ]
.BR \-M [ M ]]
[\c
.BI \-d \ debuglevel\fR]
[\c
......@@ -31,9 +31,9 @@ ldapcompare \- LDAP compare tool
[\c
.BI \-p \ ldapport\fR]
[\c
.BI \-P \ 2\fR\||\|\fI3\fR]
.BR \-P \ { 2 \||\| 3 }]
[\c
.BR \-O \ security-properties ]
.BI \-O \ security-properties\fR]
[\c
.BR \-I ]
[\c
......@@ -49,10 +49,12 @@ ldapcompare \- LDAP compare tool
[\c
.BI \-Y \ mech\fR]
[\c
.BR \-Z[Z] ]
.IR DN \ <
.BR attr:value \ |
.BR attr::b64value \ >
.BR \-Z [ Z ]]
.IR DN
{\c
.BI attr: value
|
.BI attr:: b64value\fR}
.SH DESCRIPTION
.I ldapcompare
is a shell-accessible interface to the
......@@ -66,14 +68,14 @@ name in the directory. \fIAttr\fP should be a known attribute. If
followed by one colon, the assertion \fIvalue\fP should be provided
as a string. If followed by two colons, the base64 encoding of the
value is provided. The result code of the compare is provided as
the exit code and, unless ran with -z, the program prints
the exit code and, unless ran with \fB\-z\fP, the program prints
TRUE, FALSE, or UNDEFINED on standard output.
.LP
.SH OPTIONS
.TP
.B \-n
Show what would be done, but don't actually perform the compare. Useful for
debugging in conjunction with -v.
debugging in conjunction with \fB\-v\fP.
.TP
.B \-v
Run in verbose mode, with many diagnostics written to standard output.
......@@ -82,7 +84,7 @@ Run in verbose mode, with many diagnostics written to standard output.
Run in quiet mode, no output is written. You must check the return
status. Useful in shell scripts.
.TP
.B \-M[M]
.BR \-M [ M ]
Enable manage DSA IT control.
.B \-MM
makes control critical.
......@@ -97,7 +99,7 @@ Use simple authentication instead of SASL.
.TP
.BI \-D \ binddn
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
For SASL Binds, the server is expected to ignore this value.
For SASL binds, the server is expected to ignore this value.
.TP
.B \-W
Prompt for simple authentication.
......@@ -120,7 +122,7 @@ by default appends a trailing newline to the echoed string.
The recommended portable way to store a cleartext password in a file
for use with this option is to use
.BR slappasswd (8)
with \fI{CLEARTEXT}\fP as hash and the option \fI\-n\fP.
with \fI{CLEARTEXT}\fP as hash and the option \fB\-n\fP.
.TP
.BI \-H \ ldapuri
Specify URI(s) referring to the ldap server(s); only the protocol/host/port
......@@ -129,13 +131,13 @@ is expected.
.TP
.BI \-h \ ldaphost
Specify an alternate host on which the ldap server is running.
Deprecated in favor of -H.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-p \ ldapport
Specify an alternate TCP port where the ldap server is listening.
Deprecated in favor of -H.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-P \ 2\fR\||\|\fI3
.BR \-P \ { 2 \||\| 3 }
Specify the LDAP protocol version to use.
.TP
.BI \-O \ security-properties
......@@ -160,20 +162,17 @@ depends on the actual SASL mechanism used.
Specify the requested authorization ID for SASL bind.
.I authzid
must be one of the following formats:
.B dn:\c
.I <distinguished name>
.BI dn: "<distinguished name>"
or
.B u:\c
.I <username>
.BI u: <username>
.TP
.BI \-Y \ mech
Specify the SASL mechanism to be used for authentication. If it's not
specified, the program will choose the best mechanism the server knows.
.TP
.B \-Z[Z]
.BR \-Z [ Z ]
Issue StartTLS (Transport Layer Security) extended operation. If you use
.B \-ZZ\c
, the command will require the operation to be successful.
\fB\-ZZ\fP, the command will require the operation to be successful.
.SH EXAMPLES
.nf
ldapcompare "uid=babs,dc=example,dc=com" sn:Jensen
......
......@@ -13,7 +13,7 @@ ldapdelete \- LDAP delete entry tool
[\c
.BR \-c ]
[\c
.BR \-M[M] ]
.BR \-M [ M ]]
[\c
.BI \-d \ debuglevel\fR]
[\c
......@@ -31,11 +31,11 @@ ldapdelete \- LDAP delete entry tool
[\c
.BI \-h \ ldaphost\fR]
[\c
.BI \-P \ 2\fR\||\|\fI3\fR]
.BR \-P \ { 2 \||\| 3 }]
[\c
.BI \-p \ ldapport\fR]
[\c
.BR \-O \ security-properties ]
.BI \-O \ security-properties\fR]
[\c
.BI \-U \ authcid\fR]
[\c
......@@ -55,9 +55,9 @@ ldapdelete \- LDAP delete entry tool
[\c
.BI \-z \ sizelimit\fR]
[\c
.BR \-Z[Z] ]
.BR \-Z [ Z ]]
[\c
.IR dn ]...
.IR DN \ [ ... ]]
.SH DESCRIPTION
.I ldapdelete
is a shell-accessible interface to the
......@@ -69,14 +69,14 @@ 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
those Distinguished Names are deleted. Each \fIDN\fP should be provided
using the LDAPv3 string representation as defined in RFC 4514.
If no \fIdn\fP arguments
If no \fIDN\fP arguments
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 \fB\-f\fP flag is used).
.SH OPTIONS
.TP
.B \-n
Show what would be done, but don't actually delete entries. Useful for
debugging in conjunction with -v.
debugging in conjunction with \fB\-v\fP.
.TP
.B \-v
Use verbose mode, with many diagnostics written to standard output.
......@@ -87,7 +87,7 @@ Continuous operation mode. Errors are reported, but
will continue with deletions. The default is to exit after
reporting an error.
.TP
.B \-M[M]
.BR \-M [ M ]
Enable manage DSA IT control.
.B \-MM
makes control critical.
......@@ -106,7 +106,7 @@ Use simple authentication instead of SASL.
.TP
.BI \-D \ binddn
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
For SASL Binds, the server is expected to ignore this value.
For SASL binds, the server is expected to ignore this value.
.TP
.B \-W
Prompt for simple authentication.
......@@ -126,13 +126,13 @@ is expected.
.TP
.BI \-h \ ldaphost
Specify an alternate host on which the ldap server is running.
Deprecated in favor of -H.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-p \ ldapport
Specify an alternate TCP port where the ldap server is listening.
Deprecated in favor of -H.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-P \ 2\fR\||\|\fI3
.BR \-P \ { 2 \||\| 3 }
Specify the LDAP protocol version to use.
.TP
.B \-r
......@@ -144,7 +144,7 @@ happily delete large portions of your tree. Use with care.
.BI \-z \ sizelimit
Use \fIsizelimit\fP when searching for children DN to delete,
to circumvent any server-side size limit. Only useful in conjunction
with \-r.
with \fB\-r\fP.
.TP
.BI \-O \ security-properties
Specify SASL security properties.
......@@ -168,20 +168,17 @@ depends on the actual SASL mechanism used.
Specify the requested authorization ID for SASL bind.
.I authzid
must be one of the following formats:
.B dn:\c
.I <distinguished name>
.BI dn: "<distinguished name>"
or
.B u:\c
.I <username>
.BI u: <username>
.TP
.BI \-Y \ mech
Specify the SASL mechanism to be used for authentication. If it's not
specified, the program will choose the best mechanism the server knows.
.TP
.B \-Z[Z]
.BR \-Z [ Z ]
Issue StartTLS (Transport Layer Security) extended operation. If you use
.B \-ZZ\c
, the command will require the operation to be successful.
\fB\-ZZ\fP, the command will require the operation to be successful.
.SH EXAMPLE
The following command:
.LP
......
......@@ -24,7 +24,7 @@ ldapexop
[\c
.BI \-D \ binddn\fR]
[\c
.BI \-e \ [!]ext[=extparam]\fR]
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
[\c
.BI \-f \ file\fR]
[\c
......@@ -40,7 +40,7 @@ ldapexop
[\c
.BI \-O \ security-properties\fR]
[\c
.BI \-o \ [!]ext[=extparam]\fR]
.BI \-o \ opt\fR[\fP = optparam\fR]]
[\c
.BI \-p \ port\fR]
[\c
......@@ -66,8 +66,8 @@ ldapexop
[\c
.BI \-Y \ mech\fR]
[\c
.BR \-Z[Z] ]
\ {
.BR \-Z [ Z ]]
{\c
.I oid
|
.BI oid: data
......@@ -78,8 +78,7 @@ ldapexop
|
.BI cancel \ cancel-id
|
.BI refresh \ DN \ \fR[\fIttl\fR]
}
.BI refresh \ DN \ \fR[\fIttl\fR]}
.SH DESCRIPTION
ldapexop issues the LDAP extended operation specified by \fBoid\fP
......@@ -128,7 +127,7 @@ Set the LDAP debugging level to \fIlevel\fP.
.BI \-D \ binddn
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
.TP
.BI \-e \ [!]ext[=extparam]
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
Specify general extensions. \'!\' indicates criticality.
.nf
[!]assert=<filter> (RFC 4528; a RFC 4515 Filter string)
......@@ -152,7 +151,7 @@ Read operations from \fIfile\fP.
.TP
.BI \-h \ host
Specify the host on which the ldap server is running.
Deprecated in favor of \fB-H\fP.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-H \ URI
Specify URI(s) referring to the ldap server(s); only the protocol/host/port
......@@ -165,7 +164,7 @@ only as needed.
.TP
.BI \-n
Show what would be done but don't actually do it.
Useful for debugging in conjunction with \fB-v\fP.
Useful for debugging in conjunction with \fB\-v\fP.
.TP
.BI \-N
Do not use reverse DNS to canonicalize SASL host name.
......@@ -173,7 +172,7 @@ Do not use reverse DNS to canonicalize SASL host name.
.BI \-O \ security-properties
Specify SASL security properties.
.TP
.BI \-o \ opt[=optparam]
.BI \-o \ opt\fR[\fP = optparam\fR]
Specify general options:
.nf
nettimeout=<timeout> (in seconds, or "none" or "max")
......@@ -181,7 +180,7 @@ Specify general options:
.TP
.BI \-p \ port
Specify the TCP port where the ldap server is listening.
Deprecated in favor of \fB-H\fP.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-Q
Enable SASL Quiet mode. Never prompt.
......@@ -199,7 +198,7 @@ Run in verbose mode, with many diagnostics written to standard output.
.TP
.BI \-V
Print version info and usage message.
If\fB-VV\fP is given, only the version information is printed.
If\fB\-VV\fP is given, only the version information is printed.
.TP
.BI \-w \ passwd
Use \fIpasswd\fP as the password for simple authentication.
......@@ -215,11 +214,9 @@ Use simple authentication instead of SASL.
Specify the requested authorization ID for SASL bind.
.I authzid
must be one of the following formats:
.B dn:\c
.I <distinguished name>
.BI dn: "<distinguished name>"
or
.B u:\c
.I <username>
.BI u: <username>
.TP
.BI \-y \ file
Use complete contents of \fIfile\fP as the password for
......@@ -229,9 +226,9 @@ simple authentication.
Specify the SASL mechanism to be used for authentication.
Without this option, the program will choose the best mechanism the server knows.
.TP
.B \-Z[Z]
.BR \-Z [ Z ]
Issue StartTLS (Transport Layer Security) extended operation.
Giving it twice (\fB-ZZ\fP) will require the operation to be successful.
Giving it twice (\fB\-ZZ\fP) will require the operation to be successful.
.SH DIAGNOSTICS
Exit status is zero if no errors occur.
......@@ -248,5 +245,5 @@ with \fBldapexop\fP.
Do not expect it to be complete or absolutely correct.
.SH ACKNOWLEDGEMENTS
The OpenLDAP Project <http://www.openldap.org/>
.so ../Project
......@@ -17,7 +17,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
[\c
.BR \-v ]
[\c
.BR \-M[M] ]
.BR \-M [ M ]]
[\c
.BI \-d \ debuglevel\fR]
[\c
......@@ -35,9 +35,9 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
[\c
.BI \-p \ ldapport\fR]
[\c
.BI \-P \ 2\fR\||\|\fI3\fR]
.BR \-P \ { 2 \||\| 3 }]
[\c
.BR \-O \ security-properties ]
.BI \-O \ security-properties\fR]
[\c
.BR \-I ]
[\c
......@@ -53,7 +53,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
[\c
.BI \-Y \ mech\fR]
[\c
.BR \-Z[Z] ]
.BR \-Z [ Z ]]
[\c
.BI \-f \ file\fR]
.LP
......@@ -67,7 +67,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
[\c
.BR \-v ]
[\c
.BR \-M[M] ]
.BR \-M [ M ]]
[\c
.BI \-d \ debuglevel\fR]
[\c
......@@ -85,9 +85,9 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
[\c
.BI \-p \ ldapport\fR]
[\c
.BI \-P \ 2\fR\||\|\fI3\fR]
.BR \-P \ { 2 \||\| 3 }]
[\c
.BR \-O \ security-properties ]
.BI \-O \ security-properties\fR]
[\c
.BR \-I ]
[\c
......@@ -103,7 +103,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
[\c
.BI \-Y \ mech\fR]
[\c
.BR \-Z[Z] ]
.BR \-Z [ Z ]]
[\c
.BI \-f \ file\fR]
.SH DESCRIPTION
......@@ -118,12 +118,12 @@ library calls.
.B ldapadd
is implemented as a hard link to the ldapmodify tool. When invoked as
.B ldapadd
the -a (add new entry) flag is turned on automatically.
the \fB\-a\fP (add new entry) flag is turned on automatically.
.LP
.B ldapmodify
opens a connection to an LDAP server, binds, and modifies or adds entries.
The entry information is read from standard input or from \fIfile\fP through
the use of the -f option.
the use of the \fB\-f\fP option.
.SH OPTIONS
.TP
.B \-a
......@@ -142,16 +142,16 @@ reporting an error.
.BI \-S \ file
Add or change records which where skipped due to an error are written to \fIfile\fP
and the error message returned by the server is added as a comment. Most useful in
conjunction with -c.
conjunction with \fB\-c\fP.
.TP
.B \-n
Show what would be done, but don't actually modify entries. Useful for
debugging in conjunction with -v.
debugging in conjunction with \fB\-v\fP.
.TP
.B \-v
Use verbose mode, with many diagnostics written to standard output.
.TP
.B \-M[M]
.BR \-M [ M ]
Enable manage DSA IT control.
.B \-MM
makes control critical.
......@@ -170,7 +170,7 @@ Use simple authentication instead of SASL.
.TP
.BI \-D \ binddn
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
For SASL Binds, the server is expected to ignore this value.
For SASL binds, the server is expected to ignore this value.
.TP
.B \-W
Prompt for simple authentication.
......@@ -190,13 +190,13 @@ is expected.
.TP
.BI \-h \ ldaphost
Specify an alternate host on which the ldap server is running.
Deprecated in favor of -H.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-p \ ldapport
Specify an alternate TCP port where the ldap server is listening.
Deprecated in favor of -H.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-P \ 2\fR\||\|\fI3
.BR \-P \ { 2 \||\| 3 }
Specify the LDAP protocol version to use.
.TP
.BI \-O \ security-properties
......@@ -221,22 +221,20 @@ depends on the actual SASL mechanism used.
Specify the requested authorization ID for SASL bind.
.I authzid
must be one of the following formats:
.B dn:\c
.I <distinguished name>
.BI dn: "<distinguished name>"
or
.B u:\c
.I <username>
.BI u: <username>
.TP
.BI \-Y \ mech
Specify the SASL mechanism to be used for authentication. If it's not
specified, the program will choose the best mechanism the server knows.
.TP
.B \-Z[Z]
.BR \-Z [ Z ]
Issue StartTLS (Transport Layer Security) extended operation. If you use
.B \-ZZ\c
, the command will require the operation to be successful.
.SH INPUT FORMAT
The contents of \fIfile\fP (or standard input if no \-f flag is given on
The contents of \fIfile\fP (or standard input if no \fB\-f\fP flag is given on
the command line) must conform to the format defined in
.BR ldif (5)
(LDIF as defined in RFC 2849).
......@@ -250,21 +248,21 @@ exists and has the contents:
changetype: modify
replace: mail
mail: modme@example.com
-
\-
add: title
title: Grand Poobah
-
\-
add: jpegPhoto
jpegPhoto:< file:///tmp/modme.jpeg
-
\-
delete: description
-
\-
.fi
.LP
the command:
.LP
.nf
ldapmodify -f /tmp/entrymods
ldapmodify \-f /tmp/entrymods
.fi
.LP
will replace the contents of the "Modify Me" entry's
......@@ -296,7 +294,7 @@ exists and has the contents:
the command:
.LP
.nf
ldapadd -f /tmp/newentry
ldapadd \-f /tmp/newentry
.fi
.LP
will add a new entry for Babs Jensen, using the values from the
......@@ -315,7 +313,7 @@ exists and has the contents:
the command:
.LP
.nf
ldapmodify -f /tmp/entrymods
ldapmodify \-f /tmp/entrymods
.fi
.LP
will remove Babs Jensen's entry.
......
......@@ -17,7 +17,7 @@ ldapmodrdn \- LDAP rename entry tool
[\c
.BR \-c ]
[\c
.BR \-M[M] ]
.BR \-M [ M ]]
[\c
.BI \-d \ debuglevel\fR]
[\c
......@@ -35,9 +35,9 @@ ldapmodrdn \- LDAP rename entry tool
[\c
.BI \-p \ ldapport\fR]
[\c
.BI \-P \ 2\fR\||\|\fI3\fR]
.BR \-P \ { 2 \||\| 3 }]
[\c
.BR \-O \ security-properties ]
.BI \-O \ security-properties\fR]
[\c
.BR \-I ]
[\c
......@@ -53,7 +53,7 @@ ldapmodrdn \- LDAP rename entry tool
[\c
.BI \-Y \ mech\fR]
[\c
.BR \-Z[Z] ]
.BR \-Z [ Z ]]
[\c
.BI \-f \ file\fR]
[\c
......@@ -82,7 +82,7 @@ child of the new superior.) This option is not supported in LDAPv2.
.TP
.B \-n
Show what would be done, but don't actually change entries. Useful for
debugging in conjunction with -v.
debugging in conjunction with \fB\-v\fP.
.TP
.B \-v
Use verbose mode, with many diagnostics written to standard output.
......@@ -92,33 +92,33 @@ Continuous operation mode. Errors are reported, but ldapmodrdn
will continue with modifications. The default is to exit after
reporting an error.
.TP
.B \-M[M]
.BR \-M [ M ]
Enable manage DSA IT control.
.B \-MM
makes control critical.
.TP
.B \-d debuglevel
.BI \-d \ debuglevel
Set the LDAP debugging level to \fIdebuglevel\fP.
.B ldapmodrdn
must be
compiled with LDAP_DEBUG defined for this option to have any effect.
.TP
.B \-f file
.BI \-f \ file
Read the entry modification information from \fIfile\fP instead of from
standard input or the command-line.
.TP
.B \-x
Use simple authentication instead of SASL.
.TP
.B \-D binddn
.BI \-D \ binddn
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
For SASL Binds, the server is expected to ignore this value.
For SASL binds, the server is expected to ignore this value.
.TP
.B \-W
Prompt for simple authentication.
This is used instead of specifying the password on the command line.
.TP
.B \-w passwd
.BI \-w \ passwd
Use \fIpasswd\fP as the password for simple authentication.
.TP
.BI \-y \ passwdfile
......@@ -132,13 +132,13 @@ is expected.
.TP
.BI \-h \ ldaphost
Specify an alternate host on which the ldap server is running.
Deprecated in favor of -H.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-p \ ldapport
Specify an alternate TCP port where the ldap server is listening.
Deprecated in favor of -H.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-P \ 2\fR\||\|\fI3
.BR \-P \ { 2 \||\| 3 }
Specify the LDAP protocol version to use.
.TP
.BI \-O \ security-properties
......@@ -163,28 +163,23 @@ depends on the actual SASL mechanism used.
Specify the requested authorization ID for SASL bind.
.I authzid
must be one of the following formats:
.B dn:\c
.I <distinguished name>
.BI dn: "<distinguished name>"
or
.B u:\c
.I <username>
.BI u: <username>
.TP
.BI \-Y \ mech
Specify the SASL mechanism to be used for authentication. If it's not
specified, the program will choose the best mechanism the server knows.
.TP
.B \-Z[Z]
.BR \-Z [ Z ]
Issue StartTLS (Transport Layer Security) extended operation. If you use
.B \-ZZ\c
, the command will require the operation to be successful.
\fB\-ZZ\fP, the command will require the operation to be successful.
.SH INPUT FORMAT
If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
will replace the RDN of the entry specified by the DN, \fIdn\fP.
.LP
Otherwise, the contents of \fIfile\fP (or standard input if