Linux FreeS/WAN Index file
This is an index file for the Linux FreeS/WAN documentation.
Most files described here are in the doc directory after the distribution
is unpacked and are in HTML format.
If you prefer text files over HTML, see doc/README for instructions
on creating them.
Files most users should read
- How to set up a simple network with FreeS/WAN. This also
covers initial installation.
- Configuration of FreeS/WAN.
- a list of FreeS/WAN man pages with links to HTML versions.
They are also of course available via the man command.
- information on the project mailing list
- problem reporting
- Troubleshooting
using our ipsec_barf(8) and ipsec_look(8) tools and other tools such as tcpdump(8) and sniffers
Distribution text files
Text files in the main distribution directory are README,
INSTALL, CREDITS,
CHANGES, and COPYING.
License and copyright information
All code and documentation written for this project is distributed under either the
GNU General Public License (GPL) or the GNU Library
General Public License. For details see COPYING.
Not all code in the distribution is ours, however. See
CREDITS for details. In particular, note that the
Libdes library has its own license
Printed documentation
Those who prefer documentation in printed form can, of course, print any of the HTML
documents or man pages in the usual way, and are free to write whatever scripts they
like to reformat them in the process.
(We would like to see any interesting scripts you come up with. Please post them,
or a suitable pointer, to the mailing list. Of course, if
they have any code specifically related to cryptography, you must consult your
local export laws first.)
We also provide three files designing for use with the "make book" command in the
Amaya web browser/editor from the
World Wide Web Consortium.
Going to any of these files with Amaya and clicking on the "make book" command
will give you one large file, with an automatically generated table of contents,
for browsing or printing:
These files are also usable without Amaya. Without Amaya, you cannot build the single
large "book" file, but you can follow the links to its components.
Project background information
Reference information
Automatically generated link files
Run 'make' in the doc directory if these files aren't there.
Other reference files
Specialised information
- Troubleshooting
using our ipsec_barf(8) and ipsec_look(8) tools and other
tools such as tcpdump(8) and sniffers
- Compatibility information culled from the
mailing list on using FreeS/WAN with:
- Linux distibutions other than Redhat
- CPUs other than Intel architecture
- other IPSEC implementations
- Configuration for setups with unusual requirements such as:
- implementation notes on various topics
- cross-reference between various standards and the
FreeS/WAN code and utilities