summaryrefslogtreecommitdiffstats
path: root/ipa.1
diff options
context:
space:
mode:
authorJan Zeleny <jzeleny@redhat.com>2011-02-17 03:55:14 -0500
committerRob Crittenden <rcritten@redhat.com>2011-02-17 16:05:14 -0500
commit2d97f4b335ce2f2f1d62194ef614af3ace77a57e (patch)
tree35a319d5014a20ba26400f2d64aed2ed41e12ef2 /ipa.1
parent27785b679427758ec4c111583b055a64b077c23f (diff)
downloadfreeipa-2d97f4b335ce2f2f1d62194ef614af3ace77a57e.zip
freeipa-2d97f4b335ce2f2f1d62194ef614af3ace77a57e.tar.gz
freeipa-2d97f4b335ce2f2f1d62194ef614af3ace77a57e.tar.xz
Document the --rights output format
https://fedorahosted.org/freeipa/ticket/563 https://fedorahosted.org/freeipa/ticket/588
Diffstat (limited to 'ipa.1')
-rw-r--r--ipa.115
1 files changed, 14 insertions, 1 deletions
diff --git a/ipa.1 b/ipa.1
index eb8fe8c..e346853 100644
--- a/ipa.1
+++ b/ipa.1
@@ -106,13 +106,26 @@ The above types of commands take the objects primary key as their only positiona
For some types of objects, these commands might need to take more than one primary key. This applies to IPA objects organized in hierarchies where the parent object needs to be identified first. Parent primary keys are always aligned to the left (higher in the hierarchy = more to the left). For example the automount IPA plugin enables users to manage automount maps per location, as a result all automount commands take an automountlocation primary key as their first positional argument.
-All commands that display objects have two special options for controlling output:
+All commands that display objects have three special options for controlling output:
.TP
\fB\-\-all\fR
Dispaly all attributes. Without this option only the most relevant attributes are displayed.
.TP
\fB\-\-raw\fR
Display objects as they are stored in the backing store. Disables formatting and attribute labels.
+.TP
+\fB\-\-rights\fR
+Display effective rights on all attributes of the entry. You also have to specify \fB\-\-all\fR for this to work. User rights are returned as Python dictionary where index is the name of an attribute and value is a unicode string composed (hence the u'xxxx' format) of letters specified below. Note that user rights are primarily used for internal purposes of CLI and WebUI.
+
+.ad l
+r - read\p
+s - search\p
+w - write\p
+o - obliterate (delete)\p
+c - compare\p
+W - self-write\p
+O - self-obliterate
+
.SH "EXAMPLES"
.TP
\fBipa help commands\fR