tex/manual/SCRAM.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% SCRAM manual                                                %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% modified : Fri Jun 21 14:50:47 2002 / SFA                   %
%          :                                                  %
%          :                                                  %
%          :                                                  %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Revision : $Id: SCRAM.tex,v 1.3 2002/06/21 15:02:19 sashby Exp $
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\documentclass[11pt]{report}
\usepackage{a4p}
\usepackage{html}
\usepackage{makeidx}

%% Begin the document:
\begin{document}
\pagestyle{plain}
\oddsidemargin=-0.25cm
\topmargin=-1.5cm
\setlength{\textwidth}{16.5cm}
\setlength{\textheight}{24.0cm}
\headheight 0.0cm
\footskip 35pt
\parskip 2ex plus 2pt minus 1pt

%% Define some variables here:
\newcommand{\authorname}{S.~Ashby, \textsc{CERN EP D}ivision.}
\newcommand{\revision}{1.0}
\newcommand{\scramdevelopers}{scram-developers@cern.ch}
\newcommand{\scram}{\textsc{scram}}
\newenvironment{indentlist}[2]{\begin{description}}{\end{description}}
\newcommand{\indentitem}[1]{\item[#1]}
\newcommand{\url}[2]{\htmladdnormallink{#1}{#2}}
\newcommand{\email}[1]{\htmladdnormallink{#1}{mailto:#1}}

%% Heading for title page:
\begin{titlepage}
\begin{center}
 {\Large\bf SCRAM User Manual } \\ \vspace{1cm}
\end{center}

%% Author and contact info:
\vspace{1cm}    
\begin{center}
  \begin{indentlist}{2.5cm}{3.0cm}
    \indentitem{Documentation author:}\authorname
    \indentitem{Contributors:}
  \end{indentlist}
\end{center}
\vspace{3cm}

\indent \scram~ (\textsc{s}oftware \textsc{c}onfiguration 
\textsc{r}elease \textsc{a}nd  \textsc{m}anagement) is a tool
originally conceived for the software development environment of a
high-energy physics experiment at \textsc{cern}. It provides a set of
commands allowing users to develop and test code in different physical
locations while ensuring that a common configuration is available, but
also allowing developers the flexibility to easily choose
different tools as they wish (compilers or external packages, etc\.).


Further information can be obtained from the \url{SCRAM home page.}
{http://cmsdoc.cern.ch/Releases/SCRAM/current/cgi/scrampage.cgi}

\textbf{please report bugs to \email{\scramdevelopers}}

\end{titlepage}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%% Start the sections


% Introduction and History


An overview for the impatient user

Setting up a project for the first time


Creating a developer area


using debug libraries

Changing tools or adding/configuring new tools


Description

      What is SCRAM? 
      Current SCRAM Functionality 

Installation

This section is for administrators who need to set things up. General
users can skip straight to the "Working within a SCRAM Environment" section. 

      SCRAM Installation 

            Download and general installation instructions 
            Further installation instructions for external sites 
            Configuration of Netscape to Use SCRAM 
            Controlling SCRAM versions 
            SCRAM database handling 
            Release Notes 
            GNU Public Licence 

      Installation of projects that use SCRAM 

            To install a Software Project on a remote site - Changing/defining external product locations etc. 
            Download page for SCRAM-managed projects 

Configuration Management

      Configuring a new project 
      Configuration Tools: 

            Tools Available in a SCRAM environment 
            Installing/removing tools 
            Tool Description Documents 

Working Within a SCRAM Environment

Using SCRAM in project development 

      Getting Started 
      The Runtime Environment 
      Building Binaries 
      Controlling the Build - The BuildFile 
            <Export> tags. Configuring the <Use> tag for your Software Package. 
            Defining the Configuration Interface for a Software Unit 
            BuildFile Tags 
            Glossary of BuildFile Tags 
            Some Example BuildFiles 
            Asking for Externals 
            Advanced Use of the build command 
            Specific Tools in SCRAM 


\end{document}
Revision:	1.4
Committed:	Tue Jul 2 14:45:28 2002 UTC (22 years, 10 months ago) by sashby
Content type:	application/x-tex
Branch:	MAIN
Changes since 1.3:	+75 -3 lines
Log Message:	Rewriting BuildSystem. Using some of CW earlier modules for build logging. For tests before poss release.
#	User	Rev	Content
1	sashby	1.2	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2			% SCRAM manual %
3			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4			% modified : Fri Jun 21 14:50:47 2002 / SFA %
5			% : %
6			% : %
7			% : %
8			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9	sashby	1.4	% Revision : $Id: SCRAM.tex,v 1.3 2002/06/21 15:02:19 sashby Exp $
10	sashby	1.2	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11			\documentclass[11pt]{report}
12			\usepackage{a4p}
13	sashby	1.3	\usepackage{html}
14			\usepackage{makeidx}
15	sashby	1.2
16	sashby	1.3	%% Begin the document:
17	sashby	1.2	\begin{document}
18			\pagestyle{plain}
19			\oddsidemargin=-0.25cm
20			\topmargin=-1.5cm
21			\setlength{\textwidth}{16.5cm}
22			\setlength{\textheight}{24.0cm}
23			\headheight 0.0cm
24			\footskip 35pt
25			\parskip 2ex plus 2pt minus 1pt
26
27	sashby	1.3	%% Define some variables here:
28			\newcommand{\authorname}{S.~Ashby, \textsc{CERN EP D}ivision.}
29			\newcommand{\revision}{1.0}
30			\newcommand{\scramdevelopers}{scram-developers@cern.ch}
31			\newcommand{\scram}{\textsc{scram}}
32			\newenvironment{indentlist}[2]{\begin{description}}{\end{description}}
33			\newcommand{\indentitem}[1]{\item[#1]}
34			\newcommand{\url}[2]{\htmladdnormallink{#1}{#2}}
35			\newcommand{\email}[1]{\htmladdnormallink{#1}{mailto:#1}}
36
37			%% Heading for title page:
38			\begin{titlepage}
39			\begin{center}
40			{\Large\bf SCRAM User Manual } \\ \vspace{1cm}
41			\end{center}
42
43			%% Author and contact info:
44			\vspace{1cm}
45			\begin{center}
46			\begin{indentlist}{2.5cm}{3.0cm}
47			\indentitem{Documentation author:}\authorname
48			\indentitem{Contributors:}
49			\end{indentlist}
50			\end{center}
51			\vspace{3cm}
52
53	sashby	1.4	\indent \scram~ (\textsc{s}oftware \textsc{c}onfiguration
54	sashby	1.3	\textsc{r}elease \textsc{a}nd \textsc{m}anagement) is a tool
55			originally conceived for the software development environment of a
56			high-energy physics experiment at \textsc{cern}. It provides a set of
57			commands allowing users to develop and test code in different physical
58			locations while ensuring that a common configuration is available, but
59	sashby	1.4	also allowing developers the flexibility to easily choose
60	sashby	1.3	different tools as they wish (compilers or external packages, etc\.).
61	sashby	1.2
62
63	sashby	1.4
64	sashby	1.3	Further information can be obtained from the \url{SCRAM home page.}
65			{http://cmsdoc.cern.ch/Releases/SCRAM/current/cgi/scrampage.cgi}
66	sashby	1.2
67	sashby	1.3	\textbf{please report bugs to \email{\scramdevelopers}}
68	sashby	1.2
69	sashby	1.3	\end{titlepage}
70			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
71	sashby	1.2
72	sashby	1.4	%% Start the sections
73
74
75
76			% Introduction and History
77
78
79
80			An overview for the impatient user
81
82			Setting up a project for the first time
83
84
85			Creating a developer area
86
87
88			using debug libraries
89
90			Changing tools or adding/configuring new tools
91
92
93
94
95
96
97
98
99
100
101
102
103			Description
104
105			What is SCRAM?
106			Current SCRAM Functionality
107
108			Installation
109
110			This section is for administrators who need to set things up. General
111			users can skip straight to the "Working within a SCRAM Environment" section.
112	sashby	1.2
113	sashby	1.4	SCRAM Installation
114	sashby	1.2
115	sashby	1.4	Download and general installation instructions
116			Further installation instructions for external sites
117			Configuration of Netscape to Use SCRAM
118			Controlling SCRAM versions
119			SCRAM database handling
120			Release Notes
121			GNU Public Licence
122	sashby	1.2
123	sashby	1.4	Installation of projects that use SCRAM
124	sashby	1.2
125	sashby	1.4	To install a Software Project on a remote site - Changing/defining external product locations etc.
126			Download page for SCRAM-managed projects
127	sashby	1.2
128	sashby	1.4	Configuration Management
129	sashby	1.2
130	sashby	1.4	Configuring a new project
131			Configuration Tools:
132	sashby	1.2
133	sashby	1.4	Tools Available in a SCRAM environment
134			Installing/removing tools
135			Tool Description Documents
136	sashby	1.2
137	sashby	1.4	Working Within a SCRAM Environment
138	sashby	1.2
139	sashby	1.4	Using SCRAM in project development
140	sashby	1.2
141	sashby	1.4	Getting Started
142			The Runtime Environment
143			Building Binaries
144			Controlling the Build - The BuildFile
145			<Export> tags. Configuring the <Use> tag for your Software Package.
146			Defining the Configuration Interface for a Software Unit
147			BuildFile Tags
148			Glossary of BuildFile Tags
149			Some Example BuildFiles
150			Asking for Externals
151			Advanced Use of the build command
152			Specific Tools in SCRAM
153	sashby	1.2
154
155
156
157
158
159
160
161			\end{document}