home *** CD-ROM | disk | FTP | other *** search
/ C!T ROM 5 / ctrom5b.zip / ctrom5b / DOS / UTILITY / DIVERSEN / KWIKHELP / KWIKHELP.DOC < prev    next >
Text File  |  1994-12-01  |  11KB  |  243 lines
  1.  
  2.            ┌───┐      JIM TUCKER ■ SOFTWARE
  3.          ┌─┴─┐ ├──┐   4/635 Brighton Road
  4.          │  ┌┴─┴┐ │   Seacliff
  5.          └──┤   ├─┘   South AUSTRALIA 5049
  6.             └───┘     ═════════════════════════════════════════════════
  7.                       Phone 61 8 377 1175
  8.                       jtucker@adam.com.au
  9.  
  10.        This documentation describes:
  11.  
  12.          KWIKTEXT.COM
  13.          KWIKHELP.COM
  14.          KWIKGRAB.COM
  15.          KWIKVIEW.COM
  16.          BIN2TEXT.COM
  17.          BIN2ASM.COM, BIN2C.COM, BIN2PAS.COM
  18.  
  19.        THIS is a complete version of these program and this is the only 
  20.        nag message you will see. If you find them useful registration 
  21.        is $10. Thank you. - JT.
  22.  
  23.        PLEASE distribute this package. You may bundle these programs 
  24.        with any software you sell. The A86 source code is included.
  25.        Copyright is retained for the assembled programs only. No 
  26.        copyright is claimed on the source code and this may be used for 
  27.        whatever purpose you like.
  28.  
  29.        ───────────────────────────────────────────────────────────────-
  30.        KWIKTEXT.COM
  31.        ───────────────────────────────────────────────────────────────-
  32.  
  33.        KWIKTEXT.COM is a simple DOS utility which creates resident (TSR) 
  34.        screens. These pop up to display anything you like... help or 
  35.        cheat screens. It is very easy to use.
  36.  
  37.        Write a plain ASCII text file of 25 lines or less. Call it 
  38.        anything. We'll use simply SAMPLE.TXT. Now at the command line 
  39.        enter: KWIKTEXT SAMPLE.TXT <enter>. Presto! You have a popup TSR 
  40.        that will display whenever you hit the hotkey. Dead simple.
  41.  
  42.        There are two optional switches.
  43.  
  44.        SPECIFYING A HOTKEY
  45.  
  46.        /K= You may change the default hotkey <CTRL-ALT-T> using /K=x 
  47.        where "x" is the character you want with CTRL-ALT depressed. If 
  48.        you use /K=# this provides plain F1 (with no CTRL-ALT) which is 
  49.        often used for help.
  50.  
  51.        You may load as many popup screen as you like, so long as you 
  52.        have enough memory. Each screen uses approximately 4.5K. If you 
  53.        do not specify a hotkey or use the same hotkey for each one you 
  54.        may pop them up in succession using the same key. The last one 
  55.        loaded will pop first.
  56.  
  57.        You may use alternative hotkeys (/K=1 /K=2 /K=3 for example) if 
  58.        you want to load several KWIKTEXT screens with individual 
  59.        hotkeys. If you specify a shift character ("*" for example) use 
  60.        <CTRL-ALT-LEFT SHIFT>.
  61.  
  62.        SPECIFYING A COLOR
  63.  
  64.        The second option is /C=nn where nn is the HEX number of the 
  65.        color you want your text to display. For a display of the color 
  66.        numbers simply enter KWIKTEXT /C at the system prompt.
  67.  
  68.        Text files must be 2050 bytes or less (a screenful) and lines 
  69.        after line 25 will be ignored (and may be used for comment).
  70.        KWIKTEXT may be loaded high (HL).
  71.  
  72.        That's all there is to KWIKTEXT. Enjoy it.
  73.  
  74.        ───────────────────────────────────────────────────────────────-
  75.        KWIKHELP.COM
  76.        ───────────────────────────────────────────────────────────────-
  77.  
  78.        KWIKHELP.COM is a simple DOS utility which loads resident (TSR) 
  79.        screens. These pop up to display a binary screen in color.
  80.  
  81.           KWIKHELP FILENAME.BIN [/K=Hotkey]
  82.  
  83.        You may change the default hotkey <CTRL-ALT-H> using /K=x where 
  84.        "x" is the character you want with CTRL-ALT depressed. /K=# 
  85.        provides plain F1 (with no CTRL-ALT) which is often used for 
  86.        help.
  87.  
  88.        You may load as many popup screen as you like, so long as you 
  89.        have enough memory. Each screen uses approximately 4.5K. If you 
  90.        do not specify a hotkey or use the same hotkey for each one you 
  91.        may pop them up in succession using the same key. The last one 
  92.        loaded will popup first.
  93.  
  94.        You may use alternative hotkeys (/K=1 /K=2 /K=3 for example) if 
  95.        you want to load several KWIKHELP screens with individual 
  96.        hotkeys. If you specify a shift character ("*" for example) use 
  97.        <CTRL-ALT-LEFT SHIFT>.
  98.  
  99.        BINARY FILES
  100.  
  101.        The color file must be a screen binary file, exactly 4000 bytes. 
  102.        It may be named anything. I use ".BIN" here for clarity. The file 
  103.        may be created with an ANSI editor or a screen saved on disk with 
  104.        a utility such as KWIGRAB (inluded in this package). KWIKHELP 
  105.        will not load the file unless it is precisely 4000 bytes.
  106.  
  107.        The standard PC screen is composed of 25x80 characters (2000). 
  108.        Each character has a color "attribute" in memory with the 
  109.        character. The attribute sets the foreground and background 
  110.        colors as well as foreground brightness and a blinking attribute. 
  111.        This means there are exactly 4000 bytes.
  112.  
  113.        The public domain is littered with ANSI graphic displays which 
  114.        you can convert into prompts. However, KWIKHELP does not 
  115.        recognise an ANSI file and you must edit it and convert it to 
  116.        binary. One of the best editors we have seen is the curiously 
  117.        named LAUGHING DOG available as LDOG*.ZIP from many shareware 
  118.        distributors and bulletin boards. (Currently LDOG114.ZIP).
  119.  
  120.        This is the BEST program for use with KWIKHELP and all round 
  121.        screen editing. It allows you to capture screens and turn them 
  122.        into ".BIN" files, ANSI files and self-displaying ".COM" files. 
  123.        As well, it can provide a screen as source code in several 
  124.        programming languages including BASIC, ASM, C, and PASCAL. Truly 
  125.        excellent.
  126.  
  127.        ───────────────────────────────────────────────────────────────-
  128.        KWIKGRAB.COM
  129.        ───────────────────────────────────────────────────────────────-
  130.  
  131.        KWIKGRAB.COM is an effective yet small "text screen grabber". It 
  132.        remains resident and uses about 5K of memory. Installation is 
  133.        simple:
  134.  
  135.           KWIKGRAB [/K=Hotkey] | [/U[nload]]
  136.  
  137.        The default hotkey combination is <CTRL-ALT-G>. You may change 
  138.        this each time you load using /K=x where "x" is the character 
  139.        used with CTRL-ALT depressed.
  140.  
  141.        If you specify a shift character ("*" for example) use <CTRL-ALT- 
  142.        LEFT SHIFT>.
  143.  
  144.        When the hotkey combination is pressed the contents of the 
  145.        current screen will be saved to a file. This will be a 4000-byte 
  146.        image of the screen with text and colors. The file will be 
  147.        suitable for use in my other programs such as COLRBOOT, KWIKHELP 
  148.        and KWIKVIEW.
  149.  
  150.        You may change directories without having to keep track of the 
  151.        files. KWIKGRAB saves files in the directory from which it is 
  152.        loaded. KWIKGRAB may be stored in a directory in your path and 
  153.        loaded from any drive or directory.
  154.  
  155.        Filenames begin with SCREEN00.BIN and the number is incremented 
  156.        with each screen. Existing files will not be overwritten. If the 
  157.        number exists KWIKGRAB will find the next available high number. 
  158.        If SCREEN99.BIN is reached KWIKGRAB increments the high digit 
  159.        from A-Z (from A0 to Z9).
  160.  
  161.        KWIKGRAB is careful not to crash into other programs (especially 
  162.        DOS). For example, you cannot save a screen to disk while DOS is 
  163.        formatting a disk!
  164.  
  165.        When the hotkey combination is pressed the current screen is 
  166.        stored in memory with a brief display (the display is only to 
  167.        tell you something happened). When a time slice is available 
  168.        (usually immediately) the memory is written to the disk file and 
  169.        the "OK" message flashes. 
  170.  
  171.        KWIKGRAB may be loaded high (LH). If DOS does not have enough 
  172.        space it will load it in conventional memory without telling you. 
  173.        It uses the same amount of memory as its physical size on disk.
  174.        KWIKGRAB must be loaded before Windows.
  175.  
  176.        KWIKGRAB can be unloaded from memory with the /U switch provided 
  177.        no subsequent programs have taken taken over certain memory 
  178.        locations.
  179.  
  180.        If KWIKGRAB encounters a critical error such as a full disk or a 
  181.        missing diskette for safety's sake it becomes disabled. You must 
  182.        unload it then reload it.
  183.  
  184.        ───────────────────────────────────────────────────────────────-
  185.        BIN2TEXT
  186.        ───────────────────────────────────────────────────────────────-
  187.  
  188.        BIN2TEXT converts ".BIN" files grabbed with KWIKGRAB (or any 
  189.        other screen binary files) to plain text files. It strips the 
  190.        color attributes and removes trailing spaces at the end of each 
  191.        line.
  192.  
  193.          BIN2TEXT FILE1 FILE2
  194.  
  195.        FILE1 is the source (".BIN") file and FILE2 is the text file you 
  196.        want to create. There are no switches. Screens saved with 
  197.        KWIKGRAB can be converted to text, edited with any plain word 
  198.        processor and used as help files with KWIKTEXT.
  199.  
  200.        ───────────────────────────────────────────────────────────────-
  201.        BIN2ASM, BIN2C, BIN2PAS
  202.        ───────────────────────────────────────────────────────────────-
  203.  
  204.        BIN2ASM converts ".BIN" files grabbed with KWIKGRAB (or any other 
  205.        screen binary files) to ASM data. This makes it easy to include a 
  206.        screen in an assembler language program. If you are not a 
  207.        programmer forget it. If you are a programmer it needs no more 
  208.        explanation. The data is divided into blocks for each line so 
  209.        clever folk can combine a portion of one screen with a portion of 
  210.        another. The other two are obviously for C and Pascal conversion.
  211.  
  212.        ───────────────────────────────────────────────────────────────-
  213.        KWIKVIEW
  214.        ───────────────────────────────────────────────────────────────-
  215.  
  216.        KWIKVIEW enable you to view ".BIN" screen image files. Usage is 
  217.        simple: KWIKVIEW FILENAME [/F]
  218.  
  219.        The optional /F switch will display the name of the file at the 
  220.        bottom of the screen. This is useful if you are viewing a 
  221.        sequence of saved screens using a batch file (see KV.BAT). The 
  222.        batch file is simply:
  223.  
  224.          FOR %%X IN (*.BIN) DO KWIKVIEW %%X /F
  225.  
  226.        From the command line use only a single "%" before the dummy 
  227.        argument "X".
  228.  
  229.        ───────────────────────────────────────────────────────────────-
  230.        ADDITIONAL NOTES
  231.        ───────────────────────────────────────────────────────────────-
  232.  
  233.        Some of the binary screen images with this collection are from my 
  234.        program COLOR BOOT. This program allows you to put any binary 
  235.        screen onto a non-system diskette. The screen will display if the 
  236.        user tries to "boot" from the disk. This $10 shareware program is 
  237.        available direct from me, on some BBS sites, or Internet:
  238.  
  239.            ftp://oak.oakland.edu/SimTel/msdos/bootutil/colrboot.zip
  240.  
  241.  
  242.        *** END OF FILE ***
  243.