Add documentation for -v/--verbose optionipa-1-0

451117

17 files changed, 65 insertions, 7 deletions

diff --git a/ipa-admintools/man/ipa-adddelegation.1 b/ipa-admintools/man/ipa-adddelegation.1
index 063b3b89..4db109f6 100644
--- a/ipa-admintools/man/ipa-adddelegation.1
+++ b/ipa-admintools/man/ipa-adddelegation.1
@@ -42,8 +42,11 @@ The name of the group that is being granted write permission.
 .TP 
 \fB\-t\fR, \fB\-\-target\fR=\fITARGET\fR
 The name of the group that will be written to.
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output
 .PP 
-All arguments are mandatory.
+All arguments except \-v/\-\-verbose are mandatory.
 .SH "EXAMPLES"
 .TP 
 ipa\-adddelegation \-a telephonenumber,facsimiletelephonenumber,mobile \-s secretaries \-t everyone phones
diff --git a/ipa-admintools/man/ipa-addgroup.1 b/ipa-admintools/man/ipa-addgroup.1
index 03fee1bf..0e61c619 100644
--- a/ipa-admintools/man/ipa-addgroup.1
+++ b/ipa-admintools/man/ipa-addgroup.1
@@ -34,12 +34,15 @@ Set the description of the group to \fIdescription\fR.
 Set the gid for this group to \fIgid\fR.
 If this option is not present, one is created automatically
 by \fBfreeIPA\fR.
-.TP
+.TP 
 \fB\-\-addattr\fR \fIattr=value\fR
 Adds \fIvalue\fR to attribute \fIattr\fR. Attributes set this way are done after other options. If an attribute is listed more than once or already exists in the entry, it is considered a multi\-valued attribute and a list of the values is created.
-.TP
+.TP 
 \fB\-\-setattr\fR \fIattr=value\fR
 Set attribute \fIattr\fR to \fIvalue\fR. Any existing value will be replaced with \fIvalue\fR.
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .PP 
 The group name and description are mandatory fields. If either of these are not included on the command line you will be asked interactively.
 
diff --git a/ipa-admintools/man/ipa-addservice.1 b/ipa-admintools/man/ipa-addservice.1
index 432f5438..aec92be3 100644
--- a/ipa-admintools/man/ipa-addservice.1
+++ b/ipa-admintools/man/ipa-addservice.1
@@ -48,6 +48,9 @@ The hostname must resolve to a DNS A record in order to ensure that it will work
 .TP 
 \fB\-\-force\fR
 Force the creation of the given principal name.
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "EXAMPLES"
 .TP 
 ipa\-addservice HTTP/www.example.com
diff --git a/ipa-admintools/man/ipa-adduser.1 b/ipa-admintools/man/ipa-adduser.1
index b08fe701..0b8ad3e3 100644
--- a/ipa-admintools/man/ipa-adduser.1
+++ b/ipa-admintools/man/ipa-adduser.1
@@ -71,6 +71,9 @@ Adds \fIvalue\fR to attribute \fIattr\fR. Attributes set this way are done after
 .TP 
 \fB\-\-setattr\fR \fIattr=value\fR
 Set attribute \fIattr\fR to \fIvalue\fR. Any existing value will be replaced with \fIvalue\fR.
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .PP 
 The mandatory fields are: user, first name and last name. If any of these are not included on the command line you will be asked interactively.
 
diff --git a/ipa-admintools/man/ipa-deldelegation.1 b/ipa-admintools/man/ipa-deldelegation.1
index 9ec0aee6..f3d4a904 100644
--- a/ipa-admintools/man/ipa-deldelegation.1
+++ b/ipa-admintools/man/ipa-deldelegation.1
@@ -23,6 +23,10 @@ ipa\-deldelegation \- Remove a delegation
 .SH "SYNOPSIS"
 ipa\-deldelegation \fIname\fR
 
