Annotation of cvsweb/cvsweb.8, Revision 4.1
4.1 ! schwarze 1: .\" $Id$
! 2: .\"
! 3: .\" Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org>
! 4: .\"
! 5: .\" Permission to use, copy, modify, and distribute this software for any
! 6: .\" purpose with or without fee is hereby granted, provided that the above
! 7: .\" copyright notice and this permission notice appear in all copies.
! 8: .\"
! 9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
! 10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
! 11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
! 12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
! 13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
! 14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
! 15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
! 16: .\"
! 17: .Dd $Mdocdate$
! 18: .Dt CVSWEB 8
! 19: .Os
! 20: .Sh NAME
! 21: .Nm cvsweb
! 22: .Nd CGI program to browse CVS repositories
! 23: .Sh DESCRIPTION
! 24: The kind of page generated by
! 25: .Nm
! 26: is determined by the
! 27: .Ev PATH_INFO ,
! 28: which is looked up relative to the cvsroot.
! 29: If it is the name of a directory,
! 30: files and subdirectories in that directory are listed.
! 31: If it is the name of an ordinary file, behaviour depends on the
! 32: .Ev QUERY_STRING
! 33: variables passed:
! 34: .Bl -bullet
! 35: .It
! 36: With
! 37: .Va rev ,
! 38: the content of the specified revision of the file is shown.
! 39: .It
! 40: With
! 41: .Va annotate ,
! 42: each line of the file is annotated
! 43: with the revision number and date of the last change.
! 44: .It
! 45: With
! 46: .Va r1
! 47: and
! 48: .Va r2 ,
! 49: the differences between the two specified revisions are listed.
! 50: .It
! 51: Otherwise, the commit log of the file is shown.
! 52: .El
! 53: .\" XXX Special cases, maybe describe later: tarball, .diff, Attic, module
! 54: .\" XXX .Ss QUERY_STRING variables
! 55: .\" XXX .Ss Setup
! 56: .Sh ENVIRONMENT
! 57: The web server may pass the following CGI variables to
! 58: .Nm :
! 59: .Bl -tag -width Ds
! 60: .It Ev SCRIPT_NAME
! 61: The initial part of the URI passed from the client to the server,
! 62: starting after the server's host name and ending before
! 63: .Ev PATH_INFO .
! 64: It is used to construct HTML hyperlinks and HTTP redirect targets.
! 65: .It Ev PATH_INFO
! 66: The final part of the URI path passed from the client to the server,
! 67: starting after the
! 68: .Ev SCRIPT_NAME
! 69: and ending before the
! 70: .Ev QUERY_STRING .
! 71: It is interpreted as a file or directory name relative to the cvsroot.
! 72: .It Ev QUERY_STRING
! 73: The HTTP query string passed from the client to the server.
! 74: It is the final part of the URI, after the question mark.
! 75: The variables contained in it determine
! 76: the kind of output produced by
! 77: .Nm .
! 78: .It Ev HTTP_ACCEPT_ENCODING
! 79: If this variable contains the substring
! 80: .Qq gzip ,
! 81: the HTTP header
! 82: .Dq Content-Encoding: gzip
! 83: is enabled for some browsers.
! 84: .It Ev HTTP_USER_AGENT
! 85: If the browser identification string sent by the client indicates
! 86: a browser that cannot display images, no HTML hyperlinks are attached to
! 87: .Pf < Ic img Ns >
! 88: elements.
! 89: .It Ev MOD_PERL
! 90: If set,
! 91: .Dq Content-Encoding: gzip
! 92: is never used.
! 93: .El
! 94: .Pp
! 95: The following variable is passed to child processes:
! 96: .Bl -tag -width Ds
! 97: .It Ev CVSREADONLYFS No = 1
! 98: With
! 99: .Xr cvs 1
! 100: versions 1.12.1 and newer, this setting helps
! 101: to achieve read only access to the repositories.
! 102: With other versions, it does no harm.
! 103: .El
! 104: .\" XXX .Sh FILES
! 105: .Sh SEE ALSO
! 106: .Xr cvs 1 ,
! 107: .Xr cvsweb.conf 5
! 108: .Sh HISTORY
! 109: The
! 110: .Nm
! 111: program was first used on
! 112: .Pa www.freebsd.org
! 113: in 1996 and on
! 114: .Pa www.openbsd.org
! 115: in 1997.
! 116: .Sh AUTHORS
! 117: .An -nosplit
! 118: The
! 119: .Nm
! 120: program was originally developed by
! 121: .An Bill Fenner Aq Mt fenner@freebsd.org
! 122: and maintained and extended by
! 123: .An Henner Zeller ,
! 124: .An Henrik Nordstr\(:om ,
! 125: .An Wolfram Schneider Aq Mt wosch@freebsd.org ,
! 126: and in particular by
! 127: .An Akinori MUSHA Aq Mt knu@freebsd.org
! 128: and
! 129: .An Ville Skytt\(:a Aq Mt scop@freebsd.org .
! 130: It is currently maintained by
! 131: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
CVSweb