[Bio] / SoftRelTools / MkRelHtml.1 Repository:
ViewVC logotype

View of /SoftRelTools/MkRelHtml.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1.1.1 - (download) (annotate) (vendor branch)
Fri Dec 20 20:20:56 2002 UTC (15 years, 11 months ago) by efrank
Branch: BobJacobsen, MAIN
CVS Tags: Head-20-Dec-2002, HEAD
Changes since 1.1: +0 -0 lines

Import from SLAC.  Not sure this is going to serve us, but there is a ton
of experience in this package.

.\"*****************************************************************
.\"  This manpage documents the use of MkRelHtml
.\"  It is formatted in nroff
.\"  Created:                                       11/04/96
.\"                                                 D.Johnson
.\"
.\"
.\"
.\"
.\"
.\"
.\"
.\"*****************************************************************
.TH MkRelHtml 1
.SH NAME
.TP 10
.B MkRelHtml 
Make the HTML page 
.B l.m.n_info.html 
containing a list of the packages and their versions contained in the
.B BaBar
software release l.m.n.
.BR
.\"*****************************************************************
.\"
.\"
.\"*****************************************************************
.SH SYNOPSIS
.P
MkRelHtml l.m.n 
.PP
.RS 10
where 
.B l.m.n 
is the release version number.
.RS -10
.\"*****************************************************************
.\"
.\"
.\"*****************************************************************
.SH DESCRIPTION
.PP
The 
.B PERL
script, 
.B MkRelHtml
reads the links in 
. B $BFROOT/dist/releases/l.m.n 
and uses this information to create the html page 
.B l.m.m_info.html.
The html formatted page contains a list of packages included in the 
.B BaBar
software release l.m.n and their version numbers. It determines the
package version numbers by resolving the links in
.B $BFROOT/dist/releases/l.m.n.
to their respective packages.
.P 
This script requires that the 
.B BaBar
environment be set up and that the environmental variable
.B BFROOT
be defined. If the file
.B l.m.n_info.html
already exists in the current directory, then the user will be prompted
for permission to ovewrite the file.
.P
.\"*****************************************************************
.\" A description of the substitutions made using MkRelHtml.template
.\"
.\"*****************************************************************
The following substitutions will be made by 
.B MkRelHtml
in the template file
.B MkRelHtml.template
when creating 
.B l.m.n_info.html.
.HP 3
1) All occurances of 
.B ReleaseVersionNumber
will be replaced with the
Babar software release version.
.HP 3
2) The regex
.B ^InsertionsHere 
will be replaced with the software package names and their version numbers.
.HP 3
3) The regex
.B ^InsertDateHere
will be replaced with the current date and time.
.HP 3
4) The string
.B KnownProblemsInsertedHere
will be replaced with known problems.
.HP 3
5) The string
.B InsertNewPackageNames
will be replaced with new packages in this release.
.HP 3
6) The string
.B InsertRemovedPackageNames
will be replaced with packages removed as of this releases.
.HP 3
7) The regex 
.B ^GCCVersionInsertions 
will be replaced with a table containing OS dependent compilation parameters.
.\"*****************************************************************
.\"
.\"
.\"*****************************************************************
.SH EXAMPLE
.P
Create the html info file for release 1.2.3:
.P
.RS 10
% MkRelHtml 1.2.3
.RS -10
.SH FILES
.PP
MkRelHtml
.De
MkRelHtml.template
.De
l.m.n_info.html
.\"*****************************************************************
.\"
.\"
.\"*****************************************************************
.SH AUTHOR
Doug Johnson
.De
November 4, 1996

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3