summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/user.py
diff options
context:
space:
mode:
authorRob Crittenden <rcritten@redhat.com>2010-06-02 14:08:50 -0400
committerRob Crittenden <rcritten@redhat.com>2010-06-22 13:58:04 -0400
commit901ccc1393a7e494f7b1b64eaeb2f7809056aafa (patch)
treeb9523a814ed72e08ac286134bb45cf07e6e053f4 /ipalib/plugins/user.py
parent8c6c93125f344ca117cc24b2e96c55b1d9ae31bd (diff)
downloadfreeipa-901ccc1393a7e494f7b1b64eaeb2f7809056aafa.tar.gz
freeipa-901ccc1393a7e494f7b1b64eaeb2f7809056aafa.tar.xz
freeipa-901ccc1393a7e494f7b1b64eaeb2f7809056aafa.zip
First pass at per-command documentation
Diffstat (limited to 'ipalib/plugins/user.py')
-rw-r--r--ipalib/plugins/user.py22
1 files changed, 22 insertions, 0 deletions
diff --git a/ipalib/plugins/user.py b/ipalib/plugins/user.py
index f8783eca..d72b3bb1 100644
--- a/ipalib/plugins/user.py
+++ b/ipalib/plugins/user.py
@@ -19,6 +19,28 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
Users (Identity)
+
+Manage user entries.
+
+EXAMPLES:
+
+ Create a new user:
+ ipa user-add --first=Tim --last=User --passwd tuser1
+
+ Find a user Tim:
+ ipa user-find Tim
+
+ Find all users with Tim as the first name:
+ ipa user-find --first=Tim
+
+ Lock a user account:
+ ipa user-lock tuser1
+
+ Unlock a user account:
+ ipa user-unlock tuser1
+
+ Delete a user:
+ ipa user-del tuser1
"""
from ipalib import api, errors