1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
|
#! /bin/sh /usr/share/dpatch/dpatch-run
## 04_man_page.dpatch by <csacca@thecsl.org>
##
## All lines beginning with `## DP:' are a description of the patch.
## DP: Corrects lintian infos on the man page
## DP: Changes - to \- or \(hy depending on use
@DPATCH@
--- cvs-syncmail/doc/syncmail.1 2005-08-09 09:41:27.076546440 -0400
+++ cvs-syncmail/doc/syncmail.1 2005-08-09 10:16:44.115707568 -0400
@@ -1,16 +1,16 @@
.\" 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,
+.\" Please send any bug reports, improvements, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SYNCMAIL" "1" "15 July 2003" "" ""
+.TH "SYNCMAIL" "1" "09 August 2005" "" ""
.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--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
+\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\-\-mailhost \fIhostname\fB\fR ] [ \fB\-m \fIhostname\fB\fR ] [ \fB\-\-reply\(hyto \fIemail\(hyaddress\fB\fR ] [ \fB\-R \fIemail\(hyaddress\fB\fR ] [ \fB\-\-subject\(hyprefix \fIstring\fB\fR ] [ \fB\-S \fIstring\fB\fR ] [ \fB\-\-help | \-h\fR ] \fB%{sSv}\fR \fBemail\fR\fI ...\fR
.SH "DESCRIPTION"
.PP
@@ -68,7 +68,7 @@
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.
+server\&.
.PP
To install syncmail by checking it into the repository
itself, check out a working copy of the CVSROOT module. Add
@@ -81,7 +81,7 @@
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
+checked\(hyout 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.
@@ -118,7 +118,7 @@
.nf
CVSROOT $CVSROOT/CVSROOT/syncmail %{sVv} you@example.com
-DEFAULT $CVSROOT/CVSROOT/syncmail %{sVv} myproject-checkins@example.com
+DEFAULT $CVSROOT/CVSROOT/syncmail %{sVv} myproject\(hycheckins@example.com
.fi
.PP
This will cause email to be sent to two different places, with
@@ -128,7 +128,7 @@
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
+If you have several sub\(hyproducts 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
@@ -138,8 +138,8 @@
.nf
CVSROOT $CVSROOT/CVSROOT/syncmail %{sVv} you@example.com
-one/ $CVSROOT/CVSROOT/syncmail %{sVv} myproject-one-cvs@example.com
-two/ $CVSROOT/CVSROOT/syncmail %{sVv} myproject-two-cvs@exmaple.com
+one/ $CVSROOT/CVSROOT/syncmail %{sVv} myproject\(hyone\(hycvs@example.com
+two/ $CVSROOT/CVSROOT/syncmail %{sVv} myproject\(hytwo\(hycvs@exmaple.com
.fi
.PP
Note that %{sSv} is magic that CVS
@@ -147,7 +147,7 @@
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}.
+syncmail command and the %{sSv}\&.
.PP
You can still have a "DEFAULT" line that gets used for any
additional subprojects.
@@ -167,85 +167,85 @@
.SH "OPTIONS"
.PP
When an option includes an argument, you may specify the
-argument either separate ("-d output") or mashed ("-doutput").
+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").
+("\-\-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
+\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
+\fB\-\-context \fIlines\fB\fR
.TP
-\fB-C \fIlines\fB\fR
+\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
+\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
+\fB\-u\fR
Generate unified diffs instead of context diffs. Unified
diffs are typically shorter than context diffs, but many
users find it easier to read context diffs.
.TP
-\fB--quiet\fR
+\fB\-\-quiet\fR
.TP
-\fB-q\fR
+\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
+\fB\-\-fromhost \fIhostname\fB\fR
.TP
-\fB-f \fIhostname\fB\fR
+\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--mailhost \fIhostname\fB\fR
+\fB\-\-mailhost \fIhostname\fB\fR
.TP
-\fB-m \fIhostname\fB\fR
+\fB\-m \fIhostname\fB\fR
Specify the host name that should be used to submit mail
via SMTP. By default, syncmail uses
-\fBlocalhost\fR.
+\fBlocalhost\fR\&.
.TP
-\fB--reply-to \fIemail-address\fB\fR
+\fB\-\-reply\(hyto \fIemail\(hyaddress\fB\fR
.TP
-\fB-R \fIemail-address\fB\fR
+\fB\-R \fIemail\(hyaddress\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
+\fB\-\-subject\(hyprefix \fIstring\fB\fR
.TP
-\fB-S \fIstring\fB\fR
-Provide a string that is pre-pended to the subject of
+\fB\-S \fIstring\fB\fR
+Provide a string that is pre\(hypended to the subject of
generated email. This prefix is often of the form
-\&'[Checkins]', allowing mail filters to easily identify
+'[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
+\fB\-\-help\fR
.TP
-\fB-h\fR
+\fB\-h\fR
Print a summary of the command line options to standard
output.
.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/>.
+tracker <URL:http://sourceforge.net/projects/cvs\(hysyncmail/>\&.
.SH "ALTERNATIVES"
.PP
Other people have written tools that serve similar purposes, but
@@ -253,8 +253,8 @@
from remote locations (anything other than direct filesystem
access).
.PP
-A mostly-equivalent package, written in Perl, is available as
-cvs-syncmail (Perl version) <URL:http://cvs-syncmail-pl.sourceforge.net/>.
+A mostly\(hyequivalent package, written in Perl, is available as
+cvs-syncmail (Perl version) <URL:http://cvs\(hysyncmail\(hypl.sourceforge.net/>\&.
.PP
\fBlog_accum\fR is another Perl implementation, but
there appears to be no authoritative source of information for
@@ -264,13 +264,13 @@
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/>.
+The syncmail page <URL:http://sourceforge.net/projects/cvs\(hysyncmail/> on SourceForge <URL:http://sourceforge.net/>\&.
.PP
-The CVS home page <URL:http://www.cvshome.org/>.
+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. <fdrake@acm.org>.
+This manual page was written by Fred L. Drake, Jr. <fdrake@acm.org>\&.
|