Added man pages for eurephiadm users and config

2 files changed, 119 insertions, 0 deletions

diff --git a/eurephiadm/man/eurephiadm-config.8 b/eurephiadm/man/eurephiadm-config.8
new file mode 100644
index 0000000..2ced3b4
--- /dev/null
+++ b/eurephiadm/man/eurephiadm-config.8
@@ -0,0 +1,25 @@
+.TH "eurephiadm config" "8" "July 2010" "David Sommerseth" ""
+.SH "NAME"
+eurephiadm config \- Show and modify eurephia configuration settings
+.SH "DESCRIPTION"
+The config command let you add, change or delete
+configuration parameters in the eurephia database
+in an easy way.  To be allowed to do so, you must
+have been granted 'config' access.
+.SH "OPTIONS"
+The following arguments are accepted:
+.TP
+\fB\-l\fR | \fB\-\-list\fR
+List all parameters set in the database
+.TP
+\fB\-s\fR | \fB\-\-set\fR <key> <value>
+Add or change a parameter.
+.TP
+\fB\-D\fR | \fB\-\-delete\fR <key>
+Remove the parameter.
+.TP
+If no arguments is given, you can give a key name, and the associated value will be printed.
+.SH "SEE ALSO"
+\fBeurephiadm\fR(8)
+.SH "AUTHOR"
+Copyright (C) 2008\-2010  David Sommerseth <dazo@users.sourceforge.net>
diff --git a/eurephiadm/man/eurephiadm-users.8 b/eurephiadm/man/eurephiadm-users.8
new file mode 100644
index 0000000..d6c6ec4
--- /dev/null
+++ b/eurephiadm/man/eurephiadm-users.8
@@ -0,0 +1,94 @@
+.TH "eurephiadm users" "8" "July 2010" "David Sommerseth " ""
+.SH "NAME"
+eurephiadm users \- User management module
+.SH "SYNOPSIS"
+.B eurephiadm users
+.RI "\\-\\-list|\\-l [\\-S|\\-\\-sort <sort keys>]"
+.br
+.B eurephiadm users
+.RI "\\-\\-show|\\-s [\\-i|\\-\\-uid <user id>] [\\-u|\\-\\-username <user name>]"
+.RI "[\\-l|\\-|\-lastlog] [\\-L|\\-\\-lastlog\-details] [\\-a|\\-\\-attempts] [\\-b|\\-\\-blacklist]"
+.br
+.B eurephiadm users
+.RI "\\-\\-activate|\\-a [\\-i|\\-\\-uid <user id>] [\\-u|\\-\\-username <user name>]"
+.br
+.B eurephiadm users
+.RI "\\-\\-deactivate|\\-d [\\-i|\\-\\-uid <user id>] [\\-u|\\-\\-username <user name>]"
+.br
+.B eurephiadm users
+.RI "\\-\\-add|\\-A [\\-u|\\-\\-username <user name>] [\\-P|\\-\\-password <plain text password>]"
+.RI "[\\-C|\\-\\-certid <certificate ID>] [\\-D|\\-\\-digest <certificate SHA1 digest>]"
+.RI "[\\-c|\\-\\-certfile <certificate file>] [\\-2|\\-\\-pkcs12]"
+.br
+.B eurephiadm users
+.RI "\\-\\-delete|\\-D [\\-i|\\-\\-uid <user id>] [\\-u|\\-\\-username <user name>]"
+.br
+.B eurephiadm users
+.RI "\\-\\-password|\\-p [\\-i|\\-\\-uid <user id>] [\\-u|\\-\\-username <user name>]"
+.br
+.B eurephiadm users
+.RI "[\\-h|\\-\\-help [<mode>]]"
+.SH "DESCRIPTION"
+\fBeurephiadm users\fR manages eurephia user accounts.  It provides an interface for listing, creating new, modify and delete user accounts.
+.SH "MODES"
+.SS "Available modes:"
+.TP
+.B \-l | \-\-list
+[\-S|\-\-sort <sort keys>]
+.br
+List all user accounts. Providing \fB\-S|\-\-sort\fR and a sort key will define the sort order of the list.  Valid sort keys are:
+.IP
+uid \- user ID
+.br
+username \- User name belonging to the user account
+.br
+activated \- When the user account was activated
+.br
+deactivated \- When the user account was deactivated
+.br
+lastaccess \- When the user account was last used
+.TP
+.B \-s | \-\-show
+[\-i|\-\-uid <user id>] [\-u|\-\-username <user name>] [\-l|\-\-lastlog] [\-L|\-\-lastlog\-details] [\-a|\-\-attempts] [\-b|\-\-blacklist]
+.br
+Show user account details.  \fB\-\-uid\fR or \fB\-\-username\fR are required.  The other arguments only defined which kind of information to show.
+.TP
+.B \-a | \-\-activate
+[\-i|\-\-uid <user id>] [\-u|\-\-username <user name>]
+.br
+Activate a user account.  \fB\-\-uid\fR or \fB\-\-username\fR is required.
+.TP
+.B \-d | \-\-deactivate
+[\-i|\-\-uid <user id>] [\-u|\-\-username <user name>]
+.br
+Deactivate a user account.  \fB\-\-uid\fR or \fB\-\-username\fR is required.
+.TP
+.B \-A | \-\-add
+[\-u|\-\-username <user name>] [\-P|\-\-password <plain text password>] [\-C|\-\-certid <certificate ID>] [\-D|\-\-digest <certificate SHA1 digest>] [\-c|\-\-certfile <certificate file>] [\-2|\-\-pkcs12]
+.br
+Add a new user account.  \fB\-\-username\fR is required.   If you want to assign a password for the new user account via the command line, provide the password with \fB\-\-password\fR.  
+.IP
+To associate this user account against an already regstistered certificate, it can be done by either refering to the certificate ID in eurephia using \fB\-\-certid\fR or providing the certificate SHA1 digest/fingerprint to \fB\-\-digest\fR.
+.IP
+A brand new certificate can be registered and linked to the user account directly if you have access to the certificate file.  The file can be in either PEM/DER format or PKCS#12.  Use \fB\-\-certfile\fR to indicate the certificate file to extract the information from and \fB\-\-pkcs12\fR if it is a PKCS#12 file.
+.TP
+.B \-D | \-\-delete
+[\-i|\-\-uid <user id>] [\-u|\-\-username <user name>]
+.br
+Delete a user account.  \fB\-\-uid\fR or \fB\-\-username\fR is required.
+.TP
+.B \-p | \-\-password
+[\-i|\-\-uid <user id>] [\-u|\-\-username <user name>]
+.br
+Change password on a user account.  \fB\-\-uid\fR or \fB\-\-username\fR is required.
+.TP
+.B \-h | \-\-help\fR
+[<mode>]
+.br
+Show a help screen.  Without any arguments, all modes are listed.  Providing a mode will show more information about the chosen mode.
+.PP
+.SH "SEE ALSO"
+\fBeurephiadm\fR(8)
+\fBeurephiadm\-certs\fR(8)
+.SH "AUTHOR"
+Copyright (C) 2008\-2010  David Sommerseth <dazo@users.sourceforge.net>