home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / system_utils / general / jmenu / jmenu.doc < prev    next >
Text File  |  1991-02-17  |  2KB  |  55 lines
  1.                                -- JMenu --
  2.  
  3.  
  4.   This program allows an AmigaDOS script to display a menu, wait for the
  5.   user to make a selection either with the mouse or the keyboard, and
  6.   return the selection back to the script through an environment variable.
  7.   It can also immediately execute any valid AmigaDOS command based upon
  8.   the menu selection.  The text for the menu is contained in a file which
  9.   you pass to JMenu as the first parameter and the variable name you want
  10.   to hold the user's selection is passed as the second parameter.
  11.  
  12.       Useage:  JMenu <filename> <variablename>
  13.  
  14.   The menu is always centered on the screen.  The maximum size of the 
  15.   menu is based on the screen resolution and font size, up to a maximum
  16.   of 26 selections of a maximum of 80 characters each and an optional
  17.   title area of up to 4 lines.
  18.  
  19.   Each line in the file which defines the menu begins with the word
  20.   TITLE, MENU or EXEC, followed by a single space and the text to be
  21.   displayed or the command to be executed.  Blank lines or lines which
  22.   start with a space are ignored.
  23.  
  24.       Examples:  TITLE Startup Scripts
  25.                  MENU StartC jm
  26.                  EXEC execute S:StartC jm
  27.  
  28.   The displayed menu has a 3D look to it if the proper colors are used.
  29.   It is recommended that color1 is white or very light, color2 is black
  30.   or very dark, and color3 can be anything but looks best if it is a 
  31.   shade between color1 and color2.  The standard workbench colors will do
  32.   although the orange (color3) might be a bit too much.
  33.  
  34.   All error messages are printed on stderr. Any other messages are
  35.   printed on stdout.  The following are the error codes returned.
  36.  
  37.       0  -       - OK
  38.       5  - WARN  - Ctrl-c was pressed.
  39.       10 - ERROR - The menu was too large to fit within the current screen.
  40.       20 - FAIL  - Unable to open libraries, windows, files, etc.
  41.  
  42.   Notes for use with IconX.
  43.   
  44.     If the function being EXECuted would normally display text in the CLI
  45.      window, you will not see it from JMenu running under IconX.
  46.      Also DO NOT use the AmigaDOS Run command without redirecting the text
  47.      output to a device or file (NIL: NULL: RAM:temp etc.). You will crash.
  48.   
  49.   This program is not public domain but it is free and may be freely
  50.   distributed as long as there is no charge for it.
  51.   
  52.   If you have any problems, comments, suggestions, etc. I can be reached
  53.   on PLink as JIMCOLLINS and GEnie as J.COLLINS26.
  54.  
  55.