home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 008.lha / echo / echo.doc < prev    next >
Encoding:
Text File  |  1986-11-10  |  4.6 KB  |  105 lines
  1. ***************************************************************************
  2.                            Echo
  3.  
  4.                 (C) 1986 by Larry Phillips           
  5.                    SYSOP - ICUG            
  6.                    All Rights Reserved
  7.  
  8. **************************************************************************
  9.  
  10.  This is an improved ECHO command, with options to control
  11.  colour, screen placement of text, etc.
  12.  
  13.  USAGE: ECHO [-[c0123tbiuds)!@#] [string]
  14.  
  15.  OPTIONS: -c   Clear screen before printing string.
  16.           -0   Set character colour to (same as default background colour).
  17.           -1   Set character colour to (same as default character colour).
  18.           -2   Set character colour to (same as in push/ pop gadgets).
  19.           -3   Set character colour to (to same as trashcan).
  20.           -t   Tab.
  21.           -b   Boldface.
  22.           -i   Italic.
  23.           -u   Underline
  24.           -d   Set default screen colours and styles.
  25.           -)   Set background colour to colour 0 (note: shifted 0).
  26.           -!   Set background colour to colour 1 (note: shifted 1).
  27.           -@   Set background colour to colour 2 (note: shifted 2).
  28.           -#   Set background colour to colour 3 (note: shifted 3).
  29.           -s   Supress new line after printing.
  30.  
  31.  The options are optional, as is the string to be printed. If no string is
  32.  provided, a blank line will be printed. Quotes are optional as well, and
  33.  are checked for only for compatibility with the ECHO command supplied with
  34.  the Amiga. Quotes may be included in the string, and will be printed. See
  35.  NOTES for special cases and caveats about quotes.
  36.  
  37.  NOTES: 1. The ending quote in a quoted string is not specifically checked.
  38.            If a string starts with a quote, and has no closing quote, the
  39.            last character in the string will be lost. To print quotes at the 
  40.            beginning of a line, use two quotes as follows:
  41.  
  42.            ECHO ""This is a quote," she said."
  43.  
  44.                   will print           
  45.  
  46.            "This is a quote," she said.
  47.  
  48.  
  49.         2. Options may be strung together in any order, and will affect the
  50.            output string in the order supplied. ie. if you have the statement
  51.  
  52.            ECHO -ct3tb Hello there.
  53.  
  54.            The screen will clear (c), and the phrase "Hello there." (without
  55.            the quotes) will be printed two tabs from the left margin (t) in 
  56.            colour #3 (3) and in boldface (b). The order is important in some
  57.            cases, for example, if the options (-tc) are given, the tab will
  58.            be performed, the the screen will be cleared, losing the tab.
  59.  
  60.         3. Supression of linefeeds (s), is particularly handy if you want to
  61.            highlight only part of a screen message. The sequence:
  62.  
  63.            ECHO -sb3 "WARNING: "
  64.            ECHO -d This program is addictive!
  65.  
  66.                  will print
  67.  
  68.            WARNING: This program is addictive!
  69.  
  70.            with WARNING: in boldface, colour #3, and the remainder of the
  71.            line in normal default text style and colours. Due to the lack of
  72.            a "set plain text style" sequence in the console driver, the (d)
  73.            option will reset the colours, both foreground and background, so
  74.            you must remember to set them back to what they were. ie. if the
  75.            characters were printing in colour #2 before the above example, 
  76.            and you wantd to reset them to colour #2 after the WARNING: 
  77.            highlight, you could change the options in the second command
  78.            to (-d2).
  79.  
  80.         4. Options may be entered in upper or lower case where applicable.
  81.            If you wish to echo a line that starts with a '-' (the option
  82.            delimiter), you must quote the string to prevent ECHO from using
  83.            your first word as options. If an invalid option is entered, it
  84.            will be ignored by the option parser, and will also not be printed.
  85.  
  86.         5. To install this command, simply copy it into your C: directory.
  87.            The original echo will be replaced, and you can now "jazz up" 
  88.            your script files.
  89.  
  90. ****************************************************************************
  91.  
  92.   Please see the example script file ETEST.SCR, for examples of what is 
  93. possible with the improved ECHO command.
  94.  
  95.   To get a preview, just type EXECUTE ETEST.SCR
  96.  
  97. This program is freely distributable for non commercial purposes only, and 
  98. provided that this documentation accompany all copies of the program.
  99.  
  100.   Any questions, suggestions, flames, may be sent to Larry Phillips on...
  101.  
  102.    The Source -- SIG021     (Drop by ICUGSIG for more Amiga goodies)
  103.    Compuserve -- 74025,636
  104.    CityLink                 (in beautiful Vancouver, BC)
  105.