+.SH "OPTIONS"
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "DESCRIPTION"
 Removes an existing delegation named \fIname\fR.
 
diff --git a/ipa-admintools/man/ipa-delgroup.1 b/ipa-admintools/man/ipa-delgroup.1
index 8c50f6df..4e87bcf4 100644
--- a/ipa-admintools/man/ipa-delgroup.1
+++ b/ipa-admintools/man/ipa-delgroup.1
@@ -23,6 +23,10 @@ ipa\-delgroup \- Delete a group
 .SH "SYNOPSIS"
 ipa\-delgroup \fIgroup\fR
 
+.SH "OPTIONS"
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "DESCRIPTION"
 Deletes a group with group name \fIgroup\fR.
 
diff --git a/ipa-admintools/man/ipa-delservice.1 b/ipa-admintools/man/ipa-delservice.1
index 8ba1247e..779b9eca 100644
--- a/ipa-admintools/man/ipa-delservice.1
+++ b/ipa-admintools/man/ipa-delservice.1
@@ -23,6 +23,10 @@ ipa\-delservice \- Delete a service principal
 .SH "SYNOPSIS"
 ipa\-delservice \fIprincipal\fR
 
+.SH "OPTIONS"
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "DESCRIPTION"
 Deletes a service principal with name \fIprincipal\fR.
 
diff --git a/ipa-admintools/man/ipa-deluser.1 b/ipa-admintools/man/ipa-deluser.1
index 08be8ee7..2679302e 100644
--- a/ipa-admintools/man/ipa-deluser.1
+++ b/ipa-admintools/man/ipa-deluser.1
@@ -23,6 +23,10 @@ ipa\-deluser \- Delete a user
 .SH "SYNOPSIS"
 ipa\-deluser \fIuser\fR
 
+.SH "OPTIONS"
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "DESCRIPTION"
 Deletes a user with user name \fIname\fR.
 
diff --git a/ipa-admintools/man/ipa-findgroup.1 b/ipa-admintools/man/ipa-findgroup.1
index bfba8ea2..266a60cd 100644
--- a/ipa-admintools/man/ipa-findgroup.1
+++ b/ipa-admintools/man/ipa-findgroup.1
@@ -23,6 +23,10 @@ ipa\-findgroup \- Find a group
 .SH "SYNOPSIS"
 ipa\-findgroup \fIstring\fR
 
+.SH "OPTIONS"
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "DESCRIPTION"
 Searches for a group that contains \fIstring\fR.
 
diff --git a/ipa-admintools/man/ipa-findservice.1 b/ipa-admintools/man/ipa-findservice.1
index 85a24aba..3942391c 100644
--- a/ipa-admintools/man/ipa-findservice.1
+++ b/ipa-admintools/man/ipa-findservice.1
@@ -28,6 +28,10 @@ Searches for a service principal that contains \fIstring\fR.
 The search is a substring search in the service principal. You can search for all principals for a given host, by service or a substring.
 
 All entries that match are displayed.
+.SH "OPTIONS"
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "EXAMPLES"
 Find all ldap service principals issued by the IPA KDC:
 
diff --git a/ipa-admintools/man/ipa-finduser.1 b/ipa-admintools/man/ipa-finduser.1
index 144b8637..1730daba 100644
--- a/ipa-admintools/man/ipa-finduser.1
+++ b/ipa-admintools/man/ipa-finduser.1
@@ -32,7 +32,12 @@ All entries that match are displayed.
 .TP 
 \fB\-a\fR, \fB\-\-all
 Display all attributes
-
+.TP 
+\fB\-n\fR, \fB\-\-notranslate\fR
+Don't translate the LDAP attribute names to labels that match the UI.
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .PP 
 By default, the full name, home directory, login shell, and username fields are displayed.
 .SH "EXIT STATUS"
