[Cvs-syncmail] syncmail/doc syncmail.1,NONE,1.1 syncmail.sgml,NONE,1.1

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/cvs-syncmail/syncmail/doc
In directory usw-pr-cvs1:/tmp/cvs-serv3688

Added Files:
	syncmail.1 syncmail.sgml 
Log Message:
Man page for syncmail.

--- NEW FILE: syncmail.1 ---
.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <st...@gg...>.
.TH "SYNCMAIL" "1" "03 May 2002" "" ""
.SH NAME
syncmail \- Send email notifications of CVS activity
.SH SYNOPSIS

\fBsyncmail\fR [ \fB--cvsroot \fIpath\fB\fR]  [ \fB [  [ --context]  [ -C] ] 
\fIlines\fB\fR]  [ \fB-c\fR]  [ \fB-u\fR]  [ \fB--quiet | -q\fR]  [ \fB--fromhost \fIhostname\fB\fR]  [ \fB-f \fIhostname\fB\fR]  [ \fB--help | -h\fR]  \fB%{sSv}\fR \fBemail\fR\fI ...\fR

.SH "DESCRIPTION"
.PP
\fBsyncmail\fR sends out notifications of CVS
commits via email, including the patch that was applied for
changed files, the content of new files, or notes about files
that were removed.
.PP
In any large project, keeping track of changes is difficult.
CVS does a reasonable job of allowing source changes to be
controlled and managed, but does not provide tools to make it
easier to work with a changing code base.  The hardest part of
working on a dynamic project with many changing modules is
knowing when changes occur, and what those changes are.
.PP
Software developers often are heavy email users, spending huge
amounts of time working with their email software.  Open source
developers are among the most serious email addicts out there,
sorting through hundreds of emails a day, since this is often
the only way to stay in touch with users and fellow developers.
.PP
\fBClearly, we need more email.\fR
.PP
syncmail works by integrating with CVS in the repository
using the configuration files in the repository's CVSROOT
module.  When CVS executes commands from the
\fIloginfo\fR file, syncmail is invoked if its
been configured, and it sends email to one or more email
addresses specified on the command line.
.SH "SETTING UP SYNCMAIL"
.PP
Setting up syncmail is not difficult, but there are usually
several steps:
.TP 1. 
Set up a mailing list.  Strictly speaking, this is optional,
but with most good mailing list managers, it's easier to
maintain a mailing list than it is to continually update a
list of individual email addresses on the syncmail
command line.  How this is done depends on many things, but
not syncmail, so will not be further covered here.
.TP 2. 
Install syncmail.  This is usually done by adding it to
your CVS repository, but it may be located in a directory on
the default \fBPATH\fR, or just about anywhere else.
.TP 3. 
Configure CVS to invoke syncmail.  This is a matter of
adding and/or changing some of the configuration files in
the CVSROOT module in the repository.
.SS "INSTALL SYNCMAIL"
.PP
syncmail consists of a single Python script; it does not
need any supplemental data files.  There are two approaches to
installing the script:
check it into the repository, or place it in a shared location on the CVS
server.
.PP
To install syncmail by checking it into the repository
itself, check out a working copy of the CVSROOT module.  Add
the name syncmail to the file
\fIcheckoutlist\fR in that directory as well,
and commit that change.  This will cause a copy of syncmail
to be checked out into the repository itself.  Copy te
syncmail script into the directory, make sure that it is
executable by everyone (you should use \fBchmod a+x
syncmail\fR for this), and use the \fBcvs
add\fR and \fBcvs commit\fR commands to
add it to the repository.  Once the commit is complete, a
checked-out copy of the syncmail script should be located
in the repository in the \fICVSROOT\fR directory in the
repository.  This is the usual way of integrating syncmail
into a CVS repository.
.PP
To install syncmail outside of the repository, find a
location for the script.  This can be in a "bin" directory
such as \fI/usr/local/bin/\fR, or can be in
some other location.  The only requirement is that all users
of the repository be able to execute the script (you should
use \fBchmod a+x syncmail\fR for this).  This
approach requires direct access to the CVS server machine, and
is most useful if several repositories are going to share a
single copy of syncmail (maybe to ensure the same version
is used for each; it's not large enough for disk space to be
an issue).
.SS "CONFIGURE CVS TO USE SYNCMAIL"
.PP
Getting the CVS server to invoke syncmail requires editing
one more file in the CVSROOT module of the repository.  Even
if you're using a single installation of syncmail, this
configuration needs to be performed for each repository.
.PP
The \fIloginfo\fR file in the CVSROOT module
needs to be modified to invoke syncmail when appropriate.
Just when is appropriate depends entirely on your project.  If
your \fIloginfo\fR file still contains the
comments that \fBcvs init\fR copies in, this is a
good time to read them if you haven't.  If the file does not
already contain any configuration lines, you can simply add to
the end of the file.
.PP
Here are two example lines to get you started:

