home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR8 / SHOWV20.ZIP / SHOW.DOC < prev   
Text File  |  1993-09-04  |  17KB  |  366 lines
  1.  
  2.    SHOW V20 is Copy(c)right 1989,1993 by Gary M. Raymond, New Orleans, La.
  3.       Show TEXT Converter (Text to COM) Program V2.0 by Gary M. Raymond
  4.  
  5.                ╔═════════════════════════════════════════════╗
  6.                ║               Gary M. Raymond               ║
  7.                ║                 P.O.Box 8184                ║
  8.                ║            New Orleans, La.  70182          ║
  9.                ║                (504) 288-6550               ║
  10.                ║             Compuserve 70613,3165           ║
  11.                ╚═════════════════════════════════════════════╝
  12.  
  13.     USE (G)o to --->   26)  Files & System Requirments
  14.                        44)  How SHOW was Born.
  15.                        73)  Using SHOW now!
  16.                       114)  Printing documents
  17.                       139)  Changing Colors
  18.                       159)  GOTO & FIND
  19.                       184)  Technical Stuff
  20.                       219)  Updates
  21.                       248)  Shareware License
  22.                       332)  Order Form
  23.  
  24.  
  25.  
  26.  
  27.    FILES AND SYSTEM REQUIRMENTS
  28.    ====================================================================
  29.  
  30.    Files Provided:
  31.    SHOW.COM      SHOW Engine used to convert text (ascii) files to COM
  32.    SHOW.DOC      This document.
  33.    README.COM    This document encased by SHOW engine
  34.    ORDERME.COM   Order form
  35.  
  36.    System requirements: PC/XT/AT, DOS 2.1 up, 128k ram up, floppy or
  37.    hard drive, mono or color, any type graphic adapter. Printer optional.
  38.  
  39.    ====================================================================
  40.  
  41.  
  42.  
  43.  
  44.  
  45.    How SHOW was born:
  46.    ------------------
  47.    I had a need to immediately supply a client with some rather lengthy
  48.    written instructions. He was in another city, the document was over
  49.    twenty pages, and faxing seemed to be my only option. An assistant
  50.    suggested I use one of a couple of simple utilities circulating on
  51.    the BBS'es that convert text files to self displaying executable com
  52.    files. Then I could upload it directly to his home computer. This
  53.    sounded like the perfect solution. It was, and it worked. The
  54.    advantages were obvious. The customer could read the text directly on
  55.    his computer monitor by simple typing the name of the text at the dos
  56.    prompt. The customer did not have to know beans about the dos TYPE
  57.    command, piping, the MORE utility, redirection codes, or anything.
  58.    (and, he didn't!) The best part was that the self displaying text
  59.    also had scroll control, with up and down line control, pgup and
  60.    pgdn, along with home and end.
  61.  
  62.    Unfortunately, the utility we used required some sophistication and
  63.    time consuming preperation on the part of the operator. Some of this
  64.    lost time involved embedding control characters into the text file
  65.    for color changes etc. I therefore decided to write a more user
  66.    friendly, faster and novice oriented utility. Thus SHOW was born.
  67.    SHOW was written entirely in assembler to optimize both speed and
  68.    file size. Isaacson's A86 compiler was chosen for it's power yet
  69.    ultra simplicity to use as well.
  70.  
  71.  
  72.  
  73.  
  74.    HOW TO USE
  75.    ----------
  76.    To use SHOW, you need only tell it what text file to convert and
  77.    the name of the output com file you desire. (which can be the same
  78.    name as the input file if you wish). You have an additional option of
  79.    giving it a third string parameter which will appear as a header on
  80.    the top line of the display window. The first two parameters must
  81.    be passed at the command prompt.
  82.  
  83.    Example:
  84.            1st       2nd    3rd parameter
  85.    C:>SHOW INPUT.TXT OUTEXT "Synopsis of board meeting - 2/23/92"
  86.  
  87.    Remember, the 3rd parameter is optional (as are the quotes) and
  88.    notice that a space must delimit (separate) each parameter. Since
  89.    ascii text files have extensions that generally vary from
  90.    (.ASC),(.TXT),(.DOC), (.BAS),(.PAS), etc, etc, you must provide the
  91.    correct extension for the 1st parameter or input file (assuming it
  92.    has an extension, and it does NOT have to have one!) The output file
  93.    (name.EXT) will always default to .COM if you do not supply it.
  94.  
  95.    SHOW incorporates several features not found in many of the other
  96.    text converters on the market. It is also fairly intuitive to use,
  97.    displaying its entire set of menu choices at the bottom of the screen
  98.    on line 25.
  99.  
  100.    Example:
  101.   <Esc> (W)rite (G)o (C)olor/(S) (P)rint, (F)ind, Home,End,PgUpDn,ArUpDn Ln =00
  102.  
  103.    You may <exit to dos> anytime by using the Escape key. The Line counter
  104.    at the far right of the menu bar, always indicates the position of the
  105.    very top line. Hence, if you hit <End> and see 975, there are actually
  106.    998 lines (975 plus 23) in the file. This will only vary during a text
  107.    search, in which case, the line number appearing at the bottom will be
  108.    the line number the found text appears on.
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.    PRINTING
  116.    --------
  117.    You can quickly and easily print the document to your line printer by
  118.    selecting (P)rint from the menu.
  119.  
  120.    Prompt> Is Line Printer READY [y/n] -> y
  121.  
  122.    SHOW assumes you are using LPT1 (parallel port address 3BCh).
  123.    However, if you are using LPT2 (parallel port address 378h), or LPT3
  124.    (parallel port address 278h) this is no problem. SHOW will allow you
  125.    to toggle between these ports by repeatedly hitting the Insert key.
  126.    You will note the LPT# will appear to the extreme left of the last
  127.    (25th) line on standard displays.
  128.  
  129.    You can also (W)rite the document back into a standard ascii text
  130.    file if desired. After hitting "w" you will be prompted for a standard
  131.    dos file name or handle.
  132.  
  133.    Prompt> Enter filename to save as   -> minutes.doc
  134.  
  135.    Please observe not to exceed the dos convention of 8x3 character
  136.    assignments for the handle and extension. (Examp: TEXTFILE.DOC)
  137.                                                      12345678x123  max
  138.  
  139.  
  140.    COLOR:
  141.    ------
  142.    The display screen will have a pleasant default background color of
  143.    cyan with black lettering. The top border and bottom menu line will
  144.    be blue with white lettering. The (C)olor option allows you to change
  145.    (on the fly), the body color of the document. After hitting the
  146.    letter "c", immediately use the up and down arrow keys to toggle
  147.    through the 255 choices. As you toggle the up/dn arrow keys you will
  148.    see the screen change immediately. When you are satisfied with the
  149.    selected colors, hit <Esc> and continue enjoying SHOW! There are 128
  150.    standard choices plus 128 of the same in blinking format. PgUp - PgDn
  151.    keys are also active (along with the Arrow keys) and will toggle the
  152.    background color for immediate rotation to the next background color.
  153.  
  154.    NOTICE: You may save the new color as a DEFAULT by hitting the "s"
  155.    key AFTER changing the color and hitting <Esc>. Caution: the color
  156.    cloning (saving) feature will not operate if you rename the new COM
  157.    text display file.
  158.  
  159.  
  160.    GOTO & FIND
  161.    -----------
  162.    The (G)o option request a line number to jump to. You can quickly
  163.    determine the total number of lines in your document by using the
  164.    <End> key after loading and reading the Line counter at the bottom
  165.    right. This feature can save a lot of time in scanning or jumping to
  166.    a particular place in a document.
  167.  
  168.    The (F)ind option will result in the appearance of the following
  169.    prompt at line 25: Enter search string to find -> atom bomb
  170.  
  171.    The search is case sensitive and if successful will bring the line
  172.    of text containing the match to the top of the screen. This will be
  173.    followed by another prompt asking: Search for this again [y/n] ->
  174.    A yes (Y or y) response will continue the search, any other key will
  175.    abort the search.
  176.  
  177.    If the first or any subsequent search is unsuccessful, you will be
  178.    prompted by a flashing "No Match Found" message. If a search was
  179.    successful, the line containing the found match will appear in the
  180.    center of the screen (if not the first or last page) with the
  181.    matching text highlighted.
  182.  
  183.  
  184.  
  185.    TECH STUFF:
  186.    -------------------------------------------------------------------
  187.    In order to not breach the 64k segment boundary of a dos com file and
  188.    still stuff more text into the wraparound display driver, I have
  189.    elected not to maintain a data array of line numbers like most other
  190.    similar utilities. Rather, SHOW reads line endings (crlf) on the fly,
  191.    remembers its present position and calculates page and line changes
  192.    from that reference. This saves two bytes per line in terms of
  193.    overall file size and allows you to get over 61k of text into the
  194.    driver. This could be particularly useful for files with short lines.
  195.    On the other hand, there is another limit imposed by the use of
  196.    unsigned word integers as a line count variable, you are limited to
  197.    no more than 64k lines. But, I somehow doubt this will be a problem
  198.    either.
  199.  
  200.    The color attribute is determined by a single byte that can represent
  201.    an integer from 0 to 255. There are eight basic background colors;
  202.    black, blue, green, cyan, red, magenta (purple), brown and white.
  203.    Each background color may have any one of the eight basic colors,
  204.    plus eight more of the same basic colors in lighter or brighter hues,
  205.    as a foreground color. So 8x16 = 128 choices of normal color
  206.    combinations plus another 8x16 (128) of equivalent blinking choices.
  207.    Therefore 128 + 128 = 256 choices (0 thru 255). The toggle simply
  208.    increments or decrements the byte starting with decimal 048 (the
  209.    value for producing cyan background with black foreground).
  210.    -------------------------------------------------------------------
  211.  
  212.    For programmers, I will license the assembly source code for a very
  213.    reasonable fee. Call, write or E-Mail for more details. One fellow
  214.    wanted $500 for his source. By comparison, mine is practically free
  215.    and reasonably commented throughout. Show was written for Isaacson's
  216.    A86 Assembler.
  217.  
  218.  
  219.  
  220.    UPDATES
  221.    -------
  222.    ====================================================================
  223.    V2.0  Major Upgrade. Incorporated a text (F)ind or searching function
  224.          to locate strings. This is in response to the number one most
  225.          frequently requested feature by SHOW's registered users.
  226.    ====================================================================
  227.    V1.5  Fixed a bug that prevented writing to a 8x3 com file. Also
  228.          increased file handle buffer to permit passing file path along
  229.          with file names.
  230.    ====================================================================
  231.    V1.4  Minor cosmetic changes to some menu prompts. Fixed bug on PgUp
  232.          that caused lockup if first line of text was empty. Fixed bug
  233.          that improperly set line 25 Menu when text less than 23 lines.
  234.          Changed the Printer Port Toggle key from PrnSc to Insert.
  235.    ====================================================================
  236.    V1.3  Added an error message if input text file not found. Added
  237.          PgUp & PgDn in addition to Arrow Up,Dn for faster color changes.
  238.    ====================================================================
  239.    V1.2b Replace bios screen writes with direct video to speed up display
  240.          time on old, slower CPU's.
  241.    ====================================================================
  242.    V1.1  12/19/92 Maintenance, reworked all functions, saved a few bytes.
  243.    ====================================================================
  244.    V1.0  12/15/92 First release.......................................
  245.    ====================================================================
  246.  
  247.  
  248.  
  249.     LICENSE AGREEMENT
  250.     -----------------
  251.  
  252.                            ┌─────────┐
  253.                            │ MEMBER  │   Society of
  254.                            │  ┌──────┴──┐ Independent
  255.                            │  │         │   Shareware
  256.                            └──┤    ■    │     Authors
  257.                               │    ║    │
  258.                               └────╨────┘
  259.     This program is produced by a member of the Society of Independent
  260.     Shareware Authors (SISA). The Society wants to ensure that all
  261.     valid shareware principle actually work for you and SISA members.
  262.     The principle behind shareware distribution is simple; try before
  263.     you buy. Society members agree to license all shareware for a minimum
  264.     of 10 days, free of charge, to first time users as an evaluation period.
  265.     After 10 days, buyers are then obligated to license their copy with
  266.     the Society member. Society members are obligated to provide high
  267.     quality, useful shareware, but, are free to choose whatever marketing
  268.     methods suit their specific needs. SISA sanctioned marketing methods
  269.     include: demonstration versions; providing printed documentation
  270.     after purchase; registration keys that unlock additional features
  271.     not necessary to determine basic usefulness; and, providing bug
  272.     fixes free of charge. Any Shareware author may become a member of
  273.     SISA without cost by simply agreeing to the above conditions and
  274.     displaying, at their option, this logo in their documentation.
  275.    ====================================================================
  276.  
  277.     WARRANTY:
  278.     Software:
  279.     Gary Raymond warrants that the software contained herein will
  280.     perform in substantial compliance with the documentation
  281.     accompanying the software. If you report, in writing, a significant
  282.     defect to us, and we are unable to correct it within 90 days of the
  283.     date you report the defect, you may return the software and
  284.     accompanying materials, and we will refund the purchase price.
  285.  
  286.     Diskette's and Documentation:
  287.     Gary Raymond, warrants all diskette's and documentation to be
  288.     free of defects in materials for a period of 30 days from the date
  289.     of purchase. In the event of notification within the warranty period
  290.     of defects in any materials, Gary Raymond will replace the
  291.     defective diskette or documentation.
  292.  
  293.     Remedies:
  294.     The remedy for breach of the warranty shall be limited to
  295.     replacement and shall not encompass any other damages, including but
  296.     not limited to loss of profit, special, incidental, consequential,
  297.     or similar damages, losses, or claims.
  298.  
  299.     DISCLAIMER:
  300.     Gary Raymond specifically disclaims all other warranties,
  301.     expressed or implied, including but not limited to, implied
  302.     warranties of merchantability and fitness for a particular purpose
  303.     with respect to defects in the diskette and documentation, and the
  304.     program license granted herein, in particular, and without limiting
  305.     operation of the program license with respect to any particular
  306.     application, use, or purpose.  In no event shall Gary Raymond be
  307.     liable for any loss of profit or any other commercial damage,
  308.     including but not limited to special, incidental, consequential or
  309.     other damages.
  310.  
  311.     GOVERNING LAW:
  312.     This statement shall be construed, interpreted, and governed by the
  313.     laws of the State of Louisiana.
  314.     ====================================================================
  315.  
  316.    Registering your copy will help continue the competitive advantages
  317.    of providing economical shareware. Upon receipt of your payment I
  318.    will provide you with a copy of the latest version and notify you
  319.    of all future upgrades. Your patronage is appreciated.
  320.  
  321.    My no nonsense license:
  322.    ------------------------
  323.    Your one time registration fee will license you to use SHOW to
  324.    package text files in ANY quantity for private, shareware or
  325.    commercial sales distribution.
  326.  
  327.    Re distribution via electronic transmission, or downloading, is
  328.    allowed without further permission. Re distribution of the Shareware
  329.    version of SHOW, for a fee, is also allowed without further
  330.    permission as long as that cost is limited to no more than two
  331.    dollars per copy, if supplied on any physical disk media.
  332.  
  333.    ORDER FORM
  334.    ----------
  335.    Yes Gary, I can really make use of your program and would like to
  336.    register and obtain the latest version as well as get on your mailing
  337.    list for future upgrades and new releases!
  338.  
  339.    Product: SHOWV20.EXE
  340.  
  341.    Name_____________________________________________________________
  342.  
  343.    Mailing Address__________________________________________________
  344.  
  345.    City & State ___________________________________________________
  346.  
  347.    ZIP _____________________________ Phone _________________________
  348.  
  349.    Send $4 + $1 (ship & hand) check or money order to:
  350.  
  351.                               Gary M. Raymond
  352.                                 P.O.Box 8184
  353.                             New Orleans, La. 70182
  354.                                 504-288-6550
  355.                             Compuserve 70613,3165
  356.    ====================================================================
  357.  
  358.     ACKNOWLEDGEMENTS:
  359.     -----------------
  360.     To my best friend and machine code instructor, the Padre, alias The
  361.     Machine Man, whose many patient hours of coaching and prodding helped
  362.     me learn assembler, create, and continue embellishing this neat and
  363.     useful text display utility.
  364.  
  365.                                      EOF
  366.