                                                                        Read Me
                        INSTALL THE W3C REFERENCE CODE
                                       
   
   ___________________________________
   
        (c) COPYRIGHT MIT 1995.
        Please first read the full copyright statement in the file COPYRIGH.

   This is the README file which you get when you unwrap one of our
   distribution files. Each package contains source code for building one or
   more of our Web applications and related helper applications. The set of W3C
   Web applications is currently:
   
      W3C Reference Library
      
      W3C Line Mode Browser
      
      W3C Command Line Tool
      
      W3C Mini Server
      
      W3C Mini Robot
      
   Please note that the W3C Reference Library distribution file is required in
   order to build any of the other applications. At the bottom of this file,
   you will find pointers to more information about each application.
   
Handling the Distribution Files

   A distribution file contains the source code for one or more of the modules.
   W3C also provides a set of precompiled binaries which are available for W3C
   members directly via HTTP or as public domain via anonymous FTP from
   ftp.w3.org.
   
   All distribution files are available as compressed tar files, gzipped tar
   files, or as zip files. For the compressed tar files, first uncompress and
   untar the file <dist>.tar.Z where <dist> is the name of the specific
   distribution:
   
        uncompress <dist>.tar.Z

        gunzip <dist>.tar.gz

   Then untar the file by typing
   
        tar xf <dist>.tar

   For the zip files, type the following:
   
        unzip <dist>.zip

