home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / bbs / ahatch21 / ahatch.doc < prev   
Text File  |  1992-10-16  |  7KB  |  178 lines
  1.  
  2.                            - AHATCH version 2.1 -
  3.  
  4.                   ┌──────────────────────────────────────┐
  5.                   │              ╔════════╗              │
  6.                   │              ║ AHATCH ║              │
  7.                   │              ╚════════╝              │
  8.                   │    - Automated Hatch procedure -     │
  9.                   │                                      │
  10.                   │     Version 2.1, October 16 1992     │
  11.                   │                                      │
  12.                   │         by Marcel Stikkelman         │
  13.                   │                                      │
  14.                   └──────────────────────────────────────┘
  15.  
  16.        AHATCH
  17.        ======
  18.  
  19.        AHATCH provides  an  easy and fast way  to hatch  (Tick release
  20.        utility)  a number of  files from a  FILES.BBS file into a Tick
  21.        area.  Since  AHATCH  is  an  OS/2  REXX  procedure  source  is
  22.        provided.
  23.  
  24.  
  25.        USAGE
  26.        =====
  27.                          ┌────────────────┐
  28.                          V                │
  29.           AHATCH ─ area ───┬────────────┬─┴─┬───────┬─┬──────┬─┤
  30.                            ├── /Ccfg ───┤   └ drive ┘ └ path ┘
  31.                            ├── /Ttmp ───┤
  32.                            ├── /Bfbbs ──┤
  33.                            ├── /Ddup ───┤
  34.                            ├── /R ──────┤
  35.                            └── /Ffile ──┘
  36.        Where:
  37.        area     = Tick area name
  38.        /Ccfg    = the name and location  of the Tick/Hatch config file
  39.                   default will  be that of Hatch itself  (current dir)
  40.        /Ttmp    = the name and  location of the temporary  ahatch file
  41.                   default will be AHATCH.TMP in the current dir
  42.        /Bfbbs   = the name of FILES.BBS, located in drive/path
  43.        /Ddup    = file   containing    already   released   filenames;
  44.                   dupcheck will not include  file extension unless the
  45.                   extension contains a (sequence-)number
  46.        /Ffile   = one file to hatch from FILES.BBS (no path)
  47.        /R       = use  the  Hatch  replace  file function,  checks for
  48.                   [R:file]  at te beginning of the  description,  when
  49.                   not used complete description is always used
  50.        drive    = drive  where  file  and  FILES.BBS  resides (default
  51.                   current drive)
  52.        path     = directory  path  where  file  and  FILES.BBS resides
  53.                   (default current path)
  54.  
  55.        AHATCH will  hatch all  files that exist in the  the current or
  56.        defined  directory  and  those that are named in the  FILES.BBS
  57.        (which  resides  in the  same  directory).   Files  will not be
  58.  
  59.                                  - page 1 -
  60.  
  61.                            - AHATCH version 2.1 -
  62.  
  63.        hatched  if they  already exist  in the hatch  target directory
  64.        (specified  in  the  Tick  configuration  file),   AHATCH  will
  65.        disregard the  file extension except  when a number is found in
  66.        the extension of the hatchfile.
  67.        So: FILE1.ZIP is not hatched if  FILE1.ARC or FILE1.123 exists,
  68.            FILE1.A03 is always hatched except when FILE1.A03 exists.
  69.  
  70.        When a dupfile is given,  AHATCH will also look in the dupfile
  71.        in the same way  for duplicate filenames.  The filename in the
  72.        dupfile must be the first one mentioned, so allowed is:
  73.  
  74.        FILE1.ZIP
  75.        FILE2.A39 E43232F6
  76.        FILE3
  77.        FILE4.ABC [R:FILE4.OLD] File discriptions may be here too.
  78.  
  79.        A hatched file will be moved from  the directory where the file
  80.        was found  to  the directory  of the  Tick area,  so  next time
  81.        AHATCH will not hatch the file again.
  82.  
  83.        Descriptions may  be up to 255  characters long.  AHATCH uses a
  84.        temporary file to do this (AHATCH.TMP)  which is created in the
  85.        directory where  AHATCH is started,  to change the filename and
  86.        location, use the /T parameter.
  87.  
  88.        Example (started from the TICK directory):
  89.  
  90.           AHATCH OS2NEW /DDUPS\OS2NEW.DUP /R C:\FILE\FERNUP
  91.  
  92.        Will release all files in C:\FILE\FERNUP into area OS2NEW.
  93.        Filenames  that  are  found  in the  OS2NEW.DUP  file  are  not
  94.        hatched,  just like files  that already exists  the the  OS2NEW
  95.        target directory (specified in TIC.CFG). Also when AHATCH finds
  96.        [R:<filename>]  at  the  beginning  of  the   description,  the
  97.        <filename> will be passed on to Hatch as the replace file.  The
  98.        [R:<filename>] part will be stripped from the description (only
  99.        when /R option is used!).
  100.  
  101.        To release just one file just enter:
  102.  
  103.           AHATCH OS2NEW /DDUPS\OS2NEW.DUP /FTHISONE.TXT C:\FILE\FERNUP
  104.  
  105.        To start AHATCH from the (in this example) FERNUP directory:
  106.  
  107.           AHATCH OS2NEW /CC:\TICK\TIC.CFG /DDUPS\OS2NEW.DUP
  108.  
  109.        To make the location of the  Tick configuration file permanent,
  110.        it is possible to edit AHATCH.CMD  and put a full path in front
  111.        of the confdef filename, so using /C is not necessary anymore.
  112.  
  113.        in this case the line:
  114.          confdef   = "TIC.CFG"         /* Hatch default config file */
  115.        has to be changed to:
  116.          confdef   = "C:\TICK\TIC.CFG" /* Hatch default config file */
  117.  
  118.                                  - page 2 -
  119.  
  120.                            - AHATCH version 2.1 -
  121.  
  122.        SYSTEM REQUIREMENTS
  123.        ===================
  124.  
  125.        AHATCH has been tested on a IBM-PS/2 model 80 with OS/2 1.3.
  126.        It will probably work on most systems that run OS/2 version 1.2
  127.        (EE) and up with  REXX installed.  AHATCH calls  HATCHP.EXE and
  128.        works with Hatch version 2.10
  129.  
  130.  
  131.        NOTICE
  132.        ======
  133.  
  134.        AHATCH  may  be  distributed  and  used  unmodified  with  this
  135.        documentation in  non-commercial  environments  free of charge.
  136.        Contact the author when used in commercial environments.
  137.        Use AHATCH at your  own risk only,  the author can not  be held
  138.        responsible for any damages.
  139.  
  140.        Please let me know if I should take the time to develop  AHATCH
  141.        any further.  If you have any  suggestions or comments,  please
  142.        enter or send a message to:
  143.  
  144.                    Marcel Stikkelman
  145.          Sysop of: PC-Square, BBS of the PCPC
  146.                    Zoetermeer
  147.                    the Netherlands
  148.                    Tel.: <INT>31-79-424107
  149.                    FidoNet address 2:512/4
  150.                                    81:431/5
  151.  
  152.                    or in an  appropriate echomail area if  the message
  153.                    is  useful to other users and where  you can find a
  154.                    message from me.
  155.  
  156.        AHATCH  is free to use in  non-commercial environments, but  if
  157.        someone  still has the urge to make a contribution feel free to
  158.        do so:
  159.  
  160.                    M. Stikkelman
  161.                    ABN-AMRO bank-account-number 47.35.94.412
  162.                    or GIRO 5152402
  163.                    Zoetermeer
  164.                    the Netherlands.
  165.  
  166.  
  167.        UPDATE HISTORY
  168.        ==============
  169.  
  170.        Version   Date   Changes
  171.        ------- -------- --------------------------------
  172.          2.0   05-05-92 first general release
  173.          2.1   10-16-92 added replace /R function
  174.  
  175.  
  176.  
  177.                                  - page 3 -
  178.