home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 3 / CDPDIII.bin / pd / commodities / centerscreen / centerscreen.doc < prev    next >
Text File  |  1992-10-07  |  8KB  |  191 lines
  1.  
  2.                              CenterScreen
  3.  
  4.                              (Commodity)
  5.  
  6.                                   by
  7.  
  8.                             Stefan Sticht
  9.  
  10.          This program (binary), sourcecode, documentation is 
  11.  
  12.                             PUBLIC DOMAIN.
  13.  
  14.                      You may do anything with it!
  15.  
  16.  
  17. Purpose of this commodity:
  18. --------------------------
  19. CenterScreen  is  a  commodity,  which  centers  the  frontmost screen
  20. horizontally.   If  you  have  chosen  an overscan resolution for your
  21. workbench  screen  in  screenmode prefs, you may have already noticed,
  22. that  normal width screens can be dragged horizontally with the mouse.
  23. It  looks  much  nicer if those 640 point screens would be centered in
  24. the  display.  This does CenterScreen for you.  Start CenterScreen and
  25. press left Amiga + c and the frontmost screen will be centered.
  26.  
  27.  
  28. Requirements:
  29. -------------
  30. This commodity requires at least Kickstart 37.#?  and Workbench 37.#?.
  31. Please  check  this  out  using Version in the Shell or About from the
  32. Workbench's   Workbench   menu.    You   also   need   to   have   the
  33. commodities.library in your libs:  directory.
  34.  
  35.  
  36. How to start a commodity:
  37. -------------------------
  38. First  there  are  two  basically different ways to start a commodity:
  39. via Workbench or via Shell.
  40.  
  41.     Starting  it  via Workbench is extrem simple:  just doubleclick on
  42. its  icon  and  the  commodity gets started.  Perhaps you might change
  43. some  parameters of the commodity.  You do this with tool types.  Tool
  44. types can be changed by clicking at the commodities icon and selecting
  45. Information from the Workbench's Icon menu.  In the window which opens
  46. you  see a listview gadget in which all tool types are listed.  Please
  47. refer  to  your  Workbench  documentation  on  how to change this tool
  48. types.  Which parameters you can change for this specific commodity is
  49. described below.
  50.     Please  note  that  another  double  click on the commodity's icon
  51. forces  the  commodity  to quit, if it's already running.  Running two
  52. copies  of  CenterScreen  at  the same time isn't useful and therefore
  53. possible.
  54.     To  start  a commodity via shell you type in its name.  If you get
  55. an  "Unknown  command  ???"  error  message,  you  have misspelled the
  56. commodity's  name  or the commodity isn't in your current directory or
  57. in the current search path.  The easiest way is to change your current
  58. directory  to the location of the commodity using the CD command.  You
  59. can  change  parameters  of  a commodity by command line options.  The
  60. available options are listed with ?  as the first parameter:
  61.  
  62.                             CenterScreen ?
  63.  
  64. gives you a list of the command line options.  The explanation of each
  65. option is below.  Starting the commodity once more while it is already
  66. running forces the commodity to quit.
  67.  
  68.     If  you  want  the  commodity to be started at every boot-up, it's
  69. best to add this line to your User-Startup file:
  70.  
  71.                      <path>CenterScreen <options>
  72.  
  73. Don't  forget  to  replace  <path>  by  the  path to the commodities's
  74. location  and <options> by the options you want to change. For example
  75. add this line if your commodity is located in the Tools drawer of your
  76. boot disk:
  77.  
  78.                           Tools/CenterScreen
  79.  
  80.     Another way to start the commodity at every boot-up is to drag its
  81. icon  in  the  WBStartup drawer of your boot disk.  Then the commodity
  82. gets  started  as if you had double clicked on its icon.  But you have
  83. to  add the tool type DONOTWAIT to the icon.
  84.  
  85.  
  86. Using Exchange:
  87. ---------------
  88. Exchange is the commodities controller program. With Exchange you can
  89. control all commodities: you can kill, disable, enable, show and hide
  90. commodities.
  91.     Start  the  Exchange  program,  which  usually is in the Utilities
  92. drawer  of your boot disk, by double clicking its icon.  Now you see a
  93. list  of  the available commodities.  Select the commodity you want to
  94. control.   The  commodities title, description and status is shown now
  95. below the listview gadget.
  96.     You  can  kill  the  commodity  using  the  Kill gadget...  If the
  97. commodity  has  a  window  to  open,  in which you usually change some
  98. parameters,  you  can  open  this window using Show.  Hide closes this
  99. window. CenterScreen has no window, which can be opened.
  100.  
  101.  
  102.                         Changeable parameters:
  103.                         ----------------------
  104.  
  105. CX_Priority:
  106. ------------
  107. You  can  specify the priority of the Commodity within the commodities
  108. queue  using the tool type or commandline option CX_PRIORITY=<number>,
  109. where  <number>  is  the  decimal  value  for  the  priority.  Default
  110. priority is 0.
  111.  
  112. ACTION:
  113. -------
  114. With  the  tool type or commandline option ACTION=<string> you specify
  115. the  ACTION, which centers a screen.  <string> is an input description
  116. string as explained below.  Default is "ACTION=lcommand c" (left Amiga
  117. key & c).
  118.  
  119. Examples:
  120.  
  121.     CenterScreen "action=ralt help"
  122.     CenterScreen "action=lcommand m"
  123.     CenterScreen "action=f1"
  124.  
  125.  
  126.                       Input description strings
  127.                       -------------------------
  128.  
  129. With  input  description  strings  you  can  specify  almost any input
  130. action,  for  example  the action lshift f1, which means that pressing
  131. the  left  shift  and  the  f1  key  together  is the action.  In this
  132. commodity  you  can specify the action to open the commodity's window,
  133. as described above.
  134.  
  135. Input description strings have the following template:
  136.  
  137.       [class] (([-]qual)|syn)* [[-]upstroke] [highmap|ANSIcode]
  138.  
  139. (* means zero or more occurances of the of the expression in brackets)
  140.  
  141. class   is one of the following strings:
  142.         rawkey, rawmouse, event, pointerpos, timer, newprefs,
  143.         diskremoved, diskinserted.
  144.         If not specified, the class is taken to be "rawkey".
  145.  
  146. qual    is one of the strings:
  147.         lshift, rshift, capslock, control, lalt, ralt, lcommand,
  148.         rcommand, numericpad, repeat, midbutton, rbutton, leftbutton,
  149.         relativemouse
  150.         A preceding '-' means that the value of the corresponding
  151.         qualifier is to be considered irrelevant.
  152.  
  153. syn     (synonym) is one of the strings: shift, caps, alt
  154.         shift means "left or right shift"
  155.         caps means "shift or capslock"
  156.         alt means "either alt key"
  157.  
  158. upstroke (literally "upstroke")
  159.         if this token is absent, only downstrokes are considered
  160.         for rawmouse (mousebuttons) and rawkey events.  If it is
  161.         present alone, only upstrokes count.  If it preceded by
  162.         '-' it means that both up and down strokes are included.
  163.  
  164. highmap one of the strings:
  165.         comma, space, backspace, tab, enter, return, esc, del, up,
  166.         down, right, left, help, f1, f2, f3, f4, f5, f6, f7, f8, f9,
  167.         f10, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, (, ), /, *, -, +
  168.  
  169. ansicode a single character token is interpreted as a character code,
  170.         which is looked up in the system default keymap.
  171.  
  172.  
  173. Special thanks to Jim Mackraz, who suggested this Commodity.
  174.  
  175.  
  176.    Send bug-reports, enhancement-requests, questions, gifts(!) to:
  177.    ---------------------------------------------------------------
  178.                             Stefan Sticht
  179.                           Bibereckerweg 40a
  180.                            D-8390 Passau 18
  181.                                  FRG
  182.  
  183. or (better) EMail to:
  184. sticht@edith.deg.sub.org
  185. Fido-Net: Stefan Sticht (2:246/200.4)
  186.  
  187. Please include the version number of the commodity in every bug report.
  188. You  get  the  version  number  using  the  Version  command:
  189.                      Version [<path>]<commodity>
  190.  
  191.