[BACK]Return to README CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / cvsweb

Annotation of cvsweb/README, Revision 4.5

4.5     ! schwarze    1: $Id: README,v 4.4 2019/11/11 13:28:36 schwarze Exp $
4.2       schwarze    2: $knu: README,v 1.9 2006/06/22 22:25:27 linimon
3.3       scop        3:
4.3       schwarze    4: CVSweb is a WWW interface for CVS repositories.
3.3       scop        5:
3.5       scop        6: CVSweb was originally written by Bill Fenner and improved by Henner
                      7: Zeller, Henrik Nordström, and Ken Coar, then Akinori MUSHA brought
                      8: it back to FreeBSD community and made further improvements.  Ville
4.1       schwarze    9: Skyttä continued that work; after that, the project was briefly
                     10: maintained by Jonathan Noack <noackjr@alumni.rice.edu>.
3.5       scop       11:
                     12: To track the development, access the MAIN branch of the module
4.1       schwarze   13: `cvsweb' in the mandoc.bsd.lv CVS repository.  For legacy 2.x
                     14: versions, see the branch named 'FreeBSD-cvsweb-2_0-branch'.
3.3       scop       15:
                     16:   Project home page:
4.3       schwarze   17:     <http://cvsweb.bsd.lv/>
3.3       scop       18:
                     19:   Repository access:
4.1       schwarze   20:     <http://mandoc.bsd.lv/anoncvs.html>
3.3       scop       21:
                     22:   CVSweb of CVSweb:
4.1       schwarze   23:     <http://mandoc.bsd.lv/cgi-bin/cvsweb/?cvsroot=cvsweb>
3.3       scop       24:
                     25:   Release archives:
4.3       schwarze   26:     <http://cvsweb.bsd.lv/release/>
3.3       scop       27:     <http://people.FreeBSD.org/~scop/cvsweb/>
                     28:
4.1       schwarze   29:   A mailing list used to exist at the following place,
                     30:   but was deleted in 2014 or maybe even earlier:
3.3       scop       31:     <freebsd-cvsweb@FreeBSD.org>
                     32:     <http://lists.freebsd.org/mailman/listinfo/freebsd-cvsweb>
                     33:
                     34: Here is the list of added features over Zeller's version:
                     35:
                     36: o Customizable "show functions" option
                     37:     You can specify a regexp for each file type to teach rcsdiff(1) to
                     38:     recognize function lines.
                     39:
                     40: o Customizable PR categories
                     41: o Move $prcgi to cvsweb.conf
                     42:     Now each repository can have its own PR categories and
                     43:     query-pr.cgi URL, which can be defined in cvsweb.conf-${cvstree}.
                     44:     It is useful when you have such as NetBSD and/or OpenBSD
                     45:     repositories.
                     46:
                     47: o Improved support for text-based browsers
                     48:     Unidiff is the default format for diffs, for text-based browsers.
                     49:
                     50: o Enhanced PR # hyperlinking.
                     51:     The following styles are supported.
                     52:
                     53:         PR:     12345, 67890, ..
                     54:
                     55:         PR:     #12345, #67890, ..
                     56:
                     57:         PR#     sparc/12345, i386/67890
                     58:
                     59:         PR:     ports/43210
                     60:                 kern/98765
                     61:
                     62:         .. is related to bin/4567, which is ...
                     63:
                     64: o Manpage hyperlinking.
                     65:     Both `cat(1)' and `cat.1' styles are supported.
                     66:
                     67: o Revision numbers hyperlinking in annotation.
                     68:
                     69: o Automatic tarball generation. (Obtained from Debian)
                     70:
                     71: o Automatic zipball generation.
                     72:
                     73: o Customizable repository entry order.
                     74:
                     75: o Location text field.
                     76:
                     77: o Support for the use of localized charsets.
                     78:
                     79: o Workaround for buggy web servers.
                     80:
                     81: o Numerous bugfixes regarding URI/filename manipulation.
                     82:
                     83: o HTML improvements, XHTML 1.0 Transitional, and a separate CSS file for
                     84:   presentation.
                     85:
                     86: o Security fixes to let it work under perl -T.
                     87:
                     88: o Annotate works under mod_perl and against a read only repository.
                     89:
                     90: o Syntax highlighting using GNU Enscript <http://www.iki.fi/~mtr/genscript/>.
                     91:
3.6       scop       92: o CVSHistory <http://www.jamwt.com/CVSHistory/> integration.
                     93:
