home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 080.lha / UtilMaster.doc < prev    next >
Text File  |  1986-11-20  |  14KB  |  303 lines

  1.  
  2.  
  3.         UtiliMaster
  4.  
  5.     Programable buttons!
  6.     ARC Won't hang up on duplicate files!
  7.     Two windows (Source & Destination)!
  8.     Modify "Standard" buttons!
  9.     Icon doubles as configuration file!
  10.     Run from Workbench or CLI!
  11.  
  12.     The top display window is ALLWAYS the source, the bottom destination.
  13.     The box above each display shows the current directory being displayed.
  14.     The three boxes in the lower right are the Entry ("E") box, the 
  15.     source directory Disk or Device name, and the destination
  16.     directory Disk or Device name. Swapping a disk while it's directory
  17.     is being displayed will automatically get the parent directory of
  18.     the new disk in the appropriate window UNLESS the name of the newly
  19.     inserted disk is exactly the same as the one removed.
  20.  
  21.     Standard buttons:
  22.     
  23.     "Swap" Will swap the source and destination directories. Files
  24.         may not be selected in the destination window other than
  25.         Double-Clicking sub-directories. If source and destination 
  26.         are swapped, selected files are not highlighted in the
  27.         destination window, but will be remembered and highlighted
  28.         in the source window if directories are swapped back.
  29.     "All" Selects all files in source directory.
  30.     "AllDirs" Selects all sub-directories in source directory.
  31.     "Exchange" De-selects all selected and selects all unselected.
  32.     "ExcDirs" Same for directories.
  33.     "Clear" De-selects all selected files.
  34.     "ClrDirs" Same for directories.
  35.     "Copy" Copies all selected files and sub-directories (including
  36.         files in sub-directories) to destination directory.
  37.         Copy also copies file comments, and if NOLOCK=1 has
  38.         not been entered as a tooltype in the icon, protection
  39.         on the copy is set to the same as the orriginal. (If
  40.         protection on the orriginal is "r-e-" then the copy is
  41.         set to "r-e-".)
  42.         If you enter a FileName in the "E" box, and copy
  43.         a file, it will be renamed in the destination directory.
  44.         In this case, copy stops after the first FileName if
  45.         more than one is selected.
  46.     "Rename" Will rename the FIRST selected file or directory to
  47.         the name in the "E"(Entry) box. If no name appears
  48.         in the "E" box, a requester appears requesting the 
  49.         new file name.
  50.     "Move" If destination directory is on the same device as source,
  51.             selected files will be moved into destination directory.
  52.             If not on the same device, an error message is displayed.
  53.     "Delete" Will present a requester asking if you are sure. Given an
  54.         affirmative, it will delete selected files. Selected
  55.         directories will be automatically deleted if empty.
  56.         For directories containing files, a second requester appears
  57.         reminding you they are not empty. Given an OK, these
  58.         directories, and all files and sub-directories will be
  59.         deleted.
  60.     "Lock" Changes the protection on selected files/directories to
  61.         "r-e-". They are protected from being written to or
  62.         deleted.
  63.     "UnLock" Changes protection to "rwed".
  64.     "Read" Displays the selected file(s) to the screen. ASCII files
  65.         are displayed in text mode, binary etc. are displayed
  66.         as if "c:type opt h" were used.
  67.     "FileNote" Attaches whatever is in the "E" box (Even a null string!)
  68.         as a comment to each selected file REPLACING any existing
  69.         comment. Using FileNote with the "E" box empty will
  70.         delete any existing comment.
  71.     "GetNote" Displays the comment on selected file(s) in the Status
  72.         box and the Filename in the "E" box. There is a brief delay
  73.         built in so you have a chance to read them if more than
  74.         one file is selected. Note that commented files display
  75.         a c in a circle just to the left of their size in the
  76.         display window.
  77.     "Print" By default, if Utilimaster can find a file named "c:print"
  78.         it will be RUN and passed the filename, if not, an internal
  79.         routine will print the file to PRT:. The default external
  80.         print routine can be changed. See "Setting Defaults", below.
  81.     "Show" By default uses "c:show" to display the selected file(s).
  82.         Show can also be re-defined,
  83.     "Search" By default opens a window and calls "c:search" passing it
  84.         the content of the "E" box as the string to seek, and
  85.         selected file(s) to search.
  86.     "Arc" "DeArc" & "ListArc" by default all use "c:arc".
  87.             "Arc" opens a window and Executes
  88.            "c:Arc a Filename <FileName> <FileName>" for selected
  89.            file(s).
  90.         "DeArc" Opens an interactive window and Executes
  91.            "c:Arc x FileName".  If duplicate files are found,
  92.            this version of UtiliMaster DOES NOT lock up in
  93.            the endless loop most others do!
  94.     "ListArc" Opens a window and Executes
  95.            "c:arc v FileName" The window remains open for reading
  96.            until you close it.
  97.     "Run" Is equivelant to typing "run > nil: FileName" from CLI.
  98.         No window is opened for your file by UtiliMaster.
  99.     "Edit" Defaults to "run e FileName"
  100.     "Execute" Defaults to "Execute FileName"
  101.     "GetDir" Gets the directory in the "E" box, which MUST begin
  102.         with a device name. If the "E" box is empty, the current
  103.         source directory is up-dated. Usefull if you have added
  104.         or deleted a file from some other program.
  105.         To get a sub-directory in the source window, Double-Click
  106.         on that directory's name with the left mouse button. For
  107.         a sub-directory in the destination window, Double-Click
  108.         on it with the RIGHT mouse button. To get the parent
  109.         of any sub-directory, Double-Click on the Directory
  110.         name box at the top of the listing window.
  111.     "MakeDir" Will make a directory with the name in the "E" window.
  112.         If nothing appears in the "E" window, a requester appears.
  113.         If MakeDir was clicked with the LEFT button, the directory
  114.         will be created in the source directory. If the RIGHT
  115.         button was used, the new directory goes in the destination.
  116.     "Info" Displays the number of USABLE bytes free on each device
  117.         in the window where the device name usually appears.
  118.         (Or free memory in the case of the Ram Disk) If any
  119.         files (NOT directories!) are selected, their total bytes
  120.         and number of x-modem blocks is disp[layed in the status
  121.         window.
  122.     "NewCLI" Will start up a new CLI if Utilimaster can find "c:NewCLI".
  123.     
  124.     There are four more buttons which do not appear unless defined
  125.         by the user as described below.
  126.  
  127.     All of the "Device" (DF0: DF1: RAM: etc.) buttons may be
  128.          re-programed to get other devices in the following
  129.          manner:
  130.          
  131.          To change "VD0:" to "VDK:", select (SINGLE-Click) the
  132.          Utilimaster icon on the workbench screen. Select "Info"
  133.          from the workbench menu. Click the "ADD" box next to
  134.          the "ToolTypes" window. Click in the "ToolTypes" box
  135.          and type "VD0:=VDK:" Please note that "VD0:" MUST be
  136.          upper case, but "vdk:" may be lower case if you so
  137.          desire. If you want other text in the button for the
  138.          device, leave a space and enter up to 8 characters.
  139.          EXAMPLE: To change "SYS:" to call your "s:" directory
  140.          with the button lbeled "Scripts" add a tooltype line
  141.          which says "SYS:=s: Scripts"
  142.          EXAMPLE: To change "DH1:" to call up the directory
  143.          "SYS:MyFiles" and the button to display "All Mine"
  144.          add a tooltypes line of "DH1:=sys:myfiles "All Mine"".
  145.          Note that "All Mine" should be entered in the tooltypes
  146.          box in quotes!
  147.          
  148.     Each time UtiliMaster is started (whether from workbench or CLI!)
  149.         the icon is parsed for these settings as well as those
  150.         described below.
  151.         
  152.     UtiliMaster defaults to "SYS:" as the source, and "RAM:" as the
  153.         destination directories on startup. You can change this
  154.         by adding a tooltype line that says
  155.          "DEFAULT=Directory Directory". The first directory listed
  156.          will become the default source, the second will become
  157.          the destination.
  158.  
  159.     UtiliMaster allows you to dictate a command directory other than
  160.         "c:" To do so add a tooltype line
  161.            "COMMAND=DirectoryName". If the directory does not
  162.            exist, Utilimaster will attempt to create it. Utili-
  163.            Master will then attempt to copy "c:run","c:newcli",
  164.            "c:endcli","c:execute",and "c:assign" into this
  165.            directory. It will then attempt to "assign c: 
  166.            DirectoryName". (This is due to the fact that the
  167.            DOS Execute() command invokes "c:run" in order to
  168.            function. The manx "exec()" commands don't need
  169.            "c:run", but won't function within a program started
  170.            from WorkBench!. They've got us between a rock and a 
  171.            hard place!)
  172.              On exiting UtiliMaster, "c:" will be assigned to
  173.            "SYS:c" unless you specify elswhere by a tooltype
  174.            "REASSIGN=DirectoryName".
  175.              If Utilimaster created a new command directory,
  176.             it will be deleted. If you assigned command to
  177.             an existing directory, it will be left intact on
  178.             exiting UtiliMaster. (Including any files UtiliMaster
  179.             copied into it!)
  180.               Other utilities may be copied into your newly
  181.            created command directory via a tooltype
  182.            "COPYLIST=FileName FileName FileName (etc.)". All
  183.            FileNames should include the Device:.
  184.  
  185.     USER BUTTONS: (Including changes to Show, Print, Arc, Search, etc.)
  186.     
  187.     Each of the four user buttons is defined by a tooltype line.
  188.     "USER#=FileName ButtonText [flags] [Perameters] [PromptText]"
  189.     Where FileName is the FULL directory name of the program to invoke.
  190.     ButtonText is the text (up to 8 characters) for the button.
  191.     Flags are desribed below.
  192.     Perameters (up to 8 characters) to pass to function).
  193.     PromptText (up to 30 characters) Is the Text to present in a
  194.       Requester if your program requires user input. (Example: A fileName
  195.     to create). If no promptext is provided, no requester will appear.
  196.  
  197.     Flags:
  198.       If your program is simply to be run (Example "sys:Clock"), then
  199.     flags=0. (You need not even enter them as no Perameters or Promptext
  200.     are permitted.)
  201.       Otherwise, flags starts as 0.
  202.       To RUN your program with selected FileName(s) passed to your
  203.         program, add 1. The result is as if typing:
  204.             "run >nil: CommandName FileName" 
  205.         from CLI for EACH Selected File. If 1 is NOT added the result is
  206.         like typing:
  207.             "CommandName FileName" from CLI for each selected FileName.
  208.       To open a window for your program to output text (It thinks it's
  209.     running from CLI!) add 2.
  210.       To open a window from which your program can accept keyboard input,
  211.     add 4. DO NOT add 2 AND 4!
  212.       To have perameters passed BEFORE the FileName, enter Perameters
  213.     and add 8 to flags.
  214.       To have perameters passed AFTER the FileName, enter perameters
  215.     and add 16 to flags.
  216.       If you use an output only window (you added 2) and want the window
  217.     to close after each FileName has been passed, add 32. Otherwise the
  218.     window will remain open until you close it.
  219.       To exclude selected directories from being passed to your program,
  220.     add 64.
  221.       The number entered for "Flags" should be a total of the above
  222.     depending on what you want to happen.      
  223.     EXAMPLES:
  224.       If Flags=0 Then the result of clicking the button will be like
  225.     typing "run > nil: CommandName" from CLI. Hence the tooltype
  226.       "USER1=sys:Clock Clock"  will cause the button for user1 to
  227.     read "Clock". When clicked it will RUN "sys:Clock", passing nothing
  228.     else to the program.
  229.       If Flags=65 your Program will not be invoked for any directories,
  230.     selected FileNames will be passed. Like 
  231.         "run >nil: Program FileName" from CLI.
  232.         
  233.     DEFAULT BUTTAON SETTINGS:
  234.       Each of the buttons listed may be changed by a tooltypes line.
  235.       These examples show what that line would look like to obtain
  236.     exactly what the default setting for that button is.
  237.     
  238.     PRINT=c:Print Print 65
  239.       "c:Print" is RUN and passed a FileName. No directories are allowed.
  240.       Control is returned to UtiliMaster while "c:Print" runs.
  241.     SHOW=c:Show Show 64
  242.       "c:Show is started and passed a FileName. Directories are not
  243.       allowed. Control IS NOT passed back to Utilimaster until "Show" is done.
  244.       This is to prevent Show from being run simultaniously for several files.
  245.     SEARCH=c:Search 50 all "What text?"
  246.       A window is opened, and the equivelant of typing
  247.         "c:Search FileName <"E" box content> All" takes place. If the "E"
  248.         box is empty, a requester appears whith the prompt "What text?".
  249.         The text then entered is substituted.
  250.     ARC=c:Arc Arc 0 A
  251.         Arc is a special case. Equivelent CLI line:
  252.           "c:Arc A FileName [FileName] [FileName]"
  253.     DEARC=c:Arc De-Arc 0 V
  254.         Arc is a special case. Equivelent CLI line:
  255.           "c:Arc X FileName"
  256.     LISTARC=c:Arc "List Arc" 0 V
  257.         Arc is a special case. Equivelent CLI line:
  258.           "c:Arc V FileName"
  259.     RUN=c:Run Run 64
  260.         Equivelent CLI line: "c:Run FileName"
  261.     EDIT=c:E Edit 1
  262.         Equivelent CLI line: "c:Run c:E FileName"
  263.     EXECUTE=c:Execute Execute 68
  264.         Equivelent CLI line: "c:Ececute FileName"
  265.     NEWCLI=c:NewCli "New CLI"
  266.         Equivelent CLI line: "c:Run c:Newcli"
  267.         
  268.     Please note that if a new command directory is defined, then
  269.     in each of the above examples, the new directory name will be 
  270.     used in place of "c:".
  271.     
  272.     Also note that any of these may be told to look for the program
  273.     in some other directory. For example, if you keep "Newcli" in
  274.     your "System" directory, you would then use tooltype
  275.       "NEWCLI=System:Newcli "New CLI""
  276.       (Note the quotes around "New CLI" for the button. Utilimaster
  277.       understands quotes and any group of words/letters inside quotes
  278.       is treated as one perameter regardless of spaces.
  279.  
  280.     Occasionally an error will leave you with what amounts to a
  281.     CLI window opened. You escape this window with "Endcli"
  282.  
  283.     When run from workbench, Utilimaster opens a background window.
  284.     You may change it's size by tooltype
  285.       "WINDOW=CON:<Left>/<Top>/<Width>/<Height>/"
  286.     If you use this, window MUST be "CON:" and ALL FOUR dimensions
  287.     MUST be given! (Unless you LIKE Guru Errors!)
  288.     There are some programs (The version of "Arc" that I have, for
  289.     example.) which send some of their output to ERROR out instead
  290.     of STANDARD out. This output will go to the background window
  291.     if started from WorkBench or the CLI from which UtiliMaster was
  292.         started. Sorry, I haven't figured out a way around this. You may
  293.         see this output by using the "Window to Front/Back" gadgets.
  294.         
  295.         Please send comments to:
  296.                 John Scheib
  297.                 3805 FairWay Circle
  298.                 Las Vegas, Nevada 89108
  299.                 OR
  300.                 People Link: JSCHEIB
  301.                 
  302.     Enjoy UtiliMaster!
  303.