home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / dev / asm / ssl / sslexamp / readme < prev    next >
Encoding:
Text File  |  1994-07-01  |  6.5 KB  |  230 lines
  1.  
  2.                           SS.Library Example Programs
  3.  
  4.                                    Release 2
  5.  
  6.                 Written by Martin Mares, MJSoft System Software
  7.  
  8. ================================================================================
  9.  
  10.  
  11. Preface
  12. =======
  13.  
  14.    This directory contains some useful utilities, which use the ss.library.
  15. Assembly source files (#?.asm) are included.
  16.  
  17.    All files in this archive may be freely distributed and modified without
  18. any restrictions.
  19.  
  20.    All the utilities require Kickstart 2.04 or higher and the ss.library.
  21.  
  22.    Everything except NewAlertHook is PURE and can be made RESIDENT.
  23.  
  24.  
  25. WHAT'S NEW IN THIS RELEASE:
  26. ---------------------------
  27.  
  28. Inf 1.1 - displaying of unknown filesystem types corrected ; $VER added
  29. NewAlertHook 40.3 - some small bugs removed ; EXEC conditionals added
  30.    for easy inclusion in RAM kickstart.
  31. AsmCheck removed
  32. FSort added
  33. RemDev added
  34.  
  35.  
  36. Inf
  37. ===
  38.  
  39.    This small utility is similar to the standard Info command, but displays
  40. much more information about the devices followed by short description of
  41. available memory.
  42.  
  43. Inf output is divided to nine columns:
  44.  
  45. Device - name of DOS device (for example DF0:)
  46.   Size - disk size
  47.   Free - free space
  48.   Free - free space in percents of total capacity
  49.   Stat - status - R/W=Read/Write,VAL=Validating,R/O=Read Only
  50.    Err - number of errors detected during disk access
  51.   Type - filesystem type (OFS,FFS,OFSI=OFS INTL,FFSI=FFS INTL,OFSC=OFS DIRC
  52.                           FFSC=FFS DIRC,MSD=MSDOS,MSDD=MSDOS DD)
  53.  Block - block size
  54. Volume - volume name
  55.  
  56. The device information is followed by summary of Chip, Fast and Slow (C0-RAM)
  57. memory: <RAM name> : <free space> (<largest>) of <total size>.
  58.  
  59.  
  60. DVIType
  61. =======
  62.  
  63.    Analyser of TeX Device Independent output files.
  64.  
  65. Usage: DVIType <DVI File>
  66.  
  67. Output syntax: <address> <command> [<parameters>]
  68.  
  69. For command summary see source text of TeX.
  70.  
  71.  
  72. AddModule
  73. =========
  74.  
  75.    AddModule is able to install resident modules to KickTag and KickMem lists,
  76. which makes them reset-proof.
  77.  
  78. Syntax: AddModule <ModuleName> [CLASS <class>] [PRI <pri>] [INIT]
  79.  
  80. ModuleName - name of resident module you want to install
  81.      class - module class 0-127 (see exec/resident.i). The seventh bit cannot
  82.              be overriden
  83.        pri - module priority -128-127
  84.  
  85.    You may also try to install usual libraries and devices as resident modules.
  86. In this case, specify CLASS 4 and PRI -128. If some library uses some other,
  87. try to arrange the priorities in appropriate order. The ss.library can be
  88. installed by this way.
  89.  
  90.  
  91. NewAlertHook
  92. ============
  93.  
  94.    This is a resident module (must be installed by AddModule) replacing
  95. standard alert display mechanism by slightly improved routine, which is
  96. able to show error text and name of process causing the error. The module
  97. itself doesn't require the ss.library.
  98.  
  99.    Thanks to Brian Gontowski for inspiration (InstallNewAlert). This one
  100. is only 3K long.
  101.  
  102.    Currently includes all alerts up to those generated by kickstart 3.0.
  103.  
  104.  
  105. TwoWindows
  106. ==========
  107.  
  108.    An useless example of asynchronous file I/O. Opens two console windows
  109. labeled "First Window" and "Second Window". Any text written to the first
  110. one is copied to the second one and vice versa. To abort the program,
  111. enter CTRL-\ (EOF) in both windows.
  112.  
  113.  
  114. KeyRes
  115. ======
  116.  
  117.    KeyRes is a keymap analyser. It takes a keymap file and disassembles it
  118. to special source file.
  119.  
  120. Syntax: KeyRes <from> [<to>]
  121.  
  122.   from - name of keymap to be disassembled. It can be stored in RAM or on
  123.          a disk.
  124.     to - name of file to store the output to. Default is <from>.kms.
  125.  
  126. Keymap source file is a sequence of key definition blocks, which have the
  127. following syntax:
  128.  
  129. [<KEY TYPE>] KEY <NAME> [{<QUAL>}] [CAPS]
  130. <followed by several lines of key meanings>
  131.  
  132.   Key type - can be DEAD, STRING or empty
  133.       Name - key name (described below)
  134.       Qual - qualifiers affecting processing of this key (SHIFT, ALT, CTRL)
  135.       CAPS - set if CAPS LOCK act as SHIFT
  136.  
  137. Key names:
  138.  
  139. TILDE, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, ZERO, MINUS,
  140. EQUAL, BACKSLASH, K0, Q, W, E, R, T, Y, U, I, O, P, LBRACK, RBRACK, K1, K2,
  141. K3, A, S, D, F, G, H, J, K, L, SEMICOLON, APOSTROPHE, HASH, K4, K5, K6,
  142. LESS, Z, X, C, V, B, N, M, COMMA, DOT, SLASH, KDOT, K7, K8, K9, SPACE,
  143. BACKSPACE, TAB, KENTER, ENTER, ESC, DEL, KMINUS, UP, DOWN, RIGHT, LEFT, F1,
  144. F2, F3, F4, F5, F6, F7, F8, F9, F10, KLBRACK, KRBRACK, KSLASH, KASTERISK,
  145. KPLUS, HELP, LSHIFT, RSHIFT, CAPSLOCK, CONTROL, LALT, RALT, LAMIGA, RAMIGA.
  146.  
  147. Key meaning:
  148.  
  149. Normal keys        [<QUAL>] '<character>' | <character code>
  150.                |        |
  151.                |        *--- character generated by this key
  152.                |
  153.                *-- qualifiers of this meaning (SHIFT,ALT,CTRL)
  154.                |
  155. String keys        [<QUAL>] "<string>"
  156.                |         |
  157.                |         *--- string generated by this key
  158.                |            use "" or \" for double quotes
  159.                |            use \cc for hex. char. code
  160.                |
  161.                |
  162. Dead keys        [<QUAL>] '<character>' | <character code>
  163.                |        |
  164.                |        *-- code of meaning not affected
  165.                |            by prefix (dead) keys
  166.             [<QUAL>] PREFIX <num>
  167.                |          |
  168.                |          *-- # of prefix generated by this key
  169.             [<QUAL>] PREFIX <p1>,<p2>
  170.                |   used if prefix has to be pressed twice to get
  171.                |   some other meaning. In this case, the final
  172.                |   prefix code is <p1_of_first_prefix> *
  173.                |   <p2_of_second_prefix> + <p1_of_second_prefix>.
  174.             [<QUAL>] MOD { '<char>' | <code> , ... }
  175.                     |
  176.                     *-- meaning modified by dead keys
  177.                         contains list of characters -
  178.                         - for each prefix code one char.
  179.  
  180.  
  181. KeyComp
  182. =======
  183.  
  184.    Keymap compiler - does reverse process to KeyRes. Useful for creating
  185. of keymaps in non-interactive way.
  186.  
  187. Syntax: KeyComp <source> [<dest>]
  188.  
  189.    source - source file (.kms is appended if there's no extension in it)
  190.      dest - destination file (if omitted, source file name without extension
  191.         is substituted)
  192.  
  193.  
  194. FSort
  195. =====
  196.  
  197.    Very fast file sorting utility (analogous to C:Sort).
  198.  
  199.    Speed comparison (280K file, on GVP A530 Turbo - 68EC030 40MHz)
  200.  
  201.     original C:Sort 37.3    36 seconds    380K used
  202.     ARP Sort        27 seconds    317K used
  203.     FSort            4.9 seconds    334K used
  204.  
  205. Syntax: FSort [<source> [<dest>]] [CASE]
  206.  
  207.    source - source file (standard input if omitted)
  208.      dest - destination file (standard output if omitted)
  209.      CASE - perform case-dependent sorting
  210.  
  211.    Destination identical to source is allowed.
  212.  
  213.  
  214. RemDev
  215. ======
  216.  
  217.    Device remover for handler debugging.
  218.  
  219. Syntax: RemDev <device> [FORCE]
  220.  
  221.    device - device to be removed
  222.     FORCE - remove even if ACTION_DIE refused.
  223.  
  224.  
  225. Final words
  226. ===========
  227.  
  228.    Send bug reports and suggestions to mjsoft@k332.feld.cvut.cz.
  229.  
  230.