home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 2: PC / frozenfish_august_1995.bin / bbs / d07xx / d0787.lha / GetSC / GetSC.doc < prev    next >
Text File  |  1992-12-24  |  10KB  |  257 lines
  1.  
  2.                   __
  3.                  / ////
  4.           __    ///
  5.           \ \  ///        < < <<<  GetSC v2.00  >>> > >
  6.            \ \///
  7.             \__////       USER MANUAL - Release : 15-Nov-92
  8.  
  9.                 Copyright ⌐1991-1992 Chris P. Vandierendonck, [AmiSYS].
  10.  
  11.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  12.  
  13.        Copyright Notice
  14.        ~~~~~~~~~~~~~~~~
  15.          GetSC is released  as  SHAREWARE, not excluding the copyright and
  16.          all  other  rights,  which  remain  with  the  author  Chris   P.
  17.          Vandierendonck. If you use  GetSC then you must pay the shareware
  18.          fee and register. 
  19.  
  20.          Prior  written  permission  from  the  author  is   required   to
  21.          distribute  GetSC  and  to  use  GetSC in commercial releases, on
  22.          coverdisks or diskmagazines. When distributed, all files must  be
  23.          kept together, in their original unmodified form.
  24.  
  25.          (AmigaDOS and Workbench are trademarks of Commodore Amiga Inc.)
  26.  
  27.        Disclaimer
  28.        ~~~~~~~~~~
  29.          GetSC  is provided "AS IS", WITHOUT ANY WARRANTY to its  quality,
  30.          performance or fitness for a  particular  purpose.  In  no  event
  31.          shall the author be liable or responsible  to  the  user  or  any
  32.          other person, for any kind of damage caused by the  use  of  this
  33.          software.
  34.  
  35.          Shareware registration,  suggestions,  remarks  and  bug  reports
  36.          about this program can be send to the following address :
  37.  
  38.               Chris Vandierendonck
  39.               Koning Albertstraat 188
  40.             B-8210   VELDEGEM
  41.               BELGIUM
  42.  
  43.        SHAREWARE information
  44.        ~~~~~~~~~~~~~~~~~~~~~
  45.          It's essential for the further  development  of  GetSC to pay the
  46.          shareware  fee.  You  can  register  your  version  of  GetSC for
  47.          5 (five) US dollars. If you register both  GetSC and SetSC at the
  48.          same time, then the registration fee  is  10  (ten)  US  dollars,
  49.          including one update of GetSC and of SetSC.
  50.  
  51.          If possible, use a printout  of  the  'RegForm' file to register.
  52.          Send this  form  along  with  the  shareware  fee  to  the  above
  53.          address. You can send the money in  cash  (fastest  and  cheapest
  54.          way),  or  by  (international)  money  order  payable  to   Chris
  55.          Vandierendonck. (DO NOT send  bankcheques,  since  they  are  too
  56.          expensive to clear!)
  57.  
  58.        Preface
  59.        ~~~~~~~
  60.          GetSC is a program to grab the colours  of  a  screen.  It'll  be
  61.          used primarily to get the colour palette  of  a  certain  screen,
  62.  
  63.  
  64.                                           GetSC v2.00 User Manual - Page 1
  65.  
  66.          and save it under a name to the SetSC MAPS file (see  "SetSC.doc"
  67.          for more information), so that you can access it  with  SetSC  at
  68.          any time.
  69.  
  70.          GetSC is reentrant, so it can be made resident.
  71.  
  72.        System Requirements
  73.        ~~~~~~~~~~~~~~~~~~~
  74.          GetSC requires AmigaDOS v1.2 or higher.  
  75.  
  76.        Program Usage  (Shell/CLI only)
  77.        ~~~~~~~~~~~~~
  78.         FORMAT : [[NAME] <mapname>] [SCREEN <name>] [WB] [ALL] [FORCE]
  79.                  [DELAY <secs>] [T] [S] [LIST] [VERSION]
  80.  
  81.         If no arguments are used, then  GetSC will grab the colour palette
  82.         of  the  topmost  (first)  screen,  and  show   the   colours   as
  83.         hexadecimal values.  
  84.  
  85.         Example output of 'GetSC WB' :
  86.  
  87.         ColourMap: (hBBB,h000,hFFF,h68E)            ; Workbench Screen...
  88.  
  89.        o GetSC arguments :
  90.  
  91.          ("?" gets the program format.)
  92.          
  93.          [[NAME] <mapname>] : save the  colour  palette  under  the  given
  94.                               name.  By  default  the colour map  will  be
  95.                               saved to  'S:SetSC.MAPS'  (unless  you  used
  96.                               'T'. If 'T:SetSC.MAPS' exists, then the  map
  97.                               will be saved here as well (unless you  used
  98.                               'S'). The NAME keyword is optional.
  99.  
  100.                                | E.g. 'SetSC NAME test WB' results in :
  101.                                | test (hBBB,h000,hFFF,h68E)    ; Workbench
  102.                                | Screen...
  103.  
  104.                               NOTE: when   the   'S:SetSC.MAPS'    doesn't
  105.                                     exist,  then  GetSC will  create  this
  106.                                     file  (unless   you   used   the   'T'
  107.                                     option).
  108.  
  109.          [SCREEN <name>]    : get the colour palette of  the  screen  with
  110.                               the given <name>. The <name> corresponds  to
  111.                               the first words  of  the  screen  title.  If
  112.                               this name  contains  spaces  then  you  must
  113.                               enclose the name  between  double  quotation
  114.                               marks. The screen is searched on a  non-case
  115.                               sensitive basis, so 'name' matches 'NAME'.
  116.  
  117.                                 | 'GetSC  SCREEN  workbench',  or   'GetSC
  118.                                 | SCREEN  "workbench  screen"',  gets  the
  119.                                 | colour palette of the Workbench screen.
  120.  
  121.          [WB]               : get the  colour  palette  of  the  Workbench
  122.                               screen. This option is disabled when  SCREEN
  123.                               is used.
  124.  
  125.          [ALL]              : get the colour  palettes  of  all  available
  126.  
  127.  
  128.                                           GetSC v2.00 User Manual - Page 2
  129.  
  130.                               screens.  This  option  is   disabled   when
  131.                               SCREEN or WB is used.
  132.  
  133.          [FORCE]            : if you have specified a  name  to  save  the
  134.                               colour palette under, and this name  already
  135.                               exists in the  MAPS  file,  then  GetSC will
  136.                               ask the user to exit or overwrite  the  map,
  137.                               unless you use FORCE. This option  instructs
  138.                               GetSC to overwrite the map,  if  it  already
  139.                               exists.
  140.  
  141.          [DELAY <secs>]     : wait  a  given  number  of  seconds   before
  142.                               grabbing the screen  colours.  This  can  be
  143.                               useful to  bring  a  screen  to  the  front,
  144.                               while GetSC is waiting. 
  145.  
  146.          [T]                : only  use  'T:SetSC.MAPS'  when   saving   a
  147.                               colour palette, or when  using  listing  all
  148.                               maps.  NOTE  that  this  file   is   ony   a
  149.                               temporary file!
  150.  
  151.          [S]                : only  use  'S:SetSC.MAPS'  when   saving   a
  152.                               colour palette, or when  using  listing  all
  153.                               maps.
  154.  
  155.          [LIST]             : show  all  colour  maps  available  in   the
  156.                               'S:SetSC.MAPS' and 'T:SetSC.MAPS' files.  If
  157.                               you also use 'S' then only  the  first  file
  158.                               will be listed, with 'T' the latter.
  159.  
  160.          [VERSION]          : print the program's copyright and version.
  161.  
  162.        o Compiling a collection of colourmaps :
  163.  
  164.          GetSC is THE tool to compile a collection of colourmaps, for  use
  165.          with SetSC. You can do this in two ways :
  166.  
  167.          - You can  use  GetSC (See "GetSC.doc" for more information!) and
  168.            grab the colourmap of an existing screen.
  169.  
  170.          - Another way is  to  use  a  palette  requester  (like  the  one
  171.            supplied with your system software) to change  the  colours  of
  172.            the Workbench screen (or any  other  screen),  and  then  using
  173.            GetSC to grab the colour map.
  174.  
  175.          IMPORTANT: if you want to store your colourmaps permanently,  you
  176.                     must add the colourmaps to  the  'S:SetSC.MAPS'  file,
  177.                     not to the temporary file in 'T:'! 
  178.  
  179.  
  180.  
  181.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  182.         Program antecedents
  183.         ~~~~~~~~~~~~~~~~~~~
  184.          VERS RELEASED  RC COMMENT
  185.          ==== ========= == =============================================
  186.          1.00 15-nov-91 PU First program version.
  187.          1.01 29-Mar-92 PU Minor code changes.
  188.          2.00 15-Nov-92 SW First release version.
  189.                            The code has  been  improved  and  made  more
  190.  
  191.  
  192.                                           GetSC v2.00 User Manual - Page 3
  193.  
  194.                            efficient. This resulted in  a  much  smaller
  195.                            program.
  196.                            o Option changes :
  197.                                [<name>] -> [[NAME] <mapname>]
  198.                                [-d#]    -> [DELAY <#>]
  199.                                [SILENT] -> [VERSION]
  200.                            o New options : [SCREEN  <name>],  [ALL]  and
  201.                                            [WB]. 
  202.                            o Removed the [HELP] option.
  203.  
  204.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  205.        GetSC v2.00, Copyright ⌐1991-1992 Chris P.Vandierendonck [AmiSYS], 
  206.                     All Rights Reserved.
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.                                           GetSC v2.00 User Manual - Page 4
  257.