From 650f9d746974467ff18687fb8460b127d4ce0d5d Mon Sep 17 00:00:00 2001 From: David Sommerseth Date: Thu, 1 Jul 2010 22:39:08 +0200 Subject: Added man pages for eurephiadm users and config --- eurephiadm/man/eurephiadm-config.8 | 25 ++++++++++ eurephiadm/man/eurephiadm-users.8 | 94 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 119 insertions(+) create mode 100644 eurephiadm/man/eurephiadm-config.8 create mode 100644 eurephiadm/man/eurephiadm-users.8 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 +Add or change a parameter. +.TP +\fB\-D\fR | \fB\-\-delete\fR +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 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 ]" +.br +.B eurephiadm users +.RI "\\-\\-show|\\-s [\\-i|\\-\\-uid ] [\\-u|\\-\\-username ]" +.RI "[\\-l|\\-|\-lastlog] [\\-L|\\-\\-lastlog\-details] [\\-a|\\-\\-attempts] [\\-b|\\-\\-blacklist]" +.br +.B eurephiadm users +.RI "\\-\\-activate|\\-a [\\-i|\\-\\-uid ] [\\-u|\\-\\-username ]" +.br +.B eurephiadm users +.RI "\\-\\-deactivate|\\-d [\\-i|\\-\\-uid ] [\\-u|\\-\\-username ]" +.br +.B eurephiadm users +.RI "\\-\\-add|\\-A [\\-u|\\-\\-username ] [\\-P|\\-\\-password ]" +.RI "[\\-C|\\-\\-certid ] [\\-D|\\-\\-digest ]" +.RI "[\\-c|\\-\\-certfile ] [\\-2|\\-\\-pkcs12]" +.br +.B eurephiadm users +.RI "\\-\\-delete|\\-D [\\-i|\\-\\-uid ] [\\-u|\\-\\-username ]" +.br +.B eurephiadm users +.RI "\\-\\-password|\\-p [\\-i|\\-\\-uid ] [\\-u|\\-\\-username ]" +.br +.B eurephiadm users +.RI "[\\-h|\\-\\-help []]" +.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 ] +.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 ] [\-u|\-\-username ] [\-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 ] [\-u|\-\-username ] +.br +Activate a user account. \fB\-\-uid\fR or \fB\-\-username\fR is required. +.TP +.B \-d | \-\-deactivate +[\-i|\-\-uid ] [\-u|\-\-username ] +.br +Deactivate a user account. \fB\-\-uid\fR or \fB\-\-username\fR is required. +.TP +.B \-A | \-\-add +[\-u|\-\-username ] [\-P|\-\-password ] [\-C|\-\-certid ] [\-D|\-\-digest ] [\-c|\-\-certfile ] [\-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 ] [\-u|\-\-username ] +.br +Delete a user account. \fB\-\-uid\fR or \fB\-\-username\fR is required. +.TP +.B \-p | \-\-password +[\-i|\-\-uid ] [\-u|\-\-username ] +.br +Change password on a user account. \fB\-\-uid\fR or \fB\-\-username\fR is required. +.TP +.B \-h | \-\-help\fR +[] +.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 -- cgit