home *** CD-ROM | disk | FTP | other *** search
/ synchro.net / synchro.net.tar / synchro.net / main / BBS / HDISP16.ZIP / HACKDISP.DOC < prev    next >
Encoding:
Text File  |  1995-01-29  |  20.8 KB  |  528 lines

  1.  
  2.  
  3.       ┌─────────────────────────────────────────────────────────────────┐
  4.       │                                                                 │
  5.       │   ███ ███ ▄█████▄ ██████ ███ ███ █████▄ ▀███▀ ▄█████▄ ██████    │
  6.       │   ███ ███ ███ ███ ████ ▀ ███ ██▀ ████ █  ███  ▀██▄▄ ▀ ████ █    │
  7.       │   ███████ ███████ ████ ▄ █████   ████ █  ███  ▄ ▀▀██▄ ████ █    │
  8.       │   ███ ███ ███ ███ ██████ ███ ██▄ ██████ ▄███▄ ▀█████▀ ████▀▀    │
  9.       │   version 1.666         copyright 1992-1995  James L. Powers    │
  10.       └─────────────────────────────────────────────────────────────────┘
  11.             with MOTAMA and HDUDD/IM
  12.  
  13.          The screen conversion utility of choice for
  14.  
  15.                 LAUGHING DOG
  16.                  Synchronet
  17.                   PCBoard
  18.                   Wildcat
  19.                    Binary
  20.                    &ANSI
  21.  
  22.                    display files!
  23.  
  24.  
  25. ================================================================================
  26.  
  27.   DISCLAIMER OF WARANTY
  28.   =====================
  29.  
  30.       ALTHOUGH SAFE AND EFFECTIVE WHEN USED AS DIRECTED, THIS SOFTWARE
  31.       PROGRAM AND DOCUMENTAION ("HACKDISP with MOTAMA and HDUDD/IM" OR
  32.       "HACKDISP") IS BEING OFFERED FOR EVALUATION PURPOSES "AS IS" AND
  33.       WITHOUT WARRANTIES AS TO PREFORMANCE OR MERCHANTABILITY.  BY USING
  34.       HACKDISP, YOU ARE EXPRESSLY RELEASING JAMES L. POWERS FROM ANY
  35.       LIABILITY RESULTING FROM THE USE OF THIS SOFTWARE AND/OR
  36.       DOCUMENTATION.  THE USER MUST ASSUME THE ENTIRE RISK OF USING
  37.       HACKDISP.  BECAUSE OF THE DIVERSITY OF CONDITIONS, HARDWARE AND
  38.       OPERATING ENVIRONMENTS UNDER WHICH HACKDISP MAY BE USED, NO
  39.       WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE IS OFFERED.  THE USER
  40.       IS ADVISED TO TEST AND SUPERVISE HACKDISP THOROUGHLY BEFORE
  41.       RELYING ON IT.
  42.  
  43.  
  44.  
  45.   COMIC RELIEF
  46.   ============
  47.  
  48.       Before running HACKDISP with MOTAMA and HDUDD/IM or any other
  49.       software for the first time, make a complete backup of your hard
  50.       drive(s), use a grounded wrist strap, wear protective clothing,
  51.       provide adequate ventilation, seek shelter in low lying areas,
  52.       winterize your car, say three Hail Marys, put your head between
  53.       your knees and....
  54.  
  55.  
  56. ================================================================================
  57.  
  58.  
  59.   INTRODUCTION
  60.   ============
  61.  
  62.       HACKDISP with MOTAMA and HDUDD/IM (hereafter referred to as
  63.       HACKDISP) is the de facto standard in real time mission critical
  64.       display file conversion empowerment and enabling technology for
  65.       the information age!
  66.  
  67.       HACKDISP rapidly converts color text mode display screens on the
  68.       IBM PC, XT, or AT (and 100% compatibles) between a variety of
  69.       popular and unpopular formats.
  70.  
  71.       HACKDISP was created in 1992 as a tool to convert ANSI color coded
  72.       screens to so-called "@-codes".  Up until the current version
  73.       (1.666), HD relied on the host machine's ANSI driver to provide a
  74.       display mechanism for ANSI files, limiting output to the size of
  75.       the host's screen.  HACKDISP is now totally self-contained and no
  76.       longer relies on an external driver.  The features and limitations
  77.       the HACKDISP Universal Display Driver with Intelligent Monochrome
  78.       (HDUDD/IM) are discussed in "HDUDDIM.DOC", included in this
  79.       archive.  Restrictions on the use of the HACKDISP Universal
  80.       Display Driver are documented in "REGISTER.DOC", also included.
  81.  
  82.       HACKDISP's Moron-O-Tronic Attribute Minizing Algorithm (MOTAMA)
  83.       guarantees the most efficient conversion between ANSI and its @-,
  84.       @X-, and ^A- coded cousins.  It also provides tighter compressed
  85.       Laughing Dog files than Laughing Dog Screen Maker itself.  For a
  86.       complete description of MOTAMA, see "MOTAMA.DOC", which is also
  87.       included in this archive.
  88.  
  89.       Let's get on with it, shall we?
  90.  
  91. ================================================================================
  92.  
  93.   VIEWING FILES
  94.   =============
  95.  
  96.       HACKDISP determines the file input format depending on the
  97.       filename extension you specify:
  98.  
  99.        *.ANS or *.SCR = ANSI format
  100.        *.DOG          = Laughing Dog format
  101.        *.ASC          = Synchronet ^A format
  102.        *.PCB          = PCBoard @X codes
  103.        *.BBS          = Wildcat @ codes
  104.        *.TXT          = ASCII text
  105.        *.BIN          = binary screen dump (80x25 only)
  106.  
  107.  
  108.       Therefore, entering:
  109.  
  110.       HD MYFILE.ANS
  111.  
  112.       on the DOS command line causes MYFILE.ANS to be displayed.  The
  113.       default file extension can be overridden with the -IN: (or /IN=)
  114.       switch.  Therefore:
  115.  
  116.       HD README.DOC -in:txt
  117.  
  118.       will tell HACKDISP that README.DOC is an ASCII text file.
  119.  
  120.       HACKDISP makes an excellent text file browser.  You may want to
  121.       create a DOS BATch file for this purpose:
  122.  
  123.       REM "HT.BAT" - a HACKDISP text lister
  124.       HD %1 -! -in:Txt %2 %3 %4
  125.  
  126.       With HT.BAT you could view "README.DOC" without overriding the
  127.       default file extension:
  128.  
  129.       HT README.DOC
  130.  
  131.       Wildcards in filenames are not currently supported.
  132.  
  133.  
  134.  
  135.  
  136.   OPTIONS FOR VIEWING
  137.   ===================
  138.  
  139.       If a file is larger than a single screen, HACKDISP will pop up
  140.       a "Pause" prompt before scrolling.  If you want to watch the file
  141.       zing by,
  142.  
  143.       HD MYFILE.ANS -f
  144.  
  145.       will cause a FAST display.
  146.  
  147.       HACKDISP's ANSI driver is extremely fast.  To view ANSI animation
  148.       at "normal" speed, you may want to use the ANSI driver you
  149.       installed in your computer:
  150.  
  151.       HD MYFILE.ANS /MYDRIVER
  152.  
  153.       will force HACKDISP to use your computer's internal ANSI driver.
  154.  
  155.       HACKDISP can also take advantage of EGA and VGA modes:
  156.  
  157.       HD MYFILE.ANS -50
  158.  
  159.       will cause HACKDISP to use 80x50 mode.  Other modes include -28
  160.       and -43.  28 and 50 line mode are available ONLY with VGA.  43
  161.       line mode is available in either VGA or EGA.
  162.  
  163.       If you plan to use HACKDISP only for viewing files, get outtahere.
  164.       You're done.
  165.  
  166.  
  167. ================================================================================
  168.  
  169.  
  170.   CONVERTING FILES
  171.   ================
  172.  
  173.      The same default file extensions used for viewing are used in
  174.      the conversion process.
  175.  
  176.      There are two exceptions.  "SCREEN", the default output file, may
  177.      be used for input.  An extension of "*.C" will cause the output of
  178.      C source code if the input is a Laughing Dog file.
  179.  
  180.      To convert an ANSI file to Wildcat @-codes:
  181.  
  182.      HD ANSI.SCR ANSI.BBS
  183.  
  184.      is all that is needed.  To output to a file with a non-standard
  185.      extension:
  186.  
  187.      HD ANSI.FIL ANSI.HD /in=ANS/out=PCB
  188.  
  189.      would cause HACKDISP to interpret "ANSI.FIL" as ANSI input and
  190.      "ANSI.HD" to use PCBoard @X color codes.  The /IN and /OUT switches
  191.      can have the following formats:
  192.  
  193.      -inASC  /IN=Ans  /OUT:BBS  -out=DOG  -in:Pcb  /OUTbin
  194.  
  195.      et cetera for all supported file types.
  196.  
  197.      The separator ( "=" or ":" ) is optional and is only provided for
  198.      backward compatibility with older versions of HACKDISP.
  199.  
  200.      By default, HACKDISP displays the input screen.  This is due to
  201.      its previous reliance on an external ANSI driver.  You may or may
  202.      not want to see the screen that is being converted.  Therefore:
  203.  
  204.      HD COLOR.DOG COLOR.ASC /NOSHOW
  205.  
  206.      Will cause HACKDISP to use its internal memory and conventional
  207.      memory (if needed) for its work space.  This is usually faster than
  208.      using screen memory, especially when combined with the /F switch.
  209.  
  210.      Many converters or color editors do not produce optimized files.
  211.      There may be times you want to use HACKDISP with MOTAMA to optimize
  212.      existing files.  HACKDISP will not let you use the input file as
  213.      the output file unless you specifically tell it to:
  214.  
  215.      HD C:\WC30\BULL\BULL15.BBS C:\WC30\BULL\BULL15.BBS /O
  216.  
  217.      -O or /o causes HACKDISP to overwrite the file.  Note this applies
  218.      ONLY when the input and output files ARE THE SAME.  HACKDISP will
  219.      normally overwrite ANY file that already exists.
  220.  
  221.  
  222.  
  223.   BBS USE
  224.   =======
  225.  
  226.      The best use of HACKDISP is in the automatic translation of ANSI
  227.      score files to native BBS format.  This is where file suffixes
  228.      and prefixes come into play.  Consider:
  229.  
  230.      HD SCORE.ANS BULL5.BBS /!/f/n/nos/p:@07@@CLS@~M/s:~M~M@PAUSE@
  231.  
  232.      The "/!" switch tells HD to ignore any environment variable or
  233.      configuration file (more on that later).
  234.  
  235.      The "/f" tells HD to use FAST mode.
  236.  
  237.      The "/n" switch tells HD to cut off everything past the last
  238.      non-blank character.
  239.  
  240.      The "/nos" switch is the previously mentioned /NOSHOW option.
  241.  
  242.      "/p:" introduces text to be prepended to the output file.  In
  243.      this case we send a "@07@" to set the foreground and background
  244.      colors and a "@CLS@" to clear the screen.  "~M" tells HD to add a
  245.      carriage return/line feed (Ctrl-M).
  246.  
  247.      "/s:" introduces text to be appended to the output file.  Here,
  248.      since we used the "/n" switch to chop off everything up to the
  249.      last character, we threw in a few cr/lfs (~M's) just to pretty
  250.      things up a bit.  Then we added a @PAUSE@ just for funsies.
  251.  
  252.      As with the /IN and /OUT options, you can use ":" or "=" or
  253.      nothing at all to separate the text from the switch.
  254.  
  255.      There are SIX special two-character combinations that can occur
  256.      in a file suffix or prefix.  They are:
  257.  
  258.       ~M or ^M   cr/lf
  259.       ~A or ^A   Ctrl-A (for Synchronet)
  260.       ~[ or ^[   the ESCape character
  261.       ~/ or ^/   switch character
  262.       ~- or ^-   switch character
  263.       ~_ or ^_   underscore character
  264.  
  265.      The caret character is JUST THAT: it is the caret (^) character!
  266.      It does not mean the Ctrl key.  Always use the tilde ("~") if you
  267.      run under DESQview, which will take caret-M to mean Ctrl-M!
  268.  
  269.      From the command line, spaces within a prefix or suffix MUST be
  270.      represented by UNDERSCORES.  When using an environment variable
  271.      or configuration file, this is NOT necessary.
  272.  
  273.      Prefixes and suffixes can be up to 80 characters long.
  274.  
  275.  
  276.  
  277.   THE DSZ VARIABLE & HD.CFG
  278.   =========================
  279.  
  280.       Commonly used options can be held here, for instance:
  281.  
  282.       SET HDZ=/!/f/n/p:@07@@CLS@Perverted by @8E@HACKDISP@07@!~m/s:~m
  283.  
  284.       in your AUTOEXEC.BAT file (or anywhere else) will cause HACKDISP
  285.       to prepend:
  286.  
  287.       Perverted by HACKDISP!
  288.  
  289.       to every file it processes.
  290.  
  291.       HACKDISP will search its home directory for a file named "HD.CFG"
  292.       and use any options found in it.  HD.CFG can be up to 256
  293.       characters long.  Obviously, this is primarily for very long
  294.       prefixes or suffixes.  You can specify an alternate configuration
  295.       file with the "-Z" switch.  For instance, here's a hypothetical
  296.       "BARFDOOR.CFG" for translating an ANSI score file to @-codes:
  297.  
  298.       -!-r/F/n-NoShow
  299.       /p:@07@@CLS@~M
  300.       -s=~m@07@Thanks to @0F@JOE SCHMO@07@ for registering BARF DOOR!~m
  301.  
  302.       Your BATch file for running BARF DOOR (assuming it creates a
  303.       score file called BRFSCORE.ANS after each play) might look like
  304.       this:
  305.  
  306.       @ECHO OFF
  307.       CD\BARF
  308.       BARF C:\BBS\DOOR.SYS
  309.       REM Translate score file with HACKDISP!
  310.       REM-----------------------------------------------------------
  311.       HD BRFSCORE.ANS C:\WC30\BULL\BULL10.BBS -zC:\BARF\BARFDOOR.CFG
  312.       REM-------------------------------------^^^^^^^^^^^^^^^^^^^^^^
  313.       REM make sure HD translated the file (non-zero means trouble)
  314.       IF ERRORLEVEL 1 GOTO OOPS
  315.       REM It's OK, trash the original ANSI score file
  316.       DEL BRFSCORE.ANS
  317.       :OOPS
  318.  
  319.       Then every time a new score is posted Joe Schmo gets credit for
  320.       providing the ca$h to register BARF DOOR on the first line of the
  321.       bulletin.  Awww, ain't that special?
  322.  
  323.       Note that HACKDISP can use any combination of the supported switch
  324.       and separator characters but using "=" in an environment variable
  325.       is ILLEGAL.  Also, using the ">" or "|" characters on the command
  326.       line or in the HDZ variable will cause an error.  If you have to
  327.       use either of these characters you MUST use a configuration file.
  328.  
  329.       Case is ignored, but everything between two "@"'s is ALWAYS
  330.       converted to UPPER CASE.
  331.  
  332.  
  333. ================================================================================
  334. ================================================================================
  335.  
  336.  
  337.             -=≡COMMAND LINE OPTIONS IN DEPTH≡=-
  338.  
  339.  
  340.   NOTE: a "-" (minus) character (ASCII 0x2D) can be used in place of a
  341.     "/" (slash) character (ASCII 0x2F).  Command line switches may
  342.     be separated by spaces, but each MUST be preceded with "-" or
  343.     "/".  Switches that take parameters use "=" or ":" or nothing
  344.     between the switch and the parameter.
  345.  
  346.  
  347.   /!         "Immediate" mode.  Ignore HDZ and HD.CFG if they exist.
  348.          It's a good practice to precede ALL command line switch
  349.          sequences with this switch.
  350.  
  351.   /F         FAST mode.  HD will pause for two seconds after converting
  352.          a file if this switch IS NOT present.  Will not pop up
  353.          "Pause" prompt when viewing.  Very common.
  354.  
  355.   /N         Stop at last non-blank character.  Most often used switch.
  356.  
  357.   /Q         Quiet mode.  Never beep for ^G's or @BELL@'s.  Provided
  358.          because the PC speaker is SO annoying!
  359.  
  360.   /T         Expand TABs.  Very useful.  TABs are a pain.
  361.  
  362.   /E         Use EOF (end of file) marker.  Some editors may not like
  363.          HACKDISP's default behavior of not using the EOF marker.
  364.          Some BBS and "front door" software will display EOF, so
  365.          use cautiously.  Generally not needed.
  366.  
  367.   /B         View in B&W.
  368.  
  369.   /M         Use "intelligent monochrome".  The results may or may
  370.          not look different than with the /B switch.  This option is
  371.          EXCELLENT for creating readable monochrome versions of your
  372.          color screens.
  373.  
  374.   /K         Kill the last carriage return/line feed.  As opposed to
  375.          /n, which kills EVERYTHING between the end of the file and
  376.          the last non-space character.  Seldom needed.
  377.  
  378.   /P         File prefix.  See above under "BBS Use".
  379.  
  380.   /S         File suffix.  See above under "BBS Use".
  381.  
  382.   /R         Retry locked files.  May be necessary for multi-line
  383.          BBS use.  Otherwise rarely used.
  384.  
  385.   /A         Strip ASCII characters 0-31.  Replaces them with spaces.
  386.  
  387.   /O         Overwrite the input file.  Seldom used.
  388.  
  389.   /Z         Specify alternate HD.CFG file.  (See above)
  390.  
  391.   /?         Displays help screen.  Or is it a BBS ad?  YOU decide!
  392.  
  393.   /Dxxx      Wait for xxx (0-999) seconds after displaying or
  394.          converting.  Handy for "slide shows".
  395.  
  396.   /Lxx       Use only xx lines of screen.  Not a very commonly used
  397.          option.  Retained for backward compatibility.
  398.  
  399.   /28        Twenty-eight line VGA mode.
  400.  
  401.   /43        Forty-three line EGA or VGA mode.
  402.  
  403.   /50        Fifty line VGA mode.  At times you may see "ghost
  404.          characters" in some of these VGA modes.
  405.  
  406.   /IN        File input override.  See above.
  407.  
  408.   /OUT       File output override.  See above.
  409.  
  410.   /CLS       Prepend "clear screen" to file.  This is actually better
  411.          handled by use of a file prefix.  Retained for backward
  412.          compatibility.
  413.  
  414.   /NODV      Don't worry about DESQview.  USE AT YOUR OWN RISK!
  415.  
  416.   /MSANSI    Extends background attribute to end of line when screen
  417.          scrolls up.  99% of the time, you don't want to do this,
  418.          but it's the way MSDOS ANSI.SYS works.
  419.  
  420.   /NOSHOW    Do not send file to be converted to the screen.  Use
  421.          with /F for FASTEST conversion.
  422.  
  423.   /NOBLINK   Strip out blinking attributes.
  424.  
  425.   /TRICKS    Replaces 0xDB's (the "█" character) with spaces when the
  426.          foreground and background attributes are the same.
  427.  
  428.   /MYDRIVER  Use DOS ANSI.SYS or equivalent.  HACKDISP will assume
  429.          one is installed.  Although HD handles most ANSI commands,
  430.          there may be occassions you would want to use your own
  431.          driver.  See "HDUDDIM.DOC" for details.
  432.  
  433.   /NOMOTAMA  Do not use HACKDISP's Moron-O-Tronic Attribute Minimizing
  434.          Algorithm.  See "MOTAMA.DOC" for more information.
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441. ===============================================================================
  442.  
  443. PCBoard            copyright Clark Development Co., Inc.
  444. Wildcat & Tomcat   copyright Mustang Software Inc.
  445. Synchronet         copyright Digital Dynamics
  446. RIP                copyright TeleGrafix
  447. OS/2               copyright IBM
  448. MSDOS & Windows    copyright Microsoft
  449. DESQview           copyright Quarterdeck Office Systems
  450. CKIT               copyright Rickie Belitz
  451. Laughing Dog       copyright Jeff Sloan & Yardbird Software
  452.  
  453. HACKDISP, HDUDD/IM, & MOTAMA
  454.            copyright James L. Powers
  455.  
  456. ===============================================================================
  457. ===============================================================================
  458.  
  459.  
  460.               -=≡STANDARD DISCLAIMER≡=-
  461.  
  462.      Not  responsible  for   direct,   indirect,   incidental   or
  463.      consequential  damages  resulting  from any defect, error, or
  464.      failure to perform.  No other warranty expressed or  implied.
  465.      Some  of  the trademarks mentioned in this product appear for
  466.      identification  purposes  only.   Backup  all  hard   drives,
  467.      floppies,  and  CD-ROMs  before  running  this  or  any other
  468.      program.  Any resemblance to real persons, living or dead  is
  469.      purely  coincidental.   Void where prohibited.  Some assembly
  470.      required.   List  each  check  separately  by  bank   number.
  471.      Batteries   not   included.    Contents   may  settle  during
  472.      shipment.  Use only as directed.  Do not use while  operating
  473.      a  motor vehicle or heavy equipment.  Postage will be paid by
  474.      addressee.  Apply only to affected area.  May be too  intense
  475.      for  some  viewers.   Do  not  stamp.   Use  other  side  for
  476.      additional listings.  For  recreational  use  only.   Do  not
  477.      disturb.   All  models  over  18  years of age.  If condition
  478.      persists, consult your physician.  No user-serviceable  parts
  479.      inside.   Freshest  if eaten before date on carton.  It takes
  480.      ten first class stamps to mail a VHS cassette.  This  product
  481.      is  meant  for  educational  purposes  only.  Do not apply to
  482.      mucous membranes.  Subject to change without  notice.   Times
  483.      approximate.   Simulated  picture.   Your  mileage  may vary.
  484.      This is not a news broadcast.  No postage necessary if mailed
  485.      in the United States.  Breaking seal  constitutes  acceptance
  486.      of  agreement.   For  off-road use only.  As seen on TV.  One
  487.      size fits  all.   Many  suitcases  look  alike.   Contains  a
  488.      substaintial  amount  of  non-tobacco ingredients.  Celebrity
  489.      lookalike.  Colors may, in time, fade.   Slippery  when  wet.
  490.      For  office  use  only.  Not affiliated with the American Red
  491.      Cross.  Drop in any mailbox.  Edited  for  television.   Keep
  492.      cool; process promptly.  Post office will not deliver without
  493.      postage.    List   was  current  at  time  of  printing.   At
  494.      participating locations only.  Not the Beatles.   Substantial
  495.      penalty for early withdrawal.  Grass catcher must be attached
  496.      or  door  closed while engine is running.  Do not write below
  497.      this line.  Falling rock.  Lost  ticket  pays  maximum  rate.
  498.      Your  cancelled  check  is  your  receipt.  Add toner.  Place
  499.      stamp here.  Avoid contact with  skin.   Sanitized  for  your
  500.      protection.   Be  sure  each item is properly endorsed.  Sign
  501.      here without admitting guilt.  Slightly higher  west  of  the
  502.      Mississippi.    Not   affiliated  with  Snyder's  of  Berlin.
  503.      Employees and their families are  not  eligible.   Beware  of
  504.      dog.    Not   responsible   for   errors  in  typesetting  or
  505.      photography.  Contestants have been briefed on some questions
  506.      before the show.  Limited time  offer,  call  now  to  insure
  507.      prompt delivery.  You must be present to win.  Dramatized for
  508.      television.   Persons  using hold-open latches must remain at
  509.      the refueling point during refueling.  No passes accepted for
  510.      this  engagement.   No  purchase  necessary.   Use  only   in
  511.      well-ventilated area.  Keep away from fire or flame.  Replace
  512.      with  same  type.   Approved for veterans.  Booths for two or
  513.      more.  Check here if tax deductible.  Bleu Cheese 25¢  extra.
  514.      Some  equipment  shown  is  optional.  Price does not include
  515.      taxes.  No Canadian coins.   Not  recommended  for  children.
  516.      Prerecorded   for  this  time  zone.   Reproduction  strictly
  517.      prohibited.   3%  surcharge  on  Visa  and  MasterCard.    No
  518.      solicitors.  No pedestrians, bicycles, or farm machinery.  No
  519.      anchovies  unless otherwise specified.  Vapors harmful.  Stop
  520.      engine.  No smoking.  List  at  least  two  alternate  dates.
  521.      First  pull  up,  then  pull  down.   Call  toll  free before
  522.      digging.  Driver does  not  carry  cash.   Record  additional
  523.      transactions  on  back  of  previous  stub.   Dealer  retains
  524.      incentives.  May not be  available  in  Alaska,  Hawaii,  and
  525.      Puerto Rico.  Sorry, Tennessee!
  526.  
  527.      This notice supersedes all previous notices.
  528.