IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

First draft of man pages for the admin tools

Browse Source
This commit is contained in:
Rob Crittenden
2007-10-11 10:49:32 -04:00
parent dac58ee693
commit 0a935d5be3
13 changed files with 433 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
ipa-admintools/Makefile
View File

@@ -1,6 +1,11 @@
SUBDIRS=man
SBINDIR = $(DESTDIR)/usr/sbin
all: ;
@for subdir in $(SUBDIRS); do \
(cd $$subdir && $(MAKE) $@) || exit 1; \
done
install:
install -m 755 ipa-adduser $(SBINDIR)
@@ -12,6 +17,12 @@ install:
install -m 755 ipa-findgroup $(SBINDIR)
install -m 755 ipa-groupmod $(SBINDIR)
install -m 755 ipa-passwd $(SBINDIR)
@for subdir in $(SUBDIRS); do \
(cd $$subdir && $(MAKE) $@) || exit 1; \
done
install-man:
install -m 644
clean:
rm -f *~ *.pyc

12
ipa-admintools/freeipa-admintools.spec
View File

@@ -1,6 +1,6 @@
Name: freeipa-admintools
Version: 0.4.0
Release: 1%{?dist}
Release: 2%{?dist}
Summary: FreeIPA authentication server
Group: System Environment/Base
@@ -32,8 +32,18 @@ rm -rf %{buildroot}
%files
%defattr(-,root,root,-)
%{_sbindir}/ipa*
%{_mandir}/man1/*
%changelog
* Thu Oct 11 2007 Karl MacMillan <kmacmill@redhat.com> - 0.4.0-2
- Package man files
* Tue Oct 2 2007 Karl MacMillan <kmacmill@redhat.com> - 0.4.0-1
- Milestone 4
* Mon Sep 10 2007 Karl MacMillan <kmacmill@redhat.com> - 0.3.0-1
- Milestone 3
* Fri Aug 17 2007 Karl MacMillan <kmacmill@redhat.com> - 0.2.0-4
- Package additional utilities.

12
ipa-admintools/freeipa-admintools.spec.in
View File

@@ -1,6 +1,6 @@
Name: freeipa-admintools
Version: VERSION
Release: 1%{?dist}
Release: 2%{?dist}
Summary: FreeIPA authentication server
Group: System Environment/Base
@@ -32,8 +32,18 @@ rm -rf %{buildroot}
%files
%defattr(-,root,root,-)
%{_sbindir}/ipa*
%{_mandir}/man1/*
%changelog
* Thu Oct 11 2007 Karl MacMillan <kmacmill@redhat.com> - 0.4.0-2
- Package man files
* Tue Oct 2 2007 Karl MacMillan <kmacmill@redhat.com> - 0.4.0-1
- Milestone 4
* Mon Sep 10 2007 Karl MacMillan <kmacmill@redhat.com> - 0.3.0-1
- Milestone 3
* Fri Aug 17 2007 Karl MacMillan <kmacmill@redhat.com> - 0.2.0-4
- Package additional utilities.

22
ipa-admintools/man/Makefile Normal file
View File

@@ -0,0 +1,22 @@
MANDIR = $(DESTDIR)/usr/share/man
MANFILES=\
ipa-addgroup.1 \
ipa-adduser.1 \
ipa-delgroup.1 \
ipa-deluser.1 \
ipa-findgroup.1 \
ipa-finduser.1 \
ipa-groupmod.1 \
ipa-passwd.1 \
ipa-usermod.1
all: ;
install:
mkdir -p $(MANDIR)/man1
@for i in $(MANFILES) ; do install -m 644 $$i $(MANDIR)/man1 ; gzip $(MANDIR)/man1/$$i ; done
clean:
test:

47
ipa-admintools/man/ipa-addgroup.1 Normal file
View File

@@ -0,0 +1,47 @@
.\" A man page for ipa-addgroup
.\" 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-addgroup" "1" "Oct 10 2007" "freeipa" ""
.SH "NAME"
ipa\-addgroup \- Add a group
.SH "SYNOPSIS"
ipa\-addgroup [\fIOPTION\fR]... \fIgroup\fR
.SH "DESCRIPTION"
Adds a group with group name \fIgroup\fR.
.SH "OPTIONS"
.TP
\fB\-d\fR, \fB\-\-description\fR=\fIdescription\fR
Set the description of the group to \fIdescription\fR.
.TP
\fB\-g\fR, \fB\-\-gid\fR=\fIgid\fR
Set the gid for this group to \fIgid\fR.
If this option is not present, one is created automatically
by .B freeIPA.
.PP
group and description are mandatory fields. If either of
these are not included on the command line you will be asked interactively.
If no options are passed then all questions are asked.
.SH "EXIT STATUS"
The exit status is 0 on success, nonzero on error.

80
ipa-admintools/man/ipa-adduser.1 Normal file
View File

@@ -0,0 +1,80 @@
.\" A man page for ipa-adduser
.\" 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-adduser" "1" "Oct 10 2007" "freeipa" ""
.SH "NAME"
ipa\-adduser \- Add a user
.SH "SYNOPSIS"
ipa\-adduser [\fIOPTION\fR]... \fIuser\fR
.SH "DESCRIPTION"
Adds a user with username \fIuser\fR.
.SH "OPTIONS"
.TP
\fB\-c\fR, \fB\-\-gecos\fR=\fIgecos\fR
Set the \f[SM]GECOS\fR field to \fIgecos\fR.
The \f[SM]GECOS\fR field is traditionally used to store user's real name and other information.
.TP
\fB\-d\fR, \fB\-\-directory\fR=\fIdirectory\fR
Set user's home directory to \fIdirectory\fR.
If this option is not present, a default specified by the
.B freeIPA configuration is used.
.TP
\fB\-f\fR, \fB\-\-firstname\fR=\fIgivenName\fR
Set user's first name to \fIgivenName\fR.
.TP
\fB\-l\fR, \fB\-\-lastname\fR=\fIfamilyName\fR
Set user's last name to \fIfamilyName\fR.
.TP
\fB\-p\fR, \fB\-\-password\fR=\fIpassword\fR
Set user's password to \fIpassword\fR.
.TP
\fB\-s\fR, \fB\-\-shell\fR=\fIshell\fR
Set the user's login shell to \fIshell\fR.
If this option is not present, a default specified by the
.B freeIPA configuration is used.
.TP
\fB\-G\fR, \fB\-\-groups\fR=\fIgroups\fR
Add this user to one or more groups in \fIgroups\fR.
\fIgroups\fR is a comma\-separated list of groups.
Each \fIgroup\fR must already exist.
.TP
\fB\-k\fR, \fB\-\-krb\-principal\fR=\fIprincipal\fR
Set this user's principal to \fIprincipal\fR.
By default the principal is set to \fBuser\fR.
.TP
\fB\-M\fR, \fB\-\-mailAddress\fR=\fImail\fR
Set this user's e\-mail address to \fImail\fR.
.PP
The mandatory fields are: user, first name, last name and password. If any of these are not included on the command line you will be asked interactively.
If no options are passed then all questions are asked.
.SH "EXIT STATUS"
The exit status is 0 on success, nonzero on error.

32
ipa-admintools/man/ipa-delgroup.1 Normal file
View File

@@ -0,0 +1,32 @@
.\" A man page for ipa-delgroup
.\" 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-delgroup" "1" "Oct 10 2007" "freeipa" ""
.SH "NAME"
ipa\-delgroup \- Delete a group
.SH "SYNOPSIS"
ipa\-delgroup \fIgroup\fR
.SH "DESCRIPTION"
Deletes a group with group name \fIgroup\fR.
Members of the group are not affected.
.SH "EXIT STATUS"
The exit status is 0 on success, nonzero on error.

32
ipa-admintools/man/ipa-deluser.1 Normal file
View File

@@ -0,0 +1,32 @@
.\" A man page for ipa-deluser
.\" 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-deluser" "1" "Oct 10 2007" "freeipa" ""
.SH "NAME"
ipa\-deluser \- Delete a user
.SH "SYNOPSIS"
ipa\-deluser \fIuser\fR
.SH "DESCRIPTION"
Deletes a user with name \fIname\fR.
Users are not completely removed with the command, just marked as inactive.
.SH "EXIT STATUS"
The exit status is 0 on success, nonzero on error.

34
ipa-admintools/man/ipa-findgroup.1 Normal file
View File

@@ -0,0 +1,34 @@
.\" A man page for ipa-findgroup
.\" 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-findgroup" "1" "Oct 10 2007" "freeipa" ""
.SH "NAME"
ipa\-findgroup \- Find a group
.SH "SYNOPSIS"
ipa\-findgroup \fIstring\fR
.SH "DESCRIPTION"
Searches for a group that contains \fIstring\fR.
The search is a substring search in the name and description attributes.
All entries that match are displayed.
.SH "EXIT STATUS"
The exit status is 0 on success, nonzero on error.

40
ipa-admintools/man/ipa-finduser.1 Normal file
View File

@@ -0,0 +1,40 @@
.\" A man page for ipa-finduser
.\" 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-finduser" "1" "Oct 10 2007" "freeipa" ""
.SH "NAME"
ipa\-finduser \- Find a user
.SH "SYNOPSIS"
ipa\-finduser [\fIOPTION\fR]... \fIstring\fR
.SH "DESCRIPTION"
Searches for a user that contains \fIstring\fR.
The search is a substring search in the username, given name, family name, telephone Number, organization and title attributes.
All entries that match are displayed.
.SH "OPTIONS"
.TP
\fB\-a\fR, \fB\-\-all
Display all attributes
.PP
By default the full name, home Directory and login shell and username fields are displayed.
.SH "EXIT STATUS"
The exit status is 0 on success, nonzero on error.

41
ipa-admintools/man/ipa-groupmod.1 Normal file
View File

@@ -0,0 +1,41 @@
.\" A man page for ipa-groupmod
.\" 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-groupmod" "1" "Oct 10 2007" "freeipa" ""
.SH "NAME"
ipa\-groupmod \- Modify a group
.SH "SYNOPSIS"
ipa\-groupmod [\fIOPTION\fR]... \fIgroup\fR
.SH "DESCRIPTION"
Updates the members or description of \fIgroup\fR.
.SH "OPTIONS"
.TP
\fB\-a\fR, \fB\-\-add\fR=\fIuser1,user2,...usern\fR
Add one or more users to the group
.TP
\fB\-d\fR, \fB\-\-description\fR=\fIdescription\fR
Modify the description of the group
.TP
\fB\-r\fR, \fB\-\-remove\fR=\fIuser1,user2,...usern\fR
Remove one or more users from the group
.SH "EXIT STATUS"
The exit status is 0 on success, nonzero on error.

31
ipa-admintools/man/ipa-passwd.1 Normal file
View File

@@ -0,0 +1,31 @@
.\" A man page for ipa-passwd
.\" 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-passwd" "1" "Oct 10 2007" "freeipa" ""
.SH "NAME"
ipa\-passwd \- Change a user's password
.SH "SYNOPSIS"
ipa\-password [\fIuser\fR]
.SH "DESCRIPTION"
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 "EXIT STATUS"
The exit status is 0 on success, nonzero on error.

41
ipa-admintools/man/ipa-usermod.1 Normal file
View File

@@ -0,0 +1,41 @@
.\" A man page for ipa-usermod
.\" 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-usermod" "1" "Oct 10 2007" "freeipa" ""
.SH "NAME"
ipa\-usermod \- Modify a user
.SH "SYNOPSIS"
ipa\-usermod [\fIOPTION\fR]... \fIgroup\fR
.SH "DESCRIPTION"
Updates the members or description of \fIgroup\fR.
.SH "OPTIONS"
.TP
\fB\-a\fR, \fB\-\-add\fR=\fIuser1,user2,...usern\fR
Add one or more users to the group
.TP
\fB\-d\fR, \fB\-\-description\fR=\fIdescription\fR
Modify the description of the group
.TP
\fB\-r\fR, \fB\-\-remove\fR=\fIuser1,user2,...usern\fR
Remove one or more users from the group
.SH "EXIT STATUS"
The exit status is 0 on success, nonzero on error.