@database "ICR.guide"
@author "Iain Hammond"
@(c) "Hashpipe Software"
@width 80
@nodeindex "Index"

@endnode

@node main "Contents"
      ###### ##### #####
        ##   ##    ##  ##
        ##   ##    ##  ##          #    ### ###
        ##   ##    #####          ##    # #   #
        ##   ##    ## ##     # #   #    ### ###
        ##   ##    ##  ##    # #   #      #   #
      ###### ##### ##  ##     #   ### # ### ###
      @{b}(c)1999 Hashpipe Software@{ub}

      @{"  Introduction  " link introduction}
      @{"  Requirements  " link requirements}
      @{"  Installation  " link installation}
      @{"   ICR Usage    " link icrusage}
      @{"  Distribution  " link distribution}
      @{"    History     " link history}
      @{"    Contact     " link contact}
      @{"    Copyright   " link copy}
      @{" Thanks, Greets " link this}
@endnode


@node introduction "ICR v1.93 - Introduction"
Welcome to ICR, If you use this software it is at your own risk i will not
except any blame if anything goes wrong!!!

What does this do then?

Well ICR converts all cached web sites from Ibrowse into normal viewable
pages by restoring file names and directories.
@endnode

@node requirements "ICR v1.93 - Requirements"
To be of any use you need @{B}Ibrowse@{ub} with some web pages in its cache.
@endnode

@node installation "ICR v1.93 - Installation"
Just drag the ICR draw to where ever you want it.
@endnode

@node icrusage "ICR v1.93 - Usage"
How do I use it then?

If you type in "ICR ?" it will dsiplay it's template:

      CACHE/A        : This should be full path it the IBrowse cache.

      DEST/A         : Where you want the pages restored to.

      S=SITE/K       : Restore only pages that match pattern site.

      F=FILTER       : A text file of patterns that tell ICR not to restore
                     : pages that contain any of the entries.

      W=WWW/S        : If this is present ICR will remove the WWW and it's
                     : varirents from the URL's(filenames).     (default=off)

      O=OLD/S        : Tell ICR to activate OLD MODE.           (default=off)

      D=DATE/S       : Include this to restore if date's.       (default=off)

      C=COMMENT/S    : This one restores file comments.         (default=off)

      P=PRIORITY/N   : Give ICR a different priority              (default=0)

To restore all sites:

                     ICR CACHE/A DEST/A

                e.g. ICR  ibrowse:cache ram:t

To restore one site:

                    ICR CACHE/A DEST/A S=SITE/K

        e.g. ICR ibrowse:cache ram:t SITE=www.hashpipe.freeserve.co.uk#?

Sites with "http://", "https://" or "ftp://" included
=====================================================

On such sites ICR will remove the "http", "https" or "ftp" parts

"www."(or it's vairations) will be left alone unless the "W=WWW" argument has
been set. You can now also include standard Amiga wildcards in the site
name.

        e.g. ICR ibrowse:cache ram:t SITE=#?turbo#?jet#?


If you do want the "www." parts removed the "W=WWW" argument must included on
the command line.

     e.g. ICR ibrowse:cache ram:t SITE=www.hashpipe.freeserve.co.uk#? WWW



Now you can pass a "FILTER" file to ICR which contains a list of full URL's
or patterns for matching multiple sites/pages which are *NOT* to be
restored. The "FILTER" file is just a simple text file with a list of URL's
or patterns i.e.
                #?banner#?
                #?counter#?
                www.PeeCee.com#?


To instruct ICR to use this file you need to add the "F=FILTER" argument to
the command lin to tell ICR where the "FILTER" file is.

               ICR CACHE/A DEST/A F=FILTER


         e.g. ICR ibrowse:cache ram:t FILTER=ibrowse:icr_filter


How to Save lost sites from IBrowse's cache
===========================================

When IBrowse quits it saves the sites that have visited in that session to
the global cache. Now if Ibrowse does not get to save to the global cache
maybe because of a crash the sites you have visited will be lost. Using ICR's
"o" command these lost sites can be retrived.

             e.g. ICR CACHE/A DEST/A O=OLD/S

But to restore any sites lost you must run ICR in "OLD" mode before you run
IBrowse again otherwise they will be lost, as IBrowse will delete said sites
when it starts up.

When restoring site you want the original file dates and/or comments retored
aswell you can include "D=DATE" and/or "C=COMMENT" on the command line.

Also you can set what priority ICR runs at with "P=PRIORITY". Normal values
are taken (-127 <-0-> 127).


@endnode

@node distribution "ICR v1.93 - Distribution"
You may copy this archive where ever you want, As long as all files remain
in the archive and are not changed in any way.
@endnode

@node contact "ICR v1.93 - Contact"
If you have any comments on ICR:

email:-  iain@hashpipe.freeserve.co.uk
WWW  :-  www.hashpipe.freeserve.co.uk

   Have fun...
@endnode

@node history "ICR v1.93 - History"
@{b}v1.0@{ub}
====
First release

@{b}v1.1@{ub}
====
Fixed some directory problems.

@{b}v1.2@{ub}
====
Fixed problems with filename case.

@{b}v1.3@{ub}
====
Fixed problem with file names.

@{b}v1.4@{ub}
====
ICR now only copies pages if they are newer. This does not work all the time
due to problems with file names of pages from search engines. They confuse
ICR, It try's to make directories like this,
          "supersearch/http://bla.bla/bal/@?@?@!$%thepage546374"
ICR see's all the forward slashes as different directories and ends up
with say, "supersearch/http://" which will not work. I don't see this a
major problem but if you would like me to sort it out(if i can) then email
me and i will see what i can do.

@{b}v1.41@{ub}
=====
Fixed bug where if the source or dest paths did not end with a `:' or `/'
then no files would get converted.

@{b}v1.5@{ub}
====
Add the option to restore just one site from the cache, And the option to
restore a single file from the cache.
Fixed a problem with some site names while using ICR in single site mode.

@{b}v1.6 to v1.91@{ub}
=============
No infomation!

@{b}v1.92 (BETA)@{ub}
=====
Added "P=PRIORITY" to the commande line options.
Now display some infomation while it is running.

@{b}v1.93@{ub}
=====
Public version of v1.92 with some fixes.

@endnode

@node copy "ICR v1.92 - Copyright"
@{b}ICR (c)1999 Hashpipe Software(Iain Hammond)
@endnode



@node this "ICR v1.93 - Thanks, Greets."
I would like to thank,

              My main man @{b}ANDY@{ub}!

              @{b}Alain Petit@{ub}, @{b}Joe Gilmore@{ub} and @{b}Detlef Wojtaszkiewicz@{ub}
              @{b}Henrik Farre@{ub}, @{b}Nils Goers@{ub} and @{b}Mark@{ub}
              @{b}Joerg Riemer@{ub} and @{b}Giovanni@{ub}
                                                    for sending bug reports.

@endnode