.nf
CVSROOT $CVSROOT/CVSROOT/syncmail %{sVv} yo...@ex...

DEFAULT $CVSROOT/CVSROOT/syncmail %{sVv} myp...@ex...
.fi
.PP
This will cause email to be sent to two different places, with
which depending on what files in the repository are affected.
For administrative files in the CVSROOT module, email will be
sent to <yo...@ex...>; you should probably
list all your project administrators here.  For all other
files, email will be sent to the addresses you specify.
.PP
If you have several sub-products for which you want different
checkin lists, you can change the "DEFAULT" label to match the
subtree that you want to go to each list, with a separate line
for each distinct prefix.  For example, if your repository
includes the modules "one" and "two", you could use the
following:

.nf
CVSROOT $CVSROOT/CVSROOT/syncmail %{sVv} yo...@ex...

one/ $CVSROOT/CVSROOT/syncmail %{sVv} myp...@ex...
two/ $CVSROOT/CVSROOT/syncmail %{sVv} myp...@ex...
.fi
.PP
Note that %{sSv} is magic that CVS
understands and replaces with information about the files that
are affected; be sure to enter that exactly as shown, just
before the email addresses.  Command line options for
syncmail should be placed between the name of the
syncmail command and the %{sSv}.
.PP
You can still have a "DEFAULT" line that gets used for any
additional subprojects.
.PP
If you do \fBnot\fR have a stock
\fIloginfo\fR file, then you can probably
figure out what you need to do to combine the information
above with your existing changes.  If the command lines in the
file become too long for comfort, some helper scripts can be
added to the CVSROOT module (remember to add their names to
the \fIcheckoutlist\fR as well!).
.PP
To finish the repository configuration, commit the changes
you've made.  Once the CVS server has reported that it is
"Rebuilding administrative file database", your repository is
configured to use syncmail.
.SH "OPTIONS"
.PP
When an option includes an argument, you may specify the
argument either separate ("-d output") or mashed ("-doutput").
syncmail supports both.  For long options which include an
argument, the argument may be separated from the option
("--fromhost example.com") or mashed, but with an equals sign
between the option and the argument ("--fromhost=example.com").
.TP
\fB--cvsroot \fIpath\fB\fR
Use \fIpath\fR as the value for the
\fBCVSROOT\fR environment variable.  This is
usually not needed.
.TP
\fB--context \fIlines\fB\fR
.TP
\fB-C \fIlines\fB\fR
Generate context diffs with
\fIlines\fR lines of context
displayed on either side of the changed portion.
.TP
\fB-c\fR
Generate context diffs with two lines of context shown on
either side of the changed portion.  This is the default.
.TP
\fB-u\fR
Generate unified diffs instead of context diffs.  Unified
diffs are typically shorted than context diffs, but many
users find it easier to read context diffs.
.TP
\fB--quiet\fR
.TP
\fB-q\fR
Do not display progress information to the user.  By
default, syncmail will display the email addresses it
is sending mail to and note when it starts generating the
notification email and when it is done sending the email.
.TP
\fB--fromhost \fIhostname\fB\fR
.TP
\fB-f \fIhostname\fB\fR
Specify the host name that email should appear to come
from.  By default, syncmail uses the fully qualified
name for the host it's running on, and lets the local MTA
take care of host name translation.
.TP
\fB--help\fR
.TP
\fB-h\fR
For some reason, syncmail specifically ignores "--"
anywhere it appears on the command line.
.SH "BUGS"
.PP
There are probably some bugs.  If you find them, please
report them to the maintainers using the bug
tracker <URL:http://sourceforge.net/projects/cvs-syncmail/>.
.SH "ALTERNATIVES"
.PP
Other people have written tools that serve similar purposes, but
not all of these are meant to support CVS repositories accessed
from remote locations (anything other than direct filesystem
access).
.PP
Please inform the syncmail maintainers if you can provide
current references to these efforts.
.SH "SEE ALSO"
.PP
The syncmail page <URL:http://sourceforge.net/projects/cvs-syncmail/> on SourceForge <URL:http://sourceforge.net/>.
.PP
The CVS home page <URL:http://www.cvshome.org/>.
.SH "AUTHOR"
.PP
syncmail was originally written by Barry Warsaw to send mail
based on checkins to the Python project.  Barry continues to
maintain syncmail with help from Fred L. Drake, Jr. and others.
.PP
This manual page was written by Fred L. Drake, Jr. <fd...@ac...>.

