home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / misc / yappprot / yapp.doc < prev    next >
Encoding:
Text File  |  1986-12-16  |  9.3 KB  |  308 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8. YAPP(tm) - Yet Another Packet Program 
  9.  
  10. Version 2.0
  11.  
  12. (C) Copyright 1986 by Jeff Jacobsen, WA7MBL
  13. Released For Public Distribution
  14. ALL RIGHTS RESERVED
  15.  
  16.  
  17. Permission is granted to freely distribute this code,
  18. provided that this notice and the following disclaimer are
  19. included in their entirety and without modifications of any
  20. sort.  This work may not be sold, or modified and sold, or
  21. included with any other product to be sold, without the
  22. written permission of the author.
  23.  
  24. No fee or compensation may be requested or received by any
  25. person or organization distributing this program, except by
  26. the author or an authorized distributor.
  27.  
  28. Disclaimer:
  29.  
  30. No guarantees or warranties of any kind are expressed or
  31. implied.  This code is distributed "AS IS" without any
  32. warranty of any kind, either expressed or implied,
  33. including, but not limited to the implied warranties of
  34. merchantability and fitness for a particular purpose.  You
  35. are soley responsible for the selection of the program to
  36. achieve your intended results and for the results actually
  37. obtained.  Should the program prove defective, you (and not
  38. the author) assume the entire cost of all necessary
  39. servicing, repair, or correction.
  40.  
  41. Neither the author nor anyone else who has been involved in
  42. the creation, production or delivery of this program shall
  43. be liable for any direct, indirect, consequential or
  44. incidental damages arising out of the use or inability to
  45. use this program.
  46.  
  47.  
  48. Jeff Jacobsen, WA7MBL
  49. 1400 E 900 N
  50. Logan, Utah  84321
  51.  
  52.  
  53. INTRODUCTION
  54.  
  55. YAPP(tm) was written to provide a terminal program for use
  56. in testing the WA7MBL BBS code.
  57.  
  58. A contribution of $20 is asked of any users of YAPP who
  59. find it of value.
  60.  
  61. User feedback and registration is also encouraged.  Your
  62. comments and suggestions are welcomed.  The success of this
  63. method of distribution will determine whether future
  64. versions of YAPP will be distributed freely, or sold
  65. commercially.
  66.  
  67. Whether you make a contribution or not, you are encouraged
  68. to copy and distribute this program for the private,
  69. non-commercial use of others.
  70.  
  71. A copy of this program may be obtained by either sending $5
  72. or by sending a blank, formatted disk together with an
  73. addressed, postage-paid return mailer to:
  74.  
  75.      Wes Morris, K7PYK
  76.      7422 E McKinley Street
  77.      Scottsdale, AZ  85257
  78.  
  79. A current copy should also be available for downloading
  80. from Hamnet on Compuserve.
  81.  
  82. Contributions or user feedback may be sent to the K7PYK, or
  83. directly to the author.
  84.  
  85.  
  86. HARDWARE REQUIREMENTS
  87.  
  88.  
  89. YAPP has been tested on an IBM PC, XT, AT, and a few
  90. compatibles.  Another version of YAPP (YAPPB) is available
  91. which uses an external resident I/O driver.  If you have an
  92. MS-DOS computer which does not use the standard IBM
  93. communication port locations, we may be able to help you
  94. modify the driver to adapt YAPPB for your computer.
  95.  
  96. We recommend that your CONFIG.SYS file has a FILES
  97. parameter of at least FILES=10.  We uses FILES=20 and
  98. BUFFERS=20.
  99.  
  100.  
  101. TNC SET UP
  102.  
  103. This program uses hardware handshaking.  Your TNC should
  104. also be set for no parity and 8 bit words.  If you plan to
  105. do binary file transfers, be sure that the TNC type is set
  106. correctly.  TNC type 0 is used for testing and does not
  107. send the commands to place the TNC into transparent mode. 
  108. TNC type 2 sends a break signal to place the TNC into
  109. command mode when necessary, while TNC type 1 uses the
  110. control-C method.  The most common problem is with
  111. cabling.  Be sure that your cable connects pins 1-8 and pin
  112. 20 from you serial port to your TNC.
  113.  
  114.  
  115. To enable hardware handshaking be sure the following are
  116. set:
  117.  
  118. START 0
  119. STOP  0
  120. XFLOW OFF
  121. XON   0
  122. XOFF  0
  123.  
  124. If you are using split screen mode, you will probably want:
  125.  
  126. FLOW OFF
  127. ECHO OFF
  128.  
  129. Other suggested parameters are included in TNC1SET.YAP &
  130. TNC2SET.YAP which should be included on the program diskette.
  131.  
  132.  
  133. COMMAND SUMMARY
  134.  
  135. The following commands are available from YAPP
  136.  
  137. F1    -  Display Help Menu
  138. F2    -  Toggle printer on/off
  139. F3    -  End File Capture 
  140. F4    -  Begin/Suspend File Capture 
  141. F5    -  Send text file
  142. F7    -  Send binary file
  143. F8    -  Receive binary file
  144. F9    -  DOS Gateway
  145.  
  146. Alt-B    Send Break
  147. Alt-C    Connect
  148. Alt-D    Directory
  149. Alt-E    Echo mode toggle
  150. Alt-F    Change Port
  151. Alt-G    Bell toggle
  152. Alt-P    Strip 8th bit (parity) toggle
  153. Alt-S    Split Screen toggle
  154. Alt-T    Send Time & Date
  155. Alt-W    Write Scroll buffer to disk
  156. Alt-X    Exit  
  157.  
  158. All characters that scroll off the top are saved in the
  159. "scroll" buffer.  You may redisplay this buffer by pressing
  160. Home, PgUp, or the UpArrow.  Home starts from the oldest
  161. available screen in the buffer.  PgUp shows the previous
  162. screen, and UpArrow the previous line.  Once you are
  163. reviewing the scroll buffer, you may use PgDn or DownArrow
  164. to move forward through the buffer.  End will exit the
  165. review mode.  
  166.  
  167. There are times when you wish you had saved something that
  168. scrolls off the screen.  Alt-W will write the entire
  169. contents of the scroll buffer to disk.
  170.  
  171. When in split screen mode, all received characters are
  172. displayed on the top portion of the screen and everything
  173. you type appears at the bottom.  Only that appearing in the
  174. top portion will be saved in the scroll buffer.  If you
  175. wish to print or capture everything, you should turn off
  176. split screen mode.
  177.  
  178. You may also save information by pressing F4 to turn on
  179. capture mode.  This will write all received characters (or
  180. everything if you are not in split-screen mode) to a disk
  181. file.
  182.  
  183. Pressing F4 again will suspend the capture, or pressing F3
  184. will complete the capture.
  185.  
  186.  
  187. F5 sends the contents of a file to the TNC.  You may use it
  188. to send commands to the TNC or messages.
  189.  
  190. F7 is used to send a binary file using the YAPP binary
  191. protocol.  The receiving station must also be using the
  192. YAPP protocol.
  193.  
  194. F8 is used to receive a binary file.
  195.  
  196. F9 suspends the program and lets you run DOS commands.  To
  197. return to YAPP type EXIT at the DOS prompt.  This feature
  198. requires the file DOSPGM.COM.
  199.  
  200. YAPP features a connect directory.  To use it, edit a text
  201. file called YAPP.DIR with the nickname you wish to use for
  202. a station (up to 6 characters) followed by the connect
  203. path.
  204.  
  205. For example:
  206.  
  207. Jeff   WA7MBL v WA7MXZ-1
  208. Wes    K7PYK
  209. BBS    WB7TRX v WA7MXZ-1,KD7YK-2
  210.  
  211. To connect, press Alt-C and you will be prompted for who
  212. you wish to connect to.  Enter the name, and the connect
  213. message will be sent to the TNC.
  214.  
  215.  
  216. THE CONFIGURATION FILE   (YAPP.CNF)
  217.  
  218. A new feature in YAPP version 2.0 is the use of a
  219. configuration file to set the desired parameters.
  220.  
  221. The configuration file is organized in the following
  222. format:
  223.  
  224. 1     {com port}
  225. 4800  {baud rate}
  226. 2     {TNC type}
  227. YES   {split screen}
  228. YES   {allow bells (^G)}
  229. 112   {status line attribute}
  230. 15    {standard attribute - keyboard input}
  231. 7     {received character attribute}
  232. 7     {help screen attribute}
  233. 7     {help screen border}
  234. 7     {transfer status attribute}
  235. 7     {transfer status border}
  236. 7     {set default window attribute}
  237. 7     {set default window border}
  238. 7     {directory window attribute}
  239. 7     {directory window border}
  240. 7     {misc window attribute}
  241. 7     {misc window border}
  242. mon on
  243. conok on
  244. *** EOF  {end of commands sent to TNC on program start}
  245. conok off
  246. mon off
  247. *** EOF  {end of commands sent to TNC on program end}
  248.  
  249.  
  250. The first line selects the communications port.  YAPP
  251. supports com1 or com2.
  252.  
  253. The next line is used to select the baud rate.
  254.  
  255. The next line select the type of TNC as described above
  256. under TNC SET UP.  Valid types are 0, 1, and 2.
  257.  
  258. The next line selects Split Screen mode.  YES will start
  259. YAPP in split screen mode.  NO will start with it off.  The
  260. mode may be changed from within YAPP by pressing Alt-S.
  261.  
  262. The next line selects whether Bells (Cont-G) will be heard
  263. at the terminal or not.  YES will sound the speaker when a
  264. ^G character is received.  NO will only display the
  265. graphics character on the screen.  This mode may also be
  266. changed from YAPP by pressing Alt-G.
  267.  
  268.  
  269.  
  270. The next 13 lines specify the colors to be used when
  271. displaying the characters you type, characters received
  272. from the TNC, on the status line, and by various windows.
  273. In earlier versions of YAPP, this information was kept in
  274. the file YAPP.COL and only used if you were using a color
  275. monitor.
  276.  
  277. The values shown above are for use with a monochrome
  278. monitor.  If you have a color monitor, you may want to try
  279. the following values:
  280.  
  281. 110   {status line attribute}
  282. 7     {standard attribute - keyboard input}
  283. 3     {received character attribute}
  284. 111   {help screen attribute}
  285. 111   {help screen border}
  286. 96    {transfer status attribute}
  287. 96    {transfer status border}
  288. 14    {set default window attribute}
  289. 5     {set default window border}
  290. 11    {directory window attribute}
  291. 6     {directory window border}
  292. 15    {misc window attribute}
  293. 4     {misc window border}
  294.  
  295. or experiment with other colors.  If you have a monochrome
  296. monitor, you should stick with the monochrome defaults.
  297. More information about color values is available in the
  298. file COLORS.DOC.
  299.  
  300. The next series of lines up to the *** EOF will be sent as
  301. commands to the TNC when you start the program.  These can
  302. be used to change TNC parameters, load connect or beacon
  303. message text, or for other purposes.
  304.  
  305. The final series of lines up to the last *** EOF will be
  306. sent to the TNC when you exit the program.
  307.  
  308.