.\" Copyright 2000 Ben Smithurst <ben@smithurst.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	$BCPS: src/mailutils/cvsmail.1,v 1.9 2002/12/30 22:41:14 ben Exp $
.Dd August 29, 2000
.Os
.Dt CVSMAIL 1
.Sh NAME
.Nm cvsmail
.Nd add cvsweb.cgi links to FreeBSD commit mail
.Sh SYNOPSIS
.Nm
.Op Fl CcdfGgqv
.Op Fl u Ar url
.Op Fl U Ar url
.Sh DESCRIPTION
.Nm
can be used from a
.Xr procmailrc 5
file to add cvsweb.cgi links to FreeBSD commit mail,
allowing you to easily view the diffs for a particular commit.
.Pp
The following flags are accepted:
.Pp
.Bl -tag -width indent
.It Fl C
Print diffs or links to diffs in context diff format,
rather than the default unified diff format.
.It Fl c
Print links to human-readable, coloured diffs, instead of the default plain
diffs.
.It Fl d
Include diffs in the output,
as well as links to the diffs.
.It Fl f
Munge the data so that a line starting with
.Dq From
and a space has a
.Ql >
character insterted before it.
This prevents some MUAs from assuming that line is the start of a new
message if the mailbox is in traditional mbox format.  It will also insert a
dummy
.Dq From
line as the first line of the message if the first line read by
.Nm
is not already a
.Dq From
line.
.It Fl G
This option causes the URLs for diffs to be included both after the individual change lines,
.Em and
before the actual diff.
This option only has an effect if both
.Fl d
and
.Fl g
are also specified.
.It Fl g
This option causes all the URLs for diffs, and, if
.Fl d
is specified,
the diffs themselves,
to be included at the end of the output,
rather than immediately after the ``changes'' line for that file.
.It Fl q
Operate quietly.
This is the default if stderr is not a terminal.
.It Fl v
Operate more verbosely.
This is the default is stderr is a terminal.
.It Fl u
Specify an alternate
.Nm cvsweb.cgi
script.
The default is
.Dq http://cvsweb.FreeBSD.org/ .
Please note that the argument to this
.Em must
include the trailing slash.
.It Fl U
Specify an additional
.Nm cvsweb.cgi
script, to be used in addition to the default.
As with the
.Fl u
flag,
the argument to this flag must include the trailing slash.
.El
.Sh EXAMPLES
The following
.Xr procmailrc 5
rule might be used.
.Bd -literal -offset indent
:0
* ^Sender: owner-cvs-all@freebsd.org
{
  :0
  * X-FreeBSD-CVS-Branch:.*RELENG_4
  | cvsmail -f $MAILDIR/lists/freebsd-cvs-stable

  :0
  * X-FreeBSD-CVS-Branch:.*RELENG_
  | cvsmail -f $MAILDIR/lists/freebsd-cvs-other

  :0
  | cvsmail -f $MAILDIR/lists/freebsd-cvs-all
}
.Ed
.Pp
This will separate your commit mail into separate folders based on the CVS
branch affected.
If you are a committer, you might prefer a rule more like this.
.Bd -literal -offset indent
:0
* ^Sender: owner-cvs-committers@freebsd.org
{
  :0
  * Subject:.*cvs commit:
  {
    :0
    * X-FreeBSD-CVS-Branch:.*RELENG_4
    | cvsmail -f $MAILDIR/lists/freebsd-cvs-stable

    :0
    * X-FreeBSD-CVS-Branch:.*RELENG_
    | cvsmail -f $MAILDIR/lists/freebsd-cvs-other

    :0
    | cvsmail -f $MAILDIR/lists/freebsd-cvs-all
  }

  :0
  lists/freebsd-committers
}
.Ed
.Sh AUTHORS
.An Ben Smithurst Aq ben@smithurst.org