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.3.2.1 2006/08/31 12:30:04 sashby Exp $ 
%%
%% Copyright: 2005 (C) Shaun ASHBY
%%
%%--------------------------------------------------------------------
\documentclass[12pt,twoside]{report}
\usepackage{pslatex}
\usepackage{style}
\makeindex
\begin{document}
\footskip 35pt
\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
\pagenumbering{arabic}
\pagestyle{fancy}

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