home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 203.lha / Browser_v1.6 / browser.doc < prev    next >
Text File  |  1988-12-28  |  11KB  |  299 lines
  1. Browser -- a programmer's "Workbench".
  2.  
  3. Introduction
  4.  
  5.     The Amiga "Workbench" has some serious deficiencies as a working
  6. environment. The most important one is that it doesn't let you operate
  7. on just any file (this is rumored to be fixed in 1.4, by the way), but
  8. there are others. It's designed to be easy to learn and use, but it just
  9. isn't very powerful.
  10.  
  11. This program is an attempt to deal with some of these problems. It is
  12. not a complete replacement for Workbench, nor is it intended to be. There
  13. is no attempt to support icons, and there are no disk-oriented functions
  14. (formatting, copying, etc...).
  15.  
  16.     What Browser does allow you to do, easily and conveniently, is to
  17. move, copy, rename, and delete files and directories. It will also let you
  18. execute either Workbench or CLI programs, either directly by double-
  19. clicking them or by selecting them from a menu. By combining these you can
  20. set up a complete operating environment that will, to a large extent,
  21. replace both Workbench and the CLI.
  22.  
  23.     Browser presents you with a set of windows, representing directories,
  24. with all the files and directories within each listed in alphabetical
  25. order. Directories, displayed in color 2 (red/orange), are listed first,
  26. followed by the files. Selected files are displayed in inverse video.
  27.  
  28. Selecting Files
  29.  
  30.     You can select individual files three ways. First, just click on
  31. a file name. This will select that file and deselect all others. If you
  32. hold down the shift key when you click on the file, it will be selected
  33. without deselecting other files. This way you can build a list of files
  34. to operate on. So far this is just like Workbench, but if you click a
  35. selected file while holding down the shift key, it will be deselected
  36. without affecting other selected files. This lets you take back mistakes.
  37.  
  38.     Finally, you can use the menu items "Sel All" and "Sel Match" to
  39. select a group of files at once. "Sel All" will select all files in the
  40. active window. "Sel Match" will allow you to enter a pattern and then
  41. select only files matching that pattern in the active window. These
  42. normally act as toggles... if you have any selected files in the active
  43. window they will be deselected if they match.
  44.  
  45. Actions
  46.  
  47.     There are, again, three ways to manipulate selected files. First,
  48. you can drag a file or selected files to another window by holding down the
  49. left mouse button while you move the mouse. When you release the button,
  50. Browser will attempt to move the files to the location you indicate. This
  51. is just like the Workbench.
  52.  
  53.     Secondly, double-clicking a file will open it. If it's a directory,
  54. it will be opened and files in it will be displayed. If it's a program
  55. with an accompanying '.info' file, it will be launched as a Workbench task.
  56. This will also work with Projects, if the accompanying .info file specifies
  57. a tool. Finally, Browser will ask you if you want to launch it as a CLI
  58. program.
  59.  
  60.     Any other files selected will be passed to the new program, either
  61. on the CLI command line or in the Workbench Args structure. This is the
  62. normal Workbench shift-double-click method.
  63.  
  64.     Third, you can select a menu item.
  65.  
  66. Menus
  67.  
  68.     There are two main Browser menus. The first, "Browser", relates to
  69. the browser environment itself. The second, "Actions", relates to the files
  70. and directories displayed in Browser's windows. Menu items act either on
  71. selected files or on the currently active window. There are additional
  72. menus (called Tools Menus) that can be set up by the user.
  73.  
  74. Browser Menu
  75.  
  76.     Open
  77.  
  78.         This entry is equivalent to double-clicking the selected
  79.     file. It is included for consistency with Workbench. Strictly
  80.     speaking it should be in the Actions menu, but it seems to fit
  81.     here better.
  82.  
  83.     Close
  84.  
  85.         This entry is equivalent to clicking the active window's
  86.     close gadget.  Again, it's included for consistency with the
  87.     Workbench.
  88.  
  89.     Rescan
  90.  
  91.         This entry requests Browser to re-scan the directory displayed
  92.     in the active window. This is equivalent to, but a lot more convenient
  93.     than, closing and re-opening the window. I suppose I could poll the
  94.     disk for these, but if you use floppies much this becomes slightly
  95.     inconvenient.
  96.  
  97.     File Size
  98.  
  99.         When this is selected it toggles a bit associated with the
  100.     active window that indicated whether the size of each file should be
  101.     displayed alongside the name. In a future version this will be
  102.     expanded to include a full 'list'-style listing.
  103.  
  104.     Sel All
  105.  
  106.         This selects all files in the active window. Actually, it
  107.     toggles the selection of each file. Currently selected files will
  108.     be deselected.
  109.  
  110.     Sel Match...
  111.  
  112.         This is the same as Sel All, except that a pattern may be
  113.     provided to further restrict the selection.
  114.  
  115.     Options
  116.  
  117.         This allows you to modify the global behaviour of Browser
  118.     to some extent:
  119.  
  120.         X Toggle Selections
  121.  
  122.             This affects whether a selection through the menu,
  123.         or a shift-click, will deselect an already selected file.
  124.  
  125.         X Move files into subdirectories
  126.  
  127.             This effects whether you can move files into a
  128.         subdirectory by dragging them to it and releasing the mouse
  129.         button when the mouse is over the directory's name. If this
  130.         is not set you have to open the directory first.
  131.  
  132.         X Ask before moving into subdirectories
  133.  
  134.             If you permit files to be moved into subdirectories,
  135.         this determines if Browser will prompt you beforehand.
  136.  
  137.     Quit
  138.  
  139.         This selection closes all windows and terminates Browser.
  140.  
  141. Actions Menu
  142.  
  143.     The entries in this menu act on files rather than changing the state
  144. of Browser.
  145.  
  146.     WB Tool
  147.  
  148.         The currently selected file (singular) is entered into the
  149.     Tools menu as a workbench tool.
  150.  
  151.     CLI Tool...
  152.  
  153.         The currently selected file (singular) is entered into the
  154.     Tools menu as a CLI tool. Browser will pop up a requestor and allow
  155.     you to add additional arguments.
  156.  
  157.     Rename...
  158.  
  159.         The currently selected file (singular) is renamed. Browser
  160.     will pop up a requestor and allow you to enter the new name.
  161.  
  162.     Duplicate...
  163.  
  164.         The currently selected file (singular) is duplicated. Browser
  165.     will pop up a requestor and allow you to edit the new name (generated
  166.     by BumpRevision: "file" becomes "copy of file", and so on).
  167.  
  168.     Make Dir...
  169.  
  170.         Creates a new directory in the currently active window.
  171.     Browser will pop up a requestor and allow you to specify the name of
  172.     the new directory.
  173.  
  174.     Delete
  175.  
  176.         Deletes all selected files. This will only delete directories
  177.     if they happen to be empty.
  178.  
  179.     Delete All
  180.  
  181.         Deletes all selected files AND directories, recursively.
  182.  
  183. Tools Menus
  184.  
  185.     These menus (starting with Tools) are initially empty. They are filled
  186. in by selecting "Add * Tool" or from the file "s:browser.inittab". When you
  187. select an entry in these menus they're run (either as workbench or CLI
  188. programs) with all selected files being passed to the program. If you have
  189. a choice, you should make a program run under the Workbench... it's MUCH
  190. more reliable.
  191.  
  192. Environment
  193.  
  194.     Browser can itself be run from either the Workbench or the CLI. There
  195. are two separate versions of Browser on the distribution disk. The first,
  196. "browser", is a normal CLI/Workbench program. The second, "bgbrowser", is
  197. basically the same as "browser", but contains some extra code that
  198. automatically detaches it from your CLI.
  199.  
  200.     Browser uses a file, "s:browser.inittab", to pre-load the command
  201. menus. Each line in the file is a separate menu item, made up of 5 fields
  202. separated by semicolons:
  203.  
  204.     name;environment;command;stack;window
  205.  
  206.     The first field is the name that is to appear in the menu. This
  207. name can be preceded by the name of the menu to insert it in followed by
  208. a period. If the menu name is left off, the "Tools" menu will be used.
  209. For example, "Applications.Terminal Emulator" will create a menu entry
  210. for "Terminal Emulator" and install it in the "Applications" menu. If the
  211. menu doesn't already exist, it will be created.
  212.  
  213.     The two environments currently supported are the CLI and the
  214. Workbench. Project files (such as AmigaBasic programs) aren't supported
  215. through the menu system at this time, though they may be at a later date.
  216. They do work just fine when you double-click them.
  217.  
  218.     If our terminal emulator was to be run as a Workbench program, then
  219. this field should contain "Workbench". If it can't run under the Workbench,
  220. then it should contain "CLI". It is better, if possible, to run programs
  221. under the Workbench. It's a cleaner environment, and you don't get extra
  222. windows cluttering up your display.
  223.  
  224.     The next field is the name of the command. This should contain the
  225. full path name to the program. If the command is a CLI command, additional
  226. arguments can be included at this point. The names of any files highlighted
  227. when this menu is selected will be added to the end. If the command is
  228. a Workbench command, this should just be the program name. Highlighted
  229. files will be passed to the program in the Workbench Args structure.
  230.  
  231.     The next field is the stack size. It may be left off, and will
  232. default to 8K.
  233.  
  234.     The last field is the window. For a CLI command, this is the
  235. window that will be opened to run the CLI in. For a Workbench command,
  236. this is the ToolWindow that will be passed to it. If it's left off a
  237. default will be used.
  238.  
  239.     Applications.Terminal Emulator;Workbench;sys:system/Termulator
  240.  
  241. Limitations:
  242.  
  243.     The CLI capability occasionally leaves you in an interactive CLI
  244. after you exit the program. This is caused by using one of the BREAK keys
  245. while you're in the program. I had to leave this in to get finicky CLI
  246. programs, such as Manx 'Z' editor, to work properly.
  247.  
  248.     If you're copying a file to disk and you get a disk error,
  249. occasionally browser will appear to ignore disk errors and keep on trying
  250. to write. Actually, Browser handles all disk errors that get reported to
  251. it. For some reason AmigaDOS doesn't report errors promptly. I suspect
  252. this is related to requesting writes larger than a disk buffer, but I
  253. don't plan on having Browser do anything about this in the near future.
  254.  
  255.     Browser seems to run just fine with only the standard 4K stack. The
  256. minimum environment you need to run browser is:
  257.  
  258.      libs (dir)
  259.        icon.library
  260.  
  261. If you also want to run CLI programs, you also need:
  262.  
  263.      c (dir)
  264.        cd                               EndCLI
  265.        Failat                           NewCLI
  266.        Run                              Stack
  267.      l (dir)
  268.        Ram-Handler
  269.  
  270. These are needed to run the little scripts Browser builds in RAM: when you
  271. run a CLI program.
  272.  
  273. Author:
  274.  
  275.     Peter da Silva
  276.  
  277.     U.S.Mail:
  278.         1620 Enclave Parkway #2710
  279.         Houston, TX  77077
  280.  
  281.     Internet address:
  282.         peter@sugar.uu.net
  283.     UUCP path:
  284.         texbell!sugar!peter
  285.     Compuserve:
  286.         70216,1076
  287.  
  288. Donations:
  289.  
  290.     If you find this program useful, you may send a donation to the
  291. author, Peter da Silva. For a donation of thirty dollars or more you will
  292. receive the latest version of Browser (or, if you prefer, the next version
  293. whenever it comes out). I plan on listing donors in future versions of the
  294. manual in a "Sponsors" section. If you want your name to be used, let me
  295. know. If you don't say anything, I'll assume you want anonymity and will
  296. respect your privacy. Whatever you do I'll never sell your name to a
  297. mailing list :->.
  298.  
  299.