home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / ansi / ansit100.arj / ANSITDOC.ENG < prev    next >
Encoding:
Text File  |  1992-05-01  |  16.1 KB  |  362 lines
  1.  
  2.             ██████▄
  3.             ███  ██ ████▄ █▄   ████▄ ██     █▄ █████▄ █████▄ █████▄
  4.             ███  ██ ██  █ ██   ██    ██     ██ ██   █ ██   █ ██
  5.             ███▄▄██ ██  █ ██   ██▄▄  ██  █  ██ ██▄▄▄█ ██▄▄▄█ ██▄▄
  6.    ▓▓▓▓▓▓▓▓▓███░░░▓▓██░░█░██░░▓██░░▓▓██░▓█░▓██░██░░▓█░██░░█░▓██░░▓▓▓▓▓▓▓▓▓▓▓▓
  7.    ▓▓       ███     ██▄▄█ ██▄▄ ██▄▄▄ ██▄▄█▄▄██ ██   █ ██  █▄ ██▄▄▄▄        ▓▓
  8.    ▓▓                                                                      ▓▓
  9.    ▓▓                             PRESENTS                                 ▓▓
  10.    ▓▓                                                                      ▓▓
  11.    ▓▓                                                                      ▓▓
  12.    ▓▓                        ANSIT!   Version 1.00                         ▓▓
  13.    ▓▓                                                                      ▓▓
  14.    ▓▓                 Copyright (c) 1992 Steve Danielsson                  ▓▓
  15.    ▓▓                                                                      ▓▓
  16.    ▓▓                       BENCHMARK DOCUMENTATION                        ▓▓
  17.    ▓▓                                                                      ▓▓
  18.    ▓▓                                                                      ▓▓
  19.    ▓▓                                                                      ▓▓
  20.    ▓▓                                                                      ▓▓
  21.    ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
  22.  
  23.  
  24.  
  25.  
  26.  
  27.                           CONTENTS OF THIS FILE
  28.                           ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  29.  
  30.  
  31.   OVERVIEW.................... What ANSIT is and why you want to use it.
  32.  
  33.   USAGE....................... How to use the program.
  34.  
  35.   BENCHMARK DESCRIPTION....... Detailed description of the tests
  36.                                performed by ANSIT.
  37.  
  38.   ADDITIONAL NOTES............ A few notes on the interpretation of
  39.                                the benchmark results.
  40.  
  41.   ADVANCED OPTIONS............ ANSIT commandline arguments to run in
  42.                                auto-mode. Programmers should be interrested.
  43.  
  44.   FINAL WORD.................. How to reach me and my thanks.
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.                                  OVERVIEW
  52.                                  ▀▀▀▀▀▀▀▀
  53.  
  54.     There are a lot of ANSI drivers on the PD/SW market, and most of
  55.     them are much faster then ANSI.SYS - but which one is the fastest?
  56.  
  57.     ANSIT! gives you the answer. It's a benchmark program testing how
  58.     fast your machine (or your current ANSI driver, actually) can
  59.     execute ANSI escape sequences, screen writes and scrolls.
  60.  
  61.     So load an ANSI driver and run ANSIT! You can compare different
  62.     ANSI drivers to see which one is the fastest on your machine.
  63.     Besides, it's fun. I tried to make this program look pretty,
  64.     not just execute.
  65.  
  66.     Is it really worth the trouble to test an ANSI driver, install
  67.     another one, reboot the machine, test it and so on ?
  68.     The answer is an unconditional: Yes!
  69.     Look at the file INDEX.RES. It's a result file produced by ANSIT
  70.     on a 12 MHz AT 286.  Four popular ANSI drivers are tested, and as
  71.     you can see, the fastest one does screen writes 4 times (!) faster
  72.     than the slowest one. Four times faster screen writes is worth some
  73.     trouble! (You could beep up the screen writes by using Shadow RAM
  74.     BIOS or a software BIOS, but it's preferable to use a ANSI driver
  75.     that takes care of this itself).
  76.  
  77.     Note however that the results in the INDEX.RES file is valid for
  78.     that machine only, don't take them for granted.
  79.     The same ANSI drivers may (and propably will) perform different
  80.     on your machine, with your graphics card and your setup.
  81.  
  82.     For the curious user I've included REF.RES
  83.     This is a result file for different machines, all tested with
  84.     ANSI.SYS loaded in a 'clean' setup. There is no need or real
  85.     interrest in compairing your machine to other machines but if
  86.     you want to do it for fun, look at this file.
  87.  
  88.     The ANSI driver you're testing must be able to handle most standard
  89.     ANSI sequences, but don't worry - I haven't seen one that doesn't!
  90.  
  91.     This program won't look that fancy on a monocrome monitor, you'll
  92.     need color to really enjoy it, but the test is just as valid.
  93.  
  94.     All in all, ANSIT is the complete ANSI workout. It tests everything
  95.     the ANSI driver does (with the exception of keyboard redefinition).
  96.     It also tests the speed of screen writes/scrolling so it can be used
  97.     to benchmark Software BIOS replacements as well as ANSI drivers.
  98.  
  99.     If you don't have a clear understanding on what a ANSI driver is
  100.     or how DOS handles screen output, I recommend you to read the ANSI
  101.     TUTORIAL file included (ANSITUT.DOC), right away.
  102.  
  103.  
  104.  
  105.                                  USAGE
  106.                                  ▀▀▀▀▀
  107.  
  108.     Program usage is simple, enter ANSIT <return> and you'll see
  109.     the first menu. Select ESCape to abort testing or <S> to start
  110.     the benchmark program. Five different tests are performed as
  111.     described below.
  112.  
  113.     When all the five tests are executed, you'll see a graph
  114.     displaying the current ANSI performance.
  115.     The 'Speed Index' values given represents the speed of your
  116.     machine's ANSI processing. Higher value = faster ANSI.
  117.     The Speed Index scale will not show the entire scale of 0 to 14.
  118.     Instead you will see the part of the scale valid to your machine.
  119.     That is, the scale could go from 0 - 6,  5 - 11 or whatever is
  120.     enough to display all your index values.
  121.  
  122.     Now you may choose to Exit or Write a report file to disk.
  123.     The reportfile option will create a textfile called ANSIT.REP
  124.     and write the Speed Index values for all tests to the file.
  125.     You will be asked to name the test, this isn't a filename but
  126.     a name written to the report file.
  127.     ANSIT checks for the existance of the reportfile before creating,
  128.     if it already exist, ANSIT will append to it. This will
  129.     create a neat table if more than one benchmark is executed.
  130.  
  131.     The built-in ANSI file display timer:
  132.     To display an ANSI animation or textfile, enter:
  133.     ANSIT <filename> [<times>]
  134.  
  135.     <filename>  is the name/path of the file to display.
  136.     <times>     is (optional) times to display the file.
  137.                 Default is 1 time.
  138.  
  139.     For further information on this function, see the next chapter.
  140.  
  141.     You may interrupt the benchmark by pressing Ctrl-C / Ctrl-Break.
  142.  
  143.  
  144.                            BENCHMARK DESCRIPTION
  145.                            ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  146.  
  147.     What does this benchmark measure, really ?
  148.     It measures the time it takes for your machine to perform
  149.     different ANSI escape sequences, text and character output
  150.     and scrolling of the screen.
  151.     The speed of the computer does, of course, affect the result,
  152.     but the most important is the speed of the graphics card and
  153.     in particular the ANSI driver loaded. Needless to say, the
  154.     faster your machine/graphics card/ANSI driver can perform these
  155.     actions the faster screen output you'll get.
  156.     Benchmarks are often "theoretical". This is strait forward.
  157.     If a test is performed faster with one ANSI-driver than with
  158.     another, the output really IS faster. Simple and fool proof!
  159.  
  160.     Note that programs using direct screen writes is bypassing the
  161.     ANSI driver, writing directly to the screen. The ANSI performance
  162.     only affects applications writing to STDOUT and/or using ANSI
  163.     escape sequences. All DOS funtions does this, so the ANSI driver
  164.     performace does count when typing textfiles, displaying ANSI
  165.     files, directory listing etcetera.
  166.  
  167.     Now, let's examine the different tests in detail.
  168.  
  169.     The tests performed by ANSIT is as follows:
  170.     ---------------------------------------------------------------
  171.         Test 1:      Position Cursor.
  172.                      Test the ANSI escape sequence:
  173.                      Position Cursor        CUP  ESC[n;nH
  174.                      Set Graphics Rendition SGR  ESC[n;nm
  175.                      CUP and SGR is important to the overall speed
  176.                      in applications using ANSI to change color of
  177.                      the text and/or background or positioning the
  178.                      cursor on the screen.
  179.  
  180.         Test 2:      Text Write.
  181.                      This test reflect the speed of text string output
  182.                      via the BIOS routines or ANSI device driver.
  183.                      Also test ANSI sequence:
  184.                      Set Graphics Rendition SGR  ESC[n;nm
  185.  
  186.         Test 3:      Animation test.
  187.                      Test ANSI sequences:
  188.                      Cursor Up              CUU  ESC[nA
  189.                      Cursor Down            CUD  ESC[nB
  190.                      Cursor Forward         CUF  ESC[nC
  191.                      Cursor Backward        CUB  ESC[nD
  192.                      Cursor Save Position   SCP  ESC[s
  193.                      Cursor Restore Pos.    RCP  ESC[u
  194.                      This test reflects the speed of ANSI animations
  195.                      in particular, but also any application using ANSI
  196.                      to move the cursor across the screen. It also
  197.                      measures the general speed of the ANSI drivers
  198.                      parsing and handling of escape sequences.
  199.         
  200.       Test 4:        Screen scroll test.
  201.                      Test ANSI driver or ROM BIOS screen scrolling speed.
  202.                      The ANSI drivers/graphics card speed when scrolling
  203.                      the entire screen is vital when displaying textfiles
  204.                      via DOS and when performing directory listings etc.
  205.  
  206.       Test 5:        Single Character Output.
  207.                      Test speed of single character screen write.
  208.                      You will notice that different ANSI drivers aren't
  209.                      always as good at single character output as they
  210.                      are at text string output. This affects any output
  211.                      of single characters via TTY as well as ANSI
  212.                      animations etcetera.
  213.  
  214.  
  215.     ANSI animation / text file display Timer.
  216.  
  217.     In addition to the five tests described above, it's possible
  218.     to time the display of an ANSI or ASCII file. This is useful as
  219.     an extra benchmark of the ANSI performance. It's impossible to
  220.     calculate a relative Index value for this test (since I don't
  221.     know how big the file you want to display is and what it does),
  222.     instead the time, in seconds, that the display took is the output.
  223.  
  224.     To time large animated ANSI files is a good addition to the five
  225.     internal tests ANSIT can do for you. Comparing the time used
  226.     to display a large animation gives a good overall performance.
  227.  
  228.     You may also load a plain textfile and display it a large number
  229.     of times to get a higher resolution of the screen scroll performance
  230.     than with the internal screen-scroll test.
  231.  
  232.     Files are loaded into memory before they are displayed, so your
  233.     drive performance doesn't influence the test.
  234.     Files are limited to 255 Kbytes and an error message will be
  235.     displayed if ANSIT cannot allocate enough memory for the file.
  236.     This function gives you the possibility to create "user-defined"
  237.     tests, you can make an ANSI animation (with an ANSI editor) that
  238.     does exactly the things you want to test further and time it.
  239.  
  240.     For information on how to use this function see the previous
  241.     chapter, Usage.
  242.  
  243.  
  244.  
  245.                              ADDITIONAL NOTES
  246.                              ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  247.  
  248.     Note that ANSIT can be used to benchmark any speedup utility
  249.     affecting the screen writes or ANSI handling.
  250.     There are a lot of TSR's and Video BIOS drivers available.
  251.     Run ANSIT with your favorite ANSI-driver, install the speedup
  252.     program and run ANSIT again. Comparing the results will give
  253.     you an idea how effective the speedup utility is.
  254.  
  255.     The Speed Index:
  256.     The index scale goes from 0 to 14.
  257.     I've calibrated the tests to get a standard value around 6.0
  258.     on a 12 MHz AT-286. The Index scale should be enough to measure
  259.     any machine from an 8088 XT to a 486 with a quick VGA card.
  260.     ANSIT has been tested on everything up to a 33 MHz 386.
  261.  
  262.     Should you, however, get a 14+ value on your machine, concider this:
  263.     Your machine is so fast you will not notice any difference between
  264.     different ANSI drivers. Delete this program and all ANSI drivers but
  265.     one, install it and sit there with a happy smile on your face!
  266.  
  267.     If your machine, ont the other hand, is so slow that you cannot raise
  268.     the index value above 0.0 with any driver and any setup:
  269.     Welcome to the nineties! Buy a (faster) computer (or a typewriter).
  270.  
  271.  
  272.  
  273.                            ADVANCED OPTIONS
  274.                            ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  275.  
  276.     You may run ANSIT in AUTO mode by using commandline arguments.
  277.     This option was added mostly with regard to fellow programmers that
  278.     may want to use ANSIT to optimize something they are working on,
  279.     an ANSI.SYS replacement driver, Software Video BIOS or anything using
  280.     it's own ANSI interpretation or screen output routines.
  281.     Note that ANSIT won't display the performace screen when runned in
  282.     auto-mode. As soon as the selected tests are performed, ANSIT will write
  283.     to the resultfile and exit.
  284.  
  285.     ANSIT will accept the following commandline arguments:
  286.     ------------------------------------------------------
  287.     ANSIT [/?|H] [/A] [/1] [/2] [/3] [/4] [/5] [/C<comment>]
  288.  
  289.     /?  /H       Display a short syntax help.
  290.  
  291.     /A            Run ANSIT in auto-mode, all five tests.
  292.     /1 - /5       Run ANSIT in auto-mode using these tests, any combination
  293.                   of selected tests are possible.
  294.     /C<comment>   Write this comment to the result file.
  295.                   This is optional, if not entered ANSIT will write AUTO-RUN
  296.                   as comment to the results.
  297.                   NO SPACES in this argument, use underline or something!
  298.  
  299.     Examples:
  300.  
  301.     ANSIT /3 /4 /5 /CMy_Driver   Will run tests 3, 4 and 5 and write the
  302.                                  comment "My_Driver" to the resultfile.
  303.  
  304.     ANSIT /A                     Will run all five tests and write the
  305.                                  default comment "AUTO-RUN" to the resultfile.
  306.  
  307.     ANSIT /3 /CTestrun_6         Will run test 3 only, write "Testrun_6" as
  308.                                  comment in the resultfile.
  309.  
  310.  
  311.     With these options you can test exacly and only the ANSI routines you
  312.     are interrested in. Also you may write a batchfile to run ANSIT several
  313.     times (since it will exit automaticly, when runned in auto-mode).
  314.  
  315.  
  316.  
  317.  
  318.                              FINAL WORD
  319.                              ▀▀▀▀▀▀▀▀▀▀
  320.  
  321.     I do appriciate comments on the program, even if it's just a
  322.     message saying "Hey, I like it!"  (or even "It sucks!").
  323.  
  324.     Any comments, questions or suggestions can be Netmailed to me at:
  325.          
  326.     Steve Danielsson
  327.         FidoNet :  2:201/270   (PoleWare Support Centre)
  328.         VirNet  :  9:462/127   (---------- " ----------)
  329.         SuperNet: 42:1001/111  (---------- " ----------)
  330.         IntlNet : 57:4601/107  (---------- " ----------)
  331.  
  332.  
  333.  
  334.     Or Postcarded to:    Steve Danielsson
  335.                               Glasmalarv. 5
  336.                               S-12231 Enskede
  337.                               SWEDEN
  338.  
  339.  
  340.     Last but not least, for endless patience when beta-testing this
  341.     and other programs for me, my Very Special Thanks to:
  342.  
  343.     Jonas Ekelund  (SysOp PoleWare Support Centre)
  344.     Ulf Ekstrom    (SysOp EDKX PCBoard BBS)
  345.  
  346.     (These guys have nightmares in animated ANSI, but they still
  347.      won't quit on the job!)
  348.  
  349.  
  350.      ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  351.  
  352.        ANSIT! is Freeware. You may use and spread it freely, but may not
  353.        sell it or include it in commercial packages. You may not change
  354.        the program or this documentation in any way.
  355.        Please, include the DOC file when distributing the program.
  356.  
  357.      ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  358.  
  359.  
  360.  
  361.                                                                        
  362.