--- NEW FILE: syncmail.sgml ---
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@
  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Fred</firstname>">
  <!ENTITY dhsurname   "<surname>Drake</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>May 3, 2002</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>fd...@ac...</email>">
  <!ENTITY dhusername  "Fred L. Drake, Jr.">
  <!ENTITY dhucpackage "<refentrytitle>SYNCMAIL</refentrytitle>">
  <!ENTITY dhpackage   "syncmail">

  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY sourceforge "<ulink url='http://sourceforge.net/'>SourceForge</ulink>">
]>
<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2002</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>Send email notifications of CVS activity</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg>--cvsroot <replaceable>path</replaceable></arg>
      <arg><group><arg>--context</arg><arg>-C</arg></group>
           <replaceable>lines</replaceable></arg>
      <arg>-c</arg>
      <arg>-u</arg>
      <arg><option>--quiet</option> | <option>-q</option></arg>
      <arg>--fromhost <replaceable>hostname</replaceable></arg>
      <arg>-f <replaceable>hostname</replaceable></arg>
      <arg><option>--help</option> | <option>-h</option></arg>
      <arg choice="req">%{sSv}</arg>
      <arg choice="req" rep="repeat">email</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      <command>&dhpackage;</command> sends out notifications of CVS
      commits via email, including the patch that was applied for
      changed files, the content of new files, or notes about files
      that were removed.
    </para>
    <para>
      In any large project, keeping track of changes is difficult.
      CVS does a reasonable job of allowing source changes to be
      controlled and managed, but does not provide tools to make it
      easier to work with a changing code base.  The hardest part of
      working on a dynamic project with many changing modules is
      knowing when changes occur, and what those changes are.
    </para>
    <para>
      Software developers often are heavy email users, spending huge
      amounts of time working with their email software.  Open source
      developers are among the most serious email addicts out there,
      sorting through hundreds of emails a day, since this is often
      the only way to stay in touch with users and fellow developers.
    </para>
    <para>
      <emphasis>Clearly, we need more email.</emphasis>
    </para>
    <para>
      &dhpackage; works by integrating with CVS in the repository
      using the configuration files in the repository's CVSROOT
      module.  When CVS executes commands from the
      <filename>loginfo</filename> file, &dhpackage; is invoked if its
      been configured, and it sends email to one or more email
      addresses specified on the command line.
    </para>
  </refsect1>

  <refsect1>
    <title>SETTING UP SYNCMAIL</title>
    <para>
      Setting up &dhpackage; is not difficult, but there are usually
      several steps:
    </para>
    <orderedlist numeration="arabic">
      <listitem>
        <para>
          Set up a mailing list.  Strictly speaking, this is optional,
          but with most good mailing list managers, it's easier to
          maintain a mailing list than it is to continually update a
          list of individual email addresses on the &dhpackage;
          command line.  How this is done depends on many things, but
          not &dhpackage;, so will not be further covered here.
        </para>
      </listitem>
      <listitem>
        <para>
          Install &dhpackage;.  This is usually done by adding it to
          your CVS repository, but it may be located in a directory on
          the default <envar>PATH</envar>, or just about anywhere else.
        </para>
      </listitem>
      <listitem>
        <para>
          Configure CVS to invoke &dhpackage;.  This is a matter of
          adding and/or changing some of the configuration files in
          the CVSROOT module in the repository.
        </para>
      </listitem>
    </orderedlist>

    <refsect2>
      <title>Install &dhpackage;</title>
      <para>
        &dhpackage; consists of a single Python script; it does not
        need any supplemental data files.  There are two approaches to
        installing the script:
        <simplelist type="inline">
          <member>check it into the repository</member>
          <member>or place it in a shared location on the CVS
          server</member>
        </simplelist>.
      </para>
      <para>
        To install &dhpackage; by checking it into the repository
        itself, check out a working copy of the CVSROOT module.  Add
        the name <literal>syncmail</literal> to the file
        <filename>checkoutlist</filename> in that directory as well,
        and commit that change.  This will cause a copy of &dhpackage;
        to be checked out into the repository itself.  Copy te
        &dhpackage; script into the directory, make sure that it is
        executable by everyone (you should use <command>chmod a+x
        syncmail</command> for this), and use the <command>cvs
        add</command> and <command>cvs commit</command> commands to
        add it to the repository.  Once the commit is complete, a
        checked-out copy of the &dhpackage; script should be located
        in the repository in the <filename
        class="directory">CVSROOT</filename> directory in the
        repository.  This is the usual way of integrating &dhpackage;
        into a CVS repository.
      </para>
      <para>
        To install &dhpackage; outside of the repository, find a
        location for the script.  This can be in a "bin" directory
        such as <filename
        class="directory">/usr/local/bin/</filename>, or can be in
        some other location.  The only requirement is that all users
        of the repository be able to execute the script (you should
        use <command>chmod a+x syncmail</command> for this).  This
        approach requires direct access to the CVS server machine, and
        is most useful if several repositories are going to share a
        single copy of &dhpackage; (maybe to ensure the same version
        is used for each; it's not large enough for disk space to be
        an issue).
      </para>
    </refsect2>

    <refsect2>
      <title>Configure CVS to use &dhpackage;</title>
      <para>
        Getting the CVS server to invoke &dhpackage; requires editing
        one more file in the CVSROOT module of the repository.  Even
        if you're using a single installation of &dhpackage;, this
        configuration needs to be performed for each repository.
      </para>
      <para>
        The <filename>loginfo</filename> file in the CVSROOT module
        needs to be modified to invoke &dhpackage; when appropriate.
        Just when is appropriate depends entirely on your project.  If
        your <filename>loginfo</filename> file still contains the
        comments that <command>cvs init</command> copies in, this is a
        good time to read them if you haven't.  If the file does not
        already contain any configuration lines, you can simply add to
        the end of the file.
      </para>
      <para>
        Here are two example lines to get you started:
