home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / trn_197b.zip / INSTALL < prev    next >
Text File  |  1994-04-25  |  6KB  |  110 lines

  1. Installation Instructions for trn 3.0:
  2.  
  3. 1)  Decide what package you want to use to solve your news database
  4.     needs.  There's currently two supported by trn:  mthreads and
  5.     news overview.  Mthreads creates smaller files that load faster
  6.     each time you enter a group, however it is more taxing on your
  7.     cpu and disk bandwidth because it keeps the files in thread order.
  8.     Overview files are larger, but they are less taxing on your system
  9.     because the format is pretty "raw" and the files are maintained by
  10.     your news software (either a modified C news or INN 1.3 and above).
  11.     Though they load slower than .thread files, they have subject and
  12.     author headers that are not truncated (unlike mthreads headers)
  13.     which means that trn won't have to "freshen" these headers during
  14.     its idle time.  The final choice is to not store a database.  If
  15.     you go this route it will take significantly longer to start up
  16.     a group in threaded mode, but you could chose to read one or more
  17.     groups unthreaded.
  18.  
  19. 2)  If you are going to make a version of trn that uses NNTP to get its
  20.     news remotely, be sure you have installed some version of inews that
  21.     sends articles to your news server.  The reference NNTP (v1.5.11)
  22.     comes with a version of inews that you can use, and C news and INN
  23.     both have versions that can be used remotely.
  24.  
  25. 3)  Run Configure.  This will figure out various things about your system.
  26.     Some things Configure will figure out for itself, other things it will
  27.     ask you about.  It will then proceed to make config.h, config.sh, the
  28.     Makefile, and a bunch of shell scripts.  You might possibly have to
  29.     trim # comments from the front of Configure if your sh doesn't handle
  30.     them, but all other # comments will be taken care of.
  31.  
  32.     NOTE: This package allows the build to be performed in a directory
  33.     other than where the sources are.  You will need a "make" that supports
  34.     VPATH to do this.  Just create a directory where you want to do the
  35.     build, cd into it, and run "path/Configure" from there where "path" is
  36.     either a relative or absolute path reference to the trn source directory.
  37.  
  38. 4)  Glance through config.h and common.h to make sure system dependencies
  39.     are correct.  Most of them should have been taken care of by running
  40.     the Configure script.
  41.  
  42.     If you have any additional changes to make to the C definitions, they
  43.     can be done in the Makefile, in config.h, or in common.h.  If you have
  44.     strange mailboxes on your system you should modify mbox.saver to correctly
  45.     append an article to a mailbox or folder.
  46.  
  47.     If you are on a machine with limited address space, you probably don't
  48.     want to be using trn.  Feel free to give it a try, though -- there are
  49.     some defines in common.h that can be turned off to try to make trn fit
  50.     (see the System Dependencies section).  You might run a "make depend"
  51.     afterward just to be safe.
  52.  
  53. 5)  make
  54.  
  55.     This will attempt to make trn in the current directory.
  56.  
  57. 6)  make install
  58.  
  59.     This will put trn, newsetup, newsgroups, Pnews, Rnmail, trn-artchk, and
  60.     nntplist into a public directory (normally /usr/local/bin), and put a
  61.     number of files into the private trn library (e.g. /usr/local/lib/trn).
  62.     It also tries to put the trn man page in a reasonable place.  One of
  63.     the installed scripts is "newsetup", which creates a .newsrc for a
  64.     user that doesn't have one.  This script reads the subscriptions
  65.     file from your news library directory or sends a LIST SUBSCRIPTIONS
  66.     command to your server to get the default list of newsgroups for a
  67.     new user.  If you don't like this, customize the script as desired.
  68.  
  69.     NOTE: if you have an old installation of trn that put artcheck and
  70.     getactive into the trn library directory, once you ensure that all
  71.     your installed scripts are using the new files (trn-artchk and
  72.     nntplist) you can delete the old ones from the lib directory.
  73.  
  74. 7)  Read the manual entry before running trn, or at least read the file
  75.     NEW if you are already familiar with trn.  Those that are brand new
  76.     to trn can get a quick idea of what's different from rn by reading
  77.     the WHAT'S NEW section of the man page.  Also check out the HINTS
  78.     file for some ways to get the most out of using trn.
  79.  
  80. 8)  Try trn, and play with some of the switches (use -x and -X if you told
  81.     Configure to leave these options off by default).  Any options you find
  82.     that you want to make the default for everyone can be placed into the
  83.     INIT file in the trn library.  Personal defaults can be put in a file
  84.     and the environment variable TRNINIT defined to point to it.
  85.  
  86. 9)  Once trn is running ok, make sure any database software you've installed
  87.     is going ok and interfacing properly with trn.  Read the documentation
  88.     that comes with the package of your choosing.
  89.  
  90. 10) IMPORTANT!  Help save the world!  Communicate any problems and suggested
  91.     patches to Wayne Davison <davison@borland.com> so we can keep the world
  92.     in sync.  If you have a problem, there's someone else out there who
  93.     either has had or will have the same problem.  If the problem affects
  94.     regular rn, code, I will pass it on to Stan Barber.
  95.  
  96.     If possible, send in patches such that the patch program will apply them.
  97.     Unified or regular context diffs are the best, then normal diffs.  Don't
  98.     send ed scripts--I've probably changed my copy since the version you have.
  99.  
  100.     Watch for trn patches in news.software.readers.  Patches will always be
  101.     in the unified context diff format, for application by the patch program.
  102.     If you don't have a patch program that handles unified context diffs,
  103.     you'll probably want to get one (such as patch version 12g8).  Otherwise,
  104.     you can use the (included) filter "unipatch", which can be generated with
  105.     the command "make unipatch".  To apply patches, use the command:
  106.  
  107.     unipatch <patchfile | patch -p
  108.  
  109. 11) If you are going to hack on trn, please refer to rn's HACKERSGUIDE first.
  110.