Add manpages and remove TODO

This commit is contained in:
Michael Spang 2007-12-16 18:26:18 -05:00
parent 06d1e8b48b
commit 14069b2c08
5 changed files with 47 additions and 7 deletions

1
debian/manpages vendored Normal file
View File

@ -0,0 +1 @@
docs/*.[0-9]

View File

@ -1,7 +0,0 @@
TODO:
* Python bindings for libkadm5
* Python bindings for quota?
* Logging via syslog
* Try to recover and roll-back on error during account creation
* Write manpages

13
docs/addclub.1 Normal file
View File

@ -0,0 +1,13 @@
.TH ADDCLUB 1 "December 16, 2007"
.SH NAME
addclub \- add club accounts to the directory
.SH SYNOPSIS
.B addclub
userid clubname
.SH DESCRIPTION
.B Addclub
creates an LDAP entry and home directory for new club accounts.
.SH SEE ALSO
.BR ceo (1).
.SH AUTHOR
Michael Spang <mspang@csclub.uwaterloo.ca>

16
docs/addmember.1 Normal file
View File

@ -0,0 +1,16 @@
.TH ADDMEMBER 1 "December 16, 2007"
.SH NAME
addmember \- add club members to the directory
.SH SYNOPSIS
.B addmember
userid name [ program ]
.SH DESCRIPTION
.B Addmember
performs all tasks necessary for creation of a new CSC member. It creates
an LDAP entry, Kerberos principal, and home directory for the new member.
It does NOT register the new member for any terms. This must be done after
the member is created.
.SH SEE ALSO
.BR ceo (1).
.SH AUTHOR
Michael Spang <mspang@csclub.uwaterloo.ca>

17
docs/ceo.1 Normal file
View File

@ -0,0 +1,17 @@
.TH CEO 1 "December 16, 2007"
.SH NAME
ceo \- CSC Electronic Office
.SH DESCRIPTION
CSC Electronic Office is used to manage membership registration and
user accounts for the Computer Science Club. It has a graphical
user interface, started by typing
.B ceo
with no arguments.
.PP
.SH SEE ALSO
.BR addmember (1),
.BR addclub (1).
.SH AUTHORS
Michael Spang <mspang@csclub.uwaterloo.ca>
.br
David Bartley <dtbartle@csclub.uwaterloo.ca>