OracleAuth Manual
-----------------

Setting         | Default
----------------------------
oracle_user     |
oracle_pass     |
oracle_db       | users
oracle_table    | maildb
field_user      | username
field_pass      | password
field_translate |
loglevel        | info
debug           | false
domain          | 
use_sha         | true

oracle_user:     This is the login username for the oracle database.

oracle_pass:     This is the login password for the oracle database.

oracle_db:       This is the name of the oracle database.

oracle_table:    This is the table within the oracle database to use.

field_user:      This is the name of the field that contains the users username.

field_pass:      This is the name of the field what contains the users password.

field_translate: This setting allows you to translate field names, for example
                 "field_translate forward fwd" will cause oracleauth to read
                 the "forward" field from the database and return it as "fwd",
                 the opposite is true if you set a user and set fwd="foo" then
                 oracleauth will set the forward field to "foo".

loglevel:        The amount of data to log, error logs only errors, info logs 
                 errors and info, debug logs everything.
             
debug:           If set to "true" has same effect as "loglevel debug".

domain:          The domain name, if set this domain name is appended to all 
                 usernames returned by all the commands. It is NOT appended to
                 usernames added to the system.
                 
use_sha:         This tells oracleauth to encrypt users passwords with our ssha
                 encryption routines. Oracleauth will now successfull check both
                 ssha and clear text passwords.
             
Command line options
--------------------

-path        Tells Oracleauth where to create it's logfile and where to find it's
             config file.
             
-debug       Sets the logging level to debug.


Supported commands
------------------

check <user> <pass>
lookup <user>
set <user> <pass>|(NULL) [label="value"]
del <user>
search <string> [-from n] [-max m]
version
help
quit
exit

check        Verifies user <user> has password <pass>, this command also
             returns the users other field values.
             
lookup       Verifies the existance of user <user> and returns users fields
             as the check field above does.
             
set          Add new user or modify an existing user. The special case (NULL)
             is used to modify a users info without re-setting the password.
             Label="value" is the format used to set the other database fields.

del          Deletes a user.

search       Returns a list of users matching the search <string>, the string
             may contain a * or ? wildcard, if it does the string is matched
             as if it was a wildcard string, otherwise a match is found only
             if the username contains the string.

version      Returns the version number.

help         Returns the above list of commands

quit         Ends session

exit         Ends session


Command responses
-----------------

A command will usually respond with a one line response, that response will
start with +OK or -ERR, example:
  +OK User test@domain.com created successfully
  -ERR Failed to create test@domain.com

If a command wants to return more that one line as a response it will send
lines starting with +DATA before the final +OK or -ERR response, example:
  +DATA test@domain.com config 0
  +DATA test2@domain.com config 0
  +OK Search Complete 2 items found out of 80

If UnixAuth has a fatal error while trying to initialise then it will return
a -DEAD message like the following...
  -DEAD Failed to load config settings, access denied
  
If you have any questions about OracleAuth please don't hesitate to contact:
  support-netauth@netwinsite.com
