tex/manual/SCRAM.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% SCRAM manual                                                     %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Revision : $Id: SCRAM.tex,v 1.25 2002/10/29 15:25:52 sashby Exp $
%          :                                                       %
%          :                                                       %
%          :                                                       %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\documentclass[12pt,twoside]{report}
\usepackage{a4}
\usepackage{epsfig}
\usepackage{html}
\usepackage{makeidx}
\usepackage{tabularx}
%% Begin the document:
\begin{document}
\pagestyle{plain}
%% This stuff taken from a4p.sty:
\newlength{\dinwidth}
\newlength{\dinmargin}
\setlength{\dinwidth}{21.0cm}
\setlength{\textheight}{24.2cm} 
\setlength{\textwidth}{17.0cm}
\setlength{\dinmargin}{\dinwidth}
\addtolength{\dinmargin}{-\textwidth}
\setlength{\dinmargin}{0.5\dinmargin}
\setlength{\oddsidemargin}{-1.0in}
\addtolength{\oddsidemargin}{\dinmargin}
\setlength{\evensidemargin}{\oddsidemargin}
\setlength{\marginparwidth}{0.9\dinmargin}
\setlength{\marginparsep}{8pt} 
\setlength{\marginparpush}{5pt}
\setlength{\topmargin}{-42pt}
\setlength{\headheight}{12pt}
\setlength{\headsep}{30pt}
\setlength{\footskip}{24pt}
%%%%
\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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Include definitions:                                                %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\include{defs}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Heading for title page:                                             %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{titlepage}
\vspace{5cm}
\begin{latexonly}
  \begin{center}
    {\Large\bf SCRAM User Manual } \\ \vspace{1cm}
  \end{center}
\end{latexonly}
\begin{htmlonly}
  \begin{center}
    \textbf{SCRAM User Manual}
  \end{center}
\end{htmlonly}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Author and contact info:                                            %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\vspace{5cm}    
\begin{center}
  \begin{indentlist}{2.5cm}{3.0cm}
    \indentitem{Documentation author:}\authorname
    \indentitem{Contributors:}
    \indentitem{Release Version:}\thisrelease
  \end{indentlist}
\end{center}
\vspace{3cm}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% A brief synopsis:                                                   %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ni \scram ({\bf S}oftware {\bf C}onfiguration 
{\bf R}elease {\bf A}nd  {\bf M}anagement) is a configuration
management and build tool originally conceived for the software 
development environment of a high-energy physics experiment at
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, external packages \etc).

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

