home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 451.lha / eco_v3.40 / eco.hlp < prev    next >
Text File  |  1990-12-08  |  9KB  |  256 lines
  1.                            _____  ___    ____
  2.                           / ___/ / __/  / _  >
  3.                          / __/  / <__  / </ /
  4.                         <____/ <____/ <____/
  5.  
  6.   ECO is an enhanced version of the ECHO command, written by Lattice C 5.04
  7.   Note that "eco" means "echo" in the Italian language.
  8.   This is version 3.40! It is provided in two versions:
  9.  
  10.   ECO     less than 3K
  11.   ECOX    more than 8K
  12.  
  13.   ECOX has the same features of ECO plus those marked by # in the
  14.   present file. Hereinafter ECO is used for both ECO and ECOX.
  15.   Have fun!
  16.  
  17.                               Dr.Dario de Judicibus - Rome (ITALY)
  18.  
  19.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  20.  Version:  3.40
  21.  Date:     1st April 1990
  22.  
  23.  Format:   Eco <string>
  24.  Template: ECO " "
  25.  Purpose:  To display the argument given.
  26.  
  27.  Syntax:   string needs double quotes only if there are semicolons ";",
  28.            or redirectioning operators ">" and "<" in the string.
  29.            Echo has no options but use escape sequences to allow
  30.            different display formats. The escape character is
  31.            backslash (\).
  32.  
  33.            Help:
  34.  
  35.            ?         without the escape character, if first of line
  36.            \h        anywhere in string
  37.  
  38.            Special Characters:
  39.  
  40.            \\        display escape character (\)
  41.            \q        display double quotes (")
  42.            \?        display a question mark (?)
  43.  
  44.            Cursor sequences:
  45.  
  46.            \n        Line Feed + Carriage Return (newline)
  47.            \f        Carriage Return (first column)
  48.            \t        Horizontal Tab
  49.            \v        Vertical Tab
  50.            \(x,y)    Cursor position at row <x> and/or column <y>
  51.            \c        Clear from current position to the end of screen
  52.            \C        Home and clear the whole screen
  53.            \H        Home
  54.  
  55.            Text styles:
  56.  
  57.            \p        plain (normal) style (works as \d)
  58.            \i        italic
  59.            \b        bold
  60.            \u        underscore
  61.            \r        reverse
  62.  
  63.            Text colors:
  64.  
  65.            \0 to \3  Foreground colours 0 to 3
  66.            \4 to \7  Background colours 0 to 3
  67.            \d        Back to default colours\style
  68.  
  69.    #       Variables:
  70.    #
  71.    #       \[vx..vx] where vx are:
  72.    #
  73.    #                 vx  Date                 vx  Time
  74.    #
  75.    #                 d1  YYMMDD               t1  HHMMSS
  76.    #                 d2  MM/DD/YY             t2  HH:MM:SS
  77.    #                 d3  MM-DD-YY             t3  HHMMSSCC
  78.    #                 d4  MMM DD, YYYY         t4  HH:MM:SS.CC
  79.    #                 d5  Month DD, YYYY       t5  HH:MM
  80.    #                 d6  DD MMM YY            t6  HH:MM:SS AM/PM
  81.    #                 d7  DD MMM YYYY          t7  HH:MM AM/PM
  82.    #
  83.    #                 vx  Day of Week          vx  Path
  84.    #
  85.    #                 w1  DDD                  p   CurrentDir
  86.    #                 w2  DayOfWeek
  87.    #
  88.    #       Delays:
  89.    #
  90.    #       \W        Wait until the user presses ENTER
  91.    #       \Dx       Wait for "x" seconds
  92.    #
  93.    #       Environment:
  94.    #
  95.    #       \{evar}   where evar is an environment variable (ENV:)
  96.    #
  97.    #       \$cmd$    where cmd is any command you wish to issue while
  98.    #                 eco is running
  99.  
  100.            Others:
  101.  
  102.            \?        To get a short help
  103.            \x..      Display an HEX character ".." (e.g. \x45 = "E")
  104.            \s        No auto \n at the end of string (sequence) (§)
  105.  
  106.            (§)  Note: this sequence works only if appended at the end
  107.                       of the string, otherwise it is ignored.
  108.  
  109.  Notes:    Use ECO ? to get the help. If the first character of string
  110.            is a question mark, the help is displayed and the rest of
  111.            string is ignored. If you wish to echo a string beginning with
  112.            a question mark, you have to way:
  113.  
  114.            ECO "? This string begins with a question mark."
  115.  
  116.            ECO \? This string begins with a question mark, too.
  117.  
  118.            If you wish to display the help within your text, just use
  119.            \h as follows:
  120.  
  121.            ECO "The help of ECO is:\n\h\nNice, isn't it?"
  122.  
  123.            NOW BOTH ECO AND ECOX ARE PURE! That is you can make them
  124.            resident by
  125.  
  126.            RESIDENT ECO (or ECOX)
  127.  
  128.            No PURE option is necessary, unless you copied or unarchived
  129.            the programs in such a way to loose the PURE bit.
  130.  
  131.  Examples: [both ECO and ECOX features]
  132.  
  133.            let's suppose that colors are:
  134.  
  135.            0 --> Grey;  1 --> White;  2 --> Black;  3 --> Red;
  136.  
  137.            the sequence
  138.  
  139.            Echo "\6\C\(5,10) Heeelp!  \(10) \d\c"
  140.  
  141.            1) Set the background to Black
  142.            2) Clear the screen and put the cursor on top-left corner
  143.            3) Position the cursor at row 5, column 10
  144.            4) Write " Heeelp! "
  145.            5) Put the cursor at the first column of row 10
  146.            6) Reset the background to the default (Grey)
  147.            7) Clear the screen from current position to the bottom line
  148.  
  149.            Note that the sequences \C\6 and \6\C have different effects:
  150.            the first former the whole screen and display the new background
  151.            only for the output string, the latter set the background and,
  152.            clearing the screen, fill it with the selected color.
  153.  
  154.            By using the \(..;..) sequence, you can create CLI macro which
  155.            write always on the same line, so that it's possible to change
  156.            continuosly a counter in a prompt as well as when you format a
  157.            diskette. However, in that case, is better you clear the screen
  158.            by using \C to avoid side effects on old output lines. If you
  159.            don't want to clear the screen, use the \v (vertical tab)
  160.            sequence, which allows you to go up one line.
  161.  
  162.            You may want to use the ECO command to make passwords invisible
  163.            while typing in, as follows:
  164.  
  165.            ECO Enter your password:\x9B0 p\0\4\n
  166.            --- get the password here ---
  167.            ECO \x9B p
  168.            IF WARN
  169.              ECO \1Wrong password
  170.            ELSE
  171.              ECO \3You got it!\1
  172.            ENDIF
  173.  
  174.            where the sequence "\x9b0 p" ["\9b p"] is used to make the cursor
  175.            invisible [visible].
  176.  
  177.            By ECO you may stop for user pressing ENTER, as follows:
  178.  
  179.            ECO "Here are... a lot of lines"
  180.            ECO "Press ENTER to continue...\W"
  181.            ECO "Here are... a lot of lines again"
  182.  
  183.            or just delay for a predefined number of seconds (1 to 9):
  184.  
  185.            ECO "Now wait two seconds\D2 and go ahead..."
  186.  
  187.            You can include environment (ENV:) variables in your text by
  188.            using the \{..} sequence. Let's suppose you did the following:
  189.  
  190.            SETENV bye "Hello, world!"
  191.  
  192.            Then you get the variable string as follows:
  193.  
  194.            ECO "\2\{bye}\d That's all, folk!"
  195.  
  196.            You can also issue commands while ECO is running. For instance,
  197.            the following line will display the name and the content of the
  198.            current directory:
  199.  
  200.            ECO "Current dir is \2\[p]\1 and its content is:\n\$dir$"
  201.  
  202.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  203.  Compile &
  204.  Link ECO: To compile and link ECO you have three way:
  205.  
  206.            «1»  lmk -f eco.lmk
  207.            «2»  rx doeco
  208.            «3»  execute eco.c
  209.  
  210.            To compile and link ECOX you have three way:
  211.  
  212.            «1»  lmk ecox -f eco.lmk
  213.            «2»  rx doeco EXTRA
  214.            «3»  execute eco.c (see below)
  215.  
  216.            Only mode «1» is complete and automatic. Mode «2» does assume
  217.            that eco.sym has been already generated. If not, you have to do
  218.            that by issuing
  219.  
  220.            LC -ph -oeco.sym ecohdr.c
  221.  
  222.            Mode «3» assumes eco.sym as mode «2». Furthermore, to generate
  223.            ECOX, you have to delete the semicolon character in front of two
  224.            statements in the eco.c header lines, and add the same character
  225.            two the equivalent lines used to generate ECO.
  226.  
  227.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  228.  Package:  ECO.ZOO (or LZH) contains the following files:
  229.  
  230.             ---p-rwed 90-04-01 17:49:16    7     3268 eco
  231.             ---p-rwed 90-04-01 17:51:16   20     9424 ecox
  232.             -----rwed 90-04-01 17:48:00   29    13752 eco.c
  233.             -----rwed 90-04-01 17:24:56    1      310 ecohdr.c
  234.             -----rwed 90-04-01 17:25:12   49    23511 eco.sym
  235.             -----rwed 90-04-01 18:05:10   20     9449 eco.hlp
  236.             -----rwed 90-04-01 17:24:45    2      584 eco.lmk
  237.             --s------ 90-04-01 17:54:30    4     1807 eco.me
  238.             -----rwed 90-04-01 17:25:01    3     1126 doeco.rexx
  239.  
  240.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  241.  Problems: I didn't find any wait to reset the text style WITHOUT resetting
  242.            colours too. Hence \p works as \d, rather than restoring the
  243.            style only.
  244.  
  245.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  246.  Author:   Dario de Judicibus
  247.  Address:  via Canton 101
  248.            I 00144 Roma (Italia)
  249.  Phone:    (+39-6) 68.88.765 (evening only local time)
  250.  
  251.  E-Mail:   SAM Link  (+39-6) 423.322   Userid 244
  252.            MC Link   (+39-6) 418.0440  Userid MC2120
  253.            ARGO      (+39-6) 519.1770  Userid Dario de Judicibus
  254.  
  255.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  256.