.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "COMMITLOG2CVSWEB 1" .TH COMMITLOG2CVSWEB 1 "2006-06-22" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" commitlog2cvsweb \- convert FreeBSD commitlog files to HTML .SH "SYNOPSIS" .IX Header "SYNOPSIS" .IP "." 4 commitlog2cvsweb [\-\-cvsweb=\fI\s-1URL\s0\fR] [\-\-urlsuffix=\fI\s-1SFX\s0\fR] [\-\-branch=\fI\s-1TAG\s0\fR] [\-\-showallbranches] [\-\-outfile=\fI\s-1FILE\s0\fR] [\-\-committer=\fI\s-1PATTERN\s0\fR] [\-\-and] [\-\-insensitive] [\-\-logmessage=\fI\s-1PATTERN\s0\fR]... [\-\-link\-committers] [\-\-queryprcgi=\fI\s-1URL\s0\fR] [\-\-number\-commits] [\-\-maximum=\fI\s-1NUM\s0\fR] [\-\-sort\-arguments] \fIcommitlog-file\fR... .IP "." 4 commitlog2cvsweb \-\-version .SH "DESCRIPTION" .IX Header "DESCRIPTION" The commitlog2cvsweb program takes one ore more commitlog files and converts them into \s-1HTML\s0. The commitlog files are usually stored under \&\fI/home/ncvs/CVSROOT/commitlogs/\fR and can be retrieved by cvsup-ing the cvsroot-common and cvsroot-src collections in \s-1CVS\s0 mode. (See cvsup, http://www.FreeBSD.org/doc/en/books/handbook/cvsup.html and \&\*(L"\s-1EXAMPLES\s0\*(R".) .PP The generated \s-1HTML\s0 has hyperlinks to the \f(CW\*(C`cvsweb.cgi\*(C'\fR script. This means you can click on any of the changed files and see the \s-1CVS\s0 log (change history) and have access to all the revisions and deltas. .PP (The \s-1CGI\s0 script \f(CW\*(C`cvsweb.cgi\*(C'\fR was originally written by Bill Fenner for the FreeBSD project. It allows browsing of CVS-repositories with a HTML\-browser. \s-1CVS\s0 is a popular version control system. \f(CW\*(C`cvsup\*(C'\fR is written by John Polstra . It is a network distribution package for \s-1CVS\s0 repositories.) .PP Options may be abbreviated to a unique prefix. The options are as follows: .IP "\-\-cvsweb=\fI\s-1URL\s0\fR" 4 .IX Item "--cvsweb=URL" Specify \s-1URL\s0 of cvsweb.cgi script. Default: http://cvsweb.FreeBSD.org/ .IP "\-\-urlsuffix=\fI\s-1SFX\s0\fR" 4 .IX Item "--urlsuffix=SFX" Specify some extra information for appending to generated URLs. (You should not type a leading \f(CW\*(C`?\*(C'\fR or \f(CW\*(C`&\*(C'\fR character because it will be added automatically.) .IP "\-\-branch=\fI\s-1TAG\s0\fR" 4 .IX Item "--branch=TAG" Output only commit messages from branch \fI\s-1TAG\s0\fR. .IP "\-\-showallbranches" 4 .IX Item "--showallbranches" Tell \f(CW\*(C`cvsweb.cgi\*(C'\fR that you want to see file revisions on all branches. The default behaviour is to show only revisions on the branch selected with \f(CW\*(C`\-\-branch\*(C'\fR. .IP "\-\-outfile=\fI\s-1FILENAME\s0\fR" 4 .IX Item "--outfile=FILENAME" Specify the output file. If no output file is specified standard output is used. .IP "\-\-committer=\fI\s-1PATTERN\s0\fR" 4 .IX Item "--committer=PATTERN" Output only commit messages from committer \fI\s-1PATTERN\s0\fR. More than one committer is requested by separating the committer names with a bar. Committer names in \fI\s-1PATTERN\s0\fR are case insensitive and must match the full committer name. .IP "\-\-filename=\fI\s-1PATTERN\s0\fR" 4 .IX Item "--filename=PATTERN" Output only commits affecting file \fI\s-1PATTERN\s0\fR. (Note that the pattern is in Perl syntax and not in Shell syntax!) .IP "\-\-logmessage=\fI\s-1PATTERN\s0\fR" 4 .IX Item "--logmessage=PATTERN" Output only commits with matching commit log messages. This option may be be specified multiple times. .IP "\-\-and" 4 .IX Item "--and" Output only commits matching all logmessage patterns (\s-1AND\s0). The default is to output commits matching any pattern (\s-1OR\s0). .IP "\-\-insensitive" 4 .IX Item "--insensitive" Ignore case when matching logmessage patterns. .IP "\-\-link\-committers" 4 .IX Item "--link-committers" Add hyperlinks to committers previous/next commit. .IP "\-\-number\-commits" 4 .IX Item "--number-commits" Sequentially number all commits. (Numbering is done on a per file basis.) .IP "\-\-queryprcgi=\fI\s-1URL\s0\fR" 4 .IX Item "--queryprcgi=URL" Use \fI\s-1URL\s0\fR to query problem reports. Default: http://www.FreeBSD.org/cgi/query\-pr.cgi .IP "\-\-maximum=\fI\s-1NUM\s0\fR" 4 .IX Item "--maximum=NUM" Output at most \fI\s-1NUM\s0\fR commits per input file. .IP "\-\-body\-attributes=\fI\s-1ATTRIBUTES\s0\fR" 4 .IX Item "--body-attributes=ATTRIBUTES" Specify attributes for the html \s-1BODY\s0 tag. .IP "\-\-noheadfoot" 4 .IX Item "--noheadfoot" Suppress output of \s-1HTML\s0, \s-1HEAD\s0 and \s-1BODY\s0 tags. This is for including the output into another \s-1HTML\s0 file. .IP "\-\-from=\fI\s-1DATE\s0\fR" 4 .IX Item "--from=DATE" Output only commit messages made after \fI\s-1DATE\s0\fR. Options \f(CW\*(C`\-\-after\*(C'\fR and \&\f(CW\*(C`\-\-since\*(C'\fR are aliases for \f(CW\*(C`\-\-from\*(C'\fR. .IP "\-\-to=\fI\s-1DATE\s0\fR" 4 .IX Item "--to=DATE" Output only commit messages made before \fI\s-1DATE\s0\fR. Options \f(CW\*(C`\-\-before\*(C'\fR and \f(CW\*(C`\-\-upto\*(C'\fR are aliases for \f(CW\*(C`\-\-to\*(C'\fR. If \fI\s-1DATE\s0\fR does not contain a timezone then the date is interpreted according to the local timezone. Check Time::ParseDate for supported date/time formats. .IP "\-\-nofileheaders" 4 .IX Item "--nofileheaders" Do not emit H1 tags for each input file. .IP "\-\-commitlogdir=\fI\s-1DIR\s0\fR" 4 .IX Item "--commitlogdir=DIR" Look for commitlogfiles in \fI\s-1DIR\s0\fR. (May contain shell wildcard characters.) .IP "\-\-sort\-arguments" 4 .IX Item "--sort-arguments" Arguments (input files) are processed in order of their modification times. This is useful to process several commitlog files in chronological order. .IP "\-\-version" 4 .IX Item "--version" Print version information and exit. .PP Input file names may contain shell wildcard characters ('\f(CW\*(C`*\*(C'\fR', \&'\f(CW\*(C`?\*(C'\fR'). The \-\f(CW\*(C`\-\-commitlogdir\*(C'\fR is prepended if given. Input files may have been compressed with \f(CW\*(C`gzip\*(C'\fR. .SH "FILES" .IX Header "FILES" \&\f(CW\*(C`commitlog2cvsweb\*(C'\fR looks for a configuration file in three places. .IP "\(bu" 4 If the variable \f(CW\*(C`CVSWEB_CONVERTERS_CONF\*(C'\fR is set in the environment its content is interpreted as the name of the configuration file, otherwise .IP "\(bu" 4 the file \fI~/.cvsweb\-converters.conf\fR is examined, and finally .IP "\(bu" 4 \&\fI/tmp/etc/cvsweb\-converters.conf\fR is tried. .PP Only the first existing file is used. .SH "EXAMPLES" .IX Header "EXAMPLES" .Sh "Step1: Retrieving the commitlog files" .IX Subsection "Step1: Retrieving the commitlog files" As a first step you need to get commitlog files. Retrieve them with \&\fIcvsup\fR\|(1). An example supfile is: .PP .Vb 12 \& # Change the next line to use your nearest CVSup mirror site, check \& # out http://www.FreeBSD.org/doc/en/books/handbook/cvsup.html \& *default host=cvsup2.FreeBSD.org base=/usr prefix=/home/ncvs \& *default release=cvs delete use-rel-suffix \& # If you have a slow network link, uncomment the following line! \& #*default compress \& # Next two lines will fetch/sync the commitlogs of /usr/src only. \& # If you are interested in doc/ports/projects too then you will \& # need "cvsroot-all" instead of only -common and -src. \& #cvsroot-all \& cvsroot-common \& cvsroot-src .Ve .PP Store this as file \fIcvsroot-supfile\fR and run cvsup: .PP \&\f(CW\*(C`cvsup \-i CVSROOT\e*/commitlogs cvsroot\-supfile\*(C'\fR .PP This will retrieve all commitlog files. That is some 32 MiB as of June 2006. If you are not interested in old logs use a refuse file as described in cvsup or a more selective \f(CW\*(C`\-i\*(C'\fR option in the above command line example. .Sh "Step2: HTMLizing with commitlog2cvsweb" .IX Subsection "Step2: HTMLizing with commitlog2cvsweb" To check what was going on in the area of FreeBSD kernel development since last monday run this command: .PP \&\f(CW\*(C`commitlog2cvsweb \-\-since "monday 0:00" \-o sys.html /home/ncvs/CVSROOT/commitlogs/sys\*(C'\fR .PP and open \fIsys.html\fR. .PP To see all kernel commits mentioning \f(CW\*(C`sound\*(C'\fR or \f(CW\*(C`pcm\*(C'\fR dating from the year 2006 run: .PP \&\f(CW\*(C`commitlog2cvsweb \-\-since 2006\-01\-01 \-\-before 2007\-01\-01 \&\-o sound2006.html \-i \-\-log sound \-\-log '\ebpcm\eb' \-\-sort /home/ncvs/CVSROOT/commitlogs/sys*\*(C'\fR .PP Note how \f(CW\*(C`\eb\*(C'\fR (word boundary) was used to avoid matching \f(CW\*(C`pcmcia\*(C'\fR! .SH "BUGS" .IX Header "BUGS" This implementation is too slow. .PP Commit messages pasted into logs of other commits may confuse the parser. .PP Timestamps in commitlog files without a timezone are interpreted according to the local timezone. (These timestamps occur only in very old FreeBSD commit logs.) .PP Option \f(CW\*(C`\-\-link\-commiters\*(C'\fR always adds a link to the next commit made by the same committer. This is wrong for the last one. (This bug is a consequence of single pass processing.) .SH "AUTHOR" .IX Header "AUTHOR" Martin Kammerhofer