home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PASCAL / TMODEM.ZIP / TMODEM.DOC < prev    next >
Encoding:
Text File  |  1987-06-15  |  12.5 KB  |  241 lines
  1.  
  2.                            Documentation for TMODEM
  3.  
  4.       TMODEM is short for Turbo Modem.  A communications program for IBM
  5.       Personal Computers and compatible units.  TMODEM is supplied with
  6.       source code in Turbo PASCAL version 3.00B, the user is encouraged
  7.       to customize this code as he wishes, but he must not remove, bypass,
  8.       or alter the copyright notice presented by the program.  The author,
  9.       Paul Meiners, and his company, P & M Software, reserve the copyright
  10.       to this program and all related materials.  The user is granted a
  11.       license to use the program and is encouraged to make a donation if
  12.       the program is found to be useful.  $10 is recommended.  Send
  13.       donations to the following address:
  14.  
  15.                           P & M Software Company
  16.                           9350 Country Creek #30
  17.                           Houston, Texas 77036
  18.  
  19.       In addition, the user is granted the right to make unlimited copies
  20.       of the program and to distribute these copies as he desires, except
  21.       that the author reserves the sole right to distribute the program
  22.       for profit.  The user may ask for a duplication charge, not to exceed
  23.       $5 per copy.
  24.  
  25.       Why distribute another modem program?  There are plenty of them around,
  26.       commercial, user supported and public domain.  Answer: To make available
  27.       customizable code, as PC-TALK did, but in a classier language, PASCAL.
  28.       Our hope is that people will become exposed to PASCAL and will support
  29.       it in a serious manner, the way BASIC has been supported.
  30.  
  31.       Features:
  32.  
  33.          1. TTY emulation.
  34.          2. ANSI.SYS style color graphics.
  35.          3. BASIC style PLAY for single voice music.  Nice, but due
  36.             to PASCAL's limited sound capability, it plays in foreground,
  37.             so the serial input buffer may wrap around while the music
  38.             plays.  The serial input buffer contains 5k bytes.
  39.          4. Fully buffered, interrupt driven, serial I/O.
  40.          5. XMODEM file transfer.
  41.          6. Removable window subsystem.
  42.          7. Telephone directory, with up to 999 entries.
  43.          8. File capture, limited only by the amount of available
  44.             memory.
  45.          9. ASCII file transmission, using XON/XOFF protocol.
  46.         10. Utility package of BASIC style procedures and
  47.             functions.
  48.         11. Full control of all communication parameters.
  49.         12. 40 macro keys, to store logon, passwords, etc.
  50.  
  51.  
  52.       Most of the features of the program are self-documenting, however
  53.       for the sake of the novice user, some explanation is necessary.
  54.  
  55.          The program is distributed in both .COM and .PAS form.  The
  56.          .COM version can be executed immediately by placing your disk
  57.          into drive A, changing the default drive to A, if not already,
  58.          then typing the name of the program, TM.  The .PAS form is
  59.          available for users who want to customize the program, the real
  60.          reason the program was written!  In order to customize the
  61.          the program, the user must possess the Turbo PASCAL compiler,
  62.          version 3.00B or better.  Needless to say, the user must also
  63.          have some familiarity with PASCAL...
  64.  
  65.          Once the user has successfully executed the program, the copy-
  66.          right notice will appear, and the user will be asked if music
  67.          is wanted, strike a "y" if you want music, if not, then strike
  68.          any other key.  The on-line screen will then appear.  At the
  69.          bottom of the online screen appears a reminder of the most
  70.          frequently used commands.  These commands may be selected by
  71.          depressing and holding the ALT key along with the indicated ALPHA
  72.          key.  If the user needs a command that does not appear on the screen,
  73.          a complete list of available commands can be obtained by selecting
  74.          ALT-H.  Commands may be selected while the HELP screen is still on
  75.          screen, so that the user does not need to call up the HELP screen
  76.          repetitively.  Here is a brief description of each command:
  77.  
  78.          ALT-T .... Terminate and return to DOS.
  79.                     If other windows are open on the screen, this command
  80.                     will be deferred until all windows have been closed.
  81.  
  82.          ALT-R .... Receive a file using XMODEM protocol.
  83.  
  84.          ALT-X .... Transmit a file using XMODEM protocol.
  85.  
  86.          ALT-A .... Transmit a file using the ASCII XON/XOFF protocol,
  87.                     where the DC1 character is used for XON and the
  88.                     DC3 character is used for XOFF.
  89.  
  90.          ALT-C .... Turn capture mode ON if it is OFF, or OFF if it is ON.
  91.                     When this mode is turned OFF, either thru the ALT-C
  92.                     command or with the ALT-T command, the user will be
  93.                     prompted for a file name wherein to save the contents of
  94.                     the capture buffer.  During capture mode operations, a
  95.                     '*' or 'W' will appear in the lower left corner of the
  96.                     screen.  The '*' reminds the user that capture mode
  97.                     is ON, the 'W' warns the user that memory space is
  98.                     short.  Capture mode will make use of all available
  99.                     memory.  Capture mode is useful for recording complete
  100.                     sessions for review later, so you don't read so much
  101.                     on those long distance phone calls.
  102.  
  103.          ALT-L .... Display disk directory, under a user supplied mask.
  104.                     For example, to see all files on the logged drive
  105.                     and current directory, the user would enter the mask
  106.                     "*.*", when prompted.   Or see just the files with an
  107.                     extension of .PAS by entering the mask "*.pas", when
  108.                     prompted.
  109.  
  110.          ALT-N .... Allows the user to change to a new logged drive and/or
  111.                     new current directory.
  112.  
  113.          ALT-V .... View the contents of a file, uses the same style as
  114.                     MORE, the DOS utility.
  115.  
  116.          ALT-K .... Kill a file.  Delete a file from the disk.
  117.  
  118.          ALT-M .... Macro key management.  Allows the user to define the
  119.                     contents of the function keys F1 thru F10, and all
  120.                     combinations of the function keys and shift, Ctrl or
  121.                     Alt.  This gives the user 40 different macro keys.
  122.  
  123.          ALT-H .... Produces the HELP screen for the user.
  124.  
  125.          ALT-S .... Switch communication parameters.  The program starts
  126.                     with these default values: 1200 baud, No Parity,
  127.                     8 data bits, 1 stop bit.  Permissible values for the
  128.                     baud rate are: 300, 1200, 2400.
  129.  
  130.          ALT-D .... Modem dialing and phone directory management.
  131.                     The phone directory may have up to 999 entries,
  132.                     if there is enough disk space.
  133.  
  134.          ALT-O .... Sort the dialing directory into ascending sequence
  135.                     by name.  Performs a IN MEMORY sort, so there must
  136.                     be enough memory to hold all the phone directory
  137.                     entries.
  138.  
  139.          ALT-G .... Redial the last number dialed.
  140.  
  141.          ALT-E .... Turn Half Duplex ON if it is OFF, or OFF if it
  142.                     is on.  If Half Duplex is ON, then a 'H' will
  143.                     appear in the lower right corner of the screen to
  144.                     remind the user.
  145.  
  146.          ALT-Q .... Hang-up the phone line, put the modem "ON HOOK".
  147.                     Drops the terminal ready signal to the modem for 3
  148.                     seconds and resets the UART.
  149.  
  150.          ALT-W .... Clear the screen.
  151.  
  152.          ALT-P .... Play a tune, at random, from the several tunes
  153.                     prestored in the program.
  154.  
  155.       The dialing management sub-section has a list of commands also:
  156.  
  157.           A = Add an entry to the dialing directory.
  158.           C = Change an entry in the dialing directory.
  159.           D = Delete an entry in the dialing directory, a sort of the
  160.               directory is recommended after this option or the Add option.
  161.           M = Dial a number not in the directory.
  162.           G = Dial a number that is in the directory.
  163.           S = Stop the modem, after it has dialed, but before it goes online.
  164.               This allows you to dial another number when a previous number
  165.               is busy, without waiting for the modem to timeout waiting for
  166.               carrier.
  167.           F = Display the next page of the directory.
  168.           B = Display the previous page of the directory.
  169.           Q = Quit, returns to the online screen.
  170.  
  171.       Note: When editing Phone Directory entries or Macro Key definitions,
  172.             the program responds to the following editing keys as indicated:
  173.  
  174.             Backspace .... Delete character to the left of cursor.
  175.             Del .......... Delete character under the cursor.
  176.             End .......... Move the cursor to the end of the field.
  177.             Ins .......... Toggle between insert and overwrite mode.
  178.                            When in insert mode the cursor becomes fat.
  179.             Left Arrow ... Move the cursor to the left 1 position.
  180.             Right Arrow .. Move the cursor to the right 1 position.
  181.  
  182.       There are several files associated with the system.  Here is a
  183.       description of each:
  184.  
  185.          TM.COM ......... Absolute program.  The one to execute.
  186.          TM.PAS ......... The main program module, source code.
  187.          TMODEM.IN1 ..... An Include file, source code.
  188.          TMODEM.IN2 ..... An Include file, source code.
  189.          MUSIC.INC ...... The musical Include file, source code.
  190.          RWINDOW.INC .... The windowing Include file, source code.
  191.          DIRECT.INC ..... The file management Include file, source code.
  192.          BASIC.INC ...... The BASIC style Include file, source code.
  193.          TMODEM.DIR ..... The phone directory, data file.
  194.          TMODEM.KEY ..... Macro key definitions, data file.
  195.          TMODEM.CNF ..... The configuration, data file.  You may need
  196.                           to edit the configuration file, using EDLIN or
  197.                           other DOS compatible editor, so here is a detailed
  198.                           examination of the file:
  199.  
  200.                 In position 1-3 of each record in the configuration
  201.                 file is a code to identify a parameter.  After the
  202.                 "=" the value of the parameter appears.
  203.                 The codes are:
  204.  
  205.                            ST=  Stopbits
  206.                            DA=  Databits
  207.                            PA=  Parity. 0=None,1=Even,2=Odd
  208.                            BA=  Baud Rate. 300,1200 or 2400.
  209.                            WA=  Number of ticks in 1/3 of a second,
  210.                                 at 4.77 MHz clock.  The value should be
  211.                                 larger if the clock is faster.
  212.                                 The units for the value is milleseconds,
  213.                                 and it is used for waiting, hence the WA=.
  214.                            PR=  Dialing Pre String.
  215.                            PO=  Dialing Post String, use the | character
  216.                                 where a RETURN is needed.
  217.                            MI=  Modem initialization string.
  218.                                 The default value, AT S0=0, will cause the
  219.                                 modem not to answer the phone.  Again, use
  220.                                 the | character where a RETURN is needed.
  221.                            * =  Comment lines.
  222.  
  223.             For Example:   ST=1
  224.                            DA=8
  225.                            PA=0
  226.                            BA=1200
  227.                            WA=333
  228.                            PR=ATDT
  229.                            PO=|
  230.                            MI=AT S0=0|
  231.  
  232.  
  233.       The program has been written to use Hayes compatible commands
  234.       with the modem.  If your modem is not compatible, the program
  235.       must be customized.  This should be a simple process if you are
  236.       familiar with PASCAL and have a copy of the Turbo compiler. Also,
  237.       the program controls the modem via the DTR signal, terminal ready,
  238.       so the cable between the computer and modem must provide a connection
  239.       for pin 20 and the modem should have the internal switches set so
  240.       that the DTR signal is monitored.
  241.