home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 2: PC / frozenfish_august_1995.bin / bbs / d07xx / d0787.lha / SetSC / SetSC.doc < prev    next >
Text File  |  1992-12-24  |  19KB  |  385 lines
  1.  
  2.                   __
  3.                  / ////
  4.           __    ///
  5.           \ \  ///        < < <<<  SetSC v2.10  >>> > >
  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.          SetSC 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  SetSC then you must pay the shareware
  18.          fee and register. 
  19.  
  20.          Prior  written  permission  from  the  author  is   required   to
  21.          distribute  SetSC  and  to  use  SetSC 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.          SetSC  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  SetSC to pay the
  46.          shareware  fee.  You  can  register  your  version  of  SetSC for
  47.          5 (five) US dollars. If you register both  SetSC and GetSC at the
  48.          same time, then the registration fee  is  10  (ten)  US  dollars,
  49.          including one update of SetSC and of GetSC.
  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.          SetSC is a program to  easily  change  the  colours  of  a  given
  61.          screen. This can be either  the  Workbench  screen,  the  topmost
  62.  
  63.  
  64.                                           SetSC v2.10 User Manual - Page 1
  65.  
  66.          (first) screen or a screen with  a  certain  name  (title).  It's
  67.          also possible to change all screens with  the  same  colour  map.
  68.          You can specify colours directly on the command line, or you  can
  69.          use one of the predefined colour maps, as stored in a  SetSC.MAPS
  70.          file.
  71.  
  72.          In view of the recent change in the colour palette with  AmigaDOS
  73.          Release  2,  a  REMAP  option  was  implemented  in  SetSC.  This
  74.          function enables you to switch the black and white colours  of  a
  75.          screen.  
  76.  
  77.          Furthermore,  SetSC  includes a delay and an  exchange  function.
  78.          The first lets the program wait for  a  number  of  seconds.  The
  79.          latter enables you to change  the  screencolours  for  a  certain
  80.          period, after which the original screencolours are restored. 
  81.          SetSC currently  supports  a  colourmap  with  a  maximum  of  32
  82.          colours. (This can change  in  future  versions,  since  the  new
  83.          breed of Amigas support upto 256 colours!)
  84.  
  85.          SetSC is reentrant, so it can be made resident.
  86.  
  87.        System Requirements
  88.        ~~~~~~~~~~~~~~~~~~~
  89.          SetSC requires AmigaDOS v1.2 or higher.  
  90.  
  91.        Program Usage  (Shell/CLI only)
  92.        ~~~~~~~~~~~~~
  93.         FORMAT : [[NAME] <mapname>]   [(x,x,x,x,..)]   [WBCOLS]    [REMAP]
  94.                  [FORCE]    [SCREEN <name>] [WB]  [ALL]  [EXCHANGE <secs>]
  95.                  [DELAY <secs>] [INIT] [T] [S] [LIST] [VERSION] 
  96.  
  97.        o SetSC arguments :
  98.  
  99.         ("?" gets the program format.)
  100.          
  101.          [[NAME] <mapname>] : use  the  colour   map   saved   under   the
  102.                               <mapname>  in  the   SetSC.MAPS   file.   At
  103.                               startup  SetSC will look  if  the  temporary
  104.                               'T:SetSC.MAPS'  file  exists,  if  so   then
  105.                               SetSC will look in this file for the  wanted
  106.                               colourmap.  If  the  temporary  file   isn't
  107.                               present,  then  SetSC will create this file,
  108.                               and   copy   all   colourmaps    from    the
  109.                               'S:SetSC.MAPS' file (same as using INIT).
  110.  
  111.                               The optional keyword NAME  can  be  used  to
  112.                               prevent  SetSC  from interpreting a  mapname
  113.                               as an argument keyword. E.g. if you  have  a
  114.                               colourmap with  name  'WBCOLS'  then,  SetSC
  115.                               will think it's the keyword for  the  WBCOLS
  116.                               option, unless you use 'SetSC NAME wbcols'.
  117.  
  118.          [(x,x,x,x,..)]     : you  can  also  specify  directly   on   the
  119.                               command line the colourmap  to  use,  rather
  120.                               than using a predefined colourmap.  You  can
  121.                               give  upto  32   colours,   but   it   isn't
  122.                               necessary to always give as many colours  as
  123.                               the screen uses. E.g. if the  target  screen
  124.                               uses 8 colours, and you only want to  change
  125.                               the first two  colour  registers,  then  you
  126.  
  127.  
  128.                                           SetSC v2.10 User Manual - Page 2
  129.  
  130.                               may give only two colours.
  131.  
  132.                               The colourmap must  always  be  enclosed  by
  133.                               brackets, while  the  colourvalues  must  be
  134.                               seperated by commas. The  colourvalues  must
  135.                               be in the 0..4095 range. The values  can  be
  136.                               supplied in four different  number  systems.
  137.                               To  specify  the  number  system,  you  must
  138.                               preceed the value by one  of  the  following
  139.                               system identifiers:
  140.  
  141.                                  - '','d' or 'D' : decimal     value
  142.                                  - 'h' or 'H'    : hexadecimal   "
  143.                                  - 'b' or 'B'    : binary        "
  144.                                  - 'o' or 'O'    : octal         "
  145.                 
  146.                                | Type  'SetSC  (h88B,h000,hFFF,hC34)   WB'
  147.                                | and  see  how   the   colours   of   your
  148.                                | Workbench screen change. 
  149.  
  150.          [WBCOLS]           : use the colours of the Workbench  screen  to
  151.                               change the screencolours.
  152.  
  153.          [REMAP]            : switch values of colour  register  1  and  2
  154.                               (in other words switch the black  and  white
  155.                               colours). In AmigaDOS Release 2  register  1
  156.                               corresponds to  white,  and  register  2  to
  157.                               black.   In   earlier   AmigaDOS   versions,
  158.                               register  1  corresponds   to   black,   and
  159.                               register 2 to white.
  160.  
  161.                                | 'SetSC  REMAP   WB'   will   switch   the
  162.                                | colours  of  register  1  and  2  of  the
  163.                                | Workbench   screen.   (You'll   certainly
  164.                                | notice the effect  on  the  icons,  since
  165.                                | they'll appear to be remapped.)
  166.  
  167.                               If REMAP  is  used  in  conjunction  with  a
  168.                               colourmap,   then   SetSC  will  remap  this
  169.                               colourmap, before using  it  on  the  target
  170.                               screen.
  171.  
  172.                                | 'SetSC (hBBB,h000,hFFF,h68E) REMAP WB'
  173.                                | This will change the workbench screen  to
  174.                                | the specified colours,  except  that  the
  175.                                | second  and  third   colour   will   have
  176.                                | changed places. If  you  use  'GetSC  WB'
  177.                                | to check  the  colours,  you'll  get  the
  178.                                | next colour  map:  (hBBB,hFFF,h000,h68E).
  179.                                | Noticed the difference?
  180.  
  181.          [FORCE]            : in some cases you'll  supply  a  colour  map
  182.                               that has  less  or  more  colours  than  the
  183.                               target screen uses.  If  this  is  so,  then
  184.                               SetSC will ask the user  to  proceed  or  to
  185.                               exit.   (Note:   there's   no   danger    in
  186.                               proceeding, since  SetSC will only change as
  187.                               many colours as the screen allows.)
  188.  
  189.                               E.g. your default Workbench  screen  uses  4
  190.  
  191.  
  192.                                           SetSC v2.10 User Manual - Page 3
  193.  
  194.                               colours. If you supply a  colourmap  with  8
  195.                               colours, then  SetSC will ask what to do. If
  196.                               you  proceed,  then  SetSC will only use the
  197.                               first  four  colours  of  the  colourmap  to
  198.                               change the Workbench colours.
  199.  
  200.                               The FORCE option is to  prevent  that  SetSC
  201.                               asks what  to  do.  SetSC will simply change
  202.                               the screen colours safely.
  203.  
  204.          [SCREEN <name>]    : change the colours of  the  screen  with the
  205.                               given <name>. The <name> corresponds to  the
  206.                               first words of the  screen  title.  If  this
  207.                               name contains spaces then you  must  enclose
  208.                               the name  between  double  quotation  marks.
  209.                               The  screen  is  searched  on   a   non-case
  210.                               sensitive basis, so 'name' matches 'NAME'.
  211.  
  212.                                 | 'SetSC  SCREEN  workbench',  or   'SetSC
  213.                                 | SCREEN "workbench screen"', changes  the
  214.                                 | colour palette of the Workbench screen.
  215.  
  216.          [WB]               : change the colours of the Workbench  screen.
  217.                               This option  is  disabled  when  the  SCREEN
  218.                               option is used.
  219.  
  220.          [ALL]              : change   the   colours   of   all    screens
  221.                               available. This option is disabled when  the
  222.                               SCREEN or WB option is used.
  223.  
  224.          [EXCHANGE <secs>]  : change the screencolours  to  those  of  the
  225.                               specified colourmap,  and  after  the  given
  226.                               number  of  seconds  restore  the   original
  227.                               screencolours.
  228.  
  229.          [DELAY <secs>]     : wait the  given  number  of  seconds  before
  230.                               changing the screencolours.
  231.  
  232.          [INIT]             : update  the  temporary  'T:SetSC.MAPS'  file
  233.                               with the 'S:SetSC.MAPS'.  This  function  is
  234.                               important when you have added a  new  colour
  235.                               map  to  the  'S:SetSC.MAPS'  file.  Because
  236.                               SetSC  won't  find  this  new  map  in   the
  237.                               'T:SetSC.MAPS' file, you'll have  to  update
  238.                               this   temporary   file   with    the    new
  239.                               'S:SetSC.MAPS' file.
  240.  
  241.          [T]                : only use 'T:SetSC.MAPS' to work with.
  242.  
  243.          [S]                : only use 'S:SetSC.MAPS' to work with.
  244.  
  245.          [LIST]             : list  all  colourmaps   available   in   the
  246.                               SetSC.MAPS file. If 'T' and 'S' aren't  used
  247.                               then    both    the    'S:SetSC.MAPS'    and
  248.                               'T:SetSC.MAPS' files are  listed,  otherwise
  249.                               what file is listed depends on the usage  of
  250.                               'T' and 'S'.
  251.  
  252.          [VERSION]          : print the program's copyright and version.
  253.  
  254.  
  255.  
  256.                                           SetSC v2.10 User Manual - Page 4
  257.  
  258.        o Compiling a collection of predefined colourmaps :
  259.  
  260.          You can collect colourmaps in three ways :
  261.  
  262.          - You can edit the  'S:SetSC.MAPS'  file,  and  define  your  own
  263.            colourmap. Note that these entries must  be  in  the  following
  264.            format  :  <mapname>  (x,x,x,x,..).  If  you  want  to   insert
  265.            comments, you must use  the  semicolon  (;)  like  in  AmigaDOS
  266.            scripts. This way of  working  is  very  difficult,  since  you
  267.            normally don't know which colours  will  come  from  the  given
  268.            values. Therefore it's better to define colourmaps by the  next
  269.            two ways, which both involve the use of GetSC. 
  270.  
  271.          - You can  use  GetSC (See "GetSC.doc" for more information!) and
  272.            grab the colourmap of an existing screen.
  273.  
  274.          - Another way is  to  use  a  palette  requester  (like  the  one
  275.            supplied with your system software) to change  the  colours  of
  276.            the Workbench screen (or any  other  screen),  and  then  using
  277.            GetSC to grab the colour map.
  278.  
  279.          IMPORTANT: if you want to store your colourmaps permanently,  you
  280.                     must add the colourmaps to  the  'S:SetSC.MAPS'  file,
  281.                     not to the temporary file in 'T:'! 
  282.  
  283.  
  284.  
  285.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  286.         Program antecedents
  287.         ~~~~~~~~~~~~~~~~~~~
  288.          VERS  RELEASED  RC COMMENT
  289.          ====  ========= == ============================================
  290.          1.0   08-May-91 PU First program version.
  291.          1.10  29-Jul-91 PU Minor updated version.
  292.          1.10a 16-aug-91 PU Minor internal code changes.
  293.          2.00  15-nov-91 PU Remove the  builtin  colour  maps.  SetSC  now
  294.                             gets   its   values   from   a   file   called
  295.                             'S:SetSC.col' or from the CLI argument line.
  296.                             New arguments added :
  297.                             o [HELP]   : display help text.
  298.                             o [SILENT] : don't print copyright prompt.
  299.                             o [-eX]    : change  to  new  colours  for  x-
  300.                                          secs.
  301.                             o [-dX]    : only change after x-seconds.
  302.                             o [WB]     : only change the workbench.
  303.                             o [WBC]    : use the workbench colours on  the
  304.                                          first screen.
  305.                             o [ALL]    : change colours from all screens.
  306.                             o [FORCE]  : change screen colours, no  matter
  307.                                          what the screendepth is.
  308.                             o [NOT]    : do not use colour maps in T:.
  309.                             o [INIT]   : reread colour maps from file.
  310.                             o [LIST]   : list all colour maps in use.
  311.          2.01  28-dec-91 PU Added new argument :
  312.                             o [REMAP]  : switches  the  black  and   white
  313.                                          colours.
  314.          2.02  29-Mar-92 PU Minor code changes.
  315.          2.10  15-Nov-92 SW First public release version.
  316.                             This  version  is  an   improvement   to   the
  317.                             previous ones. The program  has  been  totally
  318.  
  319.  
  320.                                           SetSC v2.10 User Manual - Page 5
  321.  
  322.                             rewritten, resulting in  much  more  efficient
  323.                             and shorter code.
  324.                             New options     : [SCREEN <name>]
  325.                                               [T]
  326.                             Option changes  : [NOT] -> [S]
  327.                                               [WBC] -> [WBCOLS]
  328.                                               [-eX] -> [EXCHANGE <#>]
  329.                                               [-dX] -> [DELAY <#>]
  330.                                               [SILENT] -> [VERSION]
  331.                             Removed options : [HELP]
  332.  
  333.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  334.        SetSC v2.10, Copyright ⌐1991-1992 Chris P.Vandierendonck [AmiSYS], 
  335.                     All Rights Reserved.
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.                                           SetSC v2.10 User Manual - Page 6
  385.