tex/manual/SCRAM-manual.tex

%%____________________________________________________________________ 
%% File: SCRAM-manual.tex
%%____________________________________________________________________ 
%%  
%% Author: Shaun ASHBY <Shaun.Ashby@cern.ch>
%% Update: 2005-11-02 16:58:03+0100
%% Revision: $Id: SCRAM-manual.tex,v 1.5 2006/05/09 09:42:57 sashby Exp $ 
%%
%% Copyright: 2005 (C) Shaun ASHBY
%%
%%--------------------------------------------------------------------
\documentclass[12pt,twoside]{report}
\usepackage{pslatex}
\usepackage{style}
\usepackage{pslatex}
\makeindex
\begin{document}

\parskip 2ex plus 2pt minus 1pt
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% SCRAM manual: definitions                                        %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newcommand{\authorname}{S.~Ashby, \textsc{CERN PH D}ept.}
\newcommand{\scrammaintainers}{S.~Ashby}
\newcommand{\thisrelease}{V1\_0\_3}
\newcommand{\lastrelease}{V1\_0\_2}
\newcommand{\scramvx}{V1\_x}
\newcommand{\scramdevelopers}{scram-developers@cern.ch}
\newcommand{\savannahURL}{http://savannah.cern.ch/projects/scram/}
\newcommand{\scram}{\texttt{scram}}
%%
\newcommand{\scramcvsrepository}{\small{
    \texttt{:pserver:anonymous@cmscvs.cern.ch:/cvs\_server/repositories/SCRAM}
    }\normalsize}
\newcommand{\spiscramcvsrepository}{\small{
    \texttt{:pserver:anonymous@spitools.cern.ch:/cvs/SPITOOLS}
    }\normalsize}
%% New environment for indenting lists:
\newenvironment{indentlist}[2]{\begin{description}}{\end{description}}
\newcommand{\indentitem}[1]{\item[#1]}
\renewcommand{\ni}{\noindent}
\newcommand{\example}[1]{\paragraph{{\sffamily #1}:}}
\newcommand{\libcrh}{$2.1.x$}
\newcommand{\lbkt}{$<$}
\newcommand{\rbkt}{$>$~}
\newcommand{\mylongrightarrow}{$\longrightarrow$}
\newcommand{\pipe}{$|$}
\begin{htmlonly}
\newcommand{\libcrh}{\texttt{2.1.x}}
\newcommand{\lbkt}{<}
\newcommand{\rbkt}{> }
\newcommand{\mylongrightarrow}{\texttt{-->}}
\newcommand{\pipe}{|}
\end{htmlonly}
\newcommand{\option}[1]{[\textit{#1}]}
\newcommand{\marg}[1]{\texttt{#1}}
\newcommand{\optionwflag}[2]{[\textbf{#1}~\textit{#2}]}
\newcommand{\flag}[1]{[\textbf{#1}]}
\newcommand{\inbrackets}[1]{$<$\texttt{#1}$>$}
\newcommand{\buildfile}{BuildFile} %% Could change this to texttt
% 
\newenvironment{scramcmd}[1]{%
  \texttt{scram #1}
}{} %
% 
\newcommand{\tagstart}[1]{\lbkt\texttt{#1}\rbkt}
\newcommand{\tagend}[1]{\lbkt/\texttt{#1}\rbkt}
%% Define a new environment for typesetting tags with blank lines above
%% and below and slightly indented:
\newenvironment{tagprint}{%
  \begin{list}{}{\item[]}}
  {\end{list}}%
%
\newenvironment{indentprint}{%
  \begin{list}{}{\item[]}}
  {\end{list}}%

%% Other shortcuts:
\newcommand{\iie}{\emph{i.e.\ }}
\newcommand{\ieg}{\emph{e.g.\ }}
\newcommand{\ietc}{\emph{etc.\ }}
\newcommand{\ie}{i.e.\ }
\newcommand{\eg}{e.g.\ }
\newcommand{\etc}{etc.\ }

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Heading for title page:                                             %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagestyle{empty}
\begin{titlepage}
  \vspace{8cm}
  \begin{latexonly}
    \begin{center}
      {\Large\bf SCRAM: \thisrelease } \\ \vspace{1cm}
    \end{center}
  \end{latexonly}
  
  % Author and contact info:                                            %%  
  \vspace{5cm}    
  \begin{center}
    \begin{indentlist}{2.5cm}{3.0cm}
      \indentitem{Documentation Author:}\authorname
      \indentitem{Release Date:}\today
    \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. This manual is for SCRAM \thisrelease.
  \bigskip\bigskip
  \bigskip\bigskip
  \begin{center}
    \textbf{Please report bugs to \savannahURL}
  \end{center}
\end{titlepage}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 
\pagestyle{plain}
\pagenumbering{roman}
\tableofcontents            % Contents
\listoffigures
\pagestyle{plain}
\pagestyle{fancy}
\pagenumbering{arabic}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 
% SCRAM manual: scram-main. The main text.                         %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\include{Introduction}
\include{Installation}
\include{CreatingProjects}
\include{BuildSystem}
\include{Examples}
\include{QuickHelpGuide}

\include{Appendix}
\include{ReleaseNotes}

%% Finally, the index:
%% Now the index:
\small
\printindex
\normalsize
%%
\end{document}
%%____________________________________________________________________ 
%% End of SCRAM-manual.tex
%%____________________________________________________________________ 
%%  
Revision:	1.6
Committed:	Mon Sep 11 13:37:36 2006 UTC (18 years, 8 months ago) by sashby
Content type:	application/x-tex
Branch:	MAIN
CVS Tags:	V1_0_3-p4, V1_0_3-p3, V1_0_3-p2, V1_0_3-p1, V1_0_3
Branch point for:	v103_with_xml
Changes since 1.5:	+4 -3 lines
Log Message:	Merged from v103_branch
#	User	Rev	Content
1	sashby	1.1	%%____________________________________________________________________
2			%% File: SCRAM-manual.tex
3			%%____________________________________________________________________
4			%%
5			%% Author: Shaun ASHBY <Shaun.Ashby@cern.ch>
6			%% Update: 2005-11-02 16:58:03+0100
7	sashby	1.6	%% Revision: $Id: SCRAM-manual.tex,v 1.5 2006/05/09 09:42:57 sashby Exp $
8	sashby	1.1	%%
9			%% Copyright: 2005 (C) Shaun ASHBY
10			%%
11			%%--------------------------------------------------------------------
12			\documentclass[12pt,twoside]{report}
13	sashby	1.6	\usepackage{pslatex}
14	sashby	1.1	\usepackage{style}
15	sashby	1.5	\usepackage{pslatex}
16	sashby	1.1	\makeindex
17			\begin{document}
18	sashby	1.4
19	sashby	1.1	\parskip 2ex plus 2pt minus 1pt
20			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
21			% SCRAM manual: definitions %
22			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
23			\newcommand{\authorname}{S.~Ashby, \textsc{CERN PH D}ept.}
24			\newcommand{\scrammaintainers}{S.~Ashby}
25	sashby	1.6	\newcommand{\thisrelease}{V1\_0\_3}
26			\newcommand{\lastrelease}{V1\_0\_2}
27	sashby	1.1	\newcommand{\scramvx}{V1\_x}
28			\newcommand{\scramdevelopers}{scram-developers@cern.ch}
29			\newcommand{\savannahURL}{http://savannah.cern.ch/projects/scram/}
30			\newcommand{\scram}{\texttt{scram}}
31			%%
32			\newcommand{\scramcvsrepository}{\small{
33			\texttt{:pserver:anonymous@cmscvs.cern.ch:/cvs\_server/repositories/SCRAM}
34			}\normalsize}
35			\newcommand{\spiscramcvsrepository}{\small{
36			\texttt{:pserver:anonymous@spitools.cern.ch:/cvs/SPITOOLS}
37			}\normalsize}
38			%% New environment for indenting lists:
39			\newenvironment{indentlist}[2]{\begin{description}}{\end{description}}
40			\newcommand{\indentitem}[1]{\item[#1]}
41			\renewcommand{\ni}{\noindent}
42			\newcommand{\example}[1]{\paragraph{{\sffamily #1}:}}
43			\newcommand{\libcrh}{$2.1.x$}
44			\newcommand{\lbkt}{$<$}
45			\newcommand{\rbkt}{$>$~}
46			\newcommand{\mylongrightarrow}{$\longrightarrow$}
47			\newcommand{\pipe}{$\|$}
48			\begin{htmlonly}
49			\newcommand{\libcrh}{\texttt{2.1.x}}
50			\newcommand{\lbkt}{<}
51			\newcommand{\rbkt}{> }
52			\newcommand{\mylongrightarrow}{\texttt{-->}}
53			\newcommand{\pipe}{\|}
54			\end{htmlonly}
55			\newcommand{\option}[1]{[\textit{#1}]}
56			\newcommand{\marg}[1]{\texttt{#1}}
57			\newcommand{\optionwflag}[2]{[\textbf{#1}~\textit{#2}]}
58			\newcommand{\flag}[1]{[\textbf{#1}]}
59			\newcommand{\inbrackets}[1]{$<$\texttt{#1}$>$}
60			\newcommand{\buildfile}{BuildFile} %% Could change this to texttt
61			%
62			\newenvironment{scramcmd}[1]{%
63			\texttt{scram #1}
64			}{} %
65			%
66			\newcommand{\tagstart}[1]{\lbkt\texttt{#1}\rbkt}
67			\newcommand{\tagend}[1]{\lbkt/\texttt{#1}\rbkt}
68			%% Define a new environment for typesetting tags with blank lines above
69			%% and below and slightly indented:
70			\newenvironment{tagprint}{%
71			\begin{list}{}{\item[]}}
72			{\end{list}}%
73			%
74			\newenvironment{indentprint}{%
75			\begin{list}{}{\item[]}}
76			{\end{list}}%
77
78			%% Other shortcuts:
79			\newcommand{\iie}{\emph{i.e.\ }}
80			\newcommand{\ieg}{\emph{e.g.\ }}
81			\newcommand{\ietc}{\emph{etc.\ }}
82			\newcommand{\ie}{i.e.\ }
83			\newcommand{\eg}{e.g.\ }
84			\newcommand{\etc}{etc.\ }
85
86			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
87			%% Heading for title page: %%
88			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
89			\pagestyle{empty}
90			\begin{titlepage}
91	sashby	1.2	\vspace{8cm}
92			\begin{latexonly}
93			\begin{center}
94			{\Large\bf SCRAM: \thisrelease } \\ \vspace{1cm}
95			\end{center}
96			\end{latexonly}
97
98			% Author and contact info: %%
99			\vspace{5cm}
100	sashby	1.1	\begin{center}
101	sashby	1.2	\begin{indentlist}{2.5cm}{3.0cm}
102			\indentitem{Documentation Author:}\authorname
103			\indentitem{Release Date:}\today
104			\end{indentlist}
105			\end{center}
106			\vspace{3cm}
107
108			% A brief synopsis: %%
109
110			\ni SCRAM ({\bf S}oftware {\bf C}onfiguration
111			{\bf R}elease {\bf A}nd {\bf M}anagement) is a configuration
112			management and build tool originally conceived for the software
113			development environment of a high-energy physics experiment at
114			CERN. This manual is for SCRAM \thisrelease.
115			\bigskip\bigskip
116			\bigskip\bigskip
117			\begin{center}
118			\textbf{Please report bugs to \savannahURL}
119	sashby	1.1	\end{center}
120			\end{titlepage}
121
122	sashby	1.2	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
123	sashby	1.1	\pagestyle{plain}
124			\pagenumbering{roman}
125			\tableofcontents % Contents
126	sashby	1.4	\listoffigures
127			\pagestyle{plain}
128			\pagestyle{fancy}
129	sashby	1.1	\pagenumbering{arabic}
130
131	sashby	1.2	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
132	sashby	1.1	% SCRAM manual: scram-main. The main text. %
133			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
134
135			\include{Introduction}
136			\include{Installation}
137			\include{CreatingProjects}
138	sashby	1.3	\include{BuildSystem}
139	sashby	1.1	\include{Examples}
140			\include{QuickHelpGuide}
141	sashby	1.2
142	sashby	1.1	\include{Appendix}
143			\include{ReleaseNotes}
144
145			%% Finally, the index:
146			%% Now the index:
147			\small
148			\printindex
149			\normalsize
150			%%
151			\end{document}
152			%%____________________________________________________________________
153			%% End of SCRAM-manual.tex
154			%%____________________________________________________________________
155			%%