
                  OS/2 Command Line Utilities "read me!"

            Copyright (c) 1993-1999 Jonathan de Boyne Pollard.
         c/o 1 Queen's Close KENILWORTH  CV8 1JR, United Kingdom

              Jonathan de Boyne Pollard, FIDONET#2:257/609.3
              Jonathan de Boyne Pollard, FIDONET#1:109/921.70
           Jonathan de Boyne Pollard <J.deBoynePollard@tesco.net>


    Guarantee and Software licence
    

    The OS/2 Command Line Utilities are copyrighted software, with all
    rights reserved by the author, which the author encourages everyone to
    share and to use freely.  The terms and conditions of the software
    licence, and the guarantee information, are contained in the on-line
    help document OS2CLU02.INF.


    Installation to a dedicated directory
    

    To install the utilities to a directory dedicated to holding them,
    such as C:\CLU, for example, simply unpack the distribution archive
    into that directory.

        PKZIP -extract -dir=curr OS2CLU02 C:\CLU\ *

    ( This assumes that the distribution archive that you received was in
      ZIP format, and that you are using PKZIP version 2.50 for OS/2. )

    This will extract the files that comprise the utilities into various
    subdirectories of C:\CLU.  You will then need to add the relevant
    subdirectories to the PATH, DPATH, LIBPATH, HELP, and BOOKSHELF
    environment variables.  For example, if you have unpacked the
    utilities into the C:\CLU directory, you will need to either

        (a) Create a *.CMD file with the following statements in it

                PATH C:\CLU\BIN;%PATH%
                DPATH C:\CLU\DATA;%DPATH%
                SET HELP=C:\CLU\HELP;%HELP%
                SET BOOKSHELF=C:\CLU\BOOK;%BOOKSHELF%
                SET BEGINLIBPATH=C:\CLU\DLL;%BEGINLIBPATH%

            which you then execute before using the utilities; or

        (b) Make the following changes to your CONFIG.SYS

                Add C:\CLU\BIN to your PATH environment variable
                Add C:\CLU\DATA to your DPATH environment variable
                Add C:\CLU\HELP to your HELP environment variable
                Add C:\CLU\BOOK to your BOOKSHELF environment variable
                Add C:\CLU\DLL to your LIBPATH directive

            and restart your system.


    Installation to a multipurpose directory
    

    If you already have general purpose catch-all directories where you
    like to store your third-party tools, message files, and on-line help
    files, then you simply need to extract the relevant parts of the
    distribution archive into the different directories.

    For example, if your general-purpose directory for executables is
    C:\LOCAL\BIN, for message files is C:\LOCAL\DATA, for dynamic link
    libraries is C:\LOCAL\DLL, for on-line help files is C:\LOCAL\HELP,
    for on-line documentation files is C:\LOCAL\BOOK, and for README files
    is C:\LOCAL\README, then you need to extract as follows:

        PKZIP -extract -path=none OS2CLU02 C:\LOCAL\BIN\ *.EXE *.CMD
        PKZIP -extract -path=none OS2CLU02 C:\LOCAL\DATA\ *.MSG
        PKZIP -extract -path=none OS2CLU02 C:\LOCAL\BOOK\ *.INF
        PKZIP -extract -path=none OS2CLU02 C:\LOCAL\HELP\ *.HLP
        PKZIP -extract -path=none OS2CLU02 C:\LOCAL\DLL\ *.DLL
        PKZIP -extract -path=none OS2CLU02 C:\LOCAL\README\ *.TXT

    ( This assumes that the distribution archive that you received was in
      ZIP format, and that you are using PKZIP version 2.50 for OS/2. )

    Several of the commands (FF, GREP, WC, SUM, TOUCH) have common names,
    that may duplicate other commands of the same name on your system.
    Care should thus be taken when extracting the files from the archive.
    PKZIP will prompt you whether to overwrite the existing utilities or
    extract to a new name of your choosing in such cases.


    Replacing utilities supplied with OS/2
    

    Several of the commands (ATTRIB, COMP, FIND, HELP, SORT, TREE) have
    the same names as commands supplied with OS/2.  This is deliberate,
    because they are intended to be 32-bit replacements for those 16-bit
    OS/2 utilities, with additional features.  They allow one to remove
    those particular 16-bit vestiges from OS/2 Warp.

    Which command is used, the OS/2-supplied one or the OS2CLU02 one, is
    determined by the order in which the relevant directories appear in
    your PATH environment variable.  To execute the OS2CLU02 utilities in
    preference to the ones supplied with OS/2, place C:\CLU (or whatever
    directory name you have chosen) ahead of C:\OS2 in your PATH
    environment variable.


    Getting help after installation
    

    The on-line documentation is in the book OS2CLU02.INF.  To read it,
    either double-click on the file on your Workplace Shell desktop or run
    the command

        VIEW OS2CLU02

    at the command line.  You can go directly to the help for individual
    commands by specifying the command name as a second argument:

        VIEW OS2CLU02 FF

    Each command also presents a short summary of its syntax in response
    to the /? option.  To use this, /? must be the first option on the
    command line for the command, and may not be combined with other
    options.  For example, to see the summary for the GREP command, type

        GREP /?

    ( See the note on message files below. )


    Users of JP Software's 4OS2 and Take Command for OS/2
    

    Users of JP Software's 4OS2 and Take Command for OS/2 should read the
    section of the on-line documentation dealing with those command
    interpreters.

        VIEW OS2CLU02 JPSOFT


    Message files
    

    In order to make it easy to produce non-English versions of the
    utilities, should anyone ever require them, all of the error messages
    and the on-line help text for the /? option for each command are
    stored in message files, CLU.MSG and CLUH.MSG, rather than being
    embedded within the EXEs themselves.

    The commands also require the OSO001.MSG file, supplied with OS/2
    itself, in order to display the error messages for various system
    errors.

    Both of these message files must be in directories that are listed in
    the DPATH environment variable.  If they aren't, then the commands
    will not be able to display comprehensible error and help messages.


