home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / network / trmp104b.zip / NEWS.DOC < prev    next >
Text File  |  1991-12-16  |  14KB  |  402 lines
  1.                       Trumpet Version 1.04
  2.  
  3.                 A News Reader for MS-DOS machines.
  4.  
  5.                      Written by Peter R. Tattam
  6.  
  7.                       Copyright (c) Sep, 1991
  8.  
  9.  
  10. ************************** IMPORTANT ***********************************
  11. YOU MUST SET UP YOUR NEWS READER NEWS.PRM FILE BEFORE EXECUTING NEWS.EXE
  12. ************************************************************************
  13.  
  14. The following document describes the setup of the news reader.
  15.  
  16. The files required are :
  17.  
  18.     NEWS.EXE  - the executable file.
  19.     NEWS.PRM  - a setup file for the news reader.
  20.     NEWS.INI  - a list of the newsgroups subscribed to.
  21.  
  22. NEWS recognizes the existence of a novell network, and will
  23. act appropriately. Individual users will save their own NEWS.PRM and
  24. NEWS.INI in their mail directory.  This directory is SYS:MAIL\nnnn where
  25. nnnn is their unique user-id number.
  26.  
  27. The relevant information for setting up is in NEWS.PRM
  28.  
  29. A typical stand-alone setup follows.
  30.  
  31.     myip        = 131.217.35.100
  32.     user        = peter
  33.     netmask     = 255.255.0.0
  34.     mygateway   = 131.217.250.1
  35.     nntp-host   = 131.217.1.19
  36.     smtp-host   = 131.217.1.19
  37.     site        = psychnet.psychol.utas.edu.au
  38.     organization= Psychology Department, University of Tasmania
  39.     mss         = 512
  40.     fullname    = Peter R. Tattam
  41.     signame     = c:\news\my.sig
  42.  
  43. Parameters may be in any order.
  44.  
  45. The individual parameters are :
  46.   myip         - an ip address, rarp or bootp (in lower case)
  47.   netmask      - your ip local network mask
  48.   mygateway    - ip address of your gateway outside your local net
  49.   nntp-host    - ip address of the NNTP server.
  50.   smtp-host    - ip address of the SMTP server
  51.   mss          - maximum segment size that tcp can send. default 512
  52.  
  53.   site         - your e-mail site name
  54.   user         - your e-mail user name
  55.   organization - the name of your organization
  56.   fullname     - your full name
  57.   signame      - your signature file name
  58.  
  59.  
  60. Executing News
  61. --------------
  62.  
  63. NEWS takes the following parameters.
  64.  
  65.     news [ myip ] [ nntp-host ]  [-d] { other-parameters }
  66.  
  67. The parameters 'myip' and 'nntp-host' can be overridden in this manner.  The
  68. option '-d' enables debugging.  This is only used for debugging the TCP/IP part
  69. of the program.
  70.  
  71. Novell users will have some parameters stored in their user parameter file.
  72. The only parameters saved (via Setup menu option) are 'fullname' and 'signame'.
  73. When running from a network, some parameters may change from machine to machine.
  74. One such parameter is the ip address 'myip'. One can use RARP to determine the
  75. IP address of a workstation.  A way of overriding the IP address is to provide
  76. this address as the first parameter when calling the program.
  77.  
  78. Using News
  79. ----------
  80.  
  81. When using NEWS, if all goes well, you should be connected to the NNTP server
  82. and then you will be able to read the news. You will be presented with a large
  83. window with 2 scrolling frames. The top frame is for locating a newsgroup, the
  84. bottom for scanning through a group.  A groups articles will not be displayed
  85. until the newsgroup is selected with <enter>. To jump between the frames, type
  86. <tab>. To move about, use the cursor keys.  You may also locate a group or
  87. subject by typing a sequence of characters which form part of the group name or
  88. article subject.  For example the sequence 'n','o','v','e' will located the
  89. group 'comp.sys.novell'.  This make it easy to locate a group or subject without
  90. typing too much.
  91.  
  92. Note: if NEWS.INI does not exist, trumpet will attempt to subscribe to all the
  93. newsgroups available.  This could take some time, and make you think that the
  94. computer has gone dead.  A ticker should count over showing you that trumpet
  95. is loading all the newsgroup info.  The same thing happens when you select the
  96. subscribe box.
  97.  
  98. To read an article, merely select the article in the lower window by pressing
  99. <enter>.
  100.  
  101. All in all, the program is probably "self-explanatory".
  102.  
  103. (well not really, but I'm sure you'll figure it out :-)
  104.  
  105. Some special commands.  Note [X] means press Alt-X.
  106.  
  107. In the news article window
  108.  
  109. F7/F8     - will jump to the prev/next group with articles to be read.
  110. [R]eadall  - will mark all the articles as having been read for the current
  111.             group and then scan to the next group with articles in it.
  112. [U]nread   - Unread 20 articles at a time
  113. [T]oggle   - will toggle the read status of an article.
  114. [S]kip     - will mark the article as having been read without reading it.
  115. [F]ollow   - do a follow up to the article
  116. [P]ost     - post a new article
  117. f[O]rward  - forward article to mail user (defaults to self)
  118.  
  119. In the news group window
  120.  
  121. Ins       - open a window of all the unsubscribed groups
  122.             (when open, <enter> will subscribe the newsgroup)
  123. Del       - unsubscibe from a news groups
  124. [Z]ap      - Unsubscribe from all news groups
  125.  
  126. In the article reader window
  127.  
  128. [H]eader   - toggle viewing of the header
  129. [W]ordwrap - toggle word wrapping
  130. [P]rint    - print an article (Can also save to a file this way)
  131. [S]ave     - save article to a file (if files exists, then it is appended)
  132. [M]ail     - mail a letter to author of the article.
  133. [R]eply    - mail a reply to the author of the article. (includes article)
  134. f[O]rward  - forward article to mail user (defaults to self)
  135.  
  136. The use of a mouse is supported via the standard mouse driver.  Load your
  137. mouse driver before use.
  138.  
  139. Notes for Novell Users  (non-supervisor)
  140. ----------------------------------------
  141. The suggested way to run trumpet is as follows.  The trumpet news.exe program
  142. should reside in a public directory.  e.g. SYS:PUBLIC or SYS:TRUMPET
  143.  
  144. A typical public setup follows. Notice that some parameters are missing.
  145.  
  146.     myip        = rarp
  147.     netmask     = 255.255.0.0
  148.     mygateway   = 131.217.250.1
  149.     nntp-host   = 131.217.1.19
  150.     smtp-host   = 131.217.1.19
  151.     dns-host    = 131.217.1.19
  152.     time-host   = 131.217.1.19
  153.     site        = psychnet.psychol.utas.edu.au
  154.     organization= Psychology Department, University of Tasmania
  155.     rwin        = 4096
  156.     mss         = 1024
  157.  
  158. A typical user setup follows.
  159.  
  160.     signame     = c:\news\my.sig
  161.  
  162. Trumpet will only require the file NEWS.PRM in the public directory.  This file
  163. should contain all the trumpet parameters except for the username, fullname and
  164. .sig file location.
  165.  
  166. The users will automatically have a NEWS.INI and NEWS.PRM created in their mail
  167. directory.  When trumpet is started, the existence of a NEWS.INI is checked,
  168. and if one is not found, a list of news groups will be retrieved from the
  169. NNTP server.  This can take some time, so be patient.
  170.  
  171. The sequence of events for a novell user are :
  172.  
  173.    1) determination of mail directory
  174.    2) NEWS.PRM loaded from user mail directory. (if exists)
  175.    3)
  176.    4) NEWS.PRM loaded from NEWS.EXE directory.  This will override any attempt
  177.       to forge some of the global parameters.
  178.    5) username and fullname recovered from novell server.
  179.    6) NNTP session opened.
  180.    7-a) if NEWS.INI exists in user mail directory then load it
  181.    7-b) or if NEWS.INI exists in NEWS.EXE directory then load it
  182.    7-c) or subscribe to all newsgroups on the NNTP server.
  183.    ....
  184.    ....
  185.    [ optional
  186.      8) User changes Setup (limited to only .sig file name)
  187.      9) NEWS.PRM saved in mail directory
  188.    ]
  189.    ....
  190.    ....
  191.    10) User quits.
  192.    11) NEWS.INI saved in mail directory
  193.    12) NNTP session ended.
  194.    13) program ends.
  195.  
  196. Debug options
  197. -------------
  198. The command line parameter -debug enables certain debugging options.
  199.  
  200. the format is
  201.  
  202.     news -debug=xyz
  203.  
  204. where xyz is a string of the following characters
  205.  
  206.     e = ether header trace  (only if ip trace, arp trace or rarp trace is on)
  207.     a = arp trace
  208.     r = rarp trace
  209.     u = udp trace
  210.     i = ip trace
  211.     t = tcp trace
  212.  
  213. e.g.
  214.     news -debug=ate
  215.  
  216. will trace arp packets with ether headers, and trace the tcp
  217.  
  218. The -d option is equivalent to -debug=t
  219.  
  220. You can also send output to a debug file with the option
  221.  
  222. e.g.
  223.    news -d -dbfile=test.dbg
  224.  
  225. will trace the tcp info into the file 'test.dbg'
  226.  
  227. NEWS.INI format
  228. ---------------
  229.  
  230. You may modify your own news.ini file.  This can save space in trumpet.
  231.  
  232. The file is simply a list of lines, one per newsgroup.
  233.  
  234. Each line has the following format.
  235.  
  236. <name> <subscribed> <readto> <unread-list>
  237.  
  238. where <name>        ::= string
  239.       <subscribed>  ::= Y | N
  240.       <readto>      ::= integer
  241.       <unread-list> ::= { integer [ - integer ] }
  242.  
  243. e.g.
  244.  
  245. comp.sys.novell Y 2345
  246. sci.physics Y 1234 1021 1034-1041 1211
  247.  
  248. Bug Reports
  249. -----------
  250.  
  251. If you find a bug in Trumpet,  I would like to hear about it.
  252. You can e-mail me at
  253.  
  254.     peter@psychnet.psychol.utas.edu.au
  255.  
  256. If you can, send me the NEWS.PRM that you are using (supervisor version if
  257. using Novell), and the NEWS.INI file (if one has been created).
  258.  
  259. If you are having networking troubles, send the following traces to a text
  260. file using the -debug and -dbfile options and e-mail that with your problem.
  261.  
  262.          news -debug=t -dbfile=debug.tcp
  263.  
  264.          news -debug=eairtu -dbfile=debug.all
  265.  
  266. Trouble shooting check list
  267. ---------------------------
  268.  
  269. Can't connect to NNTP server.
  270.  
  271.       Check that you have a packet driver loaded.  Packet drivers are
  272.       available from omnigate.clarkson.edu.
  273.  
  274.       Check that you have a valid IP-address either manually or via
  275.       RARP or BOOTP.
  276.  
  277.       Try telnetting to port 119 of the NNTP host using NCSA telnet to see
  278.       if it is accessible.
  279.  
  280. Can access NNTP server but can't read any articles.
  281.  
  282.       You need to be authorized to use the NNTP server.
  283.       See the administrator of the NNTP server.
  284.  
  285. Can read articles, but can't POST.
  286.  
  287.       You need to be authorized to post articles.
  288.       Some groups don't allow posting.
  289.  
  290. Can read articles, but can't MAIL.
  291.  
  292.       You need to be authorized to use the SMTP host.
  293.       See the system administrator.
  294.  
  295. Interface runs really, really slow. (on ethernet)
  296.  
  297.       Packets are most likely being dropped because your host is sending
  298.       too many packets at a time.  Try setting RWIN=512, and MSS=512.
  299.       Experiment a little.
  300.  
  301. Interface runs really, really slow. (via SLIP).
  302.  
  303.       You really want to use trumpet via SLIP???? :-)
  304.       Seriously... Later versions of trumpet may have special
  305.       facilities for background SLIP processing.
  306.  
  307. When I read large groups or large articles, trumpet bombs.
  308.  
  309.      This is a known bug.  Future versions of trumpet will attempt to
  310.      fix it up by providing article/group limits.
  311.  
  312. Trumpet hangs halfway through a session.
  313.  
  314.      Many possible causes.
  315.        IPXPKT being used with mss > 256.... set mss=256
  316.        Communications broken.
  317.        Some TSR is interacting badly with trumpet.
  318.        Mouse driver behaving badly.
  319.        Monster groups/articles.
  320.  
  321. -------------------------------------------------------------------------------
  322. Known bugs:
  323.  
  324.     Please report any bugs to
  325.  
  326.         peter@psychnet.psychol.utas.edu.au
  327.  
  328.     You can trace bugs with posting by creating a file called POST.LOG in
  329.     the same directory as NEWS.INI.  All lines posted to the NNTP server will be
  330.     saved in this file.
  331.     large articles still crash trumpet. This is because of
  332.     poor error handling when expanding Turbo Vision Collections.
  333.  
  334.  
  335. Current wish list:
  336.  
  337.     Archiving of articles via a simple database.  (a bit further off)
  338.     Automatic uuencode/uudecode facility for binary postings.
  339.     Saving of wordwrap/header options etc.
  340.     Specify packet driver interrupt
  341.     Use external editor
  342.     Use novell bindery for posting/reading/mailing restrictions.
  343.  
  344. Version 1.01 fixes the following bugs.
  345. --------------------------------------
  346.  
  347. Internal - NNTP result codes interpreted when exceptions occur.
  348. TCP/IP - modified to recycle packets out of sequence
  349. Unable to change IP address on command line.
  350. Some posting editor bugs fixed.
  351. Fixed RARP packets, timeout 10 seconds (was 5).
  352.  
  353. Enhancements in Version 1.01
  354. ----------------------------
  355. On initial startup (or NEWS.INI missing) the setup screen appears
  356. automatically.
  357. Any error conditions will display a message on the screen for a couple of
  358. seconds.
  359. U(nread command now unreads 20 articles at a time
  360.  
  361. Version 1.02 fixes the following bugs
  362. -------------------------------------
  363.  
  364. Check for low memory.  Displays a message, and limps on with reduced memory.
  365. Article numbers > 65535 should work now.
  366.  
  367. Version 1.03 fixes the following bugs
  368. -------------------------------------
  369.  
  370. Some ARP code broken.
  371. TCP code improved for sending data.
  372. SMTP address not saved after setup screen.
  373. fixed bug when unread list contains old articles which have disappeared from
  374. NNTP host.
  375. Fixed bug in screen display when focussing a new group without loading.
  376. Fixed bug introduced by Memory low checking. If there were unread articles,
  377. the readto pointer was assigned to the last of them. Updated correctly now.
  378.  
  379. Version 1.03 Enhancements
  380. -------------------------
  381. Forwarding command in article and news item windows.  (defaults to self)
  382. Mail command sends new letter to author of article.
  383. Reply command replies to author of article.
  384. Indicator on start up about IP address shows netmask and default gateway.
  385. More dials on load/save of news.ini.
  386. Full name extracted from Novell bindery.
  387. BOOTP installed.
  388. More robust Novell usage.
  389. Command line entry of all parameters.
  390. Extended debug options.
  391.  
  392. Version 1.04 Bug fixes
  393. ----------------------
  394.  
  395. TCP code modified to avoid Silly Window Syndrone
  396. Inclusion of RWIN parameter for small/slow ethernet adaptors.
  397. RARP bug fixed (The BOOTP enhancement broke this part)
  398. Path line contains the DNS look up for the IP address.
  399. Date line fixed to conform to Usenet format.
  400. Traces may be sent to a text file for later analysis
  401. You can now escape using any when reading large groups.
  402. You can now shell to DOS.