home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / util2 / to-retrn.lzh / TO-RET.DOC < prev    next >
Text File  |  1989-01-05  |  18KB  |  777 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                    TO - RETURN
  22.  
  23.                                    Version 1.2
  24.  
  25.  
  26.  
  27.                         Directory Changing Utility for the IBM
  28.                         Personal Computer and Other Compatibles
  29.  
  30.                                     ---------
  31.  
  32.  
  33.  
  34.                                   User's Manual
  35.  
  36.  
  37.                               (c) 1989 PC Soft-Tech
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.                               Table of Contents
  78.  
  79.  
  80.  
  81.  
  82.         Introduction/Overview.......................................1
  83.  
  84.         How TO.COM and RET.COM Work.................................2
  85.  
  86.         How to Use TO.COM ..........................................3
  87.  
  88.         How to Use RET.COM .........................................4
  89.  
  90.         Sample - The TO.TRE File....................................5
  91.  
  92.         Options and Performance Tips................................6
  93.  
  94.         System Requirements.........................................7
  95.  
  96.         Disclaimer..................................................8
  97.  
  98.         Registration................................................9
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.                                                                  PAGE 1
  137.  
  138.  
  139.        -- Introduction/Overview --
  140.  
  141.           TO - RETURN is a utility to help the user move around the
  142.           various directories and drives of their PC in a fast,
  143.           efficient manner.  It eliminates the need for typing long path
  144.           names with the DOS Change Directory (CD) command.  TO.COM and
  145.           RET.COM may also be used in batch (.bat) files such as
  146.           autoexec.bat or menu systems.
  147.  
  148.           Unlike many similar utilities, TO - RETURN is NOT sensitive to
  149.           one drive only.  As many as five drives can be accessed at any
  150.           time with TO - RETURN. Even the order in which to process the
  151.           drives can be specified with TO - RETURN.
  152.  
  153.           TO - RETURN has the added capability of being able to go back
  154.           to the last drive/directory the user was working in by simply
  155.           typing "RET".  And not only once, but three times to the last
  156.           three drives/directories to be made current with the TO
  157.           command.
  158.  
  159.           TO - RETURN has a simple description of how to use the program
  160.           included on-line simply by typing "TO".
  161.  
  162.           TO - RETURN is available as share-ware from many public
  163.           bulletin board systems.  The user may register his/her copy by
  164.           sending $10.00 to:
  165.  
  166.                    PC Soft-Tech
  167.                    P.O. Box 742
  168.                    Mequon, WI  53092
  169.  
  170.           Registration of TO - RETURN gives to user the following
  171.           additional benefits:
  172.  
  173.               o    Support by phone, mail, or PC Soft-Tech's private
  174.                    bulletin board.
  175.  
  176.               o    Notice of significant upgrades or bug fixes.  You
  177.                    will be notified by mail for any such updates.  There
  178.                    will be no charge for updates as long as you send us
  179.                    a diskette and return postage.  You may also receive
  180.                    a free update through the PC Soft-Tech Bulletin
  181.                    Board.
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.                                                                  PAGE 2
  203.  
  204.        -- How TO.COM and RET.COM Work --
  205.  
  206.           TO.COM and RET.COM are written in Assembler language and are
  207.           therefore extremely fast in operation.  When TO.COM is started
  208.           for the first time (or in subsequent updating), a file TO.TRE
  209.           is created in the root directory.  This file contains three
  210.           pieces of information used by TO.COM and RET.COM.  On the
  211.           first line of the file is information regarding the drives to
  212.           be processed by TO.COM and RET.COM.  The next three lines of
  213.           the file contain the last three drive/directories moved to
  214.           with the TO or RET command.  The rest of the file contains a
  215.           snapshot of the users directory tree.
  216.  
  217.           When the TO command is issued, followed by a string (full or
  218.           partial path name - see page 3) representing the
  219.           drive/directory to move to, the TO.TRE file is searched for
  220.           the for the drive/directory and automatically issues the DOS
  221.           command to move to that directory.  The TO.TRE file is then
  222.           updated to record the directory moved to.  If multiple
  223.           directories contain the identical string, TO.COM will move the
  224.           user to the first directory it finds containing the requested
  225.           string.
  226.  
  227.           When the RET command is issued, the TO.TRE file is searched
  228.           for the last directory moved from that is stored in the file
  229.           and issues the DOS command to move to that directory.  The
  230.           TO.TRE file is then updated and rearranged so that subsequent
  231.           issuing of a RET command will continue to move the user
  232.           through the last three directories used in the same continuing
  233.           order until another TO command is issued.
  234.  
  235.           A number of error messages have been included in the
  236.           programs to notify the user of any problems the program is
  237.           having with executing the commands as typed by the user.
  238.           These error messages include, NO MATCHING DIRECTORY FOUND,
  239.           DRIVE LETTER ENTERED DOES NOT EXIST ON THIS SYSTEM, TO.TRE HAS
  240.           BEEN CORRUPTED, INVALID DIRECTORY TREE - RESCANING, etc.
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.                                                                  PAGE 3
  269.  
  270.       -- How to Use TO.COM --
  271.  
  272.           TO.COM should be placed on the users hard disk in a utility
  273.           directory or some other directory which is contained in a path
  274.           statement installed in the root directory's autoexec.bat file.
  275.           Otherwise the TO command will only work if the user is in the
  276.           directory containing the TO.COM file.
  277.  
  278.           To use TO.COM for the first time, simply type:
  279.  
  280.                    TO /(Drives)
  281.  
  282.           Where (Drives) are a list of drives to be processed by the TO
  283.           command.  Up to five drives may be processed (C,D,E,F,G...)
  284.           in user defined order.  As and example, if the user wishes
  285.           the TO command to include three hard drives, he/she would
  286.           type:
  287.  
  288.                    TO /CDE (or TO /DCE to process drive D: first)
  289.  
  290.           This command creates the TO.TRE file used by the program to
  291.           move the user from directory to directory.  If the user wishes
  292.           to update the TO.TRE for added or deleted directories or
  293.           drives, he/she issues the same command used to create the file
  294.           initially.
  295.  
  296.           Once the TO.TRE file has been created, the user can move to
  297.           any directory on their system by typing:
  298.  
  299.                    TO (Path)
  300.  
  301.           Where (Path) can be any full or partial path name.  As an
  302.           example; to move to the directory C:\UTILITY\BATCH\SPECIAL,
  303.           the user could type any of the following:
  304.  
  305.                    to special
  306.                    to ut\spe
  307.                    to ty\tch\ial
  308.                    to bat\spec
  309.  
  310.           If a user attempts to move to a recently added or nonexistent
  311.           directory (not in TO.TRE file), an error message "NO MATCHING
  312.           DIRECTORY FOUND" will be given.  Many other error messages are
  313.           included as part of the TO.COM program to tell the user if an
  314.           invalid drive was specified, or the TO.TRE file has become
  315.           corrupted, etc, to aid the user in running the program.
  316.  
  317.           SPECIAL NOTE: The user must be aware that if he/she wishes to
  318.           move to the root directory c: (or a:, d: etc), the user must
  319.           type the ":" as typing just "to c" will cause the program to
  320.           search for the first directory containing a "c".  As an
  321.           alternative to typing c:, the user may type "to \" to move to
  322.           the root directory of the current drive.
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.                                                                  PAGE 4
  335.  
  336.        -- How to Use RET.COM --
  337.  
  338.           As with TO.COM, RET.COM should be placed on the users hard
  339.           disk in a utility directory or some other directory which is
  340.           contained in a path statement installed in the root
  341.           directory's autoexec.bat file.  Otherwise the RET command will
  342.           only work if the user is in the directory containing the
  343.           RET.COM file.
  344.  
  345.           Unlike TO.COM, RET.COM has no special requirement for first
  346.           time running.  However, TO.COM must have be run to set up the
  347.           TO.TRE file before RET will work.  To return to a directory
  348.           that a user moved from, he/she simply issues the RET command.
  349.           RET.COM uses lines 2 through 4 of the TO.TRE file to review
  350.           the last three directories the user moved to with the TO
  351.           command.  When the RET command is issued, the program will
  352.           execute and move to the latest directory moved from.  This is
  353.           on line 2 of the TO.TRE file.  After the move is complete, the
  354.           program will update the TO.TRE file moving the directories on
  355.           lines 3 and 4 to lines 2 and 3 respectfully.  It then moves
  356.           the directory that was on line 2 to line 4.  In this manner
  357.           the user may return to the last three directories in the same
  358.           order over and over (roll through).
  359.  
  360.           If TO.COM has not been run to set up the TO.TRE file and the
  361.           RET command is issued, an error message "NOWHERE TO RETURN TO"
  362.           will be displayed.
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.                                                                  PAGE 5
  401.  
  402.        -- Sample - The TO.TRE File --
  403.  
  404.           Following is a sample of the TO.TRE File as created for a
  405.           system with two hard drives.
  406.  
  407.  
  408.  
  409.                       DRIVES PROCESSED: CD
  410.                       C:\SYMPHONY\FILES
  411.                       C:\UTILITY\ARCHIVE
  412.                       C:\COMM
  413.                       C:\
  414.                       C:\ACCNTING
  415.                       C:\AST3270
  416.                       C:\AST4-02
  417.                       C:\CM
  418.                       C:\CM\CERTIF
  419.                       C:\CM\CMDIR1
  420.                       C:\COMM
  421.                       C:\DBASE
  422.                       C:\SYMPHONY
  423.                       C:\SYMPHONY\FILES
  424.                       C:\UTILITY
  425.                       C:\UTILITY\ARCHIVE
  426.                       C:\UTILITY\MACE
  427.                       C:\UTILITY\SPF
  428.                       D:\
  429.                       D:\MASTER
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.                                                                  PAGE 6
  467.  
  468.        -- Options and Performance Tips
  469.  
  470.           In order to make TO and RETURN run as fast as possible,
  471.           you should put TO.COM and RET.COM in a ram disk and set
  472.           the PATH statement to point to the ram disk first. The
  473.           total amount of ram disk space required is about 7K.
  474.           Refer to your DOS manual for information on creating
  475.           a ram disk and the PATH statements. For those of you
  476.           that have and expanded/extended memory board, the
  477.           manufacturer of the board has probably supplied their
  478.           own version of the ram disk software and drivers.
  479.  
  480.  
  481.  
  482.           By default, TO and RET create and use a tree file
  483.           called TO.TRE that is created in the root directory
  484.           of drive C. If you wish to put this file in another
  485.           directory and/or drive, set an environment variable
  486.           called TO-RET to the full path name of the file you
  487.           wish to use.
  488.  
  489.           For example, if you want to put the tree file on
  490.           drive D in sub-directory UTILITY\FILES and call the
  491.           file TO-RET.FLE, put the following command in your
  492.           autoexec.bat:
  493.  
  494.                   SET TO-RET=D:\UTILITY\FILES\TO-RET.FLE
  495.  
  496.           All further uses of TO and RET will then look for the
  497.           file on drive D, in subdirectory UTILITY\FILES with a
  498.           file name of TO-RET.FLE.
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.                                                                  PAGE 7
  533.  
  534.       -- SYSTEM REQUIREMENTS --
  535.  
  536.  
  537.           TO - RETURN has been successfully run using DOS 2.0 through
  538.           DOS 3.3 and has been run on the following machines (not all
  539.           versions of DOS on all machines):
  540.  
  541.                     o IBM PC
  542.                     o IBM XT
  543.                     o IBM XT/286
  544.                     o IBM AT
  545.                     o IBM PS/2 Model 50, 60 and 80
  546.                     o Compac Deskpro
  547.                     o Leading Edge Model D
  548.                     o Panasonic Business Partner
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.                                                                  PAGE 8
  599.  
  600.        -- DISCLAIMER --
  601.  
  602.  
  603.           The following disclaimer should be viewed as a legal
  604.           obligation on PC SOFT-TECH's part to protect itself.  We by no
  605.           means imply that TO - RETURN is flawed in any way.  We have
  606.           every intention to make modifications and enhancements to
  607.           ensure that TO - RETURN is the best possible product.  If you
  608.           are having problems with TO - RETURN or suspect that it may be
  609.           flawed in any way, notify PC SOFT-TECH and we will make the
  610.           necessary changes as soon as possible, and distribute it
  611.           accordingly.
  612.  
  613.  
  614.  
  615.  
  616.           TO - RETURN is distributed as is, with no guarantee that it
  617.           will work correctly in all situations.  In no event will the
  618.           Author be liable for any damages, including lost profits, lost
  619.           savings or other incidental or consequential damages arising
  620.           out of the use of or inability to use this program, even if
  621.           the Author has been advised of the possibility of such
  622.           damages, or for any claim by any other party.
  623.  
  624.  
  625.           TO - RETURN distribution package, consisting of the program
  626.           and documentation file are copyright (c) 1988 PC SOFT-TECH.
  627.           The author reserves the exclusive right to distribute this
  628.           product, or any part thereof, for profit.
  629.  
  630.  
  631.           Under NO CIRCUMSTANCES may modified versions or disassembled
  632.           versions be distributed, either for profit or in the public
  633.           domain.
  634.  
  635.  
  636.           User's groups, clubs, libraries and clearing houses are
  637.           authorized to distribute TO - RETURN pursuant to the
  638.           following conditions:
  639.  
  640.               1.  No charge is made for the software or documentation.
  641.                   A nominal distribution fee may be charged, provided
  642.                   that it is no more that $5 total.
  643.  
  644.               2.  The program and documentation are distributed together
  645.                   and are not modified in ANY way.
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.                                                                  PAGE 9
  665.  
  666.  
  667.        -- REGISTRATION --
  668.  
  669.  
  670.           Once you become a registered user of TO - RETURN, you will
  671.           receive you will receive the following benefits:
  672.  
  673.             o   Support by phone, mail, or through our private bulletin
  674.                 board system.  Support will only be provided to
  675.                 registered users.
  676.  
  677.             o   Notice of significant upgrades and bug fixes.  You will
  678.                 be notified by mail for any such updates.  There will be
  679.                 no charge for updates as long as you send us a diskette
  680.                 and return postage.  You can also receive a free update
  681.                 through our private bulletin board.
  682.  
  683.  
  684.           Each copy of TO - RETURN is registered for use on one computer
  685.           only and a registered copy is required for each additional
  686.           computer.  The price per registered copy of TO - RETURN is
  687.           $10.
  688.  
  689.           The registered version of TO - RETURN can be used in
  690.           commercial, educational, and governmental institutions.
  691.  
  692.           The free version of TO - RETURN is expressly prohibited for
  693.           use in commercial, educational, and governmental institutions
  694.           except for the purpose of evaluation.
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730.                                                                  PAGE 10
  731.  
  732.       -- REGISTRATION FORM --
  733.  
  734.  
  735.         Please add me to the list of registered users, to be eligible
  736.         for support and update notices.  Enclosed is my check or money
  737.         order for $10.
  738.  
  739.  
  740.         Computer Model: ________________________________________________
  741.  
  742.  
  743.         Company Name: ________________________________________________
  744.  
  745.         Your Name:    ________________________________________________
  746.  
  747.         Title:        ________________________________________________
  748.  
  749.         Address:      ________________________________________________
  750.  
  751.         City, State, Zip: ____________________________________________
  752.  
  753.  
  754.  
  755.  
  756.  
  757.         Any initial comments about TO - RETURN?  ________________________
  758.         _________________________________________________________________
  759.         _________________________________________________________________
  760.         _________________________________________________________________
  761.  
  762.         Where did you hear about TO - RETURN?  __________________________
  763.         _________________________________________________________________
  764.         _________________________________________________________________
  765.         _________________________________________________________________
  766.  
  767.  
  768.  
  769.          Send registration form and check or money order to:
  770.  
  771.                    PC SOFT-TECH
  772.                    P.O.  Box 742
  773.                    Mequon, Wi.  53092
  774.                    (414) 241-9119
  775.  
  776.  
  777.