mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2025-01-15 19:01:55 -06:00
Add documentation for -v/--verbose option
451117
This commit is contained in:
parent
fb9f92c9f3
commit
469fc7663c
@ -42,8 +42,11 @@ The name of the group that is being granted write permission.
|
|||||||
.TP
|
.TP
|
||||||
\fB\-t\fR, \fB\-\-target\fR=\fITARGET\fR
|
\fB\-t\fR, \fB\-\-target\fR=\fITARGET\fR
|
||||||
The name of the group that will be written to.
|
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
|
.PP
|
||||||
All arguments are mandatory.
|
All arguments except \-v/\-\-verbose are mandatory.
|
||||||
.SH "EXAMPLES"
|
.SH "EXAMPLES"
|
||||||
.TP
|
.TP
|
||||||
ipa\-adddelegation \-a telephonenumber,facsimiletelephonenumber,mobile \-s secretaries \-t everyone phones
|
ipa\-adddelegation \-a telephonenumber,facsimiletelephonenumber,mobile \-s secretaries \-t everyone phones
|
||||||
|
@ -34,12 +34,15 @@ Set the description of the group to \fIdescription\fR.
|
|||||||
Set the gid for this group to \fIgid\fR.
|
Set the gid for this group to \fIgid\fR.
|
||||||
If this option is not present, one is created automatically
|
If this option is not present, one is created automatically
|
||||||
by \fBfreeIPA\fR.
|
by \fBfreeIPA\fR.
|
||||||
.TP
|
.TP
|
||||||
\fB\-\-addattr\fR \fIattr=value\fR
|
\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.
|
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
|
\fB\-\-setattr\fR \fIattr=value\fR
|
||||||
Set attribute \fIattr\fR to \fIvalue\fR. Any existing value will be replaced with \fIvalue\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
|
.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.
|
The group name and description are mandatory fields. If either of these are not included on the command line you will be asked interactively.
|
||||||
|
|
||||||
|
@ -48,6 +48,9 @@ The hostname must resolve to a DNS A record in order to ensure that it will work
|
|||||||
.TP
|
.TP
|
||||||
\fB\-\-force\fR
|
\fB\-\-force\fR
|
||||||
Force the creation of the given principal name.
|
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"
|
.SH "EXAMPLES"
|
||||||
.TP
|
.TP
|
||||||
ipa\-addservice HTTP/www.example.com
|
ipa\-addservice HTTP/www.example.com
|
||||||
|
@ -71,6 +71,9 @@ Adds \fIvalue\fR to attribute \fIattr\fR. Attributes set this way are done after
|
|||||||
.TP
|
.TP
|
||||||
\fB\-\-setattr\fR \fIattr=value\fR
|
\fB\-\-setattr\fR \fIattr=value\fR
|
||||||
Set attribute \fIattr\fR to \fIvalue\fR. Any existing value will be replaced with \fIvalue\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
|
.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.
|
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.
|
||||||
|
|
||||||
|
@ -23,6 +23,10 @@ ipa\-deldelegation \- Remove a delegation
|
|||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
ipa\-deldelegation \fIname\fR
|
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"
|
.SH "DESCRIPTION"
|
||||||
Removes an existing delegation named \fIname\fR.
|
Removes an existing delegation named \fIname\fR.
|
||||||
|
|
||||||
|
@ -23,6 +23,10 @@ ipa\-delgroup \- Delete a group
|
|||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
ipa\-delgroup \fIgroup\fR
|
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"
|
.SH "DESCRIPTION"
|
||||||
Deletes a group with group name \fIgroup\fR.
|
Deletes a group with group name \fIgroup\fR.
|
||||||
|
|
||||||
|
@ -23,6 +23,10 @@ ipa\-delservice \- Delete a service principal
|
|||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
ipa\-delservice \fIprincipal\fR
|
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"
|
.SH "DESCRIPTION"
|
||||||
Deletes a service principal with name \fIprincipal\fR.
|
Deletes a service principal with name \fIprincipal\fR.
|
||||||
|
|
||||||
|
@ -23,6 +23,10 @@ ipa\-deluser \- Delete a user
|
|||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
ipa\-deluser \fIuser\fR
|
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"
|
.SH "DESCRIPTION"
|
||||||
Deletes a user with user name \fIname\fR.
|
Deletes a user with user name \fIname\fR.
|
||||||
|
|
||||||
|
@ -23,6 +23,10 @@ ipa\-findgroup \- Find a group
|
|||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
ipa\-findgroup \fIstring\fR
|
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"
|
.SH "DESCRIPTION"
|
||||||
Searches for a group that contains \fIstring\fR.
|
Searches for a group that contains \fIstring\fR.
|
||||||
|
|
||||||
|
@ -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.
|
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.
|
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"
|
.SH "EXAMPLES"
|
||||||
Find all ldap service principals issued by the IPA KDC:
|
Find all ldap service principals issued by the IPA KDC:
|
||||||
|
|
||||||
|
@ -32,7 +32,12 @@ All entries that match are displayed.
|
|||||||
.TP
|
.TP
|
||||||
\fB\-a\fR, \fB\-\-all
|
\fB\-a\fR, \fB\-\-all
|
||||||
Display all attributes
|
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
|
.PP
|
||||||
By default, the full name, home directory, login shell, and username fields are displayed.
|
By default, the full name, home directory, login shell, and username fields are displayed.
|
||||||
.SH "EXIT STATUS"
|
.SH "EXIT STATUS"
|
||||||
|
@ -27,6 +27,10 @@ ipa\-listdelegation
|
|||||||
Lists all current delegations.
|
Lists all current delegations.
|
||||||
|
|
||||||
No sorting is done.
|
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"
|
.SH "EXIT STATUS"
|
||||||
0 if the delegations are listed successfully
|
0 if the delegations are listed successfully
|
||||||
|
|
||||||
|
@ -31,5 +31,8 @@ Users are not removed from groups when their account is locked.
|
|||||||
.TP
|
.TP
|
||||||
\fB\-u\fR, \fB\-\-unlock
|
\fB\-u\fR, \fB\-\-unlock
|
||||||
Unlock a user's account
|
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"
|
.SH "EXIT STATUS"
|
||||||
The exit status is 0 on success, nonzero on error.
|
The exit status is 0 on success, nonzero on error.
|
||||||
|
@ -31,15 +31,15 @@ A delegation is used to grant access to certain attributes from one group to ano
|
|||||||
.TP
|
.TP
|
||||||
\fB\-a\fR, \fB\-\-attributes\fR=\fIATTRIBUTES\fR
|
\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.
|
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
|
.TP
|
||||||
\fB\-s\fR, \fB\-\-source\fR=\fISOURCE\fR
|
\fB\-s\fR, \fB\-\-source\fR=\fISOURCE\fR
|
||||||
The name of the group that is being granted write permission.
|
The name of the group that is being granted write permission.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB\-t\fR, \fB\-\-target\fR=\fITARGET\fR
|
\fB\-t\fR, \fB\-\-target\fR=\fITARGET\fR
|
||||||
The name of the group that will be written to.
|
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
|
.PP
|
||||||
At least one of \-a, \-s or \-t is required.
|
At least one of \-a, \-s or \-t is required.
|
||||||
.SH "EXIT STATUS"
|
.SH "EXIT STATUS"
|
||||||
|
@ -49,5 +49,8 @@ Remove an attribute and all values
|
|||||||
.TP
|
.TP
|
||||||
\fB\-\-setattr\fR \fIattr=value\fR
|
\fB\-\-setattr\fR \fIattr=value\fR
|
||||||
Set an attribute to a new value, removing all old ones
|
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"
|
.SH "EXIT STATUS"
|
||||||
The exit status is 0 on success, nonzero on error.
|
The exit status is 0 on success, nonzero on error.
|
||||||
|
@ -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.
|
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.
|
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"
|
.SH "EXIT STATUS"
|
||||||
The exit status is 0 on success, nonzero on error.
|
The exit status is 0 on success, nonzero on error.
|
||||||
|
@ -47,5 +47,8 @@ Set the minimum password length.
|
|||||||
.TP
|
.TP
|
||||||
\fB\-\-show\fR
|
\fB\-\-show\fR
|
||||||
Display the current password policy.
|
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"
|
.SH "EXIT STATUS"
|
||||||
The exit status is 0 on success, nonzero on error.
|
The exit status is 0 on success, nonzero on error.
|
||||||
|
Loading…
Reference in New Issue
Block a user