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.7 2007/02/27 11:59:41 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\_1\_0}
\newcommand{\lastrelease}{V1\_0\_3}
\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@isscvs.cern.ch:/local/reps/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}{$>$~}
%%
%% For XML tag markup:
%% <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
%% <tag att1="abc" att2="123"></tag> or
%% <tag att1="abc" att2="123"/>
%%
\newcommand{\xmldocheader}{$<$?\texttt{xml} version="1.0" encoding="UTF-8" standalone="\texttt{yes}"?$>$}
%%
\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.\ }

%% Moved from CreatingProjects.tex:
\renewcommand{\descriptionlabel}[1]{
  \setlength{\evensidemargin}{\oddsidemargin}
\rm{#1}}% We want description items to be normal
        % text, not bold. Margins adjusted.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% 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:
\small
\printindex
\normalsize

%%
\end{document}
%%____________________________________________________________________ 
%% End of SCRAM-manual.tex
%%____________________________________________________________________ 
%%  
Revision:	1.8
Committed:	Tue Feb 27 16:16:01 2007 UTC (18 years, 2 months ago) by sashby
Content type:	application/x-tex
Branch:	MAIN
CVS Tags:	HEAD_SM_071214, V1_1_0, v110p1, V110p6, V110p5, V110p4, V110p3
Branch point for:	HEAD_BRANCH_SM_071214, v200branch
Changes since 1.7:	+2 -2 lines
Log Message:	Doc updates
#	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.8	%% Revision: $Id: SCRAM-manual.tex,v 1.7 2007/02/27 11:59:41 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.7	\newcommand{\thisrelease}{V1\_1\_0}
26			\newcommand{\lastrelease}{V1\_0\_3}
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	sashby	1.8	\texttt{:pserver:anonymous@isscvs.cern.ch:/local/reps/scram}
34	sashby	1.1	}\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	sashby	1.7	%%
47			%% For XML tag markup:
48			%% <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
49			%% <tag att1="abc" att2="123"></tag> or
50			%% <tag att1="abc" att2="123"/>
51			%%
52			\newcommand{\xmldocheader}{$<$?\texttt{xml} version="1.0" encoding="UTF-8" standalone="\texttt{yes}"?$>$}
53			%%
54	sashby	1.1	\newcommand{\mylongrightarrow}{$\longrightarrow$}
55			\newcommand{\pipe}{$\|$}
56			\begin{htmlonly}
57			\newcommand{\libcrh}{\texttt{2.1.x}}
58			\newcommand{\lbkt}{<}
59			\newcommand{\rbkt}{> }
60			\newcommand{\mylongrightarrow}{\texttt{-->}}
61			\newcommand{\pipe}{\|}
62			\end{htmlonly}
63			\newcommand{\option}[1]{[\textit{#1}]}
64			\newcommand{\marg}[1]{\texttt{#1}}
65			\newcommand{\optionwflag}[2]{[\textbf{#1}~\textit{#2}]}
66			\newcommand{\flag}[1]{[\textbf{#1}]}
67			\newcommand{\inbrackets}[1]{$<$\texttt{#1}$>$}
68			\newcommand{\buildfile}{BuildFile} %% Could change this to texttt
69			%
70			\newenvironment{scramcmd}[1]{%
71			\texttt{scram #1}
72			}{} %
73			%
74			\newcommand{\tagstart}[1]{\lbkt\texttt{#1}\rbkt}
75	sashby	1.7	\newcommand{\tagend}[1]{\lbkt\texttt{/#1}\rbkt}
76	sashby	1.1	%% Define a new environment for typesetting tags with blank lines above
77			%% and below and slightly indented:
78			\newenvironment{tagprint}{%
79			\begin{list}{}{\item[]}}
80			{\end{list}}%
81			%
82			\newenvironment{indentprint}{%
83			\begin{list}{}{\item[]}}
84			{\end{list}}%
85
86			%% Other shortcuts:
87			\newcommand{\iie}{\emph{i.e.\ }}
88			\newcommand{\ieg}{\emph{e.g.\ }}
89			\newcommand{\ietc}{\emph{etc.\ }}
90			\newcommand{\ie}{i.e.\ }
91			\newcommand{\eg}{e.g.\ }
92			\newcommand{\etc}{etc.\ }
93
94	sashby	1.7	%% Moved from CreatingProjects.tex:
95			\renewcommand{\descriptionlabel}[1]{
96			\setlength{\evensidemargin}{\oddsidemargin}
97			\rm{#1}}% We want description items to be normal
98			% text, not bold. Margins adjusted.
99
100	sashby	1.1	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
101			%% Heading for title page: %%
102			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
103			\pagestyle{empty}
104			\begin{titlepage}
105	sashby	1.2	\vspace{8cm}
106			\begin{latexonly}
107			\begin{center}
108			{\Large\bf SCRAM: \thisrelease } \\ \vspace{1cm}
109			\end{center}
110			\end{latexonly}
111
112			% Author and contact info: %%
113			\vspace{5cm}
114	sashby	1.1	\begin{center}
115	sashby	1.2	\begin{indentlist}{2.5cm}{3.0cm}
116			\indentitem{Documentation Author:}\authorname
117			\indentitem{Release Date:}\today
118			\end{indentlist}
119			\end{center}
120			\vspace{3cm}
121
122			% A brief synopsis: %%
123
124			\ni SCRAM ({\bf S}oftware {\bf C}onfiguration
125			{\bf R}elease {\bf A}nd {\bf M}anagement) is a configuration
126			management and build tool originally conceived for the software
127			development environment of a high-energy physics experiment at
128			CERN. This manual is for SCRAM \thisrelease.
129			\bigskip\bigskip
130			\bigskip\bigskip
131			\begin{center}
132			\textbf{Please report bugs to \savannahURL}
133	sashby	1.1	\end{center}
134			\end{titlepage}
135
136	sashby	1.2	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
137	sashby	1.1	\pagestyle{plain}
138			\pagenumbering{roman}
139			\tableofcontents % Contents
140	sashby	1.4	\listoffigures
141			\pagestyle{plain}
142			\pagestyle{fancy}
143	sashby	1.1	\pagenumbering{arabic}
144
145	sashby	1.2	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
146	sashby	1.1	% SCRAM manual: scram-main. The main text. %
147			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
148
149			\include{Introduction}
150			\include{Installation}
151			\include{CreatingProjects}
152	sashby	1.3	\include{BuildSystem}
153	sashby	1.1	\include{Examples}
154			\include{QuickHelpGuide}
155			\include{Appendix}
156			\include{ReleaseNotes}
157
158			%% Finally, the index:
159			\small
160			\printindex
161			\normalsize
162	sashby	1.7
163	sashby	1.1	%%
164			\end{document}
165			%%____________________________________________________________________
166			%% End of SCRAM-manual.tex
167			%%____________________________________________________________________
168			%%