[Cvs-syncmail] syncmail/doc syncmail.1,1.2,1.3 syncmail.sgml,1.2,1.3

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/cvs-syncmail/syncmail/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv22766

Modified Files:
	syncmail.1 syncmail.sgml 
Log Message:
Update manpage to include --mailhost/-m, --reply-to/-R, --subject-prefix/-S,
and make the --help/-h description make sense.
Fixes http://bugs.debian.org/cgi-bin/bugreport.cgi?archive=no&bug=186358


Index: syncmail.1
===================================================================
RCS file: /cvsroot/cvs-syncmail/syncmail/doc/syncmail.1,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3

--- syncmail.1	8 Apr 2003 19:15:40 -0000	1.2
+++ syncmail.1	8 Jul 2003 21:20:23 -0000	1.3
@@ -3,13 +3,14 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <st...@gg...>.
-.TH "SYNCMAIL" "1" "08 April 2003" "" ""
+.TH "SYNCMAIL" "1" "08 July 2003" "" ""
+
 .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
+\fIlines\fB\fR ] [ \fB-c\fR ] [ \fB-u\fR ] [ \fB--quiet | -q\fR ] [ \fB--fromhost \fIhostname\fB\fR ] [ \fB-f \fIhostname\fB\fR ] [ \fB--mailhost \fIhostname\fB\fR ] [ \fB-m \fIhostname\fB\fR ] [ \fB--reply-to \fIemail-address\fB\fR ] [ \fB-R \fIemail-address\fB\fR ] [ \fB--subject-prefix \fIstring\fB\fR ] [ \fB-S \fIstring\fB\fR ] [ \fB--help | -h\fR ] \fB%{sSv}\fR \fBemail\fR\fI ...\fR
 
 .SH "DESCRIPTION"
 .PP
@@ -209,11 +210,37 @@
 name for the host it's running on, and lets the local MTA
 take care of host name translation.
 .TP
+\fB--mailhost \fIhostname\fB\fR
+.TP
+\fB-m \fIhostname\fB\fR
+Specify the host name that should be used to submit mail
+via SMTP.  By default, syncmail uses
+\fBlocalhost\fR.
+.TP
+\fB--reply-to \fIemail-address\fB\fR
+.TP
+\fB-R \fIemail-address\fB\fR
+Specify an email address that should be used for the
+Reply-To header in email.  This header is not normally
+used.
+.TP
+\fB--subject-prefix \fIstring\fB\fR
+.TP
+\fB-S \fIstring\fB\fR
+Provide a string that is pre-pended to the subject of
+generated email.  This prefix is often of the form
+\&'[Checkins]', allowing mail filters to easily identify
+mail from syncmail for a specific CVS repository or
+project.
+
+This is often not needed if mail is being sent to a
+mailing list manager that adds a prefix of it's own.
+.TP
 \fB--help\fR
 .TP
 \fB-h\fR
-For some reason, syncmail specifically ignores "--"
-anywhere it appears on the command line.
+Print a summary of the command line options to standard
+output.
 .SH "BUGS"
 .PP
 There are probably some bugs.  If you find them, please

Index: syncmail.sgml
===================================================================
RCS file: /cvsroot/cvs-syncmail/syncmail/doc/syncmail.sgml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- syncmail.sgml	8 Apr 2003 19:12:20 -0000	1.2
+++ syncmail.sgml	8 Jul 2003 21:20:23 -0000	1.3
@@ -13,7 +13,7 @@
   <!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>">
+  <!ENTITY dhdate      "<date>July 8, 2003</date>">
   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
        allowed: see man(7), man(1). -->
   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
@@ -60,6 +60,12 @@
       <arg><option>--quiet</option> | <option>-q</option></arg>
       <arg>--fromhost <replaceable>hostname</replaceable></arg>
       <arg>-f <replaceable>hostname</replaceable></arg>
+      <arg>--mailhost <replaceable>hostname</replaceable></arg>
+      <arg>-m <replaceable>hostname</replaceable></arg>
+      <arg>--reply-to <replaceable>email-address</replaceable></arg>
+      <arg>-R <replaceable>email-address</replaceable></arg>
+      <arg>--subject-prefix <replaceable>string</replaceable></arg>
+      <arg>-S <replaceable>string</replaceable></arg>
       <arg><option>--help</option> | <option>-h</option></arg>
       <arg choice="req">%{sSv}</arg>
       <arg choice="req" rep="repeat">email</arg>
@@ -342,12 +348,54 @@
       </varlistentry>
 
       <varlistentry>
+        <term><option>--mailhost <replaceable>hostname</replaceable></option></term>
+        <term><option>-m <replaceable>hostname</replaceable></option></term>
+        <listitem>
+          <para>
+            Specify the host name that should be used to submit mail
+            via SMTP.  By default, &dhpackage; uses
+            <systemitem class="systemname">localhost</systemitem>.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--reply-to <replaceable>email-address</replaceable></option></term>
+        <term><option>-R <replaceable>email-address</replaceable></option></term>
+        <listitem>
+          <para>
+            Specify an email address that should be used for the
+            Reply-To header in email.  This header is not normally
+            used.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--subject-prefix <replaceable>string</replaceable></option></term>
+        <term><option>-S <replaceable>string</replaceable></option></term>
+        <listitem>
+          <para>
+            Provide a string that is pre-pended to the subject of
+            generated email.  This prefix is often of the form
+            '[Checkins]', allowing mail filters to easily identify
+            mail from syncmail for a specific CVS repository or
+            project.
+          </para>
+          <para>
+            This is often not needed if mail is being sent to a
+            mailing list manager that adds a prefix of it's own.
+          </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.
+            Print a summary of the command line options to standard
+            output.
           </para>
         </listitem>
       </varlistentry>