Generated Directory structure

   The distribution files are all designed to be unwrapped in the directory
   named "WWW". They create different parts of a common directory tree under
   that directory. A minor part of this three will be included in multiple
   distribution files. A distribution file also contains a few informative
   files like this README file, a copyright statement, and installation
   instructions. Please take a moment to study these files. The structure of
   all the unpacked distribution file is as follows (directories):
   
        WWW                             Top-node

        WWW/All/*/Makefile.include      Platform dependent make files

@       WWW/Library                     W3C Reference Library
        WWW/Library/Implementation      Source Code
        WWW/Library/User                Documentation
        WWW/Library/User/Patch          Patches
        WWW/Library/<platform>/*        Platform dependent object files

@       WWW/LineMode                    W3C LineMode Browser
        WWW/LineMode/Implementation     Source Code
        WWW/LineMode/Defaults/          Documentation
        WWW/Library/User/Patch          Patches
        WWW/LineMode/<platform>/*       Platform dependent object files

@       WWW/MiniServ                    W3C Mini Server (example)
        WWW/MiniServ/Implementation     Source Code
        WWW/MiniServ/User/              Documentation
        WWW/MiniServ/User/Patch         Patches
        WWW/MiniServ/<platform>/*       Platform dependent object files

@       WWW/ComLine                     W3C Command Line Tool (example)
        WWW/ComLine/Implementation      Source Code
        WWW/ComLine/User/               Documentation
        WWW/ComLine/User/Patch          Patches
        WWW/ComLine/<platform>/*        Platform dependent object files

@       WWW/Robot                       W3C Mini Robot (example)
        WWW/Robot/Implementation        Source Code
        WWW/Robot/User/                 Documentation
        WWW/Robot/User/Patch            Patches
        WWW/Robot/<platform>/*  Platform dependent object files

   "@" means that each of these modules are given out as a separate
   distribution file.  Some or more of these directories might not be there but
   please make sure that at least the W3C Reference Library is.
   
Compilation

   Compilation can be put into two groups depending on your platform and if it
   is supported in the BUILD script or not. The BUILD script is placed in the
   WWW directory and you can use it to compile and link the W3C applications.
   The BUILD script figures out what platform you are on and generates a
   Makefile which consists of a platform independent part and a platform
   dependent part.
   
  COMPILATION ON ALREADY SUPPORTED UNIX PLATFORMS
  
   [IMAGE] Stop here and take a look at the "Patches" pages (indicated in the
   Generated Directory structure to see if you need to apply any patches before
   you compile any of the modules. You can find the Patches
   
   To BUILD any of the applications go to the WWW directory and type
   
        ./BUILD library

        ./BUILD daemon

        ./BUILD linemode

        ./BUILD comline

        ./BUILD miniserv

        ./BUILD robot

  COMPILATION ON UN-SUPPORTED UNIX PLATFORMS
  
   For other Unix platforms please read the guide on how to adjust the BUILD
   script for compilation on your platform.
   
  COMPILATION ON WINDOWS
  
   For Windows we have some special documentation on how you can produce DLLs
   out of the Reference Library.
   
W3C Reference Library

   The W3C Reference Library is a general code base that can be used to build
   clients and servers. It contains code for accessing HTTP, FTP, Gopher, News,
   WAIS, Telnet servers, and the local file system. Furthermore it provides
   modules for parsing, managing and presenting hypertext objects to the user
   and a wide spectra of generic programming utilities. The Library is the
   basis for many World-Wide Web applications and all the W3C software is build
   on top of it. The Library is a required part of all other W3C applications
   in this distribution.
   
   The Library documentation is included in the distribution file and you can
   find the top page at
   
        Library/User/Overview.html

   You can also use the online documentation
   
W3C Line Mode Browser

   The W3C Line Mode Browser is a simple character based client. It is
   developed for use on dumb terminals and as a test tool for the Common Code
   Library. It can be run in interactive mode, non- interactive mode and as a
   proxy client. Furthermore it gives a variety of possibilities for data
   format conversion, filtering etc. It is primarily intended as a test-tool
   for quick access to the Web or used in batch jobs.
   
   Installation is very simple as the application can run without any
   particular setup. You can specify your own HOME PAGE using the WWW_HOME
   environment variable. Remember toy setup a NNTPSERVER environment variable
   before you try to access a news server.
   
   The Line Mode Browser documentation is included in the distribution file and
   you can find the top page at
   
        LineMode/Defaults/Overview.html

   You can also use the online documentation
   
W3C Mini Server

   The W3C Mini Server is a cross platform server frame work that can be used
   as a basis for writing portable servers. It is NOT a full server - only a
   frame! It is developed in C and serves as an example of a server application
   using the W3C Reference Library.
   
   The Mini Server documentation is included in the distribution file and you
   can find the top page at
   
        MiniServ/User/Overview.html

   You can also use the online documentation
   
W3C Command Line Tool

   The W3C Command Line Tool is a cross platform command line tool for
   accessing the Web. It is developed in C and serves as an example of a client
   application using the W3C Reference Library and as a test-tool for quick
   access to the Web from scripts, cron jobs etc. It gives a variety of
   possibilities for data format conversion, filtering etc. It is primarily
   intended as a test-tool for quick access to the Web or used in scripts, cron
   jobs etc.
   
   The Command Line Tool documentation is included in the distribution file and
   you can find the top page at
   
        ComLine/Defaults/Overview.html

   You can also use the online documentation
   
W3C Mini Robot

   The W3C Mini Robot is a cross platform command line tool for accessing the
   Web. It is developed in C and serves as an example of a robot application
   using the W3C Reference Library and as a test-tool for quick access to the
   Web from scripts, cron jobs etc. It is primarily intended as a test-tool for
   quick access to the Web or used in scripts, cron jobs etc.
   
   The W3C Mini Robot documentation is included in the distribution file and
   you can find the top page at
   
        Robot/Defaults/Overview.html

   You can also use the online documentation
   
Got Problems or Comments?

   If you encounter problems, would like to feed back suggestions good ideas
   etc. then please send a mail explaining your problem and the version of the
   W3C software to libwww@w3.org
   
Useful Pointers

   These are the locations where you can get more information.
   
  W3C MEMBERS
  
      http://www.w3.org/member/WWW/Library/
      
      http://www.w3.org/member/WWW/LineMode/
      
      http://www.w3.org/member/WWW/MiniServ/
      
      http://www.w3.org/member/WWW/ComLine/
      
      http://www.w3.org/member/WWW/Robot/
      
  OTHERS
  
      http://www.w3.org/pub/WWW/Library/
      
      http://www.w3.org/pub/WWW/LineMode/
      
      http://www.w3.org/pub/WWW/MiniServ/
      
      http://www.w3.org/pub/WWW/ComLine/
      
      http://www.w3.org/pub/WWW/Robot/
      
   Have fun!
   
   
   ___________________________________
   
                                          Henrik Frystyk Nielsen, December 1995
                                                                               
   
