========================================================
Swamp 1.1.0, FAQ document ("Frequently Asked Questions")
========================================================

This document should serve as a "first-port-of-call" for anyone who thought they
understood something but got confused, or for anyone experiencing problems that
appear to have no rational explanation elsewhere in the "documents". Some of
these questions come from discussion I've had with people using swamp, and some
are ones I thought I would ask if I managed to get myself in the "lost user"
situation in the standard easy-to-do ways.

For other types of information see;

README:  General discussion of what swamp is, how to use it, and why it exists.
INSTALL: Instructions on configuring, compiling, and "install"ing swamp.
LICENSE: Rule and regs about redistribution of swamp, or incorporation into
         other projects or commercial products/distributions.
CHANGES: A list summarising changes in swamp over time/versions, and the names
         of (and thanks to) those who made them happen.

FYI: Swamp is written by Geoff Thorpe (swamp@geoffthorpe.net), as is this dinky
little document. The major contributors to swamp thus far are;

    Steve Robb <steverobb@ukgateway.net>

Please see CHANGES for more info on "who?", "when?", and "what exactly?".


================================
FAQ (Frequently Asked Questions)
================================

Before starting, it's worth noting - this FAQ is not what I'd call "extensive"
right now. I merely wanted to put this document into shape for when I have the
time to go through some basic FAQ stuff of my own or to sift through mails I
have had with others to pull out usable bits.

It is *also* worth mentioning that many items in the README document
(particularly the "Section III: Hints about using swamp" section) may be what
you are looking for here (and not finding). Please read the README before
searching here for the answer to a problem (and likewise the INSTALL file if it
involves compiling swamp).

So, if after all that you have a "Q", mail it to me (swamp@geoffthorpe.net) and
I will attempt to "A" it. If that "Q" is "F" enough, it will become, by
definition, an "FAQ". Watch this space.

So, here we go;

Hardware acceleration
---------------------
Q: Does "swamp" support the use of hardware acceleration?
A: Yes, but only if the version of OpenSSL that "swamp" is built with supports
   the hardware via the "ENGINE" interface. If that version of OpenSSL supports
   "ENGINE" at all, "swamp" will support the "-engine <id>" command-line switch,
   otherwise it will not even recognise that option. Assuming OpenSSL supports
   the hardware you want via an ENGINE id string (and the support, hardware, and
   drivers are all properly installed and functioning), you simply pass the "id"
   of the required ENGINE to swamp via the "-engine" switch and it will ask
   OpenSSL to load and use that ENGINE wherever possible.

Platform problems
-----------------
Q: Why does "swamp" configure OK on my <whatever> system yet running "make"
   gives me an error?
A: Automake. It generates (currently) makefiles that aren't as portable as they
   should be. See section III of the INSTALL document for more details.

Q: Why does "swamp" configure OK on my <whatever> system yet "make" causes the
   compiler to fail when compiling the first C file?
A: Automake. It generates (currently) ... oh, read the answer to the previous
   question. It's probably Solaris (or a system doing the same thing as). The
   generated Makefile is trying to do weird dependency stuff that just doesn't
   work on the system in question. You need to edit the Makefile after running
   "./configure". See section III of INSTALL.