Added main man page for the eurephiadm utility

1 files changed, 75 insertions, 0 deletions

diff --git a/eurephiadm/man/eurephiadm.8 b/eurephiadm/man/eurephiadm.8
new file mode 100644
index 0000000..c4a152f
--- /dev/null
+++ b/eurephiadm/man/eurephiadm.8
@@ -0,0 +1,75 @@
+.TH "eurephiadm" "8" "July 2010" "David Sommerseth" ""
+.SH "NAME"
+eurephiadm \- eurephia administration utility
+.SH "SYNOPSIS"
+.B eurephiadm\fR
+.RI "<command>"
+.RI "[\\-h|\\-\\-help] [\\-V|\\-\\-version] [<global options>]"
+.RI "[\\-l|\\-\\-log <filename>] [\\-L|\\-\\-log\\-level <log level>]"
+.RI "[<command arguments>]"
+.SH "DESCRIPTION"
+.B eurephiadm
+is a generic command line tool for administering and
+configuring the eurephia plug\-in for OpenVPN.
+.SH "COMMANDS"
+Available commands in
+.B eurephiadm
+.TP
+\fBhelp\fR [<command>]
+This help screen if no arguments are given.  If a command is given, the help screen for that command is provided.
+.TP
+\fBlogout\fR
+Logout from an active eurephiadm session.  Most of the operations in eurephiadm requires the user to authenticate him/herself.  The session will then be active for a predefined amount of time, not requiring new authentications.  The user will have to authenticate him/herself again if the session timesout or the \fBlogout\fR command is used.
+.TP
+\fBusers\fR [<arguments>]
+User management module.  Lists, adds, removes, activates, deactivates and shows user account information for each eurephia user.
+.TP
+\fBlastlog\fR
+Query the eurephia lastlog.  This log contains information about OpenVPN session authenticated via eurephia.
+.TP
+\fBattempts\fR [<arguments>]
+Show or reset registered failed login attempts registrations.
+.TP
+\fBblacklist\fR [<arguments>]
+Show, add or delete blacklisted user accounts, certificates or IP addresses.
+.TP
+\fBcerts\fR [<arguments>]
+SSL Certificate management for eurephia authentication.
+.TP
+\fBusercerts\fR [<arguments>]
+Manages the relations between eurephia user accounts and certificates.  This combination is called a user access, and defines which access level the authenticated eurephia user will have to the network.
+.TP
+\fBfwprofiles\fR [<arguments>]
+Firewall profile management.  Add, list or delete (iptables) profiles available for eurephia in the operating system.  This feature is only available if eurephiadm was compiled with firewall support.
+.TP
+\fBadminaccess\fR [<arguments>]
+Manages eurephia user accesses to administration utilities like \fBeurephiadm\fR.
+.TP
+\fBshow\-config\fR
+List all config settings set in the database and in the \fB~/.eurephia/eurephiadm.cfg\fR file.
+.TP
+\fBshow\-configfile\fR
+Similar to the \fBshow\-config\fR command, but lists only the parsed settings in the \fB~/.eurephia/eurephiadm.cfg\fR file.
+.TP
+\fBconfig\fR [<arguments>]
+Add, delete or show eurephia configuration settings stored in the database.
+.SH "FILES"
+.TP
+.B ~/.eurephia/eurephiadm.cfg
+Default configuration file which defines the database driver and the needed database parameters.
+.SH "ENVIRONMENT"
+.TP
+.B EUREPHIA_DIR
+The \fBeurephiadm\fR utility looks for a configuration file by default in \fB~/.eurephia/eurephiadm.cfg\fR.  This directory can be overridden by setting the \fBEUREPHIA_DIR\fR environment variable, and eurephiadm will use the \fBeurephiadm.cfg\fR file in this directory instead.
+.SH "SEE ALSO"
+\fBeurephiadm\-users\fR(8)
+\fBeurephiadm\-lastlog\fR(8)
+\fBeurephiadm\-attempts\fR(8)
+\fBeurephiadm\-blacklist\fR(8)
+\fBeurephiadm\-certs\fR(8)
+\fBeurephiadm\-usercerts\fR(8)
+\fBeurephiadm\-fwprofiles\fR(8)
+\fBeurephiadm\-adminaccess\fR(8)
+\fBeurephiadm\-config\fR(8)
+.SH "AUTHOR"
+Copyright (C) 2008\-2010  David Sommerseth <dazo@users.sourceforge.net>