From 14069b2c08e162374070787493bde1e4d435b7ed Mon Sep 17 00:00:00 2001 From: Michael Spang Date: Sun, 16 Dec 2007 18:26:18 -0500 Subject: [PATCH] Add manpages and remove TODO --- debian/manpages | 1 + docs/TODO | 7 ------- docs/addclub.1 | 13 +++++++++++++ docs/addmember.1 | 16 ++++++++++++++++ docs/ceo.1 | 17 +++++++++++++++++ 5 files changed, 47 insertions(+), 7 deletions(-) create mode 100644 debian/manpages delete mode 100644 docs/TODO create mode 100644 docs/addclub.1 create mode 100644 docs/addmember.1 create mode 100644 docs/ceo.1 diff --git a/debian/manpages b/debian/manpages new file mode 100644 index 0000000..afc0dc3 --- /dev/null +++ b/debian/manpages @@ -0,0 +1 @@ +docs/*.[0-9] diff --git a/docs/TODO b/docs/TODO deleted file mode 100644 index e146ba5..0000000 --- a/docs/TODO +++ /dev/null @@ -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 diff --git a/docs/addclub.1 b/docs/addclub.1 new file mode 100644 index 0000000..0e51829 --- /dev/null +++ b/docs/addclub.1 @@ -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 diff --git a/docs/addmember.1 b/docs/addmember.1 new file mode 100644 index 0000000..2765aa4 --- /dev/null +++ b/docs/addmember.1 @@ -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 diff --git a/docs/ceo.1 b/docs/ceo.1 new file mode 100644 index 0000000..ebbe59d --- /dev/null +++ b/docs/ceo.1 @@ -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 +.br +David Bartley