home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / larcos.zip / READ.ME < prev    next >
Text File  |  1995-03-03  |  12KB  |  283 lines
  1. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  2.            =========================================
  3.                         LARC Version 3.03 Release Notes
  4.            =========================================
  5.  
  6.  
  7. Overview
  8. ========
  9.     This file contains last minute notes and suggestions that did not make
  10.     it into the final version of the LARC User's Guide.  These notes should
  11.     be carefully reviewed before you attempt to use LARC.
  12.  
  13.  
  14. Installation Procedure
  15. ======================
  16.     To install LARC, execute the self extracting file LARCDOS.EXE for
  17.     for DOS, or LARCOS2.EXE for OS/2.
  18.  
  19.     To install both the OS/2 and DOS version of LARC on the same system,
  20.     you will need to create two full and separate installations using
  21.     unique directory names.
  22.  
  23.     Example LARC files are provided in the EXAMPLES.ZIP file.  It is
  24.     recommended that you unzip the example files in a unique directory
  25.     and do not mix the example files with the LARC installation files.
  26.     While no damage will occur, placing the example files in the LARC
  27.     installation directory could make it difficult to maintain or upgrade
  28.     LARC in the future.
  29.  
  30.     The default command and configuration files delivered with LARC
  31.     assume an installation directory of C:\LARC3.  Assuming you install
  32.     into C:\LARC3, then LARC will be ready to run as soon as you complete
  33.     the installation process.
  34.  
  35.     You need to print the LARC User's Guide file MANUAL.DOC and read
  36.     Chapter 2 for additional steps required to complete the
  37.     installation procedure.
  38.  
  39.     Be sure to fully read and understand the LICENSE.DOC file before you
  40.     use LARC.  Also, review the order form file ORDER.FRM for information
  41.     on the benefits of registering LARC.
  42.  
  43.  
  44. Redistributing LARC
  45. ===================
  46.     You MAY NOT redistribute LARC for use in any product you sell or support
  47.     without the prior written consent of SouthWind Software Incorporated.
  48.  
  49.     You are allowed to distribute the full LARC download program file to
  50.     friends, associates, or to a computer bulletin board system (BBS) only
  51.     if you distribute the file LRCS303.EXE in it's complete and original
  52.     form.
  53.  
  54.  
  55. Using LARC with Microsoft Visual C++
  56. ====================================
  57.     It is possible to integrate LARC into the Microsoft Visual C++ 1.0 or
  58.     1.5 IDE.  An example LARC.PIF file is included with this release and
  59.     will be installed into the LARC executable directory.  To integrate
  60.     LARC into the MSVC 1.0 or 1.5 tool bar, you simply:
  61.  
  62.         1.  Start Microsoft Windows and select Microsoft Visual C++.
  63.  
  64.         2.  Select "Options", then "Tool...".
  65.  
  66.         3.  Select "Add" and enter the LARC.PIF file name in the file
  67.             dialog box that appears.  For example, assuming you installed
  68.             LARC into C:\LARC3, enter "C:\LARC3\LARC.PIF".
  69.  
  70.         4.  Complete the tool setup by making sure that each prompt is
  71.             answered:
  72.  
  73.                 Command Line:       C:\LARC3\LARC.PIF
  74.                 Menu Text:          &LARC
  75.                 Arguments:          C:\LARC3\LARC.CFG
  76.                 Initial Directory:  $PROJDIR
  77.  
  78.             You may need to adjust the path names depending on the name
  79.             you provided to the LARC Installation Program.  $PROJDIR is used
  80.             to set the initial directory to the current MSVC project directory.
  81.             This allows you to use LARC from within MSVC to check files from
  82.             LARC to the project directory, and to check files back into LARC
  83.             from the project directory.
  84.  
  85.         5.  Select OK to save the new tool entry.  Select "Tool" from the
  86.             menu, then select LARC.  LARC should appear as a DOS windowed
  87.             application.
  88.  
  89.  
  90. Using LARC with Borland C++
  91. ===========================
  92.     LARC has not been integrated into the Borland C++ IDE.  However,
  93.     it is assumed that Borland provides the ability to add custom tools
  94.     to the IDE menu.  If so, then it should be possible to integrate LARC
  95.     into the Borland IDE as described above for the Microsoft IDE.
  96.  
  97.  
  98. New Features
  99. ============
  100.     This release allows you to define the programs that LARC will use
  101.     to manage compressed libraries.  By default, LARC is set up to issue
  102.     PKZIP and PKUNZIP (provided by PKWARE, Inc.) commands to manage
  103.     compressed libraries.  You can override these defaults and use other
  104.     compression programs.  There are four new LARC Configuration File
  105.     commands that tell LARC the names and formats of the four basic
  106.     compression routines to use.
  107.  
  108.       To add to a compressed library:
  109.  
  110.           SET COMPRESS ADD "PKZIP -k [LIBRARY] [SOURCE]"
  111.  
  112.       To check-out or copy from a compressed library:
  113.  
  114.           SET COMPRESS OUT "PKUNZIP -o [LIBRARY] [FILE] [DEST]"
  115.  
  116.       To delete a file from a compressed library:
  117.  
  118.           SET COMPRESS DELETE "PKZIP -d [LIBRARY] [FILE]"
  119.  
  120.       To verify a file in a compressed library:
  121.  
  122.           SET COMPRESS VERIFY "PKUNZIP -t [LIBRARY] [FILE]"
  123.  
  124.     To facilitate these user defined commands, LARC uses "substitution"
  125.     strings to define the LARC-specific components of the command.
  126.     These strings are:
  127.  
  128.       [LIBRARY]    Insert the full compressed library name
  129.                    (ex: C:\EXAMPLE\EXAMPLE.ZIP).
  130.  
  131.       [FILE]       Insert just the file name that is to be extracted or
  132.                    delete from the library (ex: EXAMPLE.C)
  133.  
  134.       [SOURCE]     Insert the full source file name (ex: A:\TMP\EXAMPLE.C)
  135.  
  136.       [DEST]       Insert the full destination path name (ex: A:\TMP\)
  137.  
  138.     The following notes apply to this new feature:
  139.  
  140.       NOTE 1:  The LDIR utility requires that compressed libraries be
  141.                created using PKZIP.EXE version 2.04g.  LDIR will be unable
  142.                to list the contents of compressed libraries that were
  143.                created using other compression programs.
  144.  
  145.       NOTE 2:  When LARC creates a set of release diskettes, it creates a
  146.                list file that shows the contents of the diskette(s).
  147.                LARC can expand the contents of compressed files that were
  148.                created using PKZIP.EXE version 2.04g.  LARC can not
  149.                expand the contents of compressed files created using a
  150.                different compression program.
  151.  
  152.     Neither of these exceptions should seriously impact your ability
  153.     to incorporate your favorite compression utility with LARC.
  154.  
  155.  
  156. Revision History Feature
  157. ========================
  158.     A new revision history management feature has been added.  Previously,
  159.     LARC only required that you include the embedded control information.
  160.     For example, a C file might have included the following embedded control
  161.     information:
  162.  
  163.         //
  164.         // LARC_S "Library Name Goes Here"
  165.         // LARC_D "File Description Goes Here"
  166.         // LARC_V "102"
  167.         //
  168.         // Revision History:
  169.         // kbg 03/03/95 100 - Created.
  170.         // kbg 03/03/95 101 - Fixed some bugs.  This example
  171.         //                    also demonstrates a multi-line
  172.         //                    history comment!
  173.         // kbg 03/03/95 102 - Added a new feature.
  174.         //
  175.  
  176.     This release of LARC adds new embedded control tokens called the
  177.     revision history tokens.  These tokens can be define in the LARC.CFG
  178.     file using the "SET REVISION" statement and are defaulted to
  179.     LARC_REV_ON and LARC_REV_OFF.  Here is how the same example C file
  180.     would appear using the revision history option:
  181.  
  182.         //
  183.         // LARC_S "Library Name Goes Here"
  184.         // LARC_D "File Description Goes Here"
  185.         // LARC_V "101"
  186.         //
  187.         // Revision History:
  188.         // LARC_REV_ON
  189.         // kbg 03/03/95 100 - Created.
  190.         // kbg 03/03/95 101 - Fixed some bugs.  This example
  191.         //                    also demonstrates a multi-line
  192.         //                    history comment!
  193.         // kbg 03/03/95 102 - Added a new feature.
  194.         // LARC_REV_OFF
  195.         //
  196.  
  197.     The revision history option serves achieves the following:
  198.  
  199.     1.    It forces the revision history lines to a uniform format as
  200.           shown in the examples.  You must start the first revision
  201.           history line with "iii mm/dd/yy vvv".  iii = user initials,
  202.           mm/dd/yy = the edit date and vvv = the edit version.
  203.  
  204.     2.    The revision history edit version number will be checked to
  205.           ensure that it matches the formal LARC_V edit version number.
  206.           This reduces possible confussion created whenever the edit
  207.           version number didn't match the LARC_V number.
  208.  
  209.     3.    The revision history lines will be written into a Revision
  210.           History file.  This ASCII file can be used to get a quick
  211.           read on all changes that have been made since the last build
  212.           of the system.  The Revision History file will be created with
  213.           a REV extension in the directory specified by the LARC.CFG
  214.           "SET SYSTEM DATAFILES" statement.
  215.  
  216.           Using the example shown above, the resulting Revision History
  217.           file would appear as follows:
  218.  
  219.             *** Release 3.02h(T) built 01-23-95 at 21:02:30 by KBG ***
  220.             EXAMPLE.C    kbg 03/03/95 100 - Created.
  221.             EXAMPLE.C    kbg 03/03/95 101 - Fixed some bugs.  This example
  222.             EXAMPLE.C                       also demonstrates a multi-line
  223.             EXAMPLE.C                       history comment!
  224.             EXAMPLE.C    kbg 03/03/95 102 - Added a new feature.
  225.             *** Release 3.03 (F) built 01-25-95 at 21:53:08 by KBG ***
  226.  
  227.  
  228. New Display Function Keys
  229. =========================
  230.     Two new special function keys have been added.  These keys are
  231.     supported when displaying library files.
  232.  
  233.     F3:    This key toggles the display sort order.  By default, the
  234.            files are displayed in ascending file name order.  Press
  235.            the F3 key once and the files will be sorted in ascending
  236.            file extension order (i.e. grouped by extension).  Press
  237.            F3 again and the files will be sorted in ascending date
  238.            order.
  239.  
  240.     F4:    Pressing this key expands the file display to include (or
  241.            hide) the file date and time stamp.  This option should be
  242.            used when displaying files in date/time order.
  243.  
  244.  
  245. New "T" Release Build Type
  246. ==========================
  247.     A new "T" build type for test builds has been added.  "T" builds
  248.     function exactly like "F" builds, except they do not automaticaly
  249.     execute the LARC Archive Command file (LARCARC.BAT).
  250.  
  251.  
  252. Known Software Problems
  253. =======================
  254.     The OS/2 version does not provide support for an OS/2-specific
  255.     version of PKZIP or PKUNZIP.  PKWARE is in the process of providing an
  256.     OS/2 version of PKZIP/PKUNZIP that uses the 2.04 compression software
  257.     used in the DOS version.  This would make the compressed file format
  258.     compatible between both DOS and OS/2.  Support for the OS/2 version of
  259.     PKZIP/PKUNZIP will be provided with that version.  Meanwhile, the DOS
  260.     versions should be used or you can use alternate OS/2 compression
  261.     software as described previously.
  262.  
  263.  
  264. Reporting Problems or Recommending Enhancements
  265. ===============================================
  266.     Refer to the Information section of the file LARC User's Guide for
  267.     instructions for reporting any problems you encounter with LARC.
  268.  
  269.  
  270. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  271. LARC is a trademark of SouthWind Software Incorporated.
  272. MS-DOS is a registered trademark of Microsoft Corporation.
  273. Windows is a trademark of Microsoft Corporation.
  274. OS/2 is a registered trademark of International Business Machines, Incorporated.
  275.  
  276. All other product names mentioned in this document may be trademarks
  277. or registered trademarks of their respective companies and are
  278. hereby acknowledged.
  279. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  280.           Copyright (c) 1995 by SouthWind Software Incorporated
  281.                         All rights reserved.
  282. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  283.