Return to README CVS log

Up to [CSRG BSD Unix] / 43BSDTahoe / new / nntp

Annotation of 43BSDTahoe/new/nntp/README, revision 1.1

1.1     ! root        1: NNTP README            October 15, 1987        For version 1.4 NNTP package
        !             2: 
        !             3: [See the file CHANGES to see differences between this version and
        !             4: older versions.]
        !             5: 
        !             6:      This package contains everything (well, most of it, I hope) that
        !             7: you'll need to implement a remote news server running the NNTP protocol.
        !             8: 
        !             9:      A brief tour of the directories and their programs:
        !            10: 
        !            11:        server          Source for the NNTP news server daemon.
        !            12: 
        !            13:        rrn             Patches to "rn" to allow remote news reading.
        !            14:                        These patches courtesy of Gene Spafford.
        !            15: 
        !            16:        inews           A "mini-inews" written by Steven Grady
        !            17:                        <[email protected]> which allows
        !            18:                        remote posting without changing much else.
        !            19: 
        !            20:        xmit            An active transmission client for transferring
        !            21:                        news, written by Erik Fair; see note below.
        !            22: 
        !            23:        common          Common stuff (response codes, configuration info,
        !            24:                        and some client library routines) for the
        !            25:                        the news server and the clients.  The "conf.h"
        !            26:                        file here needs to be edited to reflect
        !            27:                        the peculiarities of your system.
        !            28: 
        !            29:        support         Some support files that make the nntpd's
        !            30:                        life considerably easier.
        !            31: 
        !            32:        doc             Documentation on the server, including manual
        !            33:                        pages.  Manual pages for rrn are in rrn/.
        !            34: 
        !            35:        xfer            A passive reception client which uses the
        !            36:                        NEWNEWS command to retrieve news from a remote
        !            37:                        server.  Written by Brian Kantor, this software
        !            38:                        is UNSUPPORTED.
        !            39: 
        !            40:      Each directory has associated with it a README file (except
        !            41: for rrn -- rrn has a bunch of 'em.  The one you want is README_RRN).
        !            42: As you go through the system customizing things, you should read
        !            43: the README for each directory to get an idea of what traps await
        !            44: you in that area.  You may also want to print a copy of doc/rfc977,
        !            45: which describes the NNTP protocol.
        !            46: 
        !            47:      TWO IMPORTANT NOTES:
        !            48: 
        !            49:        1. The NNTP server assumes that the history file format
        !            50:           is 2.11 or 2.10.3; therefore you need 2.11 news.
        !            51: 
        !            52:        2. If you want to transfer news with NNTP, you'll be using
        !            53:           the "nntpxmit" program in the "xmit" directory.
        !            54:           This requires routines in 2.11 news source, and must
        !            55:           be compiled there.  See xmit/README for more info.
        !            56: 
        !            57:      >>>>> Get 2.11 news if you don't have it.
        !            58: 
        !            59:      So, time for a general and cohesive Plan:
        !            60: 
        !            61:      1. Look at common/README.  This will explain the stuff which
        !            62:        needs to be tailored for your system in common/conf.h.
        !            63:        Make the necessary changes to reflect your system.
        !            64: 
        !            65:      2. Look at server/README; there shouldn't be much to do here,
        !            66:        as the configuration stuff should have been taken care of
        !            67:        when you edited common/conf.h.
        !            68: 
        !            69:        Do a "make", and see if things work ok -- they should
        !            70:        (comforting, right?)
        !            71: 
        !            72:      3. Check out support/README and learn about the support programs.
        !            73:        Again, there should be no configuration changes, as that's
        !            74:        what common/conf.h is for.  You will need to edit the Makefile
        !            75:        here to reflect where you want your binaries to be installed,
        !            76:        however.
        !            77: 
        !            78:        Do a "make" here, too.
        !            79: 
        !            80:      4. Look at inews/README.  This is for the pseudo-inews which
        !            81:        gets installed on client news machines.  If you don't want
        !            82:        your clients to be able to post, don't worry about this.
        !            83:        But I suggest you do.  Again, there shouldn't be any
        !            84:        configuration futzing to be dealt with.
        !            85: 
        !            86:        Alas, do a make here, too.
        !            87: 
        !            88:      5. The big one: rrn.  Read rrn/README_RRN, which explains
        !            89:        Gene's patches and what to do, and do what it suggests.
        !            90: 
        !            91:      6. It would be nice if you could do a "make install" at this point,
        !            92:        but you can't: if you compile this on the NNTP server machine,
        !            93:        you don't want rrn objects installed.  On the other hand,
        !            94:        if you compile this on a client machine, you don't want
        !            95:        server objects installed.  So, from this (nntp) directory:
        !            96: 
        !            97:        Server?  Type "make install_server".  This installs "server"
        !            98:                 and "support".
        !            99: 
        !           100:        Client?  Type "make install_client".  This installs "rrn"
        !           101:                 and "inews"
        !           102: 
        !           103:        >>> A full client installation of NNTP requires the following
        !           104:            files (suitable for rdist, assuming standard directories):
        !           105: 
        !           106: NEWS = ( /usr/local/{Pnews,Rnmail,inews,rn,rrn,newsetup,newsgroups,lib/rn}
        !           107:        /usr/man/catl/{Pnews,Rnmail,rn,newsetup,newsgroups}.1 )
        !           108: 
        !           109:            You DO NOT need any of the normal news junk (e.g.,
        !           110:            /usr/lib/news, postnews, checknews, readnews) on CLIENT
        !           111:            systems.
        !           112: 
        !           113:            You DO need these on SERVER systems.
        !           114: 
        !           115:      Problems?  You can get to me via electronic mail at the
        !           116: following addresses:
        !           117: 
        !           118:        Internet:               [email protected]
        !           119:        UUCP:                   ...!ucbvax!phil
        !           120:        Telephone (home):       (415) 848-8409
        !           121:        Telephone (work):       (415) 642-6792 or (415) 642-7447
        !           122: 
        !           123:      I'm very interested in learning what hacks need to be made to
        !           124: nntpd to get it to work on various systems, and certainly, if there
        !           125: are outright bugs, please let me know.
        !           126: 
        !           127:      Also, please send me electronic mail if you decide to use this
        !           128: package, as that way I can mail out bug reports and fixes.  Be sure
        !           129: to include a reply-able address if your mailer doesn't generate
        !           130: one for you.
        !           131: 
        !           132:      One note, though -- as for "rrn", I'll support bugs caused
        !           133: by my additions/mods to it (hopefully Larry Wall will be supporting
        !           134: this soon...) but please don't send me reports about things which
        !           135: were already in rn 4.3.  Thanks.
        !           136: 
        !           137:      [Those who had the pleasure of dealing with the kill/save bug,
        !           138: it's gone now, thanks to Chris Maio.]
        !           139: 
        !           140:      Finally, I'd like to thank the various people who both inspired
        !           141: and helped to make this project a reality:  Erik Fair, whose criticism
        !           142: and suggestions helped mold NNTP (and who wrote the active transmission
        !           143: client); Brian Kantor, who really got me motivated enough to go and
        !           144: finish the thing, and whose work on the RFC was *tremendous*; Steven
        !           145: Grady, who wrote the inews interface (and wasted countless hours only
        !           146: to have his work dashed periodically...); Mike Meyer, who beta tested
        !           147: the software and pointed out numerous problems; Bob Henry, who let me
        !           148: have the resources so that it got done; Peter Yee, who repeated enough
        !           149: good ideas to get me to include them; all the folks who had patience
        !           150: with me and didn't go off and write this themselves (jsq, you
        !           151: listening?  My thanks.); Chuq von Rospach and the members of lan-news;
        !           152: Gene Spafford for eliminating having to include 1 MB of source to rn
        !           153: by a set of patches; Matt Thomas for adding support for DECNET;
        !           154: the kind folks who beta tested version 1.4 and put up with stupid
        !           155: bugs and provided helpful feedback, notably Craig Leres, Matt Thomas,
        !           156: Wengyik Yeong, and Stan Barber; all the individuals who have reported
        !           157: bugs or suggested improvements (see CHANGES for a list); and probably a
        !           158: lot of other people I've neglected to mention.  My thanks to all.
        !           159: 
        !           160:                                                Phil Lapsley
        !           161:                                                15 October 1987

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.