| 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 |
%% Revision: $Id: SCRAM-manual.tex,v 1.6 2006/09/11 13:37:36 sashby Exp $
|
| 8 |
%%
|
| 9 |
%% Copyright: 2005 (C) Shaun ASHBY
|
| 10 |
%%
|
| 11 |
%%--------------------------------------------------------------------
|
| 12 |
\documentclass[12pt,twoside]{report}
|
| 13 |
\usepackage{pslatex}
|
| 14 |
\usepackage{style}
|
| 15 |
\usepackage{pslatex}
|
| 16 |
\makeindex
|
| 17 |
\begin{document}
|
| 18 |
|
| 19 |
\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 |
\newcommand{\thisrelease}{V1\_1\_0}
|
| 26 |
\newcommand{\lastrelease}{V1\_0\_3}
|
| 27 |
\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 |
%%
|
| 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 |
\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 |
\newcommand{\tagend}[1]{\lbkt\texttt{/#1}\rbkt}
|
| 76 |
%% 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 |
%% 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 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
| 101 |
%% Heading for title page: %%
|
| 102 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
| 103 |
\pagestyle{empty}
|
| 104 |
\begin{titlepage}
|
| 105 |
\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 |
\begin{center}
|
| 115 |
\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 |
\end{center}
|
| 134 |
\end{titlepage}
|
| 135 |
|
| 136 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
| 137 |
\pagestyle{plain}
|
| 138 |
\pagenumbering{roman}
|
| 139 |
\tableofcontents % Contents
|
| 140 |
\listoffigures
|
| 141 |
\pagestyle{plain}
|
| 142 |
\pagestyle{fancy}
|
| 143 |
\pagenumbering{arabic}
|
| 144 |
|
| 145 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
| 146 |
% SCRAM manual: scram-main. The main text. %
|
| 147 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
| 148 |
|
| 149 |
\include{Introduction}
|
| 150 |
\include{Installation}
|
| 151 |
\include{CreatingProjects}
|
| 152 |
\include{BuildSystem}
|
| 153 |
\include{Examples}
|
| 154 |
\include{QuickHelpGuide}
|
| 155 |
\include{Appendix}
|
| 156 |
\include{ReleaseNotes}
|
| 157 |
|
| 158 |
%% Finally, the index:
|
| 159 |
\small
|
| 160 |
\printindex
|
| 161 |
\normalsize
|
| 162 |
|
| 163 |
%%
|
| 164 |
\end{document}
|
| 165 |
%%____________________________________________________________________
|
| 166 |
%% End of SCRAM-manual.tex
|
| 167 |
%%____________________________________________________________________
|
| 168 |
%%
|
