//
  /////u  // //         craftware        ===========
   //    // //         utilities        httprec 1.3
  // // // // // //                    ===========
 // // //  yt ///    www.utillyty.eu
             //

 httprec is a firefox addon to record visited web pages
 as to be viewed offline.

 QUICK REFERENCE

    1. Release notes
    2. Install
    3. Usage
    4. Licence
    5. Develope
    6. Revisions history


 1. Release notes
    =============

    version 1.3, 19 Oct 2009

    Project has been tested in firefox 3.5.3
    and everything is working fine.


 2. Install
    =======

    You can download httprec from one of the following sites
    (setup is automatically performed by firefox):

    - https://addons.mozilla.org/it/firefox/addon/9134
      (Firefox addons site - versione 1.3)

    - http://www.softpedia.com/get/Internet/Internet-Applications-Addons/Mozilla-Extensions/Attilio-Pavone-Http-Recorder.shtml
      (softpedia mac list - versione 1.2)

    - http://mac.softpedia.com/get/Internet-Utilities/Http-Recorder.shtml
      (softpedia mac list - versione 1.2)

    - http://www.utillyty.eu/software/httprec.xpi
      (the author's site - versione 1.3)

    NOTE: to run httprec on the last (3.5.3) version of firefox you need
          version 1.3.


 3. Usage
    =====

    httprec GUI consists of a menu button in firefox status bar
    with the following commands:

      - settings
      - record
      - play
      - stop
      - pause

    To start using httprec follows the steps below.

    * Record
      ------

      - Create a directory of your choice in your filesystem.

      - Click the "setting" buttons. In the "Working folder" text field put
        the full path of the directory.

      - Click the "record" button and start navigating. From now on
        all visited urls will be saved and catalogued.
        If you want to skip (not record) some page, click the "pause" button.
        Reclick the "play" button to restart recording.

      - Click the stop button.
        DON'T FORGET TO CLICK THE STOP BUTTON BEFORE YOU COPY THE WORKING DIRECTORY
        (if you need to copy it elsewhere)

    * Play
      ----

      - Click the "setting" buttons:

        If you copied the working directory for playing elsewhere
        (e.g.: on a usb drive, to view recordings on another computer)
        put the full path of that directory in the "Working Directory" field,
        otherwise leave it unchanged.

        Choose a TCP port (default is 8080) in the "Player port" field.
        NOTE:
          You may need to change your firewall settings accordingly,
          as this will be a listening port.

      - Go to your browser settings and change the http proxy settings.
        Host: localhost
        port: <Same-as-player-port>

      - Click the play button and navigate.
        All http traffic will be redirected to httprec that act as a web proxy
        while playing.
        It catches the url requested and search for corresponding response
        in the previosly stored catalog, sending it back to the browser,
        with the same effect as online navigation.


 4. Licence
    ====================

    Copyright (C) 2008,2009 Attilio Pavone <tilly@utillyty.eu>

    Httprec is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 2 of the License, or
    (at your option) any later version.

    Httprec is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You can find a copy of the GNU General Public License in the file
    LICENSE, or can see <http://www.gnu.org/licenses/>.


 5. Develope
    ====================

    All http incoming traffic is stored in two kind of files:
    those with an ".h" extension contain response headers, the others
    (with no extension) the response content.
    Files are progressively named "response-xxx" where xxx is the response number.
    e.g.
      response-10, response-10.h
    The cathalog of visited urls coupled with the corresponding response.x files
    is stored in the httprec.dat file, for retreaving in the playing phase.


 6. Revision history
    ====================

    version 1.1, 01 Sep 2008
      beta
    version 1.2, 04 Sep 2008
      first public release
    version 1.3, 19 Oct 2009
      this version: see release notes