home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / mex / mexsum.dqc / MEXSUM.DOC
Text File  |  1985-02-09  |  11KB  |  288 lines

  1. .he MEXSUM.DOC                                            page #
  2. .op
  3.  
  4.      MEX 1.0 Documentation Summary
  5.  
  6.           Compiled by John Wical
  7.  
  8. 3) Precepts
  9.  
  10. <filespec>     =    [<d><u>:][<filename>][.<ext>]
  11. <string>       =    must be surrounded by quotes ('"')
  12.                     caret ('^') prefixes a control char
  13. '*'            =    optional prefix to primary options
  14. ';'            =    multiple command separator (see STAT ESC)
  15.  
  16. /R    specifies a newline (Carriage return code only; same as ^M)
  17. /N    specifies carriage-return+linefeed
  18. /T    specifies a tab
  19. //    specifies the '/' character
  20. /Onnn specifies any binary value (except 0): nnn is the decimal 
  21.       value (all three digits must be present)
  22.  
  23. 4) Terminal mode
  24.  
  25. <ESC>-E         exits back to command level
  26. <ESC>-?         prints a menu of escape sequences
  27. <ESC>-S         start copying incoming text into file buffer
  28. <ESC>-U         end (un-start) copying text into file buffer
  29. <ESC>-P         toggle copy-to-printer on/off
  30. <ESC>-T         transmit a file to the remote 
  31.                 (prompts for a filename)
  32.  
  33. 5) Single-character commands (Primary options)
  34.  
  35. S: Send a file or group of files using Christensen protocol
  36. R: Receive a file or group of files using Christensen protocol
  37. T: Enter terminal mode
  38. E: Enter terminal mode with echo
  39. L: Enter terminal mode with local-echo only
  40.  
  41. 6) Secondary commands (Secondary options)
  42.  
  43.                         COMMANDS
  44. OPT       NAME          USED WITH       ACTION
  45. ---     --------        ---------       ------
  46. A       Append          E,L,T           Append to a file
  47. B       Batch           R and S         BATCH file transfers
  48. D       Disconnect      R and S         Disconnects after transfer
  49. L       Local           T,E             Local-character echo
  50. Q       Quiet           R and S         "quiet mode" file transfer
  51. R       Recv-view       R and S         Shows received-chars only
  52. S       Send-view       R and S         Shows trans chars only
  53. T       Terminal-mode   R and S         Enter Term after file xfer
  54. V       View            R and S         Views the file transfer 
  55. X       Exit            R and S         Disconnect,exit after xfer
  56.  
  57. .pa
  58.  
  59.      MEX 1.0 Command Summary
  60.  
  61. ALT <Drive><user>:  - drive + user to search for MEX LOAD files 
  62.                          (.PHN, .KEY)
  63.  
  64. BYE                 - exit to CP/M, modem not disconnected
  65.  
  66. CALL <numblist> [ # [ <retries> ] ]
  67.                     - dials <numblist> and stops after <retries> 
  68.                       goes into 'T'erminal mode when a computer 
  69.                          is reached
  70.                     - if no argmnt, phone lib listed 
  71.                          and prompts for numb to call
  72.  
  73. CLONE <filespec>    - saves MEX with defined phone numbers and 
  74.                          keystrings
  75.                       default filename = '        .   '
  76.  
  77. COLD                - restarts MEX. clears defined phone numbers 
  78.                          and keystrings
  79.  
  80. CPM                 - (same as BYE)
  81.  
  82. DEL                 - deletes open capture file
  83.  
  84. DIAL <numblist> [ # [ <retries> ] ]
  85.                     - dials <numblist> and stops after <retries> 
  86.                       returns to COMMAND mode when a computer is 
  87.                          reached
  88.  
  89. DIR <filespec>      - display directory
  90.                       defaults to logged DU:*.*
  91.  
  92. DSC                 - disconnedts modem (not implemented in all)
  93.  
  94. ERA <filespec> [V]  - erase file
  95.                     - [V] will ask for verification before 
  96.                          erasing each file
  97.  
  98. GLOBAL <2ndopt>     - cause secondary option <2ndopt> to be on 
  99.                          for all primary options
  100.  
  101. EXIT                - (same as BYE)
  102. .pa
  103. HELP <topic>        - provides help information on <topic>
  104.                       <topic>='?' will list the available topics
  105.                       NOTE:  HELP.MEX is opened with this command 
  106.                          and can be close only with a LOG command
  107.  
  108. ID <string>         - set <string> for MEX's prompt
  109.                       NOTE:  default length=28 chars
  110.  
  111. KEY [ <key>=[ <string> ] ]
  112.                     - define <key> (1 char) to <string>
  113.                       if <string> is omitted, <key> is erased
  114.                       if all arguments omitted, <keys>s listed
  115.                       invoked in 'T'erm mode with '<esc><key>'
  116.                       affected by STAT switch WTECHO
  117.  
  118. LOAD <filespec>     - load MEX's LOAD files (.KEY,.PHN)
  119.  
  120. SAVE <filespec>     - save MEX's LOAD files (.KEY,.PHN)
  121.  
  122. LOG <du>:           - reset and log to <du>:
  123.  
  124. PHONE [<name>=[<number> [<bps>]]]
  125.                     - set <name> equivalent to <number> with baud 
  126.                          rate set to <bps> whenever used
  127.                       if <number> [<bps>] omitted, <name> erased
  128.                       if all argmts omitted, phone <name>s listed
  129.  
  130. PREFIX [<string>]   - set <string> to be sent before SENDOUT 
  131.  
  132. SUFFIX [<string>]   - set <string> to be sent after SENDOUT
  133.  
  134. READ <filespec> [parmlist]
  135.                     - execute batch file <filespec>
  136.                       <filespec> may contain any valid MEX 
  137.                          command except READ
  138.                       default ext = '.MEX' (ext='.   ' illegal)
  139.                       ^C aborts
  140.                       execution stops while in 'T'erminal mode
  141.                       (see also STAT variables :  EXTEND, SILENT)
  142.                       braces ({}) may be used for command line 
  143.                          param to include imbedded spaces
  144.  
  145. {<parmno>:[ <default parm> ]}
  146.                     - parms in READ's <filespec>
  147.                       NOTE:  <default parm> does not define, it 
  148.                          just provides the <parm> for the 
  149.                          occation it is used
  150. .pa
  151. REN <newfile>=<oldfile>
  152.                     - renames <oldfile> to <newfile>
  153.                       both names must be on same <du>
  154.  
  155. SENDOUT <string>    - send <string> to remote
  156.                       affected by commands :  PREFIX, SUFFUX
  157.                       STAT var : WTECHO, RETRY, CANCHR, TRIGGER
  158.  
  159. SET                 - (defined by overlay)
  160.  
  161. SLEEP <no-secs>     - invokes delay.  ^C aborts
  162.                       useful in testing STAT's CLOCK
  163.                       useful in READ files
  164.  
  165. STAT [<keyword> [<newvalue>] ]
  166.                     - set <keyword> variable to <newvalue>
  167.                       if <newvalue> omitted, present value shown
  168.                       if <keyword>='?', variables are listed
  169.  
  170. TYPE <filespec> [P] - display contents of <filespec> on screen
  171.                       if 'P' is present, STAT PAGE variable is 
  172.                          reversed
  173.  
  174. SYSTEM              - (same as BYE)
  175.  
  176. WRT                 - writes, closes open capture file to disk
  177.  
  178.  
  179. .pa
  180.  
  181.      MEX 1.0 STAT variables
  182.  
  183. for {on|off} variables, the 'on' option is provided
  184.  
  185.  
  186. ALERT <val>         - set # of beeps made when a connection with 
  187.                          a remote system is made resulting from a 
  188.                          repeating CALL or DIAL 
  189.  
  190. BAKFILE {on|off}    - change file to backup
  191.                       else ask for erasure
  192.  
  193. BELL {on|off}       - bell sent at all prompts in MEX
  194.  
  195. BUFFER              - displays capture buffer stats (size, usd, spc)
  196.                       displays batch-filenames buffer size
  197.  
  198. TRIGGER <char>      - sets <char> to wait for before SENDOUT
  199.  
  200. CANCEL <char>       - sets <char> to continue SENDOUT until
  201.  
  202. CHAR                - lists status of all CHARacter variables
  203.  
  204. CHECKSUM {on|off}   - set file transfer verification method
  205.                       mutually exclusive with CRC
  206.  
  207. CRC {on|off}        - set file transfer verification method
  208.  
  209. CIS {on|off}        - special file transfer protocol used by 
  210.                          Compuserve in Term mode
  211.  
  212. CLOCK <val>         - set clock speed in Mhz*10
  213.                       <val> = 1 to 255 => .1 to 25.5 Mhz
  214.  
  215. DEBUG {on|off}      - incoming data in Terminal mode
  216.                       displayed in DDT's Dump format.
  217.                       disables FILTER and CIS when 'on'
  218.  
  219. HEX {on|off}        - set default radix for MEX
  220.                       including SLEEP, VAL, file transfers
  221.                       number prefixes: $=hex, #=decimal
  222.                       mutually exclusive with DECIMAL
  223.  
  224. DECIMAL {on|off}    - set default radix for MEX
  225.  
  226. ERRID {on|off}      - print ID's string at MEX's prompt
  227.  
  228. EXCLUDE {on|off}    - ignore SYS files when <filespec> is ambig
  229.  
  230. EXTEND {on|off}     - cause illegal MEX commands to be 
  231.                          interpreted as READ commands
  232.  
  233. ESC <char>          - define Term mode escape char
  234. .pa
  235. FILTER {on|off}     - ignore uncommon control chars 
  236.                       (other than CR, LF, BS, TAB)
  237.  
  238. INITFILE {on|off}   - search for INI.MEX when booting MEX
  239.  
  240. LF {on|off}         - add LF to all CR in Term file transfers
  241.  
  242. LIST {on|off}       - enable LST device
  243.  
  244. PAGE {on|off}       - paginate TYPE scrolling
  245.  
  246. REPLY [<val>]       - set time (0-255 secs) for SENDOUT to wait 
  247.                          for a reply from remote system
  248.                       if no argmnt, present setting is shown
  249.  
  250. RETRY [<val>]       - set SENDOUT retries (1-255) before aborting
  251.                       WTECHO must be on
  252.                       if no argmnt, present setting is shown
  253.  
  254. RTIME <val>         - set wait (1-30 secs) before timeout 
  255.  
  256. RUB {on|off}        - backspaces sent converted to rubs
  257.  
  258. SEARCH <val>        - set search pattern used for READ files, 
  259.                          phone libraries, keystring files, and 
  260.                          capture files (with Append option)
  261.                       0 - logged DU     2 - logged DU, ALT
  262.                       1 - ALT           3 - ALT, logged DU
  263.  
  264. SPLIT {on|off}      - phone library listed 1 per line with bps
  265.                       else listed 2 per line without bps
  266.  
  267. SILENT {on|off}     - suppress echo of READ file command lines
  268.  
  269. SWITCH              - list all '{on|off}' variables
  270.  
  271. VAL                 - list all <val> variables
  272.  
  273. WCHAR <val>         - delay after each char (0-9 in 10s of ms)
  274.  
  275. WLINE <val>         - delay after each line (0-9 in 100s of ms)
  276.  
  277. WTECHO {on|off}     - verify commands sent with their echo
  278.                       halves transmission time
  279.  
  280. SEP <char>          - set command separator for mult. cmd lines
  281.  
  282. XLINE {on|off}      - for Term mode file transfers
  283.                       waits for XON after each line (uncommon)
  284.  
  285. XON {on|off}        - for Term mode file transfers
  286.                       sends until XOFF, continues at XON
  287.  
  288. ...