home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / mar94 / os20 / wb / forceicon.lha / ForceIcon / ForceIcon.doc < prev    next >
Encoding:
Text File  |  1993-12-31  |  13.8 KB  |  397 lines
  1.    Welcome to ForcerIcon v1.2. This is a short description on how to
  2. use the program and how to configure it. ForceIcon is a utility mainly
  3. written for users of CDRom drives.
  4.  
  5.    Have you ever tried to Snapshot the disk icon (Disk.info) or tried
  6. to replace the disk icon of a CDRom ? Well, if not, do not even try,
  7. CDRom drives are read only media (how come). This is where ForceIcon
  8. comes to use. You may tell ForceIcon which volumes/devices to
  9. snoop/trace for forcing abolute positions or images.
  10.  
  11. ForceIcon is (C) 1993 Kai Iske, GiftWare
  12.  
  13.    The UserInterface was built using GadToolsBox 2.0c (37.300) by Jan
  14. van den Baard
  15.  
  16. Copyright
  17. *********
  18.  
  19.    You are allowed to copy and spread this program but only if you do
  20. not make any commercial profit out of the program itself and all
  21. supported files. The source of ForceIcon is considered teachware and
  22. the author claims the right to be the only one to produce and
  23. distribute new versions of ForceIcon. Public Domain vendors are not
  24. allowed to sell ForceIcon for more than the price of a regular disk,
  25. which should not be higher than 5 Dollars.
  26.  
  27.    ForceIcon is GiftWare, so if you like it and you you want to express
  28. your feelings, feel free to send me anything you think of being suited.
  29. Postcards, cookies, money, simply anything ;)
  30.  
  31. Guarantee
  32. *********
  33.  
  34.    The author does not give any guarantee that the program ForceIcon
  35. works perfectly.  The program was tested and it is used every day,
  36. anyway nobody is perfect and that is why I can not take the
  37. responsibilty for any damages occured during the usage of ForceIcon.
  38.  
  39. Evolution
  40. *********
  41.  
  42.    When I bought my CDRom drive I found out that the Workbench chooses
  43. quite *stupid* positions for icons with no abolute position (from my
  44. point of view). Furthermore some CDRom publishers do not seem to care
  45. for good looking disk icons (again, from my point of view; if they even
  46. supply one).  Since I could not snapshot the supplied icon, nor replace
  47. it with one of my icons, I thought it would be a good idea to have an
  48. utility which does the "snapshotting" or "replacment". This was when
  49. ForceIcon came to live.
  50.  
  51.    ForceIcon allows the user to select positions for his/her Disk.info
  52. files, either device dependant or volume dependant, ie. ForceIcon will
  53. either monitor *all* volumes inserted into a device, or just those
  54. specified by the user. It is also possible to override the settings for
  55. a device if you specify the name of a volume, too.
  56.  
  57. Whom I must say 'thank you'
  58. ***************************
  59.  
  60.    I would like to thank the following people
  61.  
  62. `Martin Taillefer'
  63.      For answering several questions
  64.  
  65. `Olaf 'Olsen' Barthel'
  66.      For suggestions and beta-testing
  67.  
  68. `Ralph Babel'
  69.      For suggestions on how to implement device dependancy and for
  70.      pointing me to a "bug".
  71.  
  72. `My girlfriend'
  73.      Who accepts what I`m doing
  74.  
  75.      ...and all the others I forgot
  76.  
  77. How to obtain updates
  78. *********************
  79.  
  80.    ForceIcon will be available on ADS, FRAS, FTP, and Fred Fish disks
  81. (CDs) as soon as there is a new release available.
  82.  
  83. How to contact the author
  84. *************************
  85.  
  86.    If you have any questions, suggestions, bug reports or anything else
  87. you want to tell me, you may contact me under one of these addresses.
  88.  
  89.    Either use normal snail mail:
  90.  
  91.      Kai Iske
  92.      Brucknerstrasse 18
  93.      63452 Hanau
  94.      Germany
  95.      Tel.: +49-(0)6181-850181
  96.  
  97.    or reach me using electronical mail
  98.  
  99.      USENET:   kai@iske.adsp.sub.org
  100.      INTERNET: iske@informatik.uni-frankfurt.de
  101.      FIDO:     Kai Iske, 2:244/6302.11
  102.      ZNET:     KAI@SWEET.ZER
  103.  
  104. Installing ForceIcon
  105. ********************
  106.  
  107.    Installing ForceIcon is not that hard. Simply copy it to your
  108. `SYS:WBStartUp' drawer (including the supplied icon), or place it
  109. somewhere else and start ForceIcon from within your `S:User-StartUp'
  110. file. I suggest you better start ForceIcon from within
  111. `S:User-StartUp', so that ForceIcon may apply all patches *before*
  112. Workbench is loaded.
  113.  
  114.    When starting from within `S:User-StartUp' issue the following line :
  115.  
  116.                        Run <NIL: >NIL: ForceIcon
  117.  
  118.    You may configure ForceIcon using the following
  119. ToolTypes/CommandLine options.
  120.  
  121. `CX_PRIORITY=n'
  122.      Sets the priority for the program`s section which controls the
  123.      HotKey.  If you issue a priority > 0 it may be that HotKeys
  124.      initialized by other programs may not be reached anymore if
  125.      ForceIcon uses the same.  Default: It`s neutral 0.
  126.  
  127. `CX_POPUP=YES|NO'
  128.      Per default the control window will be opened on startup. You may
  129.      suppress this behaviour by issuing *CX_POPUP=NO*
  130.  
  131. `CX_POPKEY=s'
  132.      Using this option you may override the default settings for the
  133.      openup HotKey.  This HotKey is used to open the control window.
  134.      Default HotKey definition is *lalt lshift i*. See HotKey, for more
  135.      about describing a HotKey.
  136.  
  137.    These options may be used within the icon`s ToolType field or on the
  138. CommandLine.
  139.  
  140. HotKey definition
  141. =================
  142.  
  143.    To ease the definition of a HotKey here is a list of
  144. key-descriptions the system "knows".
  145.  
  146.    Here is a list of qualifiers.
  147.  
  148. `ALT'
  149.      Any Alt key.
  150.  
  151. `RALT'
  152.      Only the right Alt key.
  153.  
  154. `LALT'
  155.      Only the left Alt key.
  156.  
  157. `SHIFT'
  158.      Either Shift key.
  159.  
  160. `RSHIFT'
  161.      The right Shift key.
  162.  
  163. `LSHIFT'
  164.      Only the left Shift Key.
  165.  
  166. `CAPSLOCK'
  167.      Capslock must be pressed.
  168.  
  169. `LCOMMAND'
  170.      Left Amiga key.
  171.  
  172. `RCOMMAND'
  173.      Right Amiga key.
  174.  
  175. `CONTROL'
  176.      Control Key.
  177.  
  178. `NUMERICPAD'
  179.      Keys of the Numeric Keypad are accepted.
  180.  
  181. `RBUTTON'
  182.      Right mousebutton.
  183.  
  184. `MIDBUTTON'
  185.      Middle mousebutton.
  186.  
  187. `LEFTBUTTON'
  188.      Left mousebutton.
  189.  
  190. `NEWPREFS'
  191.      Preferences have been changed. Maybe a new font was selected.
  192.  
  193. `DISKREMOVED'
  194.      A disk was removed from a drive.
  195.  
  196. `DISKINSERTED'
  197.      A disk was inserted into a drive.
  198.  
  199.    These are the qualifiers you can use in almost every combination.
  200. Now we come to the descriptions of "normal" keys.
  201.  
  202. `A - Z, 0 - 9, etc.pp.'
  203.      Normal keys, as you see them on the keyboard.
  204.  
  205. `F1 - F10'
  206.      The ten function keys.
  207.  
  208. `UP, DOWN, LEFT, RIGHT'
  209.      The cursor keys up, down, left, and right.
  210.  
  211. `HELP'
  212.      The Help key.
  213.  
  214. `DEL'
  215.      Delete key (beside HELP).
  216.  
  217. `BACKSPACE'
  218.      Backspace key
  219.  
  220. `RETURN'
  221.      Return key.
  222.  
  223. `ENTER'
  224.      Enter on Numeric Keyboard (only, if NUMERICPAD was specified).
  225.  
  226. `ESC'
  227.      Escape key.
  228.  
  229. `SPACE'
  230.      Space.
  231.  
  232. `COMMA'
  233.      A comma.
  234.  
  235. `UPSTROKE'
  236.      The apostroph (to the left of the 1).
  237.  
  238.    You can use as many qualifiers as you wish, but only one key per
  239. description.  This is the syntax for a HotKey definition:
  240.  
  241.                     [QUALIFIER [QUALIFIER ...]] KEY
  242.  
  243.    As you can see the qualifiers can be totally left out, but in how
  244. far this is usefull depends on you. Entering "None" (without quotes)
  245. will disable a HotKey.
  246.  
  247. Using ForceIcon
  248. ***************
  249.  
  250.    From within the main window you may configure ForceIcon to suit your
  251. needs and disks.
  252.  
  253.    On the right side of the window you will notice a ListView gadget
  254. showing all available volumes/devices currently known to the system.
  255. From this ListView you may select the volumes/devices to apply changes
  256. to. Simply select an entry and click on the *Add to list* gadget and
  257. the selected volume/device will be copied to the left ListView gadget
  258. named 'Used Volumes/Devices'.  You may copy an entry to the select-list
  259. by double-clicking on it, too.  If the selected entry has already been
  260. added to the list, a requester will pop up giving a warning. If a
  261. volume/device is not mounted yet you may add it`s name to the 'Used
  262. Volumes/Devices' list by clicking on *Add manually...*. A window will
  263. pop up, containing a String gadget.  Simply enter the new entry`s name
  264. *without* a trailing colon.  Selecting *Ok* will copy the entered
  265. volume to the 'Used Volumes/Devices' list, as long as it is not there
  266. yet. 'Cancel' will simply abort. You may determine the type of entry
  267. using the *Type* gadget. The third gadget underneith the 'Available
  268. Volumes/Devices' ListView called *Rescan list* may be used if a
  269. volume/device has been mounted *after* the main window has been opened.
  270.  
  271.    Underneith the 'Used Volumes/Devices' ListView there are two Button
  272. gadgets.  Selecting *Edit...*, or double clicking on an entry will open
  273. the 'Edit entry' window (see EditEntry). If you click on *Copy...*,
  274. ForceIcon will open the manual input window, so you may enter a
  275. device/volume name for the new (copied) entry. This way you may clone a
  276. specific entry, giving it all the attributes of the selected one.  The
  277. third gadget labeled *Remove from list*, will simply remove the
  278. selected entry from the 'Used Volumes/Devices' list. The Text gadget
  279. right underneith the ListView will tell you about the type of entry
  280. currently selected.
  281.  
  282.    Every time an entry is added to the list, the list will be sorted,
  283. so that volumes are shown first. This is due to the fact, that volumes
  284. have a higher priority over devices, so that you may force a volume`s
  285. icon to an other position than the position specified for the device,
  286. the volume was mounted from.
  287.  
  288.    The five gadgets at the bottom of the window are to be used as
  289. follows:
  290.  
  291. `Use'
  292.      Will copy the current settings to `ENV:ForceIcon_prefs.iff', thus
  293.      leading to temporary storage.
  294.  
  295. `Save'
  296.      Will copy the current settings to `ENV:ForceIcon_prefs.iff' *and*
  297.      to `ENVARC:ForceIcon_prefs.iff', thus leading to permanent storage
  298.      of your settings.
  299.  
  300. `About'
  301.      Displays about notices
  302.  
  303. `Hide'
  304.      Will close all windows.
  305.  
  306. `Quit'
  307.      Will close all windows *and* remove ForceIcon from memory.
  308.  
  309. Edit an entry
  310. =============
  311.  
  312.    This window may be used to edit an entry. The first gadget is a
  313. String gadget, which may be used to change the volume`s name, say the
  314. name of the volume/device ForceIcon will react on. The Cycle gadget
  315. (*Type*) underneith the String gadget allows you to change the type of
  316. entry you are editing. Below there are two Integer gadgets showing the
  317. current position of the disk icon of the selected volume. You may
  318. either set a position manually, or use the 'Position window', but only
  319. if you select *IconPos*.  If this gadget is not set, ForceIcon will
  320. force the loaded icon to have a position of NO_ICON_POSITION, say it
  321. will let the WorkBench position the icon. This might be usefull to
  322. override hardcoded positions. The position window may be opened using
  323. the *Position* Cycle gadget. Clicking on it once will open the window,
  324. whilst another click will close it again. Open the 'Position window'
  325. and drag it around your workbench. The values shown within the Number
  326. gadgets will be updated as soon as you release your left mouse button.
  327. Using this method you may determine the position of a disk`s icon on
  328. Workbench, too.
  329.  
  330.    Now following are three more gadgets which determine the image of the
  331. selected volume`s icon. Using the String gadget labeled *Icon*, you may
  332. set a name for a `.info' file which should be used, instead of the
  333. volume`s `Disk.info', or it will be used if the volume does not even
  334. have a `Disk.info'. Clicking on the GetFile gadget or holding down SHIFT
  335. while hitting the String gadget`s shortcut will open up a
  336. Filerequester, so that you may select a `.info' file using a more
  337. convenient method.  These two gadgets are only available if the
  338. following gadget is set.  Finally, the *Use Icon* gadget determines,
  339. whether the supplied icon should really be used, or not. You do not
  340. have to worry about the type of the selected `.info' file. ForceIcon
  341. will automatically apply all changes to the icon, so that it will be a
  342. *real* disk icon. These changes are applied during runtime. The file
  343. will not be modified on disk.
  344.  
  345. Program history
  346. ***************
  347.  
  348.      Revision V1.2
  349.      --------------
  350.      created on Tuesday, 07.12.93 18:10:09  by  Kai Iske.   LogMessage :
  351.        - Entries may be copied now
  352.      
  353.      Revision V1.1
  354.      --------------
  355.      created on Tuesday, 02.11.93 23:11:14  by  Kai Iske.   LogMessage :
  356.       -*-  changed on Saturday, 27.11.93 02:12:59  by  Kai Iske.   LogMessage :
  357.        - Recompiled using SAS 6.50
  358.       -*-  changed on Saturday, 20.11.93 18:14:21  by  Kai Iske.   LogMessage :
  359.        - ForceIcon will adopt the orig. window position and size now.
  360.          (Suggested by : Michael 'Mick' Hohmann and me)
  361.       -*-  changed on Saturday, 20.11.93 18:03:08  by  Kai Iske.   LogMessage :
  362.        - Icons weren`t positions as set with the Position window.
  363.          (Reported by : Michael 'Mick' Hohmann)
  364.        - Misleading explanation removed from docs
  365.          (Reported by : Michael 'Mick' Hohmann)
  366.       -*-  changed on Saturday, 20.11.93 17:33:51  by  Kai Iske.   LogMessage :
  367.        - The X/Y coordinates may be set manually, now.
  368.          (Requested by : Michael 'Mick' Hohmann)
  369.       -*-  changed on Saturday, 20.11.93 17:24:20  by  Kai Iske.   LogMessage :
  370.        - Edit Entry window`s gadget used 'I' twice
  371.          (Reported by : Michael 'Mick' Hohmann)
  372.       -*-  changed on Thursday, 11.11.93 18:43:27  by  Kai Iske.   LogMessage :
  373.        - You may now tell ForceIcon not to patch the position, but
  374.          rather let WB chose a good place. (Good when importing
  375.          volumes via network)
  376.       -*-  changed on Tuesday, 02.11.93 23:23:00  by  Kai Iske.   LogMessage :
  377.        - ListView gadgets weren`t adjusted for OS 2.x. - Should check
  378.          for OS 2.x sometime ;)
  379.          (Reported by : Bernhard Moellemann)
  380.        - Changed needed Versions of some libraries from 37 to 36
  381.       -*-  created on Tuesday, 02.11.93 23:11:14  by  Kai Iske.   LogMessage :
  382.        - If there wasn`t a filename for the Icon-File the
  383.          FileRequester sometimes showed a weird Drawer-Name
  384.          (Reported by : Dirk Federlein)
  385.      
  386.      Revision V1.0
  387.      --------------
  388.      created on Wednesday, 20.10.93 17:19:27  by  Kai Iske.   LogMessage :
  389.       -*-  changed on Thursday, 28.10.93 17:35:28  by  Kai Iske.   LogMessage :
  390.        - Suggestions for device dependancy by Ralph Babel
  391.        - Bug "found" by Ralph Babel
  392.        - Pos window used to open on default pubscreen, not on WB.
  393.          (Reported by : Bernhard Moellemann)
  394.       -*-  created on Wednesday, 20.10.93 17:19:27  by  Kai Iske.   LogMessage :
  395.          --- Initial release ---
  396.  
  397.