home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / dosutils / pathtl20.arj / PATHTOOL.DOC < prev    next >
Text File  |  1992-05-11  |  39KB  |  1,031 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                       PATHTOOL
  20.  
  21.  
  22.                                     Version 2.0
  23.  
  24.  
  25.                                     May 11, 1991
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                                   New World Designs
  33.                                      PO Box 12217
  34.                                Wichita, KS 67277-2217
  35.  
  36.  
  37.                                  BBS: (316)262-1829
  38.  
  39.                              CompuServe ID: 76260,1501
  40.  
  41.  
  42.  
  43.  
  44.  
  45.         The information in this document is subject to change without notice.
  46.  
  47.  
  48.        PACKING LIST:
  49.  
  50.        If any of the following files are missing, please download
  51.        the latest complete version from NWIS BBS (316)262-1829.
  52.  
  53.          *       .BAT - Example batch files.
  54.          BUG_RPT .DOC - PathTool problem (bug) report.
  55.          FILE_ID .DIZ - PathTool description for PCBOARD BBS.
  56.          NWDREG  .EXE - NwdReg registration branding program.
  57.          ORDER   .DOC - PathTool order form.
  58.          PATHTOOL.DES - PathTool description for generic BBS.
  59.          PATHTOOL.DOC - PathTool manual (This document).
  60.          PATHTOOL.EXE - PathTool program.
  61.          SHARE   .DOC - Description of shareware software.  Unknown author.
  62.          SUPPORT .DOC - Support BBS for PathTool.
  63.  
  64.  
  65.        SHAREWARE EVALUATION VERSION WARRANTY:
  66.  
  67.          The shareware version is provided as is.  New World Designs makes
  68.        NO warranty of any kind, expressed or implied, including without
  69.        limitation, any warranties of merchantability and/or fitness for a
  70.        particular purpose.
  71.  
  72.  
  73.        REGISTERED VERSION WARRANTY:
  74.  
  75.          New World Designs warrants the physical diskette provided with
  76.        the registered versions to be free of defects in materials and
  77.        workmanship for a period of 90 days from the date of registration.
  78.        If New World Designs receives notification within the warranty
  79.        period of defects in materials or workmanship, and such notification
  80.        is determined by New World Designs to be correct, New World Designs
  81.        will replace the defective diskette.
  82.  
  83.          The entire and exclusive liability and remedy for breach of this
  84.        warranty shall be limited to replacement of defective diskette and
  85.        shall not include or extend to any claim for or right to recover any
  86.        other damages, including but not limited to, loss of profit, data,
  87.        or use of the software, or special, incidental, or consequential
  88.        damages or other similar claims, even if New World Designs has
  89.        specifically advised of the possibility of such damages.  In NO event
  90.        will New World Designs liability for any damages to you or any other
  91.        person ever exceed the lower of the suggested list price or actual
  92.        price paid for the license to use the software, regardless of any
  93.        form of the claim!
  94.  
  95.  
  96.        LICENSE LIMITATIONS:
  97.  
  98.          The licensee shall not use, copy, rent, sell, modify, decompile,
  99.        disassemble, reverse engineer, or transfer the licensed program
  100.        except as provided in this agreement.  Any such unauthorized use
  101.        shall result in immediate and automatic termination of this license.
  102.  
  103.          New World Designs grants you the right to use one copy of PathTool
  104.        on a single computer.  You may not network PathTool or otherwise use
  105.        it on more than one computer or computer terminal at the same time.
  106.  
  107.          All rights not specifically granted in this statement are reserved
  108.        by New World Designs.
  109.  
  110.  
  111.        INTRODUCTION:
  112.  
  113.          PathTool is a powerful utility which easily lets users modify the DOS
  114.        PATH using straight-forward commands.  The worst problem with the PATH
  115.        command is changing its contents.  Changing the PATH usually requires
  116.        the user to retype the entire PATH or to use a text editor to change a
  117.        batch file and then execute the batch file.  This problem grows even
  118.        bigger on systems with many existing installed software packages.  This
  119.        is especially true of systems connected to a LAN such as Novell Netware.
  120.        Many of these systems reach a point where all path entries can't fit in
  121.        the PATH because of the 127 character limit of the DOS command line.
  122.        The solution until now has been to create many hard to manage batch
  123.        files containing the entire PATH.  PathTool solves all of these
  124.        problems and replaces the Novell MAP command in many situations.
  125.  
  126.  
  127.        EXPLANATION OF PATH AND ENVIRONMENT STRINGS:
  128.  
  129.          PATH sets a search path for programs and batch files that are not
  130.        in the current directory.  Once the PATH is defined, programs can run
  131.        in other directories without specifying their full pathnames.  DOS
  132.        searches the current directory then directories in the PATH (in the
  133.        specified order and on any drive) until it finds the program or batch
  134.        file to be executed.  DOS searches the specified path only for files
  135.        (those having .COM, .EXE, and .BAT) and then only when attempting to
  136.        execute them.  The following is the syntax of PATH:
  137.  
  138.          PATH[=][[d:]path1[;[d:]path2...]]
  139.  
  140.          The PATH is stored in the environment string area of the command
  141.        processor (COMMAND.COM).  All strings defined by SET are also stored
  142.        in this area.
  143.  
  144.  
  145.        INSTRUCTIONS FOR CHANGING THE SIZE OF THE ENVIRONMENT:
  146.  
  147.          The environment size MUST be large enough to hold all environment
  148.        strings (including PATH).  If it is not, then new strings cannot be
  149.        added until the size is expanded.  The environment size is set when
  150.        your command processor is first executed.  Normally, the environment
  151.        is 160 bytes by default.  A larger size is typically required for most
  152.        systems (1024 to 4096).  If you experience the PathTool error,
  153.        'Environment space full', then the environment size MUST be expanded!
  154.        We recommend that you expand your environment before running into that
  155.        problem.  Normally we run our development machines with 2048 bytes of
  156.        environment string space.  This will vary depending on your software.
  157.        It is not recommended to have a large environment because most of it
  158.        will never be used.  Also, every time you temporarily "shell" out of a
  159.        program to the DOS command prompt, the command processor may allocate
  160.        a similar sized environment.
  161.  
  162.        To determine the current size of your environment, the amount of free
  163.        space in the environment, and the size of your PATH.
  164.  
  165.          PATHTOOL /YB
  166.  
  167.        To set the size of the environment, change the line in your CONFIG.SYS
  168.        as follows for DOS 3.20 and later:
  169.  
  170.          SHELL=C:\COMMAND.COM  /E:nnnnn  /P
  171.  
  172.  
  173.        If you would like to experiment with the size of your environment,
  174.        type the following example:
  175.  
  176.          COMMAND.COM  /E:nnnnn
  177.  
  178.        When finished, type EXIT to return to the original command processor.
  179.  
  180.        Using /E:2048 will create an environment size of 2048 (2K) bytes.
  181.        The size can be from 160 to 32768 bytes.
  182.  
  183.        NOTE: DOS 3.10 requires the number of paragraphs instead of the number
  184.        of bytes for 'nnnnn'.  A paragraph is 16 bytes.  Use /E:128 for a 2048
  185.        (2K) byte environment.  The size can be from 10 to 2048 paragraphs.
  186.  
  187.        NOTE: DOS 3.00 and earlier do NOT support the /E switch.  In this case,
  188.        you will have to run a patch program for increasing the default size or
  189.        change to DOS 3.10 or later.  In the first case, see your DOS manual.
  190.  
  191.        NOTE: If you are using 4DOS or other command line replacements, please
  192.        read its manual for the proper syntax!
  193.  
  194.  
  195.        PATHTOOL INNER WORKINGS:
  196.  
  197.        When replacing the PATH, PathTool will first delete the old PATH so
  198.        memory will be reused.  This will prevent running out of environment
  199.        space when it is almost full.  Also, the new PATH will be placed at
  200.        the beginning of the environment to prevent DOS wasting time searching
  201.        for it in a large environment.
  202.  
  203.  
  204.        UPDATING MULTIPLE ENVIRONMENTS:
  205.  
  206.        Multiple environments may exist in your system simultaneously.  This
  207.        may occur when using some DOS SHELL programs, loading a secondary
  208.        command processor (COMMAND.COM), or "shelling out" of a program.
  209.        PathTool defaults to updating the current environment, but the user
  210.        has the ability to override this with the /U option.  The current
  211.        environment is associated with the command processor when PathTool
  212.        is run.  The option of None is provided for command processors that
  213.        are not compatible with COMMAND.COM.  A future PathTool release will
  214.        allow more control of modifying specific environments.
  215.  
  216.  
  217.      * EXPLANATION OF DIRECTORY ENTRY:
  218.  
  219.        As described earlier, the PATH string consists of multiple directories
  220.        that are searched in order by DOS.  This document will refer to the
  221.        individual directory as a 'Directory Entry'.  Some pathtool commands
  222.        will refer to a numbered directory entry using the following convention:
  223.  
  224.          PATH=c:\first;c:\second;c:\third
  225.  
  226.          1 would specify c:\first
  227.          2 would specify c:\second
  228.          3 would specify c:\third
  229.  
  230.        See the examples in this manual for the proper usage.
  231.  
  232.  
  233.        USING WITH BATCH FILES:
  234.  
  235.        PathTool can create a batch file containing the new PATH.  If you
  236.        prefer to run batch files instead of letting PathTool update the
  237.        environment, two examples are provided:
  238.  
  239.          Example #1, BAT file:
  240.  
  241.            PATHTOOL %1 %2 %3 %4 %5 %6 %7 %8 %9
  242.            IF ERRORLEVEL 1 GOTO ERROR
  243.  
  244.          Example #2, BAT file:
  245.  
  246.            PATHTOOL /MP %1 %2 %3 %4 %5 %6 %7 %8 %9
  247.            IF ERRORLEVEL 1 GOTO ERROR
  248.            CALL {PATH}.BAT                           CALL requires DOS 3.3+.
  249.            DEL  {PATH}.BAT
  250.            :ERROR
  251.  
  252.  
  253.  
  254.        USING WITH NOVELL NETWARE:
  255.  
  256.        PathTool can replace the usage of MAP in situations that manipulate
  257.        the PATH.  Using PathTool will also gain you more in flexibility.
  258.        The following three examples describe MAPs' limits:
  259.  
  260.          The following example inserts the directory f:\public\bin at the
  261.          first entry in the PATH but not destroying the current first entry:
  262.  
  263.            MAP INSERT SEARCH1: = f:\public\bin
  264.  
  265.          This may be replaced with:
  266.  
  267.            PATHTOOL /I1 f:\public\bin
  268.            or
  269.            PATHTOOL /F  f:\public\bin
  270.  
  271.  
  272.          The following example inserts the directory f:\public\bin at the
  273.          first entry in the PATH:
  274.  
  275.            MAP SEARCH1: = f:\public\bin
  276.  
  277.          This may be replaced with:
  278.  
  279.            PATHTOOL /O1 f:\public\bin
  280.  
  281.          The following example deletes the first entry of the PATH:
  282.  
  283.            MAP DELETE SEARCH1:
  284.            or
  285.            MAP REMOVE SEARCH1:
  286.  
  287.          This may be replaced with:
  288.  
  289.            PATHTOOL /D1
  290.  
  291.  
  292.          PathTool cannot replace MAP in the next example since it
  293.          creates a search drive by mapping a directory to a drive.
  294.  
  295.            MAP z: = f:\projects\xyz
  296.  
  297.  
  298.  
  299.        USING WITH WINDOWS:
  300.  
  301.        Some windows users are using SUBST command to create short "aliases"
  302.        for long directory names which allows them to place more directories
  303.        in the PATH.  It has been stated that "Some windows applications may
  304.        act improperly when using SUBST in windows".  PathTool can solve this
  305.        problem by completely avoiding SUBST and creating PATHs of any
  306.        length (depending on environment size).
  307.  
  308.  
  309.  
  310.        USING WITH 4DOS AND NDOS:
  311.  
  312.        The command line replacement, 4DOS & NDOS, can accept 255 characters
  313.        on the command line instead of the 127 for COMMAND.COM.  To
  314.        take advantage of this, add the /L255 or /L0 option to PATHTOOL.
  315.        However, you may not want to take advantage of 4DOS or NDOS, if you
  316.        plan to use the batch file on computers which have COMMAND.COM.
  317.  
  318.  
  319.        USING WITH OTHER COMMAND.COM REPLACEMENTS:
  320.  
  321.        Some COMMAND.COM replacements, which are not compatible with the
  322.        PSP and environment strings, may require PATHTOOL to create a
  323.        batch file containing the new PATH.  COMMAND.COM and 4DOS do not
  324.        require this procedure.
  325.  
  326.          Example #1, BAT file:
  327.  
  328.            PATHTOOL  /UN  /MP  [other switches...]
  329.            CALL {PATH}.BAT
  330.  
  331.  
  332.          Example #2, TYPE ON COMMAND LINE:
  333.  
  334.            PATHTOOL  /UN  /MP  [other switches...]
  335.            {PATH}.BAT
  336.  
  337.  
  338.        USEFUL TIP:
  339.  
  340.        This program was designed to give you the most use from the command
  341.        line.  Type PATHTOOL without any parameters.  A numbered list of
  342.        directory entries along with a list of all commands and options
  343.        will be displayed to help you type the next command line.
  344.  
  345.  
  346.        PATHTOOL SYNTAX SUMMARY:
  347.  
  348.        Syntax  : PATHTOOL  [{/-}command]  [{/-}options...]  [directories...]
  349.  
  350.        Command : Ad : Insert directory(s) After matching directory `d' in PATH.
  351.                  Bd : Insert directory(s) Before matching directory `d' in PATH.
  352.                  D  : Delete directory(s) from PATH.
  353.                  Dm : Delete `m' entry from PATH.
  354.                Dm-n : Delete `m' thru `n' entry from PATH.
  355.                 Dm- : Delete `m' thru last entry from PATH.
  356.                  E  : Add    directory(s) to End of PATH.
  357.                  F  : Add    directory(s) to Front of PATH.
  358.                  Im : Insert directory(s) starting at `m' entry in PATH.
  359.                  Om : Overwrite `m' entry with directory(s).
  360.                Sm=n : Swap directories  positioned at `m' and `n' entry in PATH.
  361.                  H  : Display short help text.
  362.                  ?  : Display long  help text.
  363.                  $  : Display license information text.
  364.  
  365.        Options : Ge : Get path from environment string `e' before processing it.
  366.                  Ln : Maximum Length of PATH `n' (in bytes) including 'PATH='.
  367.                        Set `n' to 127 for portability.  Set `n' to 0 to use all
  368.                        environment free space.  The SHAREWARE version
  369.                        defaults to 160 and the REGISTERED version to 0.
  370.                 MDf : Create batch file `f' for Directories.  Default {DIR}.BAT.
  371.                 MPf : Create batch file `f' for PATH.  Default is {PATH}.BAT.
  372.                  NB : Suppress displaying size of new path and environment.
  373.                  ND : Suppress error on deleting directory not in PATH. Default.
  374.                  NE : Suppress displaying ERRORLEVEL return code. Default.
  375.                  NF : Suppress converting directories to full path name.
  376.                  NI : Suppress error on inserting directory already in PATH.
  377.                  NP : Suppress displaying new PATH.
  378.                  NS : Suppress displaying separate directories of new PATH.
  379.                  NT : Suppress displaying title banner.
  380.                  NV : Suppress verifing directories.
  381.                  Pe : Put path in environment string `e' before processing it.
  382.                        Default environment string is OLDPATH.
  383.                  Uc : Update specified environments.  Default `c' is C.
  384.                        Set `c' to C=current or N=none.
  385.                  YB : Display size of new path, environment size and free.
  386.                  YD : Allow error on deleting directory not in PATH.
  387.                  YE : Display ERRORLEVEL return code.
  388.                  YF : Converting directories to full path name. Default.
  389.                  YI : Allow error on inserting directory already in PATH.
  390.                  YP : Display new PATH. Default.
  391.                 YSn : Display separate directories of new PATH.
  392.                        `n'=0 to 3.  Default `n' is 0.
  393.                  YT : Display title banner. Default.
  394.                 YVn : Verify directories.
  395.                        `n'=0 to 1.  Default `n' is 1.
  396.  
  397.        Notes : Set the environment string `PATHTOOL=' for default options.
  398.                All commands and options can either be preceded with / or -.
  399.                Commands and options with sub-parameters must connect without
  400.                spaces. Only one command can be used with any number of options.
  401.                The order of commands and options is not critical.
  402.  
  403.          Multiple directories must be specified in the correct order for proper
  404.          placement.  Only the REGISTERED version supports multiple directories.
  405.  
  406.  
  407.        COMMAND DESCRIPTIONS:
  408.  
  409.          Ad : Insert directory(s) After matching directory `d' in PATH.
  410.               If the directory 'd' is in the PATH, then directories, from the
  411.               command line, will be inserted into the PATH after the matching
  412.               directory 'd'.  All inserted directories must exist on valid
  413.               drives or else none of the directories will be inserted.
  414.               Also see /NI and /YI options for error control!
  415.  
  416.          Bd : Insert directory(s) Before matching directory `d' in PATH.
  417.               If the directory 'd' is in the PATH, then directories, from the
  418.               command line, will be inserted into the PATH before the matching
  419.               directory 'd'.  All inserted directories must exist on valid
  420.               drives or else none of the directories will be inserted.
  421.               Also see /NI and /YI options for error control!
  422.  
  423.           D : Delete directory(s) from PATH.  If all of the directory(s) on
  424.               the command line are in the PATH, then they will be deleted.
  425.               Also see /ND and /YD options for error control!
  426.  
  427.        Dm   : Delete `m' entry from PATH.
  428.        Dm-n : Delete `m' thru `n' entry from PATH.
  429.        Dm-  : Delete `m' thru last entry from PATH.
  430.               If the directory entry(s) exist, then they will be deleted.
  431.               See the text describing directory entries.
  432.  
  433.           E : Add directory(s) to End of PATH.
  434.               All specified directories to be added must exist on valid drives
  435.               or else none of the directories will be added.  Also see /NI and
  436.               /YI options for error control!
  437.  
  438.           F : Add directory(s) to Front of PATH.
  439.               All specified directories to be added must exist on valid drives
  440.               or else none of the directories will be added.  Also see /NI and
  441.               /YI options for error control!
  442.  
  443.          Im : Insert directory(s) starting at `m' entry in PATH.
  444.               All specified directories to be inserted must exist on valid
  445.               drives or else none of the directories will be inserted.  See
  446.               the text describing directory entries.  See /NI and /YI options
  447.               for error control!
  448.  
  449.          Om : Overwrite starting at `m' entry with directory(s).
  450.               All specified directories to be overwritten must exist on valid
  451.               drives or else none of the directories will be overwritten.
  452.               See the text describing directory entries.
  453.  
  454.        Sm=n : Swap directories positioned at `m' and `n' entry in PATH.
  455.               If both directory entries exist, then the directories will
  456.               be swapped.  See the text describing directory entries.
  457.  
  458.           H : Display short help text.
  459.           ? : Display long  help text.
  460.  
  461.           $ : Display license information text.
  462.  
  463.  
  464.        OPTION DESCRIPTIONS:
  465.  
  466.          Ge : Get path from environment string `e' before processing it.
  467.               If the environment string is not found in the environment,
  468.               'PATH=' will be used instead.  If an environment string is
  469.               not specified, then the default 'OLDPATH=' will be used.
  470.               This option provides a quick method to set the PATH by
  471.               recalling previously stored PATHs.  See the /P option.
  472.  
  473.          Ln : Maximum Length of PATH `n' (in bytes) including 'PATH='.
  474.               NOTE: The REGISTERED version defaults to 0 which allows access
  475.               to the entire environment free space.  The SHAREWARE version
  476.               defaults to 160 and is limited to 160.  Command.com can accept
  477.               127 characters on the DOS command line.  4DOS can accept 255
  478.               characters on the DOS command line.  If you use PathTool, the
  479.               only limit is the environment size.
  480.  
  481.         MDf : Create batch file `f' for Directories.  Make a file containing
  482.               individual directories on seperate lines.  Similar to /YS1.
  483.               The default file name is '{DIRS}.TXT'.
  484.  
  485.         MPf : Create batch file `f' for PATH.  Make a batch file containing
  486.               the new PATH.  The default file name is '{PATH}.BAT'.
  487.               Refer to 'USING WITH OTHER COMMAND.COM REPLACEMENTS'.
  488.  
  489.          NB : Suppress displaying size of new path and environment.
  490.               Opposite of /YB option.
  491.  
  492.          ND : Suppress error on deleting directory not in PATH.  Default.
  493.               Opposite of /YD option.
  494.  
  495.          NE : Suppress displaying ERRORLEVEL return code.  Default.
  496.               Opposite of /YE option.
  497.  
  498.          NF : Suppress converting directories to full path name.  This is
  499.               recommended when trying to insert the following directories
  500.               into PATH:  F:.  OR  .  OR  ..\tools   Opposite of /YF option.
  501.  
  502.          NI : Suppress error on inserting directory already in PATH.  Default.
  503.               Opposite of /YI option.
  504.  
  505.          NP : Suppress displaying new PATH.  This is provided for usage in
  506.               batch file situations to keep PathTool "quiet".
  507.               Opposite of /YP option.
  508.  
  509.          NS : Suppress displaying separate directories of new PATH.
  510.               Same as /YS0 option.
  511.  
  512.          NT : Suppress displaying title banner.  This is provided for usage
  513.               in batch file situations to keep PathTool "quiet".
  514.               Opposite of /YT option.
  515.  
  516.          NV : Suppress verifing directories.  Same as /YV0 option.
  517.  
  518.  
  519.          Pe : Put path in environment string `e' before processing it.
  520.               If an environment string is not specified, then the default
  521.               'OLDPATH=' will be used.  This option provides a quick method
  522.               to save the PATH for future recall by the /G option.
  523.  
  524.          Uc : Update specified environments.  The default 'c' is C.
  525.                 C : Update Current environment.
  526.                 N : Update NO environments.
  527.  
  528.          YB : Display size of new path, environment size, and environment
  529.               free size.  All numbers are specified in bytes.  This option
  530.               is very useful to help solve "Environment space full" problems.
  531.               If the environment free is TOO small, errors may occur in the
  532.               future.  Refer to the discusion about the environment to
  533.               increase the environment size.  Opposite of /NB option.
  534.  
  535.          YD : Allow error on deleting directory not in PATH.  If any directory
  536.               does NOT exist when using the /D command an error will occur and
  537.               PathTool will abort.  This was the default on PathTool v1.0.
  538.               This is opposite of /ND option.
  539.  
  540.          YE : Display ERRORLEVEL return code.  This option is provided to
  541.               help debug problems in batch files.  Opposite of /NE option.
  542.  
  543.          YF : Convert directories to full path name.  Default.  Directories
  544.               will be converted to the full path name.  For example, c:. might
  545.               be converted to c:\dos before being placed into the PATH.  If you
  546.               don't wish the directories to be converted use the /NF option.
  547.  
  548.          YI : Allow error on inserting directory already in PATH.  If any
  549.               directory exists when using the /A, /B, /E, /F, or /I command
  550.               an error will occur and PathTool will abort.  This was the
  551.               default on PathTool v1.0.  This is opposite of /NI option.
  552.  
  553.          YP : Display new PATH.  Default.  Opposite of /NP option.
  554.  
  555.         YSn : Display separate directories of new PATH.  Default 'n' is 0.
  556.                 0 : Don't display separate directories.
  557.                 1 : Show directories on individual lines.
  558.                 2 : Same as 1 with leading numbered lines.
  559.                 3 : Show directories in numbered two column format.
  560.  
  561.          YT : Display title banner.  Default.  Opposite of /NT option.
  562.  
  563.         YVn : Verify directories.  Default `n' is 1.
  564.                 0 : Don't do any directory verification.
  565.                 1 : Verify directories on command line.
  566.  
  567.  
  568.        DIRECTORY DESCRIPTIONS (LAST PATHTOOL PARAMETER):
  569.  
  570.          Directories can either be given in a full path format consisting
  571.          of the drive and directory or a partial directory path.
  572.  
  573.          FULL PATH EXAMPLE:
  574.            c:\tools\arctools
  575.  
  576.          PARTIAL PATH EXAMPLES:  (Also see /NF and /YF options).
  577.            .
  578.            ..\arctools
  579.            \tools\arctools
  580.  
  581.            NOTE: Partial paths only work on directories that are NOT part
  582.                  of a command.  Example: /A. and /B\TOOLS are WRONG!
  583.  
  584.  
  585.        ERRORLEVEL SUMMARY:
  586.  
  587.           0 = OK or directory found.
  588.           1 = Directory is already in PATH.
  589.           2 = Directory is not in PATH.
  590.           3 = Directory does not exist on drive.
  591.           4 = Directory entry# out of range.
  592.          10 = New PATH length is too long.
  593.          20 = Can't create file.
  594.          30 = Environment space full.
  595.          70 = Command or option error.
  596.          71 = Command in PATHTOOL environment string.
  597.          72 = Directory in PATHTOOL environment string.
  598.  
  599.  
  600.        SOLUTIONS TO COMMON PATHTOOL ERRORS:
  601.  
  602.           1: A command contains a directory which already is in the PATH.
  603.  
  604.           2: A command contains a directory which is not in the PATH.
  605.  
  606.           3: A directory has been specified which does not exist.
  607.              New directories are validated before adding to the PATH.
  608.  
  609.           4: A directory entry number is bad.  It is either negative,
  610.              does not exist, or contains a non-numeric character.
  611.  
  612.          10: The new PATH is too long.  Use /L to change the maximum
  613.              length.  NOTE: The /L option cannot be longer than 160
  614.              on the shareware version.  The registered version is only
  615.              limited to the size of your environment.
  616.  
  617.          20: DOS error when creating a file for /MD or /MP option.
  618.  
  619.          30: Enlarge environment space.  See discusion about enlarging
  620.              the environment space for the command processor.
  621.  
  622.          70: Check syntax and examples for improper usage.
  623.  
  624.          71: Remove command from the PATHTOOL environment string.
  625.  
  626.          72: Remove directory from the PATHTOOL environment string.
  627.  
  628.  
  629.        EXAMPLE SUMMARY:   (See limitations of non-registered version)
  630.  
  631.          PATHTOOL  /$
  632.  
  633.          PATHTOOL  /?
  634.  
  635.          PATHTOOL  /Ac:\match  c:\onlydir
  636.          PATHTOOL  /Ac:\match  c:\first  c:\last
  637.  
  638.          PATHTOOL  /Bc:\match  c:\onlydir
  639.          PATHTOOL  /Bc:\match  c:\first  c:\last  /L127
  640.  
  641.          PATHTOOL  /D  c:\onlydir
  642.          PATHTOOL  /D  c:\first  c:\last
  643.          PATHTOOL  /D3
  644.          PATHTOOL  /D3-4
  645.          PATHTOOL  /D3-
  646.  
  647.          PATHTOOL  /E  c:\onlydir
  648.          PATHTOOL  /E  c:\first  c:\last
  649.  
  650.          PATHTOOL  /F  c:\onlydir
  651.          PATHTOOL  /F  c:\first  c:\last
  652.  
  653.          PATHTOOL  /H
  654.  
  655.          PATHTOOL  /I4 c:\onlydir
  656.          PATHTOOL  /I4 c:\first  c:\last
  657.  
  658.          PATHTOOL  /O2 c:\onlydir
  659.          PATHTOOL  /O2 c:\first  c:\last
  660.  
  661.          PATHTOOL  /S2=4
  662.  
  663.          PATHTOOL  /NT  /NP  [other switches...]
  664.  
  665.          PATHTOOL  >dirs.txt  /YS1  /NT  /NP  /MP
  666.  
  667.          PATHTOOL  /MD  /MP
  668.  
  669.          PATHTOOL  /UN  /MP  [other switches...]
  670.  
  671.          PATHTOOL  /YB  /R   [other switches...]
  672.  
  673.          PATHTOOL  /G     [other switches...]
  674.          PATHTOOL  /GOLD1 [other switches...]
  675.          PATHTOOL  /P     [other switches...]
  676.  
  677.  
  678.        EXAMPLES:   (See limitations of non-registered version)
  679.  
  680.  
  681.          1) Display quick help text and columnized path.
  682.  
  683.             Example:  PATHTOOL
  684.  
  685.  
  686.          2) Display short help text and normal path.
  687.  
  688.             Example:  PATHTOOL  /H
  689.  
  690.  
  691.          3) Display long help text and no path.
  692.  
  693.             Example:  PATHTOOL  /?
  694.  
  695.  
  696.          4) Display license text.
  697.  
  698.             Example:  PATHTOOL  /$
  699.  
  700.  
  701.          5) If c:\match exists in PATH then insert c:\onlydir after it.
  702.  
  703.             Example:  PATHTOOL  /Ac:\match  c:\onlydir
  704.  
  705.                 Old:  PATH=c:\;c:\match;d:\
  706.  
  707.                 New:  PATH=c:\;c:\match;c:\onlydir;d:\
  708.  
  709.  
  710.          6) If c:\match exists in PATH then insert c:\first & c:\last after it.
  711.  
  712.             Example:  PATHTOOL  /Ac:\match  c:\first  c:\last
  713.  
  714.                 Old:  PATH=c:\;c:\match;d:\
  715.  
  716.                 New:  PATH=c:\;c:\match;c:\first;c:\last;d:\
  717.  
  718.  
  719.          7) If c:\match exists in PATH then insert c:\onlydir before it.
  720.  
  721.             Example:  PATHTOOL  /Bc:\match  c:\onlydir
  722.  
  723.                 Old:  PATH=c:\;c:\match;d:\
  724.  
  725.                 New:  PATH=c:\;c:\onlydir;c:\match;d:\
  726.  
  727.  
  728.          8) If c:\match exists in PATH then insert c:\first & c:\last before it.
  729.  
  730.             Example:  PATHTOOL  /Bc:\match  c:\first  c:\last
  731.  
  732.                 Old:  PATH=c:\;c:\match;d:\
  733.  
  734.                 New:  PATH=c:\;c:\first;c:\last;c:\match;d:\
  735.  
  736.  
  737.          9) If c:\onlydir exists in PATH then delete it from PATH.
  738.  
  739.             Example:  PATHTOOL  /D  c:\onlydir
  740.  
  741.                 Old:  PATH=c:\;c:\onlydir;d:\
  742.  
  743.                 New:  PATH=c:\;d:\
  744.  
  745.  
  746.         10) If c:\first & c:\last exists in PATH then delete them from PATH.
  747.  
  748.             Example:  PATHTOOL  /D  c:\first  c:\last
  749.  
  750.                 Old:  PATH=c:\last;c:\;c:\first;d:\
  751.  
  752.                 New:  PATH=c:\;d:\
  753.  
  754.  
  755.         11) Delete the 3rd path entry from PATH.
  756.  
  757.             Example:  PATHTOOL  /D3
  758.  
  759.                 Old:  PATH=c:\;d:\;e:\;f:\;g:\;h:\
  760.  
  761.                 New:  PATH=c:\;d:\;f:\;g:\;h:\
  762.  
  763.  
  764.         12) Delete the 3rd thru 5th path entry from PATH.
  765.  
  766.             Example:  PATHTOOL  /D3-5
  767.  
  768.                 Old:  PATH=c:\;d:\;e:\;f:\;g:\;h:\
  769.  
  770.                 New:  PATH=c:\;d:\;h:\
  771.  
  772.  
  773.         13) Delete the 3rd thru last path entry from PATH.
  774.  
  775.             Example:  PATHTOOL  /D3-
  776.  
  777.                 Old:  PATH=c:\;d:\;e:\;f:\;g:\;h:\
  778.  
  779.                 New:  PATH=c:\;d:\
  780.  
  781.  
  782.         14) Add c:\onlydir to end of PATH.
  783.  
  784.             Example:  PATHTOOL  /E  c:\onlydir
  785.  
  786.                 Old:  PATH=c:\;d:\
  787.  
  788.                 New:  PATH=c:\;d:\;c:\onlydir
  789.  
  790.  
  791.         15) Add c:\first & c:\last to end of PATH.
  792.  
  793.             Example:  PATHTOOL  /E  c:\first  c:\last
  794.  
  795.                 Old:  PATH=c:\;d:\
  796.  
  797.                 New:  PATH=c:\;d:\;c:\first;c:\last
  798.  
  799.  
  800.         16) Add c:\onlydir to front of PATH.
  801.  
  802.             Example:  PATHTOOL  /F  c:\onlydir
  803.  
  804.                 Old:  PATH=c:\;d:\
  805.  
  806.                 New:  PATH=c:\onlydir;c:\;d:\
  807.  
  808.  
  809.         17) Add c:\first & c:\last to front of PATH.
  810.  
  811.             Example:  PATHTOOL  /F  c:\first  c:\last
  812.  
  813.                 Old:  PATH=c:\;d:\
  814.  
  815.                 New:  PATH=c:\first;c:\last;c:\;d:\
  816.  
  817.  
  818.         18) Insert c:\onlydir at the 4th path entry.
  819.  
  820.             Example:  PATHTOOL  /I4  c:\onlydir
  821.  
  822.                 Old:  PATH=c:\;d:\;e:\;f:\;g:\
  823.  
  824.                 New:  PATH=c:\;d:\;e:\;c:\onlydir;f:\;g:\
  825.  
  826.  
  827.         19) Insert c:\first & c:\last starting at the 4th path entry.
  828.  
  829.             Example:  PATHTOOL  /I4  c:\first  c:\last
  830.  
  831.                 Old:  PATH=c:\;d:\;e:\;f:\;g:\
  832.  
  833.                 New:  PATH=c:\;d:\;e:\;c:\first;c:\last;f:\;g:\
  834.  
  835.  
  836.         20) Overwrite the 2nd path entry with c:\onlydir.
  837.  
  838.             Example:  PATHTOOL  /O2  c:\onlydir
  839.  
  840.                 Old:  PATH=c:\;d:\;e:\
  841.  
  842.                 New:  PATH=c:\;c:\onlydir;e:\
  843.  
  844.  
  845.         21) Overwrite the 2nd & 3rd path entry with c:\first & c:\last.
  846.  
  847.             Example:  PATHTOOL  /O2  c:\first  c:\last
  848.  
  849.                 Old:  PATH=c:\;d:\;e:\
  850.  
  851.                 New:  PATH=c:\;c:\first;c:\last
  852.  
  853.  
  854.         22) Swap the 2nd & 4th path entries.
  855.  
  856.             Example:  PATHTOOL  /S2=4
  857.  
  858.                 Old:  PATH=c:\;d:\;e:\;f:\;g:\
  859.  
  860.                 New:  PATH=c:\;f:\;e:\;d:\;g:\
  861.  
  862.  
  863.         23) Do not display the PathTool banner or PATH.
  864.  
  865.             Example:  PATHTOOL  /NT  /NP  [other switches...]
  866.  
  867.  
  868.         24) Create a text file containing each path entry on separate lines
  869.             and a legal batch file that contains 'PATH=...'
  870.  
  871.             Example:  PATHTOOL  >dirs.txt  /YS1  /NT  /NP  /MP
  872.  
  873.  
  874.         25) Create a text file containing each path entry on separate lines
  875.             and a legal batch file that contains 'PATH=...'
  876.  
  877.             Example:  PATHTOOL  /MD  /MP
  878.  
  879.  
  880.         26) Create a legal batch file containing PATH= and do not update
  881.             the environment with the new PATH.  This is for COMMAND.COM
  882.             replacements that are not 100% compatible.
  883.  
  884.             Example:  PATHTOOL  /UN  /MP  [other switches...]
  885.  
  886.  
  887.         27) Show size of path, environment size, and environment free bytes.
  888.             Also show ERRORLEVEL returned to DOS.
  889.  
  890.             Example:  PATHTOOL  /YB  /R   [other switches...]
  891.  
  892.  
  893.         28) Get path from default environment string 'OLDPATH'
  894.             before processing it.
  895.  
  896.             Example:  PATHTOOL  /G  [other switches...]
  897.  
  898.  
  899.         29) Get path from environment string 'OLD1' before processing it.
  900.  
  901.             Example:  PATHTOOL  /GOLD1  [other switches...]
  902.  
  903.  
  904.         30) Put path into default environment string 'OLDPATH'
  905.             before processing it.
  906.  
  907.             Example:  PATHTOOL  /P  [other switches...]
  908.  
  909.         31) Add current directory to front of PATH.
  910.             Directories do not have to be a fullpath.
  911.  
  912.             Example:  PATHTOOL  /F  .
  913.  
  914.  
  915.        SYSTEM REQUIREMENTS:
  916.  
  917.          - DOS 2.1 or later.  We recommend DOS 3.3 or later.
  918.            Has also been tested with MSDOS 5.0 and OS/2 DOS box.
  919.          - 64K RAM available to application (after DOS loaded).
  920.          - Any video card.
  921.          - Any drive types.
  922.  
  923.  
  924.        SUPPORT:
  925.  
  926.          Call: New World Information Service (NWIS) BBS : (316)262-1829
  927.                300/1200/2400/9600/14400 Baud, 24hrs, .QWK packet mail door.
  928.  
  929.          CompuServe ID: 76260,1501
  930.  
  931.          Write: New World Designs
  932.                 PO Box 12217
  933.                 Wichita, KS  67277-2217
  934.  
  935.  
  936.      * REGISTERED VERSION ADDITIONS:
  937.  
  938.          - Create PATHs longer than 160 bytes with the /L option.
  939.  
  940.          - Commands handle multiple directories.  Only the first directory
  941.            is processed on the shareware version.
  942.  
  943.  
  944.        FUTURE ADDITIONS:
  945.  
  946.          - We have around 20 NEW commands and options on our wish list.
  947.            Look for NEW versions coming in the future!
  948.  
  949.  
  950.        ACKNOWLEDGEMENTS:
  951.  
  952.          Programmer  - Steve Meirowsky.
  953.          Proofreader - Laura Haas.
  954.          Beta Tester - Ron Flory, Gary Foster, David Hagood, Jeff Rayner.
  955.  
  956.  
  957.        TRADEMARK ACKNOWLEDGEMENTS:
  958.  
  959.          IBM is a trademark of International Business Machines Corporation.
  960.          MSDOS is a registered trademark of Microsoft Corporation.
  961.          4DOS is a registered trademark of J.P. Software.
  962.          NDOS is a registered trademark of Symantec.
  963.          NetWare & Novell are registered trademarks of Novell, Inc.
  964.          PathTool rights and usage are reserved by New World Designs.
  965.  
  966.  
  967.        DISK VENDOR INFORMATION:
  968.  
  969.            Shareware distributors and disk vendors who wish to distribute
  970.          the PATHTOOL package must comply with the following restrictions:
  971.  
  972.            In order for us to ensure that only the current version is
  973.          distributed, we require that you request permission from us to
  974.          distribute any of our products.  This must be in the form of a
  975.          written and signed letter.
  976.  
  977.            You may not list any of our products in advertisements, catalogs,
  978.          or other literature which describes our products as "FREE SOFTWARE".
  979.  
  980.            Vendors who wish to distribute the PATHTOOL package as part of a
  981.          collection (including CD-ROMs) must obtain permission from New World
  982.          Designs PRIOR to beginning such a distribution.
  983.  
  984.  
  985.        REVISION HISTORY:
  986.  
  987.        Version 2.0  (05/11/92)
  988.  
  989.         o  Add `PATHTOOL=' environment string for default options.
  990.  
  991.         o  Add /YF and /NF options.  For directory conversion to full
  992.            path.  The default is /YF.  If you want to add a directory of
  993.            `F:.' or `.' then you must use the /NF option.
  994.  
  995.         o  Add /ND and /YD options.  For control of errors when deleting
  996.            directories.  With /YD option, deleting a directory which does
  997.            NOT exist in the PATH will cause an error.  /ND is default!
  998.  
  999.         o  Add /NI and /YI options.  For control of errors when inserting
  1000.            directories.  With /YI option, inserting a directory which does
  1001.            exist in the PATH will cause an error.  Commands A,B,E,F,I are
  1002.            considered insert type commands.  /NI is default!
  1003.  
  1004.         o  Add /YVn and /NV options.  For verifing directories. /NV and
  1005.            /YV0 means don't do any verification.  /YV1 means to verify the
  1006.            directories on the command line.
  1007.  
  1008.         o  Add /NB, /NE, /NS, /YT, /YP options.  Complement of other options.
  1009.            All of these options are defaults.  They are meant for overriding
  1010.            purposes from the command line in-case their complements were
  1011.            used in the PATHTOOL= environment string.
  1012.  
  1013.         o  Fix /MP option by adding missing CR/LF.
  1014.  
  1015.         o  Fix /L so will accept up to 9999.  It was 999.  Zero is unlimited.
  1016.  
  1017.         o  Enhance verification of all directories on the command line.
  1018.            Also checks if drive exists.
  1019.  
  1020.         o  Change error format to 'ERROR PTxxx'.  It was 'ERRORxxx'.
  1021.  
  1022.         o  No longer shows path directories on errors.
  1023.  
  1024.         o  Change help descriptions.
  1025.  
  1026.  
  1027.        Version 1.0  (09/02/91)
  1028.  
  1029.         o  First shareware release.
  1030.  
  1031.