diff --git a/ipa-admintools/man/ipa-listdelegation.1 b/ipa-admintools/man/ipa-listdelegation.1
index b0a044ad..9118bc9a 100644
--- a/ipa-admintools/man/ipa-listdelegation.1
+++ b/ipa-admintools/man/ipa-listdelegation.1
@@ -27,6 +27,10 @@ ipa\-listdelegation
 Lists all current delegations.
 
 No sorting is done.
+.SH "OPTIONS"
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "EXIT STATUS"
 0 if the delegations are listed successfully
 
diff --git a/ipa-admintools/man/ipa-lockuser.1 b/ipa-admintools/man/ipa-lockuser.1
index 442c0b1b..79df5c0e 100644
--- a/ipa-admintools/man/ipa-lockuser.1
+++ b/ipa-admintools/man/ipa-lockuser.1
@@ -31,5 +31,8 @@ Users are not removed from groups when their account is locked.
 .TP 
 \fB\-u\fR, \fB\-\-unlock
 Unlock a user's account
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "EXIT STATUS"
 The exit status is 0 on success, nonzero on error.
diff --git a/ipa-admintools/man/ipa-moddelegation.1 b/ipa-admintools/man/ipa-moddelegation.1
index 86edfdeb..28ab2aa9 100644
--- a/ipa-admintools/man/ipa-moddelegation.1
+++ b/ipa-admintools/man/ipa-moddelegation.1
@@ -31,15 +31,15 @@ A delegation is used to grant access to certain attributes from one group to ano
 .TP 
 \fB\-a\fR, \fB\-\-attributes\fR=\fIATTRIBUTES\fR
 A comma\-separated list of the the \f[SM]attributes\fR that may be written by the source group. This list of attributes replaces the list in the existing delegation.
-
 .TP 
 \fB\-s\fR, \fB\-\-source\fR=\fISOURCE\fR
 The name of the group that is being granted write permission.
-
 .TP 
 \fB\-t\fR, \fB\-\-target\fR=\fITARGET\fR
 The name of the group that will be written to.
-
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .PP 
 At least one of \-a, \-s or \-t is required.
 .SH "EXIT STATUS"
diff --git a/ipa-admintools/man/ipa-modgroup.1 b/ipa-admintools/man/ipa-modgroup.1
index 6a517a74..e52d9636 100644
--- a/ipa-admintools/man/ipa-modgroup.1
+++ b/ipa-admintools/man/ipa-modgroup.1
@@ -49,5 +49,8 @@ Remove an attribute and all values
 .TP 
 \fB\-\-setattr\fR \fIattr=value\fR
 Set an attribute to a new value, removing all old ones
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "EXIT STATUS"
 The exit status is 0 on success, nonzero on error.
diff --git a/ipa-admintools/man/ipa-passwd.1 b/ipa-admintools/man/ipa-passwd.1
index a2f698ce..4554d5d2 100644
--- a/ipa-admintools/man/ipa-passwd.1
+++ b/ipa-admintools/man/ipa-passwd.1
@@ -26,5 +26,9 @@ ipa\-password [\fIuser\fR]
 Changes the current user's password. If a \fIuser\fR is included on the command\-line then that user's password is modified.
 
 The user is the name in the kerberos principal, so it may not match username.
+.SH "OPTIONS"
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output.
 .SH "EXIT STATUS"
 The exit status is 0 on success, nonzero on error.
diff --git a/ipa-admintools/man/ipa-pwpolicy.1 b/ipa-admintools/man/ipa-pwpolicy.1
index 30c6e481..4c7de4c3 100644
--- a/ipa-admintools/man/ipa-pwpolicy.1
+++ b/ipa-admintools/man/ipa-pwpolicy.1
@@ -47,5 +47,8 @@ Set the minimum password length.
 .TP 
 \fB\-\-show\fR
 Display the current password policy.
+.TP 
+\fB\-v\fR, \fB\-\-verbose\fR
+Display the XML\-RPC request and response for more verbose debugging output
 .SH "EXIT STATUS"
 The exit status is 0 on success, nonzero on error.