home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_disks / 200-299 / ff289.lzh / Atree / Atree.Doc < prev    next >
Text File  |  1989-12-12  |  45KB  |  939 lines

  1.  
  2.  
  3. +-----------------------------------------------------------------------+
  4. | Atree v1.7        Copyright  1989 (pending)                           |
  5. +-----------------------------------------------------------------------+
  6. |                   A directory utility by Don Schmidt                  |
  7. +-----------------------------------------------------------------------+
  8.  
  9.  
  10.  
  11. To print Atree.Doc, at you CLI prompt enter: "type > prt: atree.doc" <CR>.
  12.  
  13.  
  14.  
  15.  
  16.  
  17. Atree v1.7 -- November 6, 1989.
  18.  
  19. This version of Atree is much improved over the previous version. Many bugs
  20. have been removed, improvements made, and options added.
  21.  
  22. This version is not fully functional -- it contains options that
  23. do not work. Options that do not work will present a requester indicating
  24. that you are not registered. You may obtain a fully functional version of
  25. Atree by sending me $25.00. You will then be entitled to upgrades as they
  26. are released. 
  27.  
  28. Send cash, check, or money order to:
  29.  
  30.               Don Schmidt
  31.               9425 Stanfield Ct.
  32.               Stockton, Calif.
  33.               95209
  34.  
  35. The author can be reached via COMPUSERVE PIN #73520,314. Comments,
  36. criticisms, suggestions and bug reports are welcomed.
  37.  
  38. Atree has no warranty or guarantee. The author assumes no responsibility
  39. whatsoever for any effects, good or bad, that Atree may have on hardware
  40. or software.
  41.  
  42. No portion of this program was intentionally designed by its author to do
  43. any damage to hardware or software or to cause any destruction or distortion
  44. of any data, i.e., it contains no intentional trojan horses or viruses of
  45. any kind. However, it is advised that caution be used with versions of the
  46. program not received directly from the author.
  47.  
  48. **************************************
  49. About Atree:
  50. **************************************
  51.  
  52. Atree is a disk utility which imitates similar utilities widely available
  53. on IBM compatibles (PC Tools, XTree, QuickDos, etc.). The intent is to allow
  54. the user a graphic representation of the entire (or any portion of the 
  55. entire) directory structure on a disk device, including the files in each
  56. directory, and the capability of moving quickly through the "tree" to a
  57. directory to access its files for purposes of copying, deleting, moving,
  58. viewing, editing, executing, etc.
  59.  
  60. Atree currently supports and will read into memory a directory tree that
  61. has a maximum depth of 65536 directories and no more than 65536 
  62. subdirectories total for the entire tree. (This is because Atree currently 
  63. supports a spreadsheet type matrix of 65536 columns, each column 
  64. representing the subdirectories of a parent directory and 65536 rows 
  65. representing a directory with the first of its children directly to the 
  66. right of it, and only a total of 65536 rows currently supported). It is 
  67. not known how the program will behave if the total number of directories 
  68. in a tree exceeds 65536 or if the depth of the tree exceeds 65536 
  69. generations.    
  70.  
  71. Although Atree can support a maximum depth of 65536 directories not to 
  72. exceed 65536 directories total in all directories for display purposes,
  73. it can only support a maximum depth of 512 directories for purposes of
  74. deleting, moving, copying, pruning, and grafting, or using any other
  75. function requiring a LOCK on a directory. Additionaly, there are more
  76. stringent limitations involved in the use of the "Replace from here" and
  77. similar routines (see the descriptions of such functions below under the
  78. "Tree Menu"). 
  79.  
  80.  
  81. ****************************************
  82. Atree Instructions:
  83. ****************************************
  84.  
  85. NOTE: If you are a first time user of Atree and do not have a
  86.       file called "Atree.Config" in your s: directory, then
  87.       running Atree will result in a requester indicating
  88.       "Failed: Object not found" -- select "CONTINUE" and Atree 
  89.       will continue to load and initialize without problem.
  90.       You should set up your config file during your first
  91.       session; see instructions for the CONFIG menu below.
  92.  
  93.       If you are a user of a previous version of a Atree 
  94.       and are using this version for the first time, it 
  95.       is recommended that you delete or move the 
  96.       Atree.Config file from your s: directory and redefine
  97.       your configs on your first run of this version.
  98.  
  99.       This version of Atree has an "Atree.Config" file
  100.       accompanying it. If you wish, copy this file to
  101.       your s: directory before running Atree. At least
  102.       you will have some pleasant colors in your first
  103.       session.
  104.  
  105.  
  106. *********************************************
  107. Running the program.
  108. *********************************************
  109.  
  110. Atree Operates only from the CLI. The general format of the command should 
  111. be:
  112.  
  113.       "run atree pathname pathname pathname ......".
  114.  
  115. Examples:
  116.  
  117.       run atree df0: df1: dh0: ram: df1:utilities df1:pictures/flowers
  118.  
  119. The above reads into memory six trees. The first four will be read from
  120. the ROOT directory of the indicated devices, and the last two will be
  121. trees read from the indicated subdirectories of the indicated devices.
  122.  
  123.       run atree dh1: dh1:c_sources dh1:c_objects
  124.  
  125. The above reads into memory the three trees from the same device, dh1:
  126. The first tree will be the entire tree starting with the ROOT directory,
  127. and the second and third will be the subtrees starting with the c_sources
  128. and c_objects directories respectively.
  129.  
  130.       run atree df0: df0: df0:
  131.  
  132. The above reads into memory the entire tree of df0: three times -- no good
  133. reason for doing it, but it can be done.
  134.  
  135.       run atree volume_1: volume_2: volume_3:
  136.  
  137. The above reads the entire tree starting from the ROOT directory of three
  138. disks whose volume names are as indicated. The system will prompt you to
  139. insert the volume in any drive if not already inserted. A two drive system
  140. can thus be used to read into memory the directory trees of more than two
  141. disks and as many as the system's memory will support.
  142.  
  143.       run atree
  144.  
  145. The above command line has no arguments and therefore atree will read into
  146. memory the entire subtree starting from the current directory specified for
  147. the operating system.
  148.  
  149. Reading into memory only the parts or sections of a directory tree may be 
  150. the desirable course if you are using a hard disk that has extensive 
  151. directories and you only intend to use two or more small portions of the 
  152. entire tree.
  153.  
  154. As many pathnames may be entered as the command line will support (Total of
  155. 255 characters).
  156.  
  157. ***********************************************
  158. Getting Atree out of the Way
  159. ***********************************************
  160.  
  161. Once Atree is up and running, you may want to get it off of your screen.
  162. The Atree window is on its own screen. You may use the mouse pointer to
  163. grab the window drag bar and drag the window down a few millimeters. Then
  164. you can grab the screen drag bar behind it and move the screen down to the
  165. bottom of your display. You can also drag the window down to expose the
  166. screen's front_to_back gadget and click on it to put the Atree screen behind
  167. any other screens present.
  168.  
  169. Atree can also be ICONIFIED. Select "Iconify" from the "Utils" menu and
  170. the program will be shrunk to a very small window that can be dragged or
  171. placed behind other screens. Click the mouse on the word "Atree" in this
  172. small window and the Atree program will be activated.
  173.  
  174.  
  175. ***********************************************
  176. Moving around in the directory and files:
  177. ***********************************************
  178.  
  179. The currently selected directory tree is shown in a large box at the left
  180. of the screen under the word "DIRECTORY:". This box can be thought of as
  181. a window to a larger box containing the entire tree. The entire tree can
  182. be thought of as represented on a large spreadsheet with 65536 rows and 
  183. 65536 columns. In this spreadsheet, a tree is formed which graphically
  184.  represents parent, child and sibling relationships between directories. 
  185. Children of the same parent (siblings) will all be in the same column; 
  186. the parent of any directory is always in the column to the left, and the 
  187. children of any directory are always in the column to the right. Line 
  188. segments between directories show how they are related. The directory box 
  189. at any moment displays up to five generations (columns) of directories, 
  190. and up to sixteen rows.
  191.  
  192. You may use either the mouse pointer in combination with the left mouse 
  193. button, or the UP, DOWN, RIGHT, and LEFT arrow keys to scroll the directory 
  194. "window" to display different sections of the whole tree spreadsheet, as 
  195. explained below.
  196.  
  197. To the right of the directory box is another box just under the word "FILES".
  198. This box lists up to sixteen files in the currently highlighted directory.
  199. You may use either the mouse pointer in conjunction with the left mouse
  200. button, or the shifted UP and shifted DOWN arrow keys to scroll through the
  201. entire list of files in the currently highlighted directory, as explained
  202. below.
  203.  
  204. On the display screen, there will always be one directory and one file that
  205. are highlighted. The highlighted file or directory is understood to be the
  206. "argument" or "object" of the various commands you can select from the 
  207. keyboard or menus.
  208.  
  209. Only the first eight (8) characters of directory names are shown in the
  210. directory box; the full name of the currently highlighted directory is
  211. displayed to the right of the word "DIRECTORY:" above the directory
  212. display box.
  213.  
  214. Only the first twenty-five (25) characters of file names are displayed
  215. in the FILES box. To see the full file name, select the RENAME/FILE
  216. option from the ATTRIBUTE menu.
  217.  
  218. Cursor keys used alone move the highlighter in the directory box. Shift/UP
  219. Shift/DOWN move the highlighter in the files box.
  220.  
  221. Click left mouse button on any legitimate directory or file and highlighter
  222. will move to it, skipping over anything between.
  223.  
  224. Hold left mouse button down and move pointer -- highlighter will follow
  225. it.
  226.  
  227. Clicking or holding the left button down with pointer close to the
  228. edge of either the directory or files boxes will cause display to scroll
  229. if there is anything to scroll to. 
  230.  
  231. The pointer with button held down functions according to the same rules
  232. as the cursor keys, no matter where on the edge of the screen the pointer
  233. is located. The position of the highlighter is what's important. Thus,
  234. if the highlighter is on a directory at the lower edge of the box
  235. and the directory has no entries in the same column below it, then no
  236. matter where you hold the pointer at the lower edge of the box, no
  237. scrolling will occur. But if you move the highlighter to a directory that
  238. does have entries in the same column below it, then no matter where you hold
  239. the pointer along the lower edge of the directory box, it will scroll.
  240.  
  241. Atree also allows you to mark your place at up to three directories
  242. in any tree and to return to a marked place from any tree (See the
  243. description of the functions in the Directory Menu below). 
  244.  
  245. Tag files: Files in a directory can be tagged. The tagged files constitute
  246. a group that can be operated on as a unit for purposes of copying, moving,
  247. deleting, archiving, etc. To tag a file, move highlighter to file and press
  248. space bar (Directories can't be tagged). Once tagged, files remain tagged
  249. until an operation is performed on them. You thus may move to another
  250. directory to perform other operations and return later to the directory
  251. containing tagged files and the files will still be tagged. Tagged files
  252. are marked with the ">" symbol immediately to their left. You may remove
  253. the tag from a file by placing the highlighter over the file and pressing
  254. the space bar.
  255.  
  256. ******************************************************
  257. Using the Atree menus:
  258. ******************************************************
  259.  
  260. Tree Menu:
  261. ----------------------
  262.  
  263.   Read next: changes the currently displayed directory tree by 
  264.   rotating through directory trees previously read into memory. Thus, if 
  265.   you have read into memory df0:, df1:, and dh0:, then selecting this 
  266.   option will cause the "next" tree to be displayed; "next" is determined 
  267.   by the currently displayed tree and the order in which the trees were 
  268.   read into memory, which, in turn, is determined by the order in which 
  269.   you entered the names on the command line.
  270.  
  271.   Get (replace): replaces currently displayed tree with a new one 
  272.   you specify. 
  273.  
  274.   Get (new): reads into memory a new tree you specify and displays 
  275.   it. This will be a new tree in addition to the others currently 
  276.   read into memory. The user can thus read into memory a number of 
  277.   trees limited only by available memory after the program has been 
  278.   activated. 
  279.  
  280.   Erase: Deletes the currently displayed tree. (You can't delete the
  281.   last or only tree -- there must always be at least one tree).
  282.  
  283.   Info: Displays disk info, like how many bytes and blocks are free. 
  284.   Note that floppy 3.5 inch disks have 512 bytes per sector, but 
  285.   24 of these bytes are reserved by the system. Therefore, the 
  286.   correct number of bytes usable by the user is 488 bytes per block 
  287.   multiplied by the total number of blocks available, and that is 
  288.   the figure used here. Also note that 512 bytes per block are 
  289.   usable on hard disks.
  290.  
  291.   Show Memory: Displays total CHIP and FAST memory available.
  292.  
  293.   Set Max Depth: This option gives Atree some real flexibility. 
  294.   It allows the user to specify the depth to which any subsequently
  295.   specified tree will be read from a disk. A depth of 0 means no depth
  296.   is specified and Atree will read all directories it can.
  297.   A depth of one (1) means only the subdirectories and files
  298.   of the specified starting directory for the tree will be read.
  299.   By specifying a depth of one (1), and by using a combination
  300.   of the options "Replace from here" and "Add from here", the
  301.   user can weave his way into a disk directory system one layer
  302.   at a time. There may be a very real time savings by using this
  303.   method. The current setting of the Max Depth variable is saved
  304.   to the Config file described below. From that point on, Atree
  305.   will use the setting in the Config file upon running the
  306.   program. In addition, the functions "Read back (add)" and
  307.   "Read back (replace)" allow the user to weave his way back
  308.   out of a disk directory system.
  309.  
  310.   Replace from here: This option replaces the currently displayed 
  311.   tree with a new one that starts with the highlighted directory. 
  312.   Used in conjunction with a Max Depth setting, the user can 
  313.   penetrate only those portions of the directory that are of interest 
  314.   as an alternative to reading the entire tree.
  315.  
  316.   Add from here: This option functions the same as the "Replace from
  317.   here" option described above, except that a new tree is created and
  318.   becomes the displayed tree; the old one still remains. 
  319.  
  320.   Read back (add): Allows the user to "back up" in a tree. For 
  321.   example, suppose you have just read your way into a directory 
  322.   such that your currently displayed tree represents everything 
  323.   from a depth of 15 to 18 from a particular directory and that 
  324.   your maxdepth for reads is set at 3. Selecting this option will 
  325.   cause the reading of a new tree. The new tree will be derived 
  326.   by selecting the parent's parent's parent of the old tree's top 
  327.   directory and use the path to that new directory as the basis 
  328.   for reading the newly added tree to a depth of three. In other 
  329.   words, from the top directory, we "back up" maxdepth levels in 
  330.   the top directory's direct line of descent and then read from 
  331.   that ancestral directory to a depth of maxdepth; in our example,
  332.   we would end up with a depth of 12 to 15. 
  333.  
  334.   Read back (replace): Functions the same as "Read back (add)" except
  335.   that the new tree replaces the old tree.
  336.  
  337.     NOTE: The four options starting with "Replace from here" 
  338.     create a directory path string representing the complete
  339.     path specification of the currently highlighted 
  340.     directory -- the tree is then read just as though the 
  341.     user had typed the path on the CLI command line on 
  342.     running Atree. The size of this string is limited to 2048
  343.     characters. These functions therefore can support a 
  344.     minimum depth of about 51 directories (if each has a 
  345.     40 character name), and a maximum of about 1000 or so 
  346.     directories (if each is assumed to have a one character 
  347.     name). This should be quite sufficient for nearly all 
  348.     applications. 
  349.  
  350. Attribute Menu:
  351. -----------------------
  352.  
  353.   Note: Allows FileNote on highlighted directory/file.
  354.  
  355.   Protection: Allows change of protection status on highlighted 
  356.   directory/file. 
  357.  
  358.   Rename: Allows renaming of highlighted file/directory.
  359.  
  360. In all of the above cases, you can select the attribute from the menu
  361. to see or view the current specification and, if you wish, you can click 
  362. on the string gadget to alter the current specification. 
  363.  
  364. Directory Menu:
  365. ----------------------
  366.  
  367.   Delete: deletes all files in highlighted directory and deletes 
  368.   directory if there are no subdirectories. NOTE: This routine 
  369.   ignores delete protection -- the user must be sure that none 
  370.   of the files in the directory are wanted.
  371.  
  372.   Make: creates a subdirectory in the highlighted directory.
  373.  
  374.   Reread Files: Updates the memory list of files contained in
  375.   the highlighted directory. This is intended to be used when
  376.   you leave Atree to do some other work with other programs and
  377.   change the composition of directories or the attributes of one
  378.   or more files. This option will delete the current memory list
  379.   of files in the highlighted directory and reread directly from
  380.   the disk in order to achieve an exact correspondence between
  381.   files in the directory and their representation in memory. Also,
  382.   if you have specified a maximum depth for reads (see the "Set
  383.   Max Depth" option in the "Tree" menu), you may end up with 
  384.   your last layer of directories showing in the directory display
  385.   box, but any files contained in these directories will not have
  386.   been read. You may use the "Reread Files" option to read only the
  387.   files in these directories (subdirectories will not be read).
  388.   These files will be incorporated in the list of all files in the
  389.   currently displayed tree -- they will therefore be included
  390.   in any subsequent use of routines in the "Sort" and "Locate"
  391.   menus. (NOTE: the Configs menu, described below, has an
  392.   option to set "reread" on or off for automatic use in some cases).
  393.  
  394.   Mark Destination: Highlighted directory becomes the target or 
  395.   destination directory for MOVE and COPY functions. Any function 
  396.   requiring a target will not work unless a MARK is set.
  397.  
  398.   Show Destination: In case you have forgotten which directory in 
  399.   which tree you have selected, this option will tell you. You will
  400.   however only get an abbreviated representation of the complete 
  401.   destination path specification; you will be given the name of 
  402.   your "tree top" (what you specified in order to read this tree) 
  403.   and the name of the directory that is marked as the destination 
  404.   (There may, of course, be more than one directory with the same 
  405.   name in a given tree, so be careful about your assumptions).
  406.   The complete destination path specification is not given for 
  407.   the simple reason that Atree supports up to a depth of 65536 
  408.   directories, each of which can have a name up to 40 characters 
  409.   long -- that represents a string of 2,621,440 characters! 
  410.  
  411.   Goto Destination: Select this and your destination directory will be
  412.   displayed and highlighted in the upper left corner of the display 
  413.   box. 
  414.  
  415.   Place Mark: Atree allows you to set up to three place markers. 
  416.   The highlighted directory is marked so that it may be subsequently
  417.   returned to from any tree or directory.
  418.  
  419.   Goto Mark:  If a place mark has been set, selecting the goto 
  420.   option (1, 2, or 3) corresponding to it will cause the marked 
  421.   directory to be displayed and highlighted in the upper left hand 
  422.   corner of the directory display box.
  423.  
  424.   Prune:  Selecting this option will delete all files and sub 
  425.   directories in the currently highlighted directory. The 
  426.   highlighted directory will also be deleted. This function is 
  427.   like cutting a complete branch from a tree. The function may not 
  428.   do a complete job of pruning if for any reason files and 
  429.   directories cannot be found or deleted. The prune function will, 
  430.   in other words, prune whatever it can. NOTE: The prune function 
  431.   will delete even delete protected files and directories without 
  432.   question or warning. Therefore, the user must make sure none of 
  433.   the files or directories in the branch to be pruned are wanted.
  434.   For best results, the user should be sure that the memory copy
  435.   of the tree's branch being pruned corresponds exactly to what is
  436.   on the disk. 
  437.  
  438.   Graft:  This function copies what it can of the branch from the 
  439.   currently highlighted directory to the currently marked 
  440.   destination. The graft function can be used to copy an entire 
  441.   disk to a blank disk or to ajoin an entire tree to a marked 
  442.   destination in another tree or in the same tree. 
  443.  
  444.   Tagged files: A requester will display the total bytes 
  445.   in all files tagged in the currently highlighted directory.
  446.  
  447.   Untag all files: Any files tagged in this directory will all be
  448.   un-tagged.
  449.  
  450.   Quick path: This option allows the making of a directory "tree"
  451.   consisting solely of the end directory of a complete directory
  452.   path you specify. This directory is automatically made the
  453.   destination directory for all subsequently selected file
  454.   operations, thus overiding whatever was previously selected as
  455.   the destination directory. To understand why this option is available
  456.   and how it improves efficiency, suppose you were in a situation where
  457.   you wanted to copy a bunch of files from the currently highlighted
  458.   directory to a specific directory on a disk in df0:. One way of
  459.   doing this would be to select "t" then "+" and specify your specific
  460.   directory. Atree would then read in the entire tree from your directory
  461.   up to the depth to which "max depth" is set. Doing this would cause
  462.   Atree to then display your new tree and you would then have to set
  463.   the desired directory as your destination. Then you would have to find
  464.   your way back to the original tree you were in, locate the directory you
  465.   previously had highlighted and then select the desired file operation.
  466.   With the "Quick path" option, assuming you already have your source
  467.   directory highlighted, you merely request "Quick path" and specify your
  468.   path. Atree quickly reads in only the end directory you specified and
  469.   marks it as the destination and leaves you in the highlighted directory.
  470.   All you have to do now is select the file operation you want involving this
  471.   new destination and away you go. Anytime later, you can find your way to
  472.   this new tree to examine it or delete it from your system.
  473.  
  474.  
  475. File Menu:
  476. ------------------
  477.   Copy, Move and Delete highlighted, tagged, or all files in currently 
  478.   highlighted directories; choices should be obvious.
  479.  
  480.   Archive: Use the Configs menu (see below) to specify the path to 
  481.   your favorite archive utility. Then select "Archive" 
  482.   highlighted/tagged/all from the FILE menu. You will be presented 
  483.   with a requester asking you to "Enter ARC arguments:". You should 
  484.   enter everything here that you want to be added to your path 
  485.   spec for your archive utility, except the filename -- this will 
  486.   be added automatically by Atree. The filename added by Atree 
  487.   depends on whether you selected highlighted, tagged, or all.
  488.  
  489.  
  490.   To make the above clearer with an example:
  491.  
  492.     Suppose you entered "dh2:utilities/arc" as your path spec 
  493.     in the Configs menu for your Archive selection. Suppose 
  494.     you now select Archive/highlighted from the FILE menu. 
  495.     You get the requester asking you to enter arc arguments.
  496.     Suppose you enter here, "a newarc". Suppose your highlighted
  497.     file name is "this_file". What will happen now is that 
  498.     Atree will execute the command line:
  499.  
  500.         dh2:utilities/arc a newarc this_file
  501.  
  502.     For my particular version of ARC, the above command line 
  503.     will create an archive file, newarc.arc, in the current 
  504.     (highlighted) directory (if it doesn't already exist) 
  505.     and then will add "this_file" to it. 
  506.  
  507.     Selecting "tagged" or "all" instead of "highlighted" 
  508.     will result in the above command line being executed 
  509.     over and over for all appropriate files.
  510.  
  511.  
  512.   NOTE: at present, despite what your ARC utility supports, this
  513.   version of Atree will not allow you to archive files whose names
  514.   contain spaces. Thus, you can archive a file named "session1",
  515.   but not "session 1".
  516.     
  517.   Execute: Executes the highlighted file with the RUN command; a 
  518.   command tail is requested via a requester and is optional.
  519.  
  520.   Text reader, editor, word processor, IFF displayer and sector 
  521.   editor should be obvious, but will not function unless first 
  522.   specified by selecting the "Paths" option from the CONFIGS menu.
  523.   If specs are made in the CONFIGS menu, the program specified  will
  524.   execute with the RUN command and with the highlighted file as the
  525.   command tail.
  526.  
  527.   Tag matching: If a pattern string has been specified via the
  528.   "string" option of the "locate" menu, selecting this option
  529.   will cause all files in the highlighted directory which match the
  530.   specified string pattern to be tagged.
  531.  
  532.   User's Choice: Using the "User's choice" option of the "Configs" menu,
  533.   you may specify the complete path for up to five programs you may wish
  534.   to execute from Atree. When you run Atree for the first time, the five
  535.   subitems of this option are listed as "??? Not Defined". Before these
  536.   can have any meaning, you must first define these options by selecting
  537.   one of the subitems under the "User's choice" option of the "Configs"
  538.   menu.
  539.  
  540.   NOTE: It is obvious that the user may alter a directory tree or 
  541.   a file in many ways without the memory copy of the tree or file 
  542.   list being correspondingly changed. Therefore, through the use 
  543.   of text editors, word processors, archive utilities, etc. your 
  544.   memory copy of a tree as displayed by Atree at any moment may 
  545.   not correspond to the disk it is supposed to represent. The user 
  546.   is advised to update the tree by re-reading it using the "Get 
  547.   (replace)" option from the TREE menu. Use the same path 
  548.   specification as necessary to update your displayed tree to keep
  549.   it in correspondence with the disk it represents. Alternatively,
  550.   if you have only changed files in a certain directory, you may
  551.   highlight that directory and select "reread" from the directory
  552.   menu to just reread the files in that directory.
  553.  
  554. Configs Menu:
  555. --------------------
  556.  
  557.   Paths: A requester allows user to specify a path leading to a 
  558.   text reader, editor, word processor, IFF display program, or 
  559.   sector editor (or of course any program specified). To use the 
  560.   requester set mouse pointer on selection, press left mouse button; 
  561.   if a specification was previously set, it will now appear in the 
  562.   uppermost string gadget at the top of the requester. If no
  563.   specification was previously made, the uppermost string gadget will
  564.   read "Enter path here". In either case, simply click on the
  565.   string gadget and enter the desired path specification and press
  566.   RETURN. When the corresponding selection is made via the FILE menu,
  567.   the specified program will be executed with the highlighted file as the
  568.   command tail. Thus, suppose you select "Text Reader" and in the string
  569.   gadget you enter "dh2:utilities/blitz". When you now go to the FILE menu
  570.   and select "Text Reader", Atree will execute the following command line:
  571.  
  572.         Run dh2:utilities/blitz <filename>
  573.  
  574.   where <filename> is the currently highlighted file.
  575.  
  576.   Selections which specify text editor, word processor, or archive
  577.   utility do not execute with the RUN command.
  578.  
  579.   Set buffer: This is the read/write buffer for copying, moving, and
  580.   grafting files -- settings above 512 or so are not too significant in
  581.   terms of promoting speed, but you may set what you like. When routines
  582.   are developed to use this buffer as a temporary storage area for sections
  583.   of text in files being searched for specified strings, a large buffer will
  584.   prove advantageous.
  585.  
  586.   Save: Saves the currently specified paths to text reader, editor 
  587.   etc. Current colors are also saved (See "Colors" option below).  
  588.   The file, Atree.Config, is created in the directory specified by 
  589.   the s: assignment. If you are a first time user of Atree, and 
  590.   the Atree.Config file does not exist, you will get a prompt upon
  591.   running Atree telling you "object not found" -- click on "continue"
  592.   and the program will proceed with its initialization. Set up your 
  593.   config file per the above instructions for future running. The 
  594.   "Save" option will also save to the config file the currently 
  595.   specified "maxdepth" setting -- see the "Set max depth"
  596.   option of the "Tree Menu" above. NOTE: the Utils menu (see below)
  597.   has options for saving and reloading the currently specified configs
  598.   (colors, etc.) to and from filenames you specify. You thus have
  599.   unlimited config file capability. Your default config file which will
  600.   always be looked for on running Atree is "s:Atree.Config".
  601.  
  602.   Check sp: Can be On or Off (Checked means "on"). If check
  603.   is on, a check is made for sufficiency of disk space prior to any
  604.   execution of copy/move/graft functions -- these routines will be
  605.   aborted via a requester if there is not enough space for the
  606.   file(s) to be copied to the device.
  607.  
  608.   Reread: If set to "on" (checked), highlighted directories will automatically
  609.   be reread after invoking the word processor, text editor, or archive
  610.   utility via Atree (i.e. from the file menu).
  611.  
  612.   Color Change: If checked, you will be able to adjust the currently
  613.   selected color (see "Colors" below on how to make adjustments). If
  614.   not checked, colors cannot be adjusted (prevents accidental color
  615.   changes).
  616.  
  617.   Colors: This option allows you to select a color so that you can
  618.   subsequently change it. After selecting a color with this option,
  619.   you can change the color by placing the mouse pointer over one of six
  620.   small areas located at the bottom of the Atree main display screen and
  621.   clicking or holding down the left mouse button. The six sensitive
  622.   areas are defined below:
  623.  
  624.  
  625.           FUNCTION                SENSITIVE AREA DEFINED BY
  626.  
  627.     Increase RED component:       The words "File size:"  
  628.     Decrease RED component:       The word  "Directory:"
  629.   
  630.     Increase GREEN component:     The upper word "Protection:"
  631.     Decrease GREEN component:     The lower word "Protection:"
  632.  
  633.     Increase BLUE component:      The upper word "Date:"
  634.     Decrease BLUE component:      The lower word "Date:"
  635.  
  636.  
  637.   The current settings of all colors are saved in the Atree.Config file
  638.   each time the "Save" option of the "Config" menu is selected.
  639.  
  640.   User's choice: You may define up to five programs to be executed with
  641.   an argument string you specify each time the program is run plus the
  642.   currently highlighted file. You can specify whether or not the program
  643.   you select is to be executed with the "RUN" command. To make this clear,
  644.   suppose you have a file searching utility called "search". Suppose
  645.   the path to this file is dh2:utilities. Suppose also that there are
  646.   several switches and search strings that you can specify for the search
  647.   and that these switches and strings are to be specified after the
  648.   executable filename (search) but before the file to be operated on (the
  649.   currently highlighted file). Thus, you may wish to execute the command
  650.   line:
  651.  
  652.     search -abcdef "search string" highlighted.filename
  653.  
  654.   It is precisely this pattern of execution that these "User's choices"
  655.   are aimed at satisfying. To set up the above example, you would select
  656.   one of the subitems from the "User's choice" option of the Configs menu.
  657.   You will be presented with a requester asking you to enter a menu subitem
  658.   name. The name you enter here is arbitrary and will appear subsequently
  659.   in the "File" menu, "User's Choice" subitem, to serve as your reminder
  660.   as to what this selection is all about. You may enter anything you like
  661.   here. "Search" would be a good idea. You will then be given a requester
  662.   that asks you for a path specification. Here you would give the complete
  663.   path specification for your "search" program, thus "dh2:utilities/search".
  664.   You will now be asked via a requester if you wish to execute this program
  665.   with a "RUN" command or not. This is explained below. You may click on
  666.   "YES" or "NO". Your definition of a User's choice is now done.
  667.  
  668.   If you now go to the "File" menu and select the "User's Choice" option
  669.   subitem you just defined ("Search" in this case), you will be presented
  670.   with a requester asking for arguments. You may now enter your arguments,
  671.   -abcdef "search string", in this case. Now, one of two command lines
  672.   will be executed:
  673.  
  674.   either:
  675.           RUN search -abcdef "search string" highlighted.filename
  676.  
  677.   or:
  678.           search -abcdef "search string" highlighted.filename
  679.  
  680.   Just which line is executed depends on what whether or not you requested
  681.   to execute the program with the "RUN" command.
  682.  
  683.   Many programs take command line arguments as described above. These user
  684.   options thus can be very useful and make your life a lot easier when using
  685.   Atree.
  686.  
  687.   One question remains. When do you opt to use or not to use "RUN"?  When
  688.   you execute a program with the RUN command from within Atree, Atree
  689.   immediately regains control and can continue on. When you execute a
  690.   program from within Atree without the RUN command, Atree will stop
  691.   dead in its tracks until you quit the program you ran (or it finishes
  692.   by itself).  The simple criteria to guide you is this: don't use the RUN
  693.   command to execute a program that may change or alter any files that
  694.   Atree itself may gain access to -- try to do otherwise and you will
  695.   (probably) be visited by various GURUs.
  696.  
  697.   Format: Use this option to set the parameters for the format option
  698.   you select from the Utils (utilities) menu (See below). You can
  699.   select one of four drives (df0: thru df3:) for formatting. if ICONS
  700.   is checked, formatting will result in the usual icons being placed on
  701.   the formatted disk; if QUICK is checked, it will be assumed that your
  702.   disk is already formatted and it will only be initialized; if FRONT
  703.   is selected, the WORKBENCH screen will be brought to the front so you
  704.   you can see the CLI window from which Atree was run -- this is where
  705.   any status and errors from the format program will be printed. All of
  706.   these settings will be saved to the Atree.Config file each time "save"
  707.   is selected from the Configs menu. The "format" command file must
  708.   be present in the c: directory.
  709.  
  710.   From dev: This option specifies the disk drive to be used as the FROM
  711.   device in the DiskCopy command accessible via the DiskCopy option of the
  712.   Utils menu (see below). The "DiskCopy" command file must be present in
  713.   the SYSTEM: directory. 
  714.  
  715.   To dev: This option specifies the disk drive to be used as the TO
  716.   device in the DiskCopy command accessible via the DiskCopy option of
  717.   Utils menu (see below). The "DiskCopy" command file must be present in
  718.   the SYSTEM: directory. 
  719.  
  720.  
  721. Locate Menu:
  722. -------------------
  723.  
  724.   String: Allows definition of search string specification for
  725.   searching through trees for directories, or for searching through 
  726.   directories for files, or for searching through all files in all 
  727.   directories in a tree for a matching file. The definition string 
  728.   may contain any of the following special meaning characters:
  729.  
  730.   ?           matches any single character
  731.  
  732.   *           matches zero or more occurrences of characters 
  733.               identical to the character preceding the "*"
  734.               
  735.   +           matches one or more occurrences of the preceding 
  736.               character
  737.  
  738.   \?          matches a question mark (?)
  739.  
  740.   \*          matches an asterisk (*)
  741.  
  742.   \+          matches a plus sign (+)
  743.  
  744.  
  745.   Here are several sample strings to help you get the idea:
  746.  
  747.   Example               Matches
  748.  
  749.   a??x            abyx, agtx, a56x, etc.
  750.  
  751.   a*x             x, ax, aax, aaax, etc.
  752.  
  753.   a?*x            ajax, abthgnfdhrrhtlo666x, etc
  754.             
  755.   a+x             ax, aax, aaax, etc.
  756.  
  757.   a\?x            matches only "a?x"
  758.  
  759.   a\*x            matches only "a*x"
  760.  
  761.         NOTE: The search string you specify will be converted to lower 
  762.   case and during the search process the compare string (a directory
  763.   or filename) is converted to lower case so that all searches are 
  764.   therefore case insensitive. Also, note that a match is considered 
  765.   to exist if your string is determined to match only the beginning 
  766.   of any compare string. Thus, "abc" will match "abcdef" and "abctuq",
  767.   etc.
  768.  
  769.   Tree:
  770.  
  771.   From Top: Searches from the top of the currently displayed tree for
  772.   a directory matching the pattern specified through selecting 
  773.   "string" above. Display moves to the found directory. The search 
  774.   is always made downward in the display column before moving to 
  775.   the next column to the right.
  776.  
  777.   From Here: Same as above, except the search begins with the next
  778.   directory down in the same column as the highlighted directory.
  779.  
  780.   Directory:
  781.  
  782.     From Top: Searches from the top of the currently highlighted
  783.     directory for a file matching the pattern string.
  784.     Search stops at end of list of files belonging
  785.     to the highlighted directory. Display moves to found.
  786.  
  787.     From Here: Same as above, except search begins with the file
  788.     next down from the highlighted file.
  789.  
  790.   All Files:
  791.  
  792.     From Top:  Searches all files in current tree irrespective 
  793.     of directory for a file matching the pattern string. 
  794.     Search starts at top. Display moves to found. 
  795.  
  796.     From Here: Same as above, except search begins with next 
  797.     file down from the currently highlighted file.
  798.  
  799. Sort Menu:
  800. ------------------
  801.  
  802.     The options in this menu should be clear -- the user can 
  803.     sort the highlighted directory's files by name, size, or 
  804.     date, and can sort the entire currently selected tree's 
  805.     files in all of its directories by name, size, or date.
  806.  
  807. Utils Menu:
  808. ------------------
  809.     Format: Formats a disk according to the parameters set via the
  810.     format option in the Configs menu. This option will present a
  811.     requester asking for the volume name you wish applied to the disk.
  812.     This option merely executes "format" with the RUN command  -- the
  813.     executable file "format" must therefore be in path, usually the
  814.     path to which SYSTEM: is assigned. The correct arguments for the
  815.     format command (drive to be formatted, etc.) are derived from
  816.     the parameter settings in the Configs menu. You have control of Atree
  817.     while the formatting is taking place. The output of the format
  818.     command is printed to the CLI from which Atree was executed -- if
  819.     you wish to view this CLI during formatting, you may find your CLI
  820.     manually, or you may select "FRONT" from the format option in
  821.     the Configs menu before starting the format process -- doing so brings
  822.     the WORKBENCH screen and the CLI window into view during the formatting
  823.     process.
  824.  
  825.     DiskCopy: This option executes the normal DiskCopy command. You specify
  826.     the FROM and TO disk drives using the "From dev" and "To dev" options
  827.     in the Configs menu. You will be asked for the name you wish to apply
  828.     to the copy and if you don't enter anything here, the name of the copy
  829.     will be the same as the name of the source disk. DO NOT set the "From
  830.     dev" and the "To dev" to the same drive as this will merely waste your
  831.     time copying the disk to itself.
  832.  
  833.     Save alt config: This option allows you to save all of your currently
  834.     specified configs (colors, etc.) to a directory and file of your choice.
  835.  
  836.     Load alt configs: This option allows you to reload a given set of
  837.     configs (colors, etc.) you previously saved to a given directory
  838.     and file via the "Save alt configs" option above.
  839.  
  840.     Iconify: This option allows the Atree screen and window to be shut
  841.     down and replaced by a very small window (not really an "icon").
  842.     This small window will always appear in the upper left hand corner
  843.     of the display. It may subsequently be dragged around on the display
  844.     or placed behind all other screens by clicking on the Window-to-back
  845.     gadget. To reactivate Atree, just click on the word "Atree" in the
  846.     small window.
  847.  
  848.     Change Dir: This option makes the currently highlighted directory the 
  849.     current directory for all AmigaDos commands subsequently entered by
  850.     selecting "CLI Command" from the Utils menu (see below). Suppose, for
  851.     example, you wish to compile a file in the currently highlighted Atree
  852.     directory. Choose "Change Dir" and the currently highlighted directory
  853.     is now the current directory for AmigaDos commands. Now select "CLI
  854.     Command" from the Utils menu and in the requestor type "lc filename".
  855.     The file whose name is "filename" will be compiled (provided "lc" is in
  856.     your path). The output of all CLI commands is directed to the CLI window
  857.     from which you started Atree. If you select "Change Dir"  and then select
  858.     "CLI Command" and type "dir" at the requestor and then find the CLI window
  859.     from which you started Atree, you will see the files/directories in the
  860.     highlighted directory printed to the CLI.
  861.  
  862.     CLI Command: See above for explanation.
  863.  
  864.     Print: Atree allows you to print to your printer all or part of a
  865.     tree or just a directory. The three options are:
  866.  
  867.       Tree long:  Prints all directories and files (with file size,
  868.                   and date). Full pathname is printed for each directory.
  869.                   Only first 30 characters of filename are printed.
  870.  
  871.       Tree short: Prints outline format of directories and files.
  872.                   Directories are preceded by a number representing
  873.                   the depth or level of the directory in the tree.
  874.                   For clarity, files are preceded by a "-" instead of
  875.                   number. Only the first 20 characters of directory and
  876.                   file names are printed. When the outline reaches the
  877.                   18th level, subsequent levels are "wrapped" back to the
  878.                   left margin of the printout and continued from there.
  879.  
  880.       Directory:  Prints the full pathname of the current directory and
  881.                   then prints all files (30 characters of name only), file
  882.                   sizes and dates.
  883.  
  884.  
  885. **********************************
  886. Keyboard operation
  887. **********************************
  888.  
  889. Most of the routines in Atree's menus may be accessed by first pressing the
  890. key corresponding to the first letter of the menu's name (thus, press the "t"
  891. key to access the routines in the "Tree" menu, or press the "f" key to access
  892. the routines in the "File" menu).  This will cause Atree to go into a mode
  893. waiting for you to press another key -- the key you press next must be either
  894. the "escape" key, or one of the keys indicated to the right of the name of
  895. one of the routines available in the menu you have selected. Thus, if you
  896. press the "t" key, followed by the "+" key, you will activate the "Get
  897. (new)" routine of the "Tree" menu. After pressing the "t", you must press
  898. the "Esc" key to abort this mode. If a menu option has additional options,
  899. you must press the appropriate keys to access those options, or the escape
  900. key. Thus, pressing the "f", "c", and "h" keys in succession will activate
  901. the "copy highlighted file" option of the "File" menu. Pressing the"f", "c",
  902. and "t" keys will activate the "copy tagged files" option of the "File" menu.
  903. If you have pressed the "f" and "c" keys in succession and you wish to abort
  904. your operation, you must press the "Esc" key. If you have pressed the "t"
  905. key but have forgotten the keys associated with any of the options of the
  906. "Tree" menu, you may still see those options by using the mouse -- the menus
  907. can still be activated, although the options associated with them cannot.
  908.  
  909. When a key corresponding to the first letter of the name of one of the menus
  910. is pressed, the window title bar will change and will indicate which menu's
  911. options Atree is now waiting for to be activated by a selection from the
  912. keyboard. As indicated above, press "Esc" to abort.
  913.  
  914.  
  915. *********************************
  916. Future Enhancements:
  917. *********************************
  918.  
  919. The following enhancements to the program are in process and will be 
  920. included in future revisions:
  921.  
  922. 1. Allow user to abort copy, move, delete, prune, graft operations.
  923.  
  924. 2. Allow moving and copying files with preservation of original datestamp.
  925.  
  926. 3. Allow use of Atree from the Workbench.
  927.  
  928. 4. Allow user to set a filespec for display, e.g. display only files with
  929.    ".doc" extension, etc.
  930.  
  931. 5. Develop disk sector editing routines.
  932.  
  933. 6. Develop routines to allow user to do string searches of text files.
  934.  
  935. 7. Set/View date routine.
  936.  
  937. 8. Datestamp change for files.
  938.  
  939.