\texttt{http://cmsdoc.cern.ch/Releases/SCRAM/current/cgi/scrampage.cgi}

\bigskip\bigskip
\bigskip\bigskip

\begin{center}
\textbf{Please report bugs to \email{\scramdevelopers}}
\end{center}
\end{titlepage}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%\tableofcontents            % Contents
%\listoffigures              % Figures 
%\listoftables               % Tables
%\clearemptydoublepage       % ---------
\include{scram-main}        % Main text
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\end{document}
Revision:	1.26
Committed:	Fri Nov 1 16:40:28 2002 UTC (22 years, 6 months ago) by sashby
Content type:	application/x-tex
Branch:	MAIN
Changes since 1.25:	+14 -7 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	sashby	1.12	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2			% SCRAM manual %
3			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4	sashby	1.26	% Revision : $Id: SCRAM.tex,v 1.25 2002/10/29 15:25:52 sashby Exp $
5	sashby	1.12	% : %
6			% : %
7			% : %
8			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9	sashby	1.16	\documentclass[12pt,twoside]{report}
10	sashby	1.21	\usepackage{a4}
11	sashby	1.16	\usepackage{epsfig}
12	sashby	1.12	\usepackage{html}
13			\usepackage{makeidx}
14	sashby	1.17	\usepackage{tabularx}
15	sashby	1.12	%% Begin the document:
16			\begin{document}
17			\pagestyle{plain}
18	sashby	1.21	%% This stuff taken from a4p.sty:
19			\newlength{\dinwidth}
20			\newlength{\dinmargin}
21			\setlength{\dinwidth}{21.0cm}
22			\setlength{\textheight}{24.2cm}
23			\setlength{\textwidth}{17.0cm}
24			\setlength{\dinmargin}{\dinwidth}
25			\addtolength{\dinmargin}{-\textwidth}
26			\setlength{\dinmargin}{0.5\dinmargin}
27			\setlength{\oddsidemargin}{-1.0in}
28			\addtolength{\oddsidemargin}{\dinmargin}
29			\setlength{\evensidemargin}{\oddsidemargin}
30			\setlength{\marginparwidth}{0.9\dinmargin}
31			\setlength{\marginparsep}{8pt}
32			\setlength{\marginparpush}{5pt}
33			\setlength{\topmargin}{-42pt}
34			\setlength{\headheight}{12pt}
35			\setlength{\headsep}{30pt}
36			\setlength{\footskip}{24pt}
37			%%%%
38	sashby	1.12	\oddsidemargin=-0.25cm
39			\topmargin=-1.5cm
40	sashby	1.21	%%\setlength{\textwidth}{16.5cm}
41			%%\setlength{\textheight}{24.0cm}
42			%%\headheight 0.0cm
43	sashby	1.12	\footskip 35pt
44			\parskip 2ex plus 2pt minus 1pt
45	sashby	1.24	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
46			%% Include definitions: %%
47			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
48	sashby	1.12	\include{defs}
49	sashby	1.24	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
50			%% Heading for title page: %%
51			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
52	sashby	1.12	\begin{titlepage}
53	sashby	1.13	\vspace{5cm}
54	sashby	1.26	\begin{latexonly}
55			\begin{center}
56			{\Large\bf SCRAM User Manual } \\ \vspace{1cm}
57			\end{center}
58			\end{latexonly}
59			\begin{htmlonly}
60			\begin{center}
61			\textbf{SCRAM User Manual}
62			\end{center}
63			\end{htmlonly}
64	sashby	1.24	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
65			%% Author and contact info: %%
66			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
67	sashby	1.13	\vspace{5cm}
68	sashby	1.12	\begin{center}
69			\begin{indentlist}{2.5cm}{3.0cm}
70			\indentitem{Documentation author:}\authorname
71			\indentitem{Contributors:}
72	sashby	1.19	\indentitem{Release Version:}\thisrelease
73	sashby	1.12	\end{indentlist}
74			\end{center}
75			\vspace{3cm}
76	sashby	1.24	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
77			%% A brief synopsis: %%
78			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
79			\ni \scram ({\bf S}oftware {\bf C}onfiguration
80			{\bf R}elease {\bf A}nd {\bf M}anagement) is a configuration
81			management and build tool originally conceived for the software
82			development environment of a high-energy physics experiment at
83			CERN. It provides a set of commands allowing users to develop and test
84			code in different physical locations while ensuring that a common
85			configuration is available, but also allowing developers the
86			flexibility to easily choose different tools as they wish (compilers, external packages \etc).
87	sashby	1.12
88	sashby	1.25	\ni Further information can be obtained from the \url{\scram home page}
89	sashby	1.13	{http://cmsdoc.cern.ch/Releases/SCRAM/current/cgi/scrampage.cgi}
90			which can be found at
91
92			\texttt{http://cmsdoc.cern.ch/Releases/SCRAM/current/cgi/scrampage.cgi}
93	sashby	1.12
94	sashby	1.13	\bigskip\bigskip
95			\bigskip\bigskip
96	sashby	1.12
97	sashby	1.13	\begin{center}
98	sashby	1.12	\textbf{Please report bugs to \email{\scramdevelopers}}
99	sashby	1.13	\end{center}
100	sashby	1.12	\end{titlepage}
101	sashby	1.24	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
102	sashby	1.26	%\tableofcontents % Contents
103			%\listoffigures % Figures
104			%\listoftables % Tables
105	sashby	1.24	%\clearemptydoublepage % ---------
106			\include{scram-main} % Main text
107			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
108	sashby	1.12	\end{document}