<literallayout>
CVSROOT $CVSROOT/CVSROOT/syncmail %{sVv} yo...@ex...

DEFAULT $CVSROOT/CVSROOT/syncmail %{sVv} myp...@ex...
</literallayout>
      </para>
      <para>
        This will cause email to be sent to two different places, with
        which depending on what files in the repository are affected.
        For administrative files in the CVSROOT module, email will be
        sent to <email>yo...@ex...</email>; you should probably
        list all your project administrators here.  For all other
        files, email will be sent to the addresses you specify.
      </para>
      <para>
        If you have several sub-products for which you want different
        checkin lists, you can change the "DEFAULT" label to match the
        subtree that you want to go to each list, with a separate line
        for each distinct prefix.  For example, if your repository
        includes the modules "one" and "two", you could use the
        following:
<literallayout>
CVSROOT $CVSROOT/CVSROOT/syncmail %{sVv} yo...@ex...

one/ $CVSROOT/CVSROOT/syncmail %{sVv} myp...@ex...
two/ $CVSROOT/CVSROOT/syncmail %{sVv} myp...@ex...
</literallayout>
      </para>
      <para>
        Note that <literal>%{sSv}</literal> is magic that CVS
        understands and replaces with information about the files that
        are affected; be sure to enter that exactly as shown, just
        before the email addresses.  Command line options for
        &dhpackage; should be placed between the name of the
        &dhpackage; command and the <literal>%{sSv}</literal>.
      </para>
      <para>
        You can still have a "DEFAULT" line that gets used for any
        additional subprojects.
      </para>
      <para>
        If you do <emphasis>not</emphasis> have a stock
        <filename>loginfo</filename> file, then you can probably
        figure out what you need to do to combine the information
        above with your existing changes.  If the command lines in the
        file become too long for comfort, some helper scripts can be
        added to the CVSROOT module (remember to add their names to
        the <filename>checkoutlist</filename> as well!).
      </para>
      <para>
        To finish the repository configuration, commit the changes
        you've made.  Once the CVS server has reported that it is
        "Rebuilding administrative file database", your repository is
        configured to use &dhpackage;.
      </para>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>
    <para>
      When an option includes an argument, you may specify the
      argument either separate ("-d output") or mashed ("-doutput").
      &dhpackage; supports both.  For long options which include an
      argument, the argument may be separated from the option
      ("--fromhost example.com") or mashed, but with an equals sign
      between the option and the argument ("--fromhost=example.com").
    </para>

    <variablelist>
      <varlistentry>
        <term><option>--cvsroot <replaceable>path</replaceable></option></term>
        <listitem>
          <para>
            Use <replaceable>path</replaceable> as the value for the
            <envar>CVSROOT</envar> environment variable.  This is
            usually not needed.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--context <replaceable>lines</replaceable></option></term>
        <term><option>-C <replaceable>lines</replaceable></option></term>
        <listitem>
          <para>
            Generate context diffs with
            <replaceable>lines</replaceable> lines of context
            displayed on either side of the changed portion.
	  </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-c</option></term>
        <listitem>
          <para>
            Generate context diffs with two lines of context shown on
            either side of the changed portion.  This is the default.
	   </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-u</option></term>
        <listitem>
          <para>
            Generate unified diffs instead of context diffs.  Unified
            diffs are typically shorted than context diffs, but many
            users find it easier to read context diffs.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--quiet</option></term>
        <term><option>-q</option></term>
        <listitem>
          <para>
            Do not display progress information to the user.  By
            default, &dhpackage; will display the email addresses it
            is sending mail to and note when it starts generating the
            notification email and when it is done sending the email.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--fromhost <replaceable>hostname</replaceable></option></term>
        <term><option>-f <replaceable>hostname</replaceable></option></term>
        <listitem>
          <para>
            Specify the host name that email should appear to come
            from.  By default, &dhpackage; uses the fully qualified
            name for the host it's running on, and lets the local MTA
            take care of host name translation.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--help</option></term>
        <term><option>-h</option></term>
        <listitem>
          <para>
            For some reason, &dhpackage; specifically ignores "--"
            anywhere it appears on the command line.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>BUGS</title>
    <para>
      There are probably some bugs.  If you find them, please
      report them to the maintainers using the <ulink
      url="http://sourceforge.net/projects/cvs-syncmail/">bug
      tracker</ulink>.
    </para>
  </refsect1>

  <refsect1>
    <title>ALTERNATIVES</title>
    <para>
      Other people have written tools that serve similar purposes, but
      not all of these are meant to support CVS repositories accessed
      from remote locations (anything other than direct filesystem
      access).
    </para>

    <para>
      Please inform the &dhpackage; maintainers if you can provide
      current references to these efforts.
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      The <ulink url="http://sourceforge.net/projects/cvs-syncmail/"
      >&dhpackage; page</ulink> on &sourceforge;.
    </para>

    <para>
      The <ulink url="http://www.cvshome.org/">CVS home page</ulink>.
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>
      &dhpackage; was originally written by Barry Warsaw to send mail
      based on checkins to the Python project.  Barry continues to
      maintain &dhpackage; with help from &dhusername; and others.
    </para>
    <para>
      This manual page was written by &dhusername; &dhemail;.
    </para>
  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->