diff options
author | Rob Crittenden <rcritten@redhat.com> | 2007-10-24 13:10:23 -0400 |
---|---|---|
committer | Rob Crittenden <rcritten@redhat.com> | 2007-10-24 13:10:23 -0400 |
commit | 0d80589bcb016e9d2894f8663cfa4fd815586e8e (patch) | |
tree | b607a9e627d31f58d49844320df7fdd4dde52e14 /ipa-admintools/man | |
parent | 60d46ac6607b3ba1e2b525b7f2f1a64b08f778c6 (diff) | |
download | freeipa-0d80589bcb016e9d2894f8663cfa4fd815586e8e.tar.gz freeipa-0d80589bcb016e9d2894f8663cfa4fd815586e8e.tar.xz freeipa-0d80589bcb016e9d2894f8663cfa4fd815586e8e.zip |
Command-line delegation tools with man pages
Diffstat (limited to 'ipa-admintools/man')
-rw-r--r-- | ipa-admintools/man/ipa-adddelegation.1 | 55 | ||||
-rw-r--r-- | ipa-admintools/man/ipa-deldelegation.1 | 36 | ||||
-rw-r--r-- | ipa-admintools/man/ipa-listdelegation.1 | 34 | ||||
-rw-r--r-- | ipa-admintools/man/ipa-moddelegation.1 | 51 |
4 files changed, 176 insertions, 0 deletions
diff --git a/ipa-admintools/man/ipa-adddelegation.1 b/ipa-admintools/man/ipa-adddelegation.1 new file mode 100644 index 000000000..5eaba52aa --- /dev/null +++ b/ipa-admintools/man/ipa-adddelegation.1 @@ -0,0 +1,55 @@ +.\" A man page for ipa-adddelegation +.\" Copyright (C) 2007 Red Hat, Inc. +.\" +.\" This is free software; you can redistribute it and/or modify it under +.\" the terms of the GNU Library General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +.\" General Public License for more details. +.\" +.\" You should have received a copy of the GNU Library General Public +.\" License along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" Author: Rob Crittenden <rcritten@redhat.com> +.\" +.TH "ipa-adddelegation" "1" "Oct 24 2007" "freeipa" "" +.SH "NAME" +ipa\-adddelegation \- Add a delegation + +.SH "SYNOPSIS" +ipa\-adddelegation [\fIOPTION\fR]... \fIname\fR + +.SH "DESCRIPTION" +Adds a delegation named \fIname\fR. + +A delegation is used to grant access to certain attributes from one group to another. + +For example, a secretary group may be granted access to modify the phone attribute of all users in a manager's group. +.SH "OPTIONS" +.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. + +.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. + +.PP +All arguments are mandatory. +.SH "EXIT STATUS" +0 if the delegation was added successfully + +1 if an error occurred + +2 if no not exactly one matching source group was found (0 or more than one) + +3 if no not exactly one matching target group was found (0 or more than one diff --git a/ipa-admintools/man/ipa-deldelegation.1 b/ipa-admintools/man/ipa-deldelegation.1 new file mode 100644 index 000000000..11129d754 --- /dev/null +++ b/ipa-admintools/man/ipa-deldelegation.1 @@ -0,0 +1,36 @@ +.\" A man page for ipa-deldelegation +.\" Copyright (C) 2007 Red Hat, Inc. +.\" +.\" This is free software; you can redistribute it and/or modify it under +.\" the terms of the GNU Library General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +.\" General Public License for more details. +.\" +.\" You should have received a copy of the GNU Library General Public +.\" License along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" Author: Rob Crittenden <rcritten@redhat.com> +.\" +.TH "ipa-deldelegation" "1" "Oct 24 2007" "freeipa" "" +.SH "NAME" +ipa\-deldelegation \- Remove a delegation + +.SH "SYNOPSIS" +ipa\-deldelegation \fIname\fR + +.SH "DESCRIPTION" +Removes an existing delegation named \fIname\fR. + +A delegation is used to grant access to certain attributes from one group to another. ipa\-deldelegation removes this access. +.SH "EXIT STATUS" +0 if the delegation was removed successfully + +1 if an error occurred + +2 if no matching delegation was found diff --git a/ipa-admintools/man/ipa-listdelegation.1 b/ipa-admintools/man/ipa-listdelegation.1 new file mode 100644 index 000000000..c7ee00c0e --- /dev/null +++ b/ipa-admintools/man/ipa-listdelegation.1 @@ -0,0 +1,34 @@ +.\" A man page for ipa-listdelegation +.\" Copyright (C) 2007 Red Hat, Inc. +.\" +.\" This is free software; you can redistribute it and/or modify it under +.\" the terms of the GNU Library General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +.\" General Public License for more details. +.\" +.\" You should have received a copy of the GNU Library General Public +.\" License along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" Author: Rob Crittenden <rcritten@redhat.com> +.\" +.TH "ipa-listdelegation" "1" "Oct 24 2007" "freeipa" "" +.SH "NAME" +ipa\-listdelegation \- Lists all current delegations + +.SH "SYNOPSIS" +ipa\-listdelegation + +.SH "DESCRIPTION" +Lists all current delegations. + +No sorting is done. +.SH "EXIT STATUS" +0 if the delegations are listed successfully + +1 if an error occurred diff --git a/ipa-admintools/man/ipa-moddelegation.1 b/ipa-admintools/man/ipa-moddelegation.1 new file mode 100644 index 000000000..5624c7c50 --- /dev/null +++ b/ipa-admintools/man/ipa-moddelegation.1 @@ -0,0 +1,51 @@ +.\" A man page for ipa-moddelegation +.\" Copyright (C) 2007 Red Hat, Inc. +.\" +.\" This is free software; you can redistribute it and/or modify it under +.\" the terms of the GNU Library General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +.\" General Public License for more details. +.\" +.\" You should have received a copy of the GNU Library General Public +.\" License along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" Author: Rob Crittenden <rcritten@redhat.com> +.\" +.TH "ipa-moddelegation" "1" "Oct 24 2007" "freeipa" "" +.SH "NAME" +ipa\-moddelegation \- Modify an existing delegation + +.SH "SYNOPSIS" +ipa\-moddelegation [\fIOPTION\fR]... \fIname\fR + +.SH "DESCRIPTION" +Modifies an existing delegation named \fIname\fR. + +A delegation is used to grant access to certain attributes from one group to another. +.SH "OPTIONS" +.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. + +.PP +At least one of \-a, \-s or \-t is required. +.SH "EXIT STATUS" +0 if the delegation was updated successfully + +1 if an error occurred + +2 if no matching delegation was found |