home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / new / amigalibdisks / d995 / parm / parm.doce < prev    next >
Text File  |  1994-04-05  |  28KB  |  677 lines
  1.  
  2.  
  3. Documentation for ParM V4.5, SetMouse V2.1, parm.library V10.2
  4.  
  5.  
  6. **************************************************************************
  7. *****************************             ********************************
  8. *****************************   WARNING   ********************************
  9. *****************************             ********************************
  10. **************************************************************************
  11.  
  12.     If  you  use  a  previous release of ParM, and tools that makes use of
  13. parm.library,  you  _MUST_  replace  ALL  theses  with those given in this
  14. release.   The  new parm.library version 7 is not compatable with previous
  15. ones.  It was just not possible to do it.
  16. As  promised  in  previous release, this new ParM only works with AmigaDOS
  17. version 37 or higher.
  18. ParM no more needs arp nor req libraries. OS 2.0 made it possible.
  19.  
  20. **************************************************************************
  21. **************************************************************************
  22.  
  23.  
  24. ParM stands for Parametrable Menu.
  25.  
  26. ParM  allows  you to build your own menus in order to run all the programs
  27. you  can  have  on  one ore more disks.  This is very useful for hard disk
  28. owners  who  have  programs deeply enclosed in subdirectories.  With ParM,
  29. you  can run them without going through directories under either WorkBench
  30. or CLI.
  31. With  ParM,  you  can start programs in either WorkBench or CLI mode.  The
  32. advantage  of  WorkBench mode is that the default directory of the program
  33. you run is the one in which the program file is.  But not all programs can
  34. be run in this mode.
  35. ParM  now  has an integrated SunMouse, screen blank, mouse accelerator...
  36. We decided to implement this since an input-handler was already present in
  37. parm.library,  and  we  had 3 windows in the workbench screen's title bar.
  38. One  for  sunmouse,  one  for  memory/time display, and the useless ParM's
  39. window.  So now, ParM's window is usefull, and is easier to catch for menu
  40. access.
  41.  
  42.  
  43.  
  44. Using ParM:
  45. -----------
  46.     Reading  this documentation can make you being confused with all modes
  47. you  can  use to run your favorite tools.  So, you will find at the end of
  48. this  text  a  tutorial about what modes you'd better use.
  49.  
  50.  
  51. Installation:
  52. -------------
  53.     Put ParM and SetMouse with their icons wherever you want, and just put
  54.     the  default  config  file  "ParM.cfg"  in  S:  if you use it.  If you
  55.     don't,  you'll  have to specify the config file in the command line or
  56.     in  the tool types of the icon, otherwise, you will have to cancel the
  57.     requester and won't have any menus.  Since version 2.6r, you must also
  58.     put parm.library in your LIBS: directory.
  59.  
  60.  
  61. Running:
  62. --------
  63.     It  is  recommended  to run ParM from CLI if you want your programs to
  64.     have  a default path other than the current directory and C:  which is
  65.     the case if you start it from WorkBench.
  66.  
  67. ParM can work in three ways.
  68. 1)  You  can  attach  ParM to the CLI you are using.  In this case, if you
  69.     don't specify any of the window options, the menus will be attached to
  70.     the  CLI  window  you  start  it  from.  You may then only "Run" it to
  71.     prevent  you from closing the CLI.  In this case, commands launched in
  72.     RUN mode will use the cli/shell window for their input/output.  If you
  73.     dont  want your shell to be trashed by these commands, use the USENULL
  74.     option.
  75.  
  76. 2)  ParM can have its own window.  This is allways the case when it is run
  77.     from  WorkBench, but you can also tell it to open it's own window when
  78.     run from CLI using OWNWINDOW option or any of the window options.  You
  79.     should then "RunBack" it to be able to close the CLI later.
  80.  
  81. 3)  ParM can be attached to Workbench, ala MyMenu.
  82.  
  83.  
  84.     ParM  have  some  options  which  are  available  for most either from
  85.     WorkBench  or from CLI.  Arguments documentation is now available from
  86.     within  ParM  itself.  Just type ParM ?, and then ?  again.  Arguments
  87.     with  /S  are  switches,  and  arguments with /K are keywords and need
  88.     something more (a number, ON or OFF, a filename,...). added /N are for
  89.     numeric arguments.
  90.     From  workbench,  keywords  are the same.  You just have to add  =TRUE
  91.     for switches, or =Argument for keywords.
  92.  
  93.     CLIWINDOW and USENULL are not available from WorkBench.
  94.  
  95.     ParM's CLI Help:
  96.  
  97. MYMENU/S,CLIWINDOW/S,OWNWINDOW/S,LEFTEDGE/K/N,TOPEDGE/K/N,DETAILPEN/K/N,BLOCKPEN/K/N,
  98. DRAGBAR/K,DEPTH/K,AUTOFRONT/K,SHOWMEM/K,SHOWTIME/K,REFRESHTIME/K/N,MTDETAILPEN/K/N,
  99. MTBLOCKPEN/K/N,MENUCOLOR/K/N,STACKSIZE/K/N,CONFIGFILE/K,USENULL/K: ?
  100.  
  101. ParM V4.2 © 1990-92 by S.R. & P.C.
  102. MYMENU            Attach menus to Workbench's (Like MyMenu)
  103. CLIWINDOW         Attach menus to CLI/Shell Window
  104. OWNWINDOW         Open its own window (default)
  105. LEFTEDGE          Left edge of ParM Window (default 0)
  106. TOPEDGE           Top edge of ParM Window (default 0)
  107. DETAILPEN         Detail pen of ParM Window (default 1)
  108. BLOCKPEN          Block pen of ParM Window (default 2)
  109. DRAGBAR   ON|OFF  Drag bar (You can't move ParM window) (default on)
  110. DEPTH     ON|OFF  Depth gadgets (default off)
  111. AUTOFRONT ON|OFF  Automatic window to front (default: on)
  112. SHOWMEM   ON|OFF  Show available memory (default off)
  113. SHOWTIME  ON|OFF  Show time. (default off)
  114. REFRESHTIME       Interval time for Mem/Time refresh in 0.1s (default 1s)
  115. MTDETAILPEN       DetailPen for Mem/Time (default: DetailPen)
  116. MTBLOCKPEN        BlockPen for Mem/Time (default: BlockPen)
  117. MENUCOLOR         Color for ParM's main menu (defaut: DetailPen)
  118. STACKSIZE         Default stack size for commands (defaut: ParM process stack)
  119. CONFIGFILE        Configuration file (default: S:ParM.cfg)
  120. USENULL   ON|OFF  Redirect output to NULL: (or NIL:) for commands in RUN mode (default: off)
  121.  
  122.  
  123. Environnement variable ParMOpt:
  124. -------------------------------
  125.     In  addition to the command line, your preferences can now be saved in
  126.     the Env:ParMOpt variable.  Just snap your cli arguments and paste them
  127.     into your text editor.  Then, save the file as Env:ParMOpt.  This file
  128.     will  be  parsed  first,  and  then  the  CLI/WB arguments, which will
  129.     override the environnement variable. (See example given).
  130.  
  131.  
  132. Configuration file:
  133. -------------------
  134.     You  will  best  understand what follows if you have in front of you a
  135.     printout of the config file supplied.
  136.  
  137.     A  configuration  file  looks  like  a structured program.  You should
  138.     indent your lines to make the file as readable as possible.
  139.  
  140.     The  default  configuration file should be in the S:  directory and be
  141.     named ParM.cfg.
  142.  
  143.     The  configuration  file defines the menus you want, and what commands
  144.     they will run.  Comments begin with a #, and continue until the end of
  145.     the line.  Upper and lowercase do not make a difference.
  146.  
  147.  
  148.     Keywords:
  149.     ---------
  150.  
  151.     CMDWIN  console_name
  152.  
  153.         This  will  override  the  default console used for Command output
  154.         which is "CON:0000/0011/0640/0100/Command window/AUTO/CLOSE/WAIT".
  155.         This should be placed anywhere in the file but better be at top of
  156.         it.  This console will in 2.0 have a close gadget, a defered open,
  157.         and wait user to hit close gadget before closing window.
  158.         Under 2.0, if you use Command in Simple mode, you MUST specify the
  159.         /WAIT  option  for your console, or it will close before you could
  160.         read it.
  161.  
  162.     SHELLWIN  console_name
  163.  
  164.         This  will  override  the  default console used for SHELL commands
  165.         which  is  "CON:0000/0011/0640/0100/Shell/Auto/Close/Wait".   This
  166.         should be placed anywhere in the file but better be at top of it.
  167.  
  168.  
  169.     SHORTCUTQUAL qual
  170.  
  171.         This  can  be  used  to  add keys to access menus short-cuts.  For
  172.         example,  you can use Left-Amiga, ALT, SHIFT or Ctrl.  If you want
  173.         several keys, you just have to add qualifiers listed below:
  174.  
  175.             Left-Shift      1
  176.             Right-Shift     2
  177.             Ctrl            8
  178.             Left-Alt        16
  179.             Right-Alt       32
  180.             Left-Amiga      64
  181.  
  182.         If for example you want both left and right ALT keys to work for
  183.         menu shortcuts:     ( 16 + 32 = 48 ! )
  184.