home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 266.lha / UserMenu / usermenu.doc < prev    next >
Text File  |  1989-07-10  |  9KB  |  242 lines
  1.         Documentation For UserMenu
  2.  
  3.  
  4.       CopyRight (C) 1987 by ZAP Software and Robert W. Albrecht.
  5.            All Rights Reserved.
  6.  
  7.               ZAP Software
  8.  
  9.  
  10.  
  11.  
  12.              Introduction
  13.  
  14.    UserMenu is an interactive personalized menuing system that simplifies
  15. the use of the CLI on Amiga Computers. It can execute most, but not all,
  16. programs that can be run on the Amiga.
  17.    UserMenu and it's companion program are designed to use as little RAM
  18. as possible and still be functional and user-friendly. They will allocate
  19. almost all memory they need from your computer's "Fast" RAM (if available),
  20. the exception being the tiny window created by UserMenu.
  21.    M is the program that processes the commands that are sent to UserMenu.
  22. By processing the commands M frees UserMenu of this task, thereby keeping
  23. the amount of memory used by usermenu to a minimum.
  24.    Commands can be sent to UserMenu through a command file allowing you to
  25. save different menu configurations.
  26.  
  27.  
  28.              Command Syntax
  29.  
  30.  
  31. run usermenu
  32.  
  33.   - This step is needed to make UserMenu RAM resident. A small window will
  34.     appear in the upper left corner of your screen.
  35.  
  36. m
  37.  
  38.   - This will display help for M and UserMenu.
  39.  
  40.  
  41. m add menu <menu name> <first item> <item action>
  42.  
  43.   - This will add a new Menu to UserMenu. It also adds the first Menu Item,
  44.     and it's associated action.
  45.  
  46.     <menu name>  The name of the Menu you want to add. Menu names with
  47.              Menus are the words that appear acorss the title-bar
  48.              of a window. The menu name can consist of spaces or
  49.              tabs if it is surrounded by double quotes. Menu names,
  50.              Item names, and sub-Item names are all case sensitive,
  51.              meaning that upper-case and lower-case letters are
  52.              treated differently by the program.
  53.  
  54.        <first item>  The name of the first Menu Item for this menu.
  55.              Menus can have Menu Items with identical names
  56.              that do different things.
  57.  
  58.       <item action>  This is the optional action that is associated with
  59.              the menu item. An action is any command that can
  60.              be executed from the CLI. For example "dir df0:"
  61.              or "cc AnyProg".
  62.  
  63.  
  64. m add item <menu name> <item name> <item action>
  65.  
  66.   - Adds a Menu Item to the specified Menu.
  67.  
  68.       <menu name>    The name of an existing Menu that you
  69.              want to add the Menu Item to.
  70.  
  71.       <item name>    The name of the Menu Item you want to add.
  72.  
  73.     <item action>    see above
  74.  
  75.  
  76. m add sub <menu name> <item name> <sub name> <sub action>
  77.  
  78.   - Adds a sub-Item to the specified  Menu Item.
  79.  
  80.       <menu name>    This is the name of an existing Menu that you
  81.              want to add the sub-Item to.
  82.  
  83.       <item name>    The name of an existing Menu Item that you want to
  84.              attach the sub-Item to.
  85.  
  86.      <sub action>    see "<item action>" above
  87.  
  88. m del menu <menu name>
  89.  
  90.   - Deletes a Menu, it's Menu Items, and their sub-Items. Memory is returned
  91.     to the system.
  92.  
  93.       <menu name>    The name of an existing Menu.
  94.  
  95.  
  96. m del item <menu name> <item name>
  97.  
  98.   - Deletes a Menu Item and it's sub-Items.
  99.  
  100.       <menu name>    The name of an existing Menu.
  101.  
  102.       <item name>    The name of an existing Menu Item
  103.              within the above Menu.
  104.  
  105. m del sub <menu name> <item name> <sub name>
  106.  
  107.   - Deletes a sub-Item.
  108.  
  109.       <menu name>    The name of an existing Menu.
  110.  
  111.       <item name>    The name of an existing Menu Item
  112.              within the above Menu.
  113.  
  114.        <sub name>    The name of an existing sub-Item
  115.              within the above Menu Item.
  116.  
  117.  
  118. m set pri <number>
  119.  
  120.    - Sets task priority.
  121.  
  122.              This command sets the priority of tasks that are
  123.              executed from Usermenu. Recomeded priorities range from
  124.              3 to -3. The standard Amiga tasks run at 0 priority.
  125.  
  126. m file <command file>
  127.  
  128.   - Allows any of the above commands to be stored in a command file.
  129.     The "m" should be removed from the command. For example: del menu MENUS.
  130.     Other command files can be used inside a command file. Command files
  131.     that are called from inside a command file are executed in the order
  132.     they appear.
  133.  
  134.    <command file>    A name of an Amiga Dos file. This file can be created
  135.              with the Amiga editor "ed" or any other editor that
  136.              can make ASCII files.
  137.  
  138.  
  139.                  Hints
  140.  
  141.    1) If you are going to execute M from UserMenu you must ALWAYS "run"
  142.       it. (eg. "run m file anyfile").
  143.       The reason for this is that M sends messages to UserMenu and
  144.       waits for a reply. If UserMenu, in turn, is waiting for M to finish
  145.       executing, a deadlock situation exists.
  146.  
  147.    2) You can use an Amiga Dos command file to run UserMenu and then run
  148.       M to set the Menus up. An intervening call to "Wait" is needed
  149.       so that UserMenu has enough time to set up shop. Example:
  150.  
  151.      run usermenu
  152.      Wait 1 secs
  153.      m file anyfile
  154.  
  155.    3) Programs that I couldn't get to work using UserMenu are;
  156.       Dpaint, Ed, and Diskcopy. It might work for you though!
  157.  
  158.    4) Programs that accept INPUT from the CLI may have problems
  159.       with UserMenu. For example; Format will format a disk IMMEDIATLY
  160.       without asking you if it's okay.
  161.  
  162.    5) You can set up a master Menu that you can load all of the other
  163.       menus from. For Example;
  164.  
  165.       add menu Master PRINT "run m file print.mnu"
  166.       add item Master COMPILE "run m file compile.mnu"
  167.       add item Master EDIT "run m file edit.mnu"
  168.  
  169.    6) Each Menu can contain a Menu Item that deletes the Menu. For Example;
  170.  
  171.       add menu Master PRINT "run m file print.mnu"
  172.       add item Master COMPILE "run m file compile.mnu"
  173.       add item Master EDIT "run m file edit.mnu"
  174.       add item Master Remove "run m del menu Master"     <--
  175.  
  176.  
  177.  
  178.                TRADEAMARKS
  179.  
  180.       UserMenu is a tredemark of ZAP Software. Amiga and Amiga Dos
  181.       are trademarks of Commodore Amiga, Inc.
  182.  
  183.  
  184.                  LICENSE
  185.  
  186.       ZAP Software and Robert W. Albrecht are exclusive owners of the
  187.       enclosed Software and Documentation. You are granted non-exclusive
  188.       license to use the Software and Documentation, but you are not
  189.       the owner of them.
  190.      Your right to use the Software and Documentation under this
  191.       agreement is the "License". "You" means the individual or legal
  192.       entity whose agent uploads this software and accepts this Agreement.
  193.       "Software" means the computer program recorded on the floppy-disk or
  194.       other media, any update to them ZAP Software may later provide you,
  195.       any back-up copies made, and the floppy-disk. "Documentation" means
  196.       the user manual and other materials packaged with this Software.
  197.  
  198.                 Transfer
  199.  
  200.       You may transfer the license for the use of the Software or
  201.       Documentation to another person.
  202.  
  203.               Backup Copies
  204.  
  205.          Make as many copies as you want.
  206.  
  207.                   Term
  208.  
  209.       The license is effective for twenty (20) years from the time you
  210.       upload the software. You may terminate the license at any time.
  211.  
  212.                ZAP Software's rights.
  213.  
  214.       The ZAP Software and Documentation is protected by copyright, trade
  215.       secret and trademark laws. You may not disclose the Software or
  216.       Documentation to others, except as allowed in this license agreement,
  217.       or remove or alter our ownership, trademark and copyright notices on
  218.       our floppy-disks or Documentation. YOU MUST MAKE A GOOD FAITH EFFORT
  219.       TO PREVENT ANY UNAUTHORIZED USE, COPYING, OR DISCLOSURE OF THE
  220.       SOFTWARE OR DOCUMENTATION. THESE OBLIGATIONS WILL SURVIVE ANY
  221.       TERMINATION OF THE LICENSE AGREEMENT.
  222.  
  223.          Disclaimer of other Warranties, and Liabilities.
  224.  
  225.       THERE ARE NO WARRANTIES, EITHER EXPRESSED OR IMPLIED, FOR THE
  226.       SOFTWARE OR DOCUMENTATION, WHICH ARE BOTH LICENSED TO YOU "AS IS".
  227.       ZAP SOFTWARE AND ROBERT W. ALBRECHT EXPRESSLY DISCLAIM ANY WARRANTY
  228.       AS TO THE PERFORMANCE OF THE SOFTWARE, OR DOCUMENTATION. WE ALSO
  229.       DISCLAIM ALL OTHER WARRANTIES, INCLUDING (WITHOUT LIMITATION) IMPLIED
  230.       WARRANTIES OF MERCANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN
  231.       NO EVENT SHALL ZAP SOFTWARE, OR ANYONE ELSE INVOLVED IN THE CREATION,
  232.       PRODUCTION, OR DISTRIBUTION, OF THE SOFTWARE OR DOCUMENTATION BE
  233.       LIABLE FOR ANY INDIRECT, SPECIAL, INCEDENTAL, OR CONSEQUENTIAL
  234.       DAMAGES RESULTING FROM THE USE OF THE SOFTWARE OR DOCUMENTATION OR
  235.       ARISING FROM ANY BREACH OF ANY WARRANTY. Some states do not allow the
  236.       exclusion or limitation of implied warranties or liability for
  237.       incedental or consequential damages so the above exclusion and
  238.       limitation may not apply to you. IN ADDITON TO THE ABOVE LIMITATION,
  239.       OUR LIABILITY TO YOU OR TO ANYONE ELSE FOR DAMAGES SHALL NOT EXCEED
  240.       THE LICENSE FEE PAID BY YOU FOR THE SOFTWARE AND DOCUMENTATION.
  241.  
  242.