          WWWOFFLE - World Wide Web Offline Explorer - Version 1.2e
          =========================================================

Simple Installation
-------------------

The following nine steps should be sufficient to demonstrate wwwoffle running.

1) Edit the Makefile to set the path for installation (INSTDIR), the spool
   directory (SPOOLDIR), and the compiler options (CC,CFLAGS).
   (The Makefile includes some machine specific options for non-Linux machines
    that may need to be uncommented.)

2) Compile the programs
     make all

3) Install the programs and create the spool directory
     make install

        **** Important * If you currently use version 1.0 ****
    This version does not have the wwwoffles program in $(INSTDIR)/sbin
    that version 1.0 had.  You *must* remove that file before installing
    this version.
        **** Important * If you currently use version 1.0  ****

4) Start the wwwoffle demon running.
   $(INSTDIR)/sbin/wwwoffled -c $(SPOOLDIR)/wwwoffle.conf

        **** Important * If you must use an external HTTP proxy ****
    You will need to add the name of the proxy and the port number to the
    configuration file $(SPOOLDIR)/wwwoffle.conf, read it for instructions.
        **** Important * If you must use an external HTTP proxy ****

        **** Important * If you currently use version 1.0 ****
    The configuration file $(SPOOLDIR)/wwwoffle.conf now contains all the
    parameters that were command line options to wwwoffled in earlier versions.
        **** Important * If you currently use version 1.0 ****

        **** Important * If you currently use version 1.1 ****
    The configuration file $(SPOOLDIR)/wwwoffle.conf has changed, the DontCache
    section is now called LocalNet.
        **** Important * If you currently use version 1.1 ****

        **** Important * If you currently use version 1.2b or earlier ****
    The wwwoffle demon now disconnects itself from the teerminal when run unless
    -d is used, this means that you do not need an '&' to run it in background.
        **** Important * If you currently use version 1.2b or earlier ****


5) Start your WWW Browser and set up localhost:8080 as the proxy.
   Disable caching between sessions within the browser.

6) a) Connect to the internet
   b) Tell the wwwoffle demon that you are online
        wwwoffle -online
   c) Start browsing
   d) Tell the wwwoffle demon that you are offline
        wwwoffle -offline
   e) Disconnect from the internet

7) Go back and browse the pages again while not connected, follow some different
   links this time (you will see a wwwoffle server message in the browser).

8) a) Connect to the internet
   b) Tell the wwwoffle demon that you are online
        wwwoffle -online
   c) Tell the wwwoffle demon to fetch the new pages
        wwwoffle -fetch
   d) Tell the wwwoffle demon that you are offline
        wwwoffle -offline
   e) Disconnect from the internet

9) a) Go to http://localhost:8080/ and find the newly downloaded pages.
   b) Browse the new pages that have just been fetched.


Compile Time Options
--------------------

In the file wwwoffle.h there are a number of extra compile time options that you
may want to change.


The first three are the compiled in defaults for the options in the StartUp
section of the wwwoffle.conf file.

/*+ The default port number to use for the http proxy demon. +*/
#define DEF_HTTP_PORT 8080

/*+ The default port number to use for the wwwoffle control. +*/
#define DEF_WWWOFFLE_PORT 8081

/*+ The default spool directory. +*/
#define DEF_SPOOL "/var/spool/wwwoffle"


The next one is the compiled in default for the Purge section age of files to
purge.

/*+ The default age of pages in days before purging. +*/
#define DEF_PURGE_AGE 14


The next four limit the number of connections that wwwoffle will accept at a
time and the number of servers that it will fork in response to this.  A total
of MAX_SERVERS, including up to MAX_FETCH_SERVERS when 'wwwoffle -fetch' is run.
These are options in wwwoffle.conf, but the absolute maximum values can be
changed here as well as the default values.

/*+ The absolute maximum number of servers to fork in total. +*/
#define MAX_SERVERS 64
/*+ The default total number of servers to fork. +*/
#define DEF_MAX_SERVERS 8

/*+ The absolute maximum number of servers to fork for fetching previously
    requested pages. +*/
#define MAX_FETCH_SERVERS 48
/*+ The default number of servers to fork for fetching pages. +*/
#define DEF_MAX_FETCH_SERVERS 4


The next option should not be changed, but it is the character that is used to
replace the '/' in path names when the files are written into the cache.

/*+ The character to use to replace '/' in the spool directories. +*/
#define PATH_SEP '%'


The last one is the amount of time that wwwoffle will wait trying to read from a
server before giving up and putting an error mesage in the cache instead.

/*+ The time in seconds to wait while reading from a socket. +*/
#define SOCKET_TIMEOUT 120


More Information
----------------

The README and manual pages give more detail on how to use the programs.

This program has been tested by me on Linux 2.0.29 with Netscape version 1.12,
Mosaic version 2.6, Lynx version 2.5, Arena version Beta 3b, Chimera 1.70 and
Emacs W3-mode version 3.  Other people have tested previous versions of the
program on different Linux and UNIX versions with different browsers.

If you wish to submit bug reports or other comments about the programs then
email me at amb@gedanken.demon.co.uk and put wwwoffle in the subject line.