3.3       scop       94: o Line number output for HTMLized views.
                     95:
                     96: o Support for showing README.cvs.html and README.cvs akin to Apache's
                     97:   FancyIndexes.
                     98:
                     99: o Support for external diff tools.
                    100:
                    101: o Works with mod_perl >= 1.99_11 as well as 1.2x.
                    102:
3.5       scop      103: o ...and much more!  See NEWS for high level changes between releases.
                    104:
                    105: See also README, as well as TODO for new features under consideration
                    106: and development.
3.3       scop      107:
                    108: -------------------------------------------------------------------------------
                    109: The original Zeller README follows (possibly outdated to some extent):
                    110: -------------------------------------------------------------------------------
3.2       scop      111:
3.1       knu       112: The cgi-script cvsweb.cgi is written by Bill Fenner <fenner@freebsd.org>
                    113: (see [1]) for the freebsd project. It allows browsing of
                    114: CVS-repositories (see [2]) with an HTML-browser.
                    115:
                    116: This version is based on Bill's script and is hacked to fit our needs,
                    117: so don't blame him if anything doesn't work ..
                    118:
                    119: Added features:
                    120:  - a colored side by side diff
                    121:  - easier navigation
                    122:  - mime-type aware checkout which allows for browsing
                    123:    of version controlled HTML-pages
                    124:  - easier configuration - everything configurable is in one
                    125:    external file now
                    126:  - added cvs-annotate - this requires cvs >= 1.9
                    127:    (tested with cvs 1.10)
                    128:  - a better way of viewing timestamps: they're shown as age
                    129:    (something like 'changed 2 days 4 hours ago')
                    130:  - sorting by filename / age - just click on the corresponding
                    131:    column
                    132:  - urlencodes all filenames so files with spaces and special
                    133:    characters in their names are viewable as well.
                    134:  - selectionbox for choosing different CVS-roots
                    135:  - overview of last revisionnumber, age and logentry in the
                    136:    directory view
                    137:  - you can check out the current revision of a file if you are
                    138:    in the directory view (idea from Nick Brachet)
                    139:  - gzip'ed output if the browser accepts this; this can reduce the
                    140:    size (and download time) by a factor of 4 (directory view) to
                    141:    10 (colored diff; the size of the colored diff could be reduced
                    142:    with CSS .. anyone ?). The use of gzip has been in the very first
                    143:    version of cvsweb (by Bill Fenner), but has been removed because
                    144:    it wasn't easy to determine if a browser actually understands it. Today
                    145:    the browsers state if they accept the Content-encoding gzip..
                    146:    .. but MSIE lies about this (so cvsweb disables gzip-encoding in this
                    147:    case).
                    148:  - Tag based browsing. An easy and what I think intuitive way to browse a
                    149:    CVS tree based on tags, with filtering of files and CVS logs to only
                    150:    show whats relevant for the selected tag.
                    151:  - "Pretty-printed" checkouts for text based files. My intention is to
                    152:    eventually add cross-referencing to this, but for now the file is only
                    153:    converted to HTML with automatic detection of various links.
                    154:  - "Click-on-version" diff selection.
                    155:  - sorting for every column now
                    156:  - uses 'cvs co' for checkout instead of rcs co
                    157:  - Ability to show directory descriptions from CVSROOT/descriptions
                    158:
                    159: cvsweb.cgi became quite huge now and is bad style code (I am not a
                    160: perl-programmer - this is what I do in my spare time!) so this
                    161: should be rewritten.
                    162:
                    163: And what about using mod_perl, and rewriting it into a set of proper Perl-5
                    164: modules?
                    165:
                    166: This software is distributed under the terms of the BSD-licence.
                    167:
                    168: You can download the latest version at
3.2       scop      169:     <http://stud.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi/>
3.1       knu       170:
                    171: or get it directly with cvs at
                    172:   CVSROOT:  :pserver:anonymous@cvs.stud.fh-heilbronn.de:/cvsroot/public
                    173:  Password:  anonymous
                    174:    Module:  cvsweb
                    175:
                    176: Please send suggestions, bugs etc to
                    177:     Henner Zeller <zeller@think.de>
                    178: or
                    179:     Henrik Nordstrom <hno@hem.passagen.se>
                    180:
                    181: -- refs
                    182: [1] for the original Version of cvsweb.cgi, see
                    183:     <http://www.freebsd.org/~fenner/cvsweb/>
3.7       scop      184: [2] for cvs, see <http://www.nongnu.org/cvs/>

CVSweb