home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / os2clu03.zip / README / ReadMe.TXT < prev   
Text File  |  2002-02-16  |  8KB  |  188 lines
  1.  
  2.                   OS/2 Command Line Utilities "read me!"
  3.  
  4.             Copyright (c) 1993-2002 Jonathan de Boyne Pollard.
  5.          c/o 1 Queen's Close KENILWORTH  CV8 1JR, United Kingdom
  6.  
  7.               Jonathan de Boyne Pollard, FIDONET#2:257/609.3
  8.               Jonathan de Boyne Pollard, FIDONET#1:109/921.70
  9.            Jonathan de Boyne Pollard <J.deBoynePollard@tesco.net>
  10.  
  11.  
  12. Guarantee and Software licence
  13. ──────────────────────────────
  14.  
  15. The OS/2 Command Line Utilities are copyrighted software, with all rights
  16. reserved by the author, which the author encourages everyone to share and
  17. to use freely.  The terms and conditions of the software licence, and the
  18. disclaimer of guarantee, are contained in the on-line help document
  19. CLU21.INF.
  20.  
  21.  
  22. Installation to a dedicated directory
  23. ─────────────────────────────────────
  24.  
  25. To install the utilities to a directory dedicated to holding them, such as
  26. C:\Apps\JdeBP\CLU, for example, simply unpack the distribution archive
  27. into that directory.
  28.  
  29.     PKZIP -extract -dir=curr CLU21 C:\Apps\JdeBP\CLU\ *
  30.  
  31. ( This assumes that the distribution archive that you received was in ZIP
  32.   format, and that you are using PKZIP version 2.50 for OS/2.  )
  33.  
  34. This will extract the files that comprise the utilities into various
  35. subdirectories of C:\Apps\JdeBP\CLU.  You will then need to add the
  36. relevant subdirectories to the PATH, DPATH, LIBPATH, HELP, and BOOKSHELF
  37. environment variables.  For example, if you have unpacked the utilities
  38. into the C:\Apps\JdeBP\CLU directory, you will need to
  39.  
  40.     (a) Create a *.CMD file with the following statements in it
  41.  
  42.             PATH C:\Apps\JdeBP\CLU\BIN;%PATH%
  43.             DPATH C:\Apps\JdeBP\CLU\DATA;%DPATH%
  44.             SET HELP=C:\Apps\JdeBP\CLU\HELP;%HELP%
  45.             SET BOOKSHELF=C:\Apps\JdeBP\CLU\BOOK;%BOOKSHELF%
  46.             SET BEGINLIBPATH=C:\Apps\JdeBP\CLU\DLL;%BEGINLIBPATH%
  47.  
  48.         which you then execute before using the utilities; or
  49.  
  50.     (b) Add the following statements to your SHELL.RUN file (if you are
  51.         using that mechanism)
  52.  
  53.             setenv PATH C:\Apps\JdeBP\CLU\BIN;%PATH%
  54.             setenv DPATH C:\Apps\JdeBP\CLU\DATA;%DPATH%
  55.             setenv HELP C:\Apps\JdeBP\CLU\HELP;%HELP%
  56.             setenv BOOKSHELF C:\Apps\JdeBP\CLU\BOOK;%BOOKSHELF%
  57.             setenv BEGINLIBPATH C:\Apps\JdeBP\CLU\DLL;%BEGINLIBPATH%
  58.  
  59.         and log out and log back in again; or
  60.  
  61.     (c) Make the following changes to your CONFIG.SYS
  62.  
  63.             Add C:\Apps\JdeBP\CLU\BIN to your PATH environment variable
  64.             Add C:\Apps\JdeBP\CLU\DATA to your DPATH environment variable
  65.             Add C:\Apps\JdeBP\CLU\HELP to your HELP environment variable
  66.             Add C:\Apps\JdeBP\CLU\BOOK to your BOOKSHELF environment variable
  67.             Add C:\Apps\JdeBP\CLU\DLL to your LIBPATH directive
  68.  
  69.         and restart your system.
  70.  
  71.  
  72. Installation to a multipurpose directory
  73. ────────────────────────────────────────
  74.  
  75. If you already have general purpose catch-all directories where you like
  76. to store your third-party tools, message files, and on-line help files,
  77. then you simply need to extract the relevant parts of the distribution
  78. archive into the different directories.
  79.  
  80. For example, if your general-purpose directory for executables is
  81. C:\LOCAL\BIN, for message files is C:\LOCAL\DATA, for dynamic link
  82. libraries is C:\LOCAL\DLL, for on-line help files is C:\LOCAL\HELP, for
  83. on-line documentation files is C:\LOCAL\BOOK, and for README files is
  84. C:\LOCAL\README, then you need to extract as follows:
  85.  
  86.     PKZIP -extract -path=none CLU21 C:\LOCAL\BIN\ *.EXE *.CMD
  87.     PKZIP -extract -path=none CLU21 C:\LOCAL\DATA\ *.MSG
  88.     PKZIP -extract -path=none CLU21 C:\LOCAL\BOOK\ *.INF
  89.     PKZIP -extract -path=none CLU21 C:\LOCAL\HELP\ *.HLP
  90.     PKZIP -extract -path=none CLU21 C:\LOCAL\DLL\ *.DLL
  91.     PKZIP -extract -path=none CLU21 C:\LOCAL\README\CLU\ *.TXT *.HTML
  92.  
  93. ( This assumes that the distribution archive that you received was in ZIP
  94.   format, and that you are using PKZIP version 2.50 for OS/2.  )
  95.  
  96. Several of the commands (FF, GREP, WC, SUM, TOUCH) have common names, that
  97. may duplicate other commands of the same name on your system.  Care should
  98. thus be taken when extracting the files from the archive.  PKZIP will
  99. prompt you whether to overwrite the existing utilities or extract to a new
  100. name of your choosing in such cases.
  101.  
  102.  
  103. Replacing utilities supplied with OS/2
  104. ──────────────────────────────────────
  105.  
  106. Several of the commands (ATTRIB, COMP, FIND, HELP, SORT, TREE) have the
  107. same names as commands supplied with OS/2.  This is deliberate, because
  108. they are intended to be 32-bit replacements for those 16-bit OS/2
  109. utilities, with additional features.  They allow one to remove those
  110. particular 16-bit vestiges from OS/2 Warp.
  111.  
  112. Which command is used, the OS/2-supplied one or the CLU21 one, is
  113. determined by the order in which the relevant directories appear in your
  114. PATH environment variable.  To execute the CLU21 utilities in preference
  115. to the ones supplied with OS/2, place C:\Apps\JdeBP\CLU (or whatever
  116. directory name you have chosen) ahead of C:\OS2 in your PATH environment
  117. variable.
  118.  
  119.  
  120. Getting help after installation
  121. ───────────────────────────────
  122.  
  123. The on-line documentation is in the book CLU21.INF.  To read it, either
  124. double-click on the file on your Workplace Shell desktop or run the
  125. command
  126.  
  127.     VIEW CLU21
  128.  
  129. at the command line.  You can go directly to the help for individual
  130. commands by specifying the command name as a second argument:
  131.  
  132.     VIEW CLU21 FF
  133.  
  134. Each command also presents a short summary of its syntax in response to
  135. the /? option.  To use this, /? must be the first option on the command
  136. line for the command, and may not be combined with other options.  For
  137. example, to see the summary for the GREP command, type
  138.  
  139.     GREP /?
  140.  
  141. ( See the note on message files below. )
  142.  
  143.  
  144. Adding a folder to the Workplace Shell Desktop
  145. ──────────────────────────────────────────────
  146.  
  147. One can add a folder to the Workplace Shell desktop, containing objects
  148. that will invoke some of the utilities and open the on-line documentation.
  149.  
  150. To create this folder, run the supplied MakeObj.CMD REXX command script.
  151. If you have installed the command-line utilities in C:\Apps\JdeBP\CLU, run
  152.  
  153.     C:\Apps\JdeBP\CLU\Bin\NotPATH\MakeObj.CMD
  154.  
  155. The folder will be created in your "Programs" folder.  It may be deleted
  156. by simply dragging and dropping it onto the Shredder.  The Command-Line
  157. Utilities does not install any modifications into the Workplace Shell
  158. itself.
  159.  
  160.  
  161. Users of JP Software's 4OS2 and Take Command for OS/2
  162. ─────────────────────────────────────────────────────
  163.  
  164. Users of JP Software's 4OS2 and Take Command for OS/2 should read the
  165. section of the on-line documentation dealing with those command
  166. interpreters.
  167.  
  168.     VIEW CLU21 JPSOFT
  169.  
  170.  
  171. Message files
  172. ─────────────
  173.  
  174. In order to make it easy to produce non-English versions of the utilities,
  175. should anyone ever require them, all of the error messages and the on-line
  176. help text for the /? option for each command are stored in message files,
  177. CLU.MSG and CLUH.MSG, rather than being embedded within the EXEs
  178. themselves.
  179.  
  180. The commands also require the OSO001.MSG file, supplied with OS/2 itself,
  181. in order to display the error messages for various system errors.
  182.  
  183. Both of these message files must be in directories that are listed in the
  184. DPATH environment variable.  If they aren't, then the commands will not be
  185. able to display comprehensible error and help messages.
  186.  
  187.  
  188.