home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d570 / fass.lha / Fass / Fass.DOC < prev    next >
Text File  |  1991-11-21  |  7KB  |  179 lines
  1.  
  2.                                Fass v1.02
  3.  
  4.                     © Copyright 1991 Jaba Development
  5.                        Written with DICE C v2.6 by
  6.                            Jan van den Baard
  7.  
  8.             Based on commodity code by Stefan Sticht (FISH 497)
  9.  
  10.  DISCAIMER
  11.  ---------------------------------------------------------------------------
  12.  The author is  NOT  responsible for  the  suitability or  accuracy of  this
  13.  documentation and/or the program(s)  it describes.  Any damage  directly or
  14.  indirectly caused by the use or  misuse of this  documentation  and/or  the
  15.  program(s) it describes is the sole responsibility of the user her/him self
  16.  ---------------------------------------------------------------------------
  17.  
  18.  COPYRIGHT
  19.  ---------------------------------------------------------------------------
  20.  Fass v1.01,  © Copyright  1991  Jaba  Development.   All  rights  reserved.
  21.  This program may be distributed  non-commercially only  providing that  the
  22.  executable,  source  code,  documentation  and   copyright  notices  remain
  23.  unchanged and are included with the distribution. This program is  FREEWARE
  24.  so no financial donation  is  necessary ( but welcome ). Send me a postcard
  25.  of your hometown if you use this program.
  26.  ---------------------------------------------------------------------------
  27.  
  28.  This program is for all of you  who has  programs that  makes use of  fonts
  29.  but don't offer the possibility to change the fonts  directory from  within
  30.  the program. Fass is a commodity that offers  the possibility to  re-assign
  31.  the fonts directory a the touch of a few keys. It's  possible to start Fass
  32.  from  either  the Shell  or  the  Workbench.  The  following  arguments are
  33.  possible:
  34.  
  35.     PRIORITY=<pri>      - With  this  argument  it's  possible   to  set  the
  36.                           commodity it's priority in  the commodities  queue.
  37.                           Default : 0
  38.  
  39.     POPWINDOW=<YES|NO>  - This enables  you to tell  wether  or not  you want
  40.                           Fass to open it's window uppon startup.
  41.                           Default : NO
  42.  
  43.     POPKEY=<hotkey>     - This enables you to set your own hotkey (See below)
  44.                           to popup Fass it's window
  45.                           Default : lalt f
  46.  
  47.     QUIT=<hotkey>       - This enables you to set your own hotkey (See below)
  48.                           to quit the commodity.
  49.                           Default : lalt q
  50.  
  51.  Here are some examples of how you can start Fass from the Shell:
  52.  
  53.     Run Fass POPWINDOW=YES POPKEY="lcommand p"
  54.     Run Fass QUIT "control q"
  55.  
  56.  NOTE: You have  to "Run" or "RunBack"  Fass  when  you  start  it  from  the
  57.        Shell. This is because DICE does  not have an  auto detach  "_main.c".
  58.        (Maybee I'll hack my own some day.....)
  59.  
  60.  You must specify the arguments via the tooltypes  array of the  program it's
  61.  icon when  it's  started  from the  Workbench.   When  you  start  Fass from
  62.  the WBStartup drawer you must specify the DONOTWAIT tooltype.
  63.  
  64.  The Fass window:
  65.  
  66.  The Fass window always opens on the default  public screen.  When the window
  67.  is open you will see five gadgets:
  68.  
  69.     Get                      -> This pops  the ASL  FileRequester for  you to
  70.                                 select a new fonts directory.
  71.  
  72.     Please enter FONTS: path -> Type the pathname of the new  fonts directory
  73.                                 in here. NOTE: Fass only checks wether or not
  74.                                 it's a directory you have entered here. There
  75.                                 is  no  checking  to see  if there are really
  76.                                 fonts in the directory.
  77.  
  78.     Assign                   -> Click on this gadget when you  want to assign
  79.                                 the  FONTS:   directory  to  you new  path. A
  80.                                 requester pops up telling  you wether  or not
  81.                                 it succeeded.
  82.  
  83.     HIDE                     -> Click on this gadget to hide the Fass window.
  84.  
  85.     QUIT                     -> Click on this gadget to remove Fass  from the
  86.                                 system.
  87.  
  88.  
  89.  Input Description Strings (HotKeys):
  90.  
  91.  The Input Description String (HotKeys) has the following template:
  92.  
  93.     <qualifier> [qualifier] [...] <key>
  94.  
  95.     qualifier:  lshift          left shift key
  96.                 rshift          right shift key
  97.                 shift           either shift key
  98.                 capslock        capslock key
  99.                 caps            shift or capslock key
  100.                 control         control key
  101.                 lalt            left alt key
  102.                 ralt            right alt key
  103.                 alt             either alt key
  104.                 lcommand        left amiga key
  105.                 rcommand        right amiga key
  106.                 numericpad      key on numericpad
  107.                 rbutton         right mouse button
  108.                 midbutton       middle mouse button
  109.                 leftbutton      left mouse button
  110.                 newprefs        change in preferences
  111.                 diskremoved     disk ejected
  112.                 diskinserted    guess what.....
  113.  
  114.     key         f1 -> f10       function keys
  115.                 up              cursor up key
  116.                 down            cursor down key
  117.                 left            cursor left key
  118.                 right           cursor right key
  119.                 help            help key
  120.                 del             delete key
  121.                 return          return key
  122.                 enter           enter key
  123.                 backspace       backspace key
  124.                 esc             escape key
  125.                 space           space key
  126.                 comma           comma key
  127.                 upstroke        key released
  128.                 a -> z, 0 -> 9  normal ansi keys
  129.  
  130.  Choose your keys carefully when other commodities are running.
  131.  
  132.  Requirements:
  133.  
  134.  Fass needs atleast Kickstart 2.0 V36++ to run.
  135.  
  136.  Error return codes.
  137.  
  138.  Fass doesn't print information to the screen when something didn't work. You
  139.  can figure out what went wrong by checking the return code with this list.
  140.  
  141.  20     FASS wasn't able to open the libraries it so desperatly needs.
  142.  21     FASS wasn't able to create a message port for the communication.
  143.  22     The broker could not be setup. This could mean that another commodity
  144.         is running which has the same name as FASS.
  145.  23     FASS wasn't able to setup it's HotKey  filters.  This  probably means
  146.         that you have fed FASS wierd HotKey strings.
  147.  24     There was an error detected if the commodity objects with CxObjError.
  148.  25     Not used!
  149.  26     Not used.
  150.  27     You passed FASS wierd arguments in the Shell.
  151.  
  152.  
  153.  History:
  154.  
  155.  V1.00 (15-Sep-1991) 7436 bytes.
  156.  
  157.     - Initial release
  158.  
  159.  V1.01 (21-Sep-1991) 6872 bytes.
  160.  
  161.     - Fass now uses the Dos routine  "ReadArgs()" for  parsing  the arguments
  162.       when run from the Shell.
  163.  
  164.     - By-Passed the main from c.lib to trim some bytes off the executable.
  165.  
  166.  V1.02 (17-Oct-1991) 7312 bytes.
  167.  
  168.     - Fass now enables the user to select the new  fonts directory  with  the
  169.       ASL FileRequester.
  170.  
  171.  Bug reports, flames, etc. to me at the following address.
  172.  
  173.  Jan van den Baard
  174.  Bakkerstraat 176
  175.  3082 HE, Rotterdam
  176.  Holland
  177.  
  178.  Fido: 2:500/29 (Jan van.den.Baard)
  179.