Added man pages for eurephia-auth.so and edb-sqlite.so

2 files changed, 80 insertions, 0 deletions

diff --git a/database/sqlite/edb-sqlite.8 b/database/sqlite/edb-sqlite.8
new file mode 100644
index 0000000..0a61843
--- /dev/null
+++ b/database/sqlite/edb-sqlite.8
@@ -0,0 +1,31 @@
+.TH "edb-sqlite" "8" "July 2010" "David Sommerseth" ""
+.SH "NAME"
+\fBedb\-sqlite\fR \- eurephia SQLite3 database driver
+.SH "DESCRIPTION"
+The \fBedb\-sqlite\fR database driver is used to enable SQLite3 database in \fBeurephia\fR.  The SQLite3 database is file based and requires no server setup at all.
+.PP 
+The database driver takes only one argument, which is a full path to the database file.b
+.SH "EXAMPLES"
+.TP 
+\fBeurephia\-auth\fR \- This is configured via the OpenVPN configuration file.
+.IP 
+plugin eurephia\-auth.so "\-i edb\-sqlite.so \-\- <full path to database file>"
+.IP 
+Plese notice the double dashes.  They are separating the arguments between the eurephia\-auth module and the database driver.
+.TP 
+\fBeurephia_init\fR \- This is set via the command line
+.IP 
+user@server:~ $ eurephia_init \-\-database\-driver edb\-sqlite.so \\ \-\-database\-args "<full path to DB file>"
+.TP 
+\fBeurephiadm\fR \- This is configured in the \fB~/.eurephia/eurephiadm.cfg\fR file
+.IP 
+database_driver = edb\-sqlite.so
+.br 
+database_params = <full path to DB file>
+.SH "SEE ALSO"
+\fBeurephia\-auth\fR(8)
+\fBeurephiadm\fR(8)
+\fBeurephia_init\fR(8)
+
+.SH "AUTHOR"
+Copyright (C) 2008\-2010  David Sommerseth <dazo@users.sourceforge.net>
diff --git a/plugin/eurephia-auth.8 b/plugin/eurephia-auth.8
new file mode 100644
index 0000000..0d27978
--- /dev/null
+++ b/plugin/eurephia-auth.8
@@ -0,0 +1,49 @@
+.TH "eurephia-auth" "8" "July 2010" "David Sommerseth" ""
+.SH "NAME"
+\fBeurephia\-auth\fR \- The eurephia OpenVPN authentication plug\-in
+.SH "DESCRIPTION"
+The \fBeurephia\-auth.so\fR is a plug\-in for OpenVPN.  It is loaded by providing the \fB\-\-plugin\fR option in the OpenVPN configuration.
+.PP 
+The syntax for OpenVPN and eurephia\-auth is:
+.IP 
+plugin eurephia\-auth.so "<plugin args> \-\- <DB args>"
+.PP 
+Please notice the quotes and the double dash.  They are important markers so that the eurephia\-auth module receives all arguments (the quotes) and that it knows when to pass on the rest of the arguments to the defined database driver, separated by the double dash.  This manual page will only look at the \fB<plugin args>\fR options.  For the \fB<DB args>\fR options, refer to the corresponding database driver you are using.
+
+.SH "OPTIONS"
+.TP 
+\fB\-\-log\-destination\fR | \fB\-l\fR
+This defines how eurephia will do its logging. It can take a filename to log to a file. If the string
+is \fBopenvpn:\fR it will pass the log data over to OpenVPN, which will combine the OpenVPN and
+eurephia logs. You can also log via syslog, by indicating \fBsyslog:\fR. The last possible special value is
+\fBnone:\fR which will disable logging completely.
+.IP 
+With syslog: you can also define which syslog facility the logging will go to. The default is to log
+to the user facility. Other supported facilities are authpriv, daemon and local0 to local7. To
+send log data to the daemon the \-\-log\-destination argument need to be
+.IP 
+    \-\-log\-destination syslog:daemon
+.TP 
+\fB\-\-log\-level\fR | \fB\-L\fR
+This defines how verbose the eurephia logging will be. The required argument to this option must be
+a numeric value, where 0 indicates as little logging as possible \- only giving informative messages,
+or a high value like 50 to give really verbose logging. In general a log level less than 4 should be
+more than enough under normal circumstances.
+.IP 
+.B NOTICE:
+The highest log level is 10, unless the eurephia\-auth modules have been compiled with debug features.
+.TP 
+\fB\-\-database\-interface\fR | \fB\-i
+This argument must have a full path to the eurephia database driver module. This defines which
+database interface eurephia will use.
+.SH "OPENVPN CLIENTS"
+The only change the OpenVPN clients needs to do is to add
+.IP 
+auth\-user\-pass
+.PP 
+to their configuration file.  This instructs the OpenVPN client to ask for user name and password when starting the connection.
+.SH "SEE ALSO"
+\fBeurephia\-sqlite\fR(8)
+\fBeurephia_init\fR(8)
+.SH "AUTHOR"
+Copyright (C) 2008\-2010  David Sommerseth <dazo@users.sourceforge.net>