[cvsreport] man page fixes

[Vincent Caron <address@hidden>]

Commit from zerodeux

2003-08-24 21:56 EDT

man page fixes

	Module	File name	Revision
	cvsreport	ChangeLog	1.30	>>>	1.31
	cvsreport	cvsreport.1	1.14	>>>	1.15

cvsreport/ChangeLog   1.30 >>> 1.31

Line 1

+ 2003/08/25 03:58  zerodeux
+ - man page
+   * fixed mass dyslexia
+   * moved 'automatic reporting' doc on top (popular feature)
+   * acknowledge 'multiple cvsreport in commitinfo' problem/bug
+

  2003/08/11 17:34  zerodeux
  - releasing 0.3.2
 

cvsreport/cvsreport.1   1.14 >>> 1.15

Line 54

  cvsreport -a -dproject.com:/cvsroot -f now-1week -e 'set myhtml {footer=; encoding=UTF-8} file myhtml -'
 
  Collect all commit events from the past week, and reports them as UTF-8 encoded HTML

- thru standard output. Also remove the default footer which advertise cvsreport.

+ thru standard output. Also remove the default footer which advertises cvsreport.
+
+
+ .SH AUTOMATIC MAIL ON COMMITS
+
+ If you don't specify the \fB-f\fP option, \fBcvsreport\fP notes its startup
+ time, waits for its caller's termination, then report on any commit events
+ which occured in between. Add this line to \fBCVSROOT/commitinfo\fP (via CVS!)
+ in the repository you want to watch :
+
+ .nf
+     ALL         cvsreport -e 'mail text address@hidden'
+ .fi

 
 
  .SH OPTIONS

Line 146

  Run a user command with its argument. It is only called if there is at least one
  commit event reported, and it is called no more than once per report. It can be
  useful to run a single command per changeset from a CVS repository, instead of

- the default CVS recusrive filter invocation (one call for every modified folder).

+ the default CVS recursive filter invocation (one call for every modified folder).

 
  .TP
  .B test

Line 158

  .SH CONFIGURATION
 
  A configuration script defines so-called \fIsets\fP which are a simple collection

- of key/value pairs, and can also include a list of commands exectued at load time.

+ of key/value pairs, and can also include a list of commands executed at load time.

  Here are the startup defaults written as a configuration script :
 
  .nf

Line 190

  statement separator can be either a newline or a semi-colon. Comments are not
  allowed after a statement, they are only accepted on their own line.
 

- Variables, deontated by the \fB$(name)\fP syntax, are substituted with their value
- at load time. Cvsreport automatically defines some variables :

+ Variables, denotated by the \fB$(name)\fP syntax, are substituted with their value
+ at load time. cvsreport automatically defines some variables :

 
  .RS
  .TP

Line 275

  .RE
 
  The mail command can be configured with the \fImail\fP set.

- The the following fields are available :

+ The following fields are available :

 
  .RS
  .TP
  .I command

- Set the command invoked to send mail. It is expected to accept the standard BSD mailx

+ Set the command invoked to send mail. It is expected to accept the standard BSD \fImailx\fP

  behaviour : \fB-a\fP for headers, \fB-s\fP for subject, addresses as regular arguments
  and body received via stdin.
 

Line 306

  .fi
 
 

- .SH AUTOMATIC MAIL ON COMMITS
-
- If you don't specify the \fB-f\fP option, \fBcvsreport\fP notes its startup
- time, waits for its caller's termination, then report on any commit events
- which occured in between. If the caller process happens to be the CVS server
- itself, we're done. Add this line to \fBCVSROOT/commitinfo\fP (via CVS!) in
- the repository you want to watch :
-
- .nf
-     ALL         cvsreport -e 'mail text address@hidden'
- .fi
-
-

  .SH FILES
  .I /etc/cvsreport.conf
  .RS

Line 341

 
  .SH BUGS
  Working on remote repositories is \fBawfully\fP slow (blame CVS).

+ .br
+ Can't run simultaneous instances in automatic report mode, but cvsreport
+ tries to make this scenario useless anyway (use its versatile configuration
+ and command mechanisms).

 
 
  .SH AUTHOR

Generated by cvsreport 0.3.2