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