Annotation of cvsweb/README, Revision 4.9
4.9 ! schwarze 1: $Id: README,v 4.8 2019/11/26 11:21:27 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 Improved support for text-based browsers
41: Unidiff is the default format for diffs, for text-based browsers.
42:
43: o Enhanced PR # hyperlinking.
44: The following styles are supported.
45:
46: PR: 12345, 67890, ..
47:
48: PR: #12345, #67890, ..
49:
50: PR# sparc/12345, i386/67890
51:
52: PR: ports/43210
53: kern/98765
54:
55: .. is related to bin/4567, which is ...
56:
57: o Manpage hyperlinking.
58: Both `cat(1)' and `cat.1' styles are supported.
59:
60: o Revision numbers hyperlinking in annotation.
61:
62: o Automatic tarball generation. (Obtained from Debian)
63:
64: o Automatic zipball generation.
65:
66: o Customizable repository entry order.
67:
68: o Location text field.
69:
70: o Workaround for buggy web servers.
71:
72: o Numerous bugfixes regarding URI/filename manipulation.
73:
74: o HTML improvements, XHTML 1.0 Transitional, and a separate CSS file for
75: presentation.
76:
77: o Security fixes to let it work under perl -T.
78:
79: o Annotate works under mod_perl and against a read only repository.
3.6 scop 80:
3.3 scop 81: o Line number output for HTMLized views.
82:
83: o Support for showing README.cvs.html and README.cvs akin to Apache's
84: FancyIndexes.
85:
86: o Support for external diff tools.
87:
88: o Works with mod_perl >= 1.99_11 as well as 1.2x.
89:
3.5 scop 90: o ...and much more! See NEWS for high level changes between releases.
91:
92: See also README, as well as TODO for new features under consideration
93: and development.
3.3 scop 94:
95: -------------------------------------------------------------------------------
96: The original Zeller README follows (possibly outdated to some extent):
97: -------------------------------------------------------------------------------
3.2 scop 98:
3.1 knu 99: The cgi-script cvsweb.cgi is written by Bill Fenner <fenner@freebsd.org>
100: (see [1]) for the freebsd project. It allows browsing of
101: CVS-repositories (see [2]) with an HTML-browser.
102:
103: This version is based on Bill's script and is hacked to fit our needs,
104: so don't blame him if anything doesn't work ..
105:
106: Added features:
107: - a colored side by side diff
108: - easier navigation
109: - mime-type aware checkout which allows for browsing
110: of version controlled HTML-pages
111: - easier configuration - everything configurable is in one
112: external file now
113: - added cvs-annotate - this requires cvs >= 1.9
114: (tested with cvs 1.10)
115: - a better way of viewing timestamps: they're shown as age
116: (something like 'changed 2 days 4 hours ago')
117: - sorting by filename / age - just click on the corresponding
118: column
119: - urlencodes all filenames so files with spaces and special
120: characters in their names are viewable as well.
121: - selectionbox for choosing different CVS-roots
122: - overview of last revisionnumber, age and logentry in the
123: directory view
124: - you can check out the current revision of a file if you are
125: in the directory view (idea from Nick Brachet)
126: - gzip'ed output if the browser accepts this; this can reduce the
127: size (and download time) by a factor of 4 (directory view) to
128: 10 (colored diff; the size of the colored diff could be reduced
129: with CSS .. anyone ?). The use of gzip has been in the very first
130: version of cvsweb (by Bill Fenner), but has been removed because
131: it wasn't easy to determine if a browser actually understands it. Today
132: the browsers state if they accept the Content-encoding gzip..
133: .. but MSIE lies about this (so cvsweb disables gzip-encoding in this
134: case).
135: - Tag based browsing. An easy and what I think intuitive way to browse a
136: CVS tree based on tags, with filtering of files and CVS logs to only
137: show whats relevant for the selected tag.
138: - "Pretty-printed" checkouts for text based files. My intention is to
139: eventually add cross-referencing to this, but for now the file is only
140: converted to HTML with automatic detection of various links.
141: - "Click-on-version" diff selection.
142: - sorting for every column now
143: - uses 'cvs co' for checkout instead of rcs co
144: - Ability to show directory descriptions from CVSROOT/descriptions
145:
146: cvsweb.cgi became quite huge now and is bad style code (I am not a
147: perl-programmer - this is what I do in my spare time!) so this
148: should be rewritten.
149:
150: And what about using mod_perl, and rewriting it into a set of proper Perl-5
151: modules?
152:
153: This software is distributed under the terms of the BSD-licence.
154:
155: You can download the latest version at
3.2 scop 156: <http://stud.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi/>
3.1 knu 157:
158: or get it directly with cvs at
159: CVSROOT: :pserver:anonymous@cvs.stud.fh-heilbronn.de:/cvsroot/public
160: Password: anonymous
161: Module: cvsweb
162:
163: Please send suggestions, bugs etc to
164: Henner Zeller <zeller@think.de>
165: or
166: Henrik Nordstrom <hno@hem.passagen.se>
167:
168: -- refs
169: [1] for the original Version of cvsweb.cgi, see
170: <http://www.freebsd.org/~fenner/cvsweb/>
3.7 scop 171: [2] for cvs, see <http://www.nongnu.org/cvs/>
CVSweb