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

Annotation of cvsweb/README, Revision 3.4

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

CVSweb