home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / comm / wterm.zip / WTERM.DOC < prev    next >
Text File  |  1990-04-30  |  11KB  |  262 lines
  1.                                  \/\/term
  2.  
  3.          WTERM is a small bare bones comm program.  Users with 
  4.          limited disk and/or memory may find it useful.  There is 
  5.          no script language and no terminal emulation.  You must 
  6.          have ANSI.SYS loaded in order to use the program.  It 
  7.          works fine for most bulletin boards.  There are no built 
  8.          in protocols - WTERM relies on DSZ Zmodem for file 
  9.          transfers.
  10.  
  11.          The program will write a log file, and you may view it
  12.          with LIST while on line.  An editor of your choice can 
  13.          be configured and loaded with a function key.
  14.  
  15.  
  16.          Setup
  17.  
  18.          Before loading WTERM, prepare a configuration file with 
  19.          an ASCII editor and name it WTERM.CFG.  The following 
  20.          options are allowed:
  21.  
  22.          PORT - the comm port WTERM is to use.  The default comm 
  23.          port is COM1.
  24.  
  25.          INIT - the initialization string to send to the modem 
  26.          when WTERM loads.
  27.  
  28.          EDITOR - the name of your editor you wish to be loaded 
  29.          when you press the F10 key.  
  30.  
  31.          NAME - your name as you would want it transmitted when 
  32.          you press the F2 key at a name prompt.  A carriage 
  33.          return is appended to the end of this string.
  34.  
  35.          UPLOAD - the drive an path to your upload directory.  
  36.          This is the path that will be used for Zmodem uploads.  
  37.          It may be edited when you are asked for the name of the 
  38.          file to send.  Include a trailing backslash on this 
  39.          line.
  40.  
  41.          PARAM - enter the maxium speed of your modem.  The next 
  42.          parameter is parity.  Use N for None, O for Odd and E 
  43.          for even.  This is followed by the bits per character 
  44.          and should be 8 for None or 7 for parity.  The last 
  45.          digit is the number of stop bits.   There should be no 
  46.          spaces between these parameters: 2400N81.
  47.  
  48.          F4-F8 - you may assign any string you wish to these 
  49.          function keys.  No carriage return is appended but you 
  50.          may send one by using a "|" character at the end of a string.
  51.          A tilde (~) will cause a 1 second pause.
  52.  
  53.          DSZUP - The string you include after this option is 
  54.          exactly what will be run from DOS when you do an upload.  
  55.          You don't have to use DSZ Zmodem, you could use the 
  56.          public domain Zmodem PCZ if you desire.  You can call a 
  57.          batch file or call the program directly.
  58.  
  59.          DSZDN - The string sent to DOS for a download.  The 
  60.          comments for DSZUP apply here as well.
  61.  
  62.          Here is a sample .CFG file:
  63.  
  64.          port com1
  65.          init atx4m3s11=40
  66.          editor edwin
  67.          name John Doe
  68.          upload c:\uplds\
  69.          param 2400N81
  70.          f4 mff*
  71.          f5 gyn|
  72.          f6 +++~~~ATH0|
  73.          f7 a/
  74.          f8 -John-|
  75.          DSZUP DSZ z pL1024 sz
  76.          DSZDN DSZ rz -y
  77.  
  78.          Case makes no difference except in NAME, the F4-F8 
  79.          strings and the DSZUP and DSZDN strings. Everything
  80.          else is converted to uppercase anyway.  The first words
  81.          in the above lines are the only ones recognized.  Each line
  82.          must begin on the first column with one space separating
  83.          the first word from the next word.
  84.  
  85.          You can specify a drive and path for the .CFG and .DIR
  86.          files that WTERM will use by using command line options.
  87.          To specify a .CFG file in other than the default directory,
  88.          use a command line option of:
  89.  
  90.                 WTERM C[drive][path]filename
  91.  
  92.          For a different phone directory use the -F option
  93.  
  94.                 WTERM -F[drive][path]filename.
  95.  
  96.  
  97.          Editing the Dialing Directory
  98.  
  99.          After editing the .CFG file, load WTERM and edit the phone
  100.          directory by typing ALT-E.  Type ALT-P to display your
  101.          passwords before you do this; otherwise they won't show
  102.          up when the directory is displayed.  The default is to
  103.          hide the passwords; it is toggled on/off by typing ALT-P.
  104.  
  105.          Start with entry 1.  Only entries up to the first blank
  106.          entry will be displayed when you type ALT-D. Up
  107.          to 20 entries are allowed.
  108.  
  109.          Dialing a Number
  110.  
  111.          When you dial a number from the dialing directory, the
  112.          parameters you have entered in the dialing directory, such
  113.          as 2400N81, are used.  Once you connect with a BBS and get
  114.          to the name prompt, hit F2 to send your name.  At the
  115.          password prompt, type F3 and the password from your dialing
  116.          directory will be transmitted.
  117.  
  118.          File Transfers
  119.  
  120.          The only provision for file transfers is through the use 
  121.          of DSZ Zmodem externally.  When downloading, the program 
  122.          will automatically detect the Zmodem download string and 
  123.          download the program automagically.  For uploading, 
  124.          WTERM detects the upload string and prompts you for a 
  125.          filename.  PgDn works manually for downloads and PgUp 
  126.          for uploads.
  127.  
  128.  
  129.  
  130.          Operation
  131.  
  132.          F1 displays a Help screen.  Hit any key to resume and the
  133.          screen will be restored.  The following functions may be 
  134.          found on the help menu:
  135.  
  136.          ALT-X  eXit WTERM back to DOS
  137.          ALT-J  Jump to DOS
  138.          ALT-H  Hangup
  139.          ALT-C  Clear the screen
  140.          ALT-D  Dial a number from the dialing directory
  141.          ALT-E  Edit the dialing directory
  142.          ALT-P  Hide and unhide Passwords in the dialing directory
  143.          ALT-N  Exit the program leaving DTR and RTS high
  144.          PgUp   Transmit a file using DSZ Zmodem
  145.          PgDn   Receive a file using DSZ Zmodem (in case Auto Zmodem
  146.                 dosn't work)
  147.  
  148.          F1     Help Menu
  149.          F2     Transmit your name
  150.          F3     Transmit your password
  151.          F4-F8  Transmit sting from .CFG file
  152.          F9     Load LIST for file viewing
  153.          F10    Load your Editor
  154.  
  155.  
  156.          Using the Dialing Directory
  157.  
  158.          ALT-D will bring up the dialing directory.  The size of 
  159.          the directory will grow with the number of entries in 
  160.          the .DIR file.  You can scroll the light bar through the 
  161.          dialing directory with the arrow keys, both up and down.  
  162.          The home key takes you back to entry one.  Pressing 
  163.          enter will cause the entry at the light bar to be 
  164.          dialed.  The entry will be dialed once.  If no 
  165.          connection is made, there will be no redial.  The first 
  166.          10 entries in the directory can be dialed with hotkeys.  
  167.          Pressing 1 will dial entry 1.  Entry 10 is dialed by 
  168.          pressing 0.  
  169.  
  170.          Single entries can be made to redial by pressing the R 
  171.          key.  Press ESC to stop the dialing.  This is the old 
  172.          method of redialing.  There is also a Que dial.  By 
  173.          hitting Q, you may mark entries you wish to dial.  
  174.          Select an entery with the light bar and press space.  
  175.          The spacebar is a toggle.  Pressing it once will mark an 
  176.          entry and pressing it again will delete the entry.  A 
  177.          check mark will be displayed by the marked entries and 
  178.          pressing enter will cause these entries to be dialed.  
  179.          When a connection is made, that entry will be removed 
  180.          from the Que.  The next time you enter the dialing 
  181.          directory, the rest of the Que will still be marked and 
  182.          pressing enter will dial the next entry.  To clear the 
  183.          Que, press C.
  184.  
  185.  
  186.          Log file
  187.  
  188.          WTERM opens a log file when a connection is made.  ANSI 
  189.          is stripped from the data written to the file.  You may 
  190.          view the log at anytime if you have LIST configured by 
  191.          pressing ALT-L.  The file will be saved until another 
  192.          connection is made, at which time it is reopened with 
  193.          the old contents destroyed.  This keeps the log file 
  194.          from growing.
  195.  
  196.  
  197.  
  198.          Jumping to DOS
  199.  
  200.          When you jump to DOS using ALT-J, the comm port remains 
  201.          active.  Assuming the receive buffer doesn't overflow, 
  202.          when you return to the program, the screen will be 
  203.          restored and data received while in the shell will be 
  204.          displayed.  While you are in the shell, the DOS prompt 
  205.          is changed to the current drive and path enclosed in 
  206.          curly brackets.  The F1 key is reassigned using ANSI so 
  207.          that pressing it will cause it to send EXIT and you will 
  208.          be returned to WTERM.  Of course you can also type EXIT 
  209.          to return.  You don't have to change back to the 
  210.          directory WTERM is in before you type EXIT.  WTERM
  211.          always changes the default directory to it's own.  If 
  212.          it is loaded from another drive it will change to its own
  213.          drive and directory.  Just add the WTERM directory to
  214.          your path and you can load it from any drive and 
  215.          directory on your system.
  216.  
  217.  
  218.  
  219.          Exiting WTERM
  220.  
  221.          There are two ways to exit WTERM.  By using ALT-X, you 
  222.          are returned to DOS. The comm port is reset and the
  223.          controls are turned off.  This will cause the modem to 
  224.          hangup if you are connected.  To exit WTERM with the 
  225.          controls left high, use ALT-N.  If you enter WTERM again 
  226.          while still connected, it detects carrier and will not 
  227.          send the modem init string.  This allows you to exit to 
  228.          DOS and have all of your RAM to do with as you wish.
  229.  
  230.  
  231.  
  232.          Acknowledgement
  233.  
  234.          After looking at several C source comm routines, I chose 
  235.          the one from a file named COMM.ZIP by Mario Grannini.  
  236.          It was modified in several places but still retains a 
  237.          good bit of his work.  It is a good example of C 
  238.          programming and easily modified for use with WTERM.
  239.  
  240.  
  241.  
  242.          Legal Stuff
  243.  
  244.          DSZ mentioned above is shareware and is not free 
  245.          software.  If you use it, you should register it and pay 
  246.          the reasonable $20 registration fee.
  247.  
  248.          While this program is free for all to use, I retain the 
  249.          copyright and reserve all rights to it.  You may not 
  250.          charge for WTERM.  The exception is that computer clubs 
  251.          may charge for a diskette and a copy fee, the total not 
  252.          to exceed $3.
  253.  
  254.          Since this is a free program and I gain nothing from it, 
  255.          I also assume no responsibility should you decide to use 
  256.          it.  Although it seems to work fine on my AT compatible, 
  257.          it may not work on your system.  You assume all 
  258.          responsibility for ANYTHING that happens if you choose 
  259.          to run WTERM.  
  260.  
  261.          \/\/alter Cox
  262.