doc/user_manual/user_manual.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %
   3 %    NEPI, a framework to manage network experiments
   4 %    Copyright (C) 2013 INRIA
   5 %
   6 %    This program is free software: you can redistribute it and/or modify
   7 %    it under the terms of the GNU General Public License as published by
   8 %    the Free Software Foundation, either version 3 of the License, or
   9 %    (at your option) any later version.
  10 %
  11 %    This program is distributed in the hope that it will be useful,
  12 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 %    GNU General Public License for more details.
  15 %
  16 %    You should have received a copy of the GNU General Public License
  17 %    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 %
  19 % Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  20 %
  21 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  22
  23
  24 %\documentclass[12pt, openright,twoside]{memoir}
  25 %% avoid blank page between chapters with openany
  26 \documentclass[12pt,openany]{memoir}
  27 %% Make margings on even and odd pages equal
  28 \setulmarginsandblock{3cm}{3cm}{*}
  29 \setlrmarginsandblock{3cm}{3cm}{*}
  30 \checkandfixthelayout
  31
  32 \usepackage[T1]{fontenc}
  33 \usepackage{kpfonts}
  34 \setSingleSpace{1.1}
  35 \SingleSpacing
  36 \usepackage{xcolor,calc}
  37 \definecolor{chaptercolor}{gray}{0.8}
  38
  39 % helper macros
  40 \newcommand\numlifter[1]{\raisebox{-2cm}[0pt][0pt]{\smash{#1}}}
  41 \newcommand\numindent{\kern37pt}
  42 \newlength\chaptertitleboxheight
  43
  44 \makechapterstyle{hansen}{
  45    \renewcommand\printchaptername{\raggedleft}
  46     \renewcommand\printchapternum{%
  47         \begingroup%
  48         \leavevmode%
  49         \chapnumfont%
  50         \strut%
  51         \numlifter{\thechapter}%
  52         \numindent%
  53         \endgroup%
  54     }
  55     \renewcommand*{\printchapternonum}{%
  56         \vphantom{\begingroup%
  57             \leavevmode%
  58             \chapnumfont%
  59             \numlifter{\vphantom{9}}%
  60             \numindent%
  61         \endgroup}
  62     \afterchapternum}
  63    \setlength\midchapskip{0pt}
  64    \setlength\beforechapskip{0.5\baselineskip}
  65     \setlength{\afterchapskip}{3\baselineskip}
  66     \renewcommand\chapnumfont{%
  67         \fontsize{4cm}{0cm}%
  68         \bfseries%
  69         \sffamily%
  70         \color{chaptercolor}%
  71     }
  72     \renewcommand\chaptitlefont{%
  73         \normalfont%
  74         \huge%
  75         \bfseries%
  76         \raggedleft%
  77     }%
  78     \settototalheight\chaptertitleboxheight{%
  79     \parbox{\textwidth}{\chaptitlefont \strut bg\\bg\strut}}
  80     \renewcommand\printchaptertitle[1]{%
  81         \parbox[t][\chaptertitleboxheight][t]{\textwidth}{%
  82             %\microtypesetup{protrusion=false}% add this if you use microtype
  83         \chaptitlefont\strut ##1\strut}%
  84     }
  85 }
  86 \chapterstyle{hansen}
  87
  88 \usepackage{verbatim}
  89 \usepackage{hyperref}
  90 %% Remove red squares on top of hyperlinks
  91 \hypersetup{%
  92         pdfborder = {0 0 0}
  93     }
  94
  95 \usepackage{graphicx}
  96 \usepackage{listings}
  97 \usepackage{color}
  98 \usepackage[scaled]{beramono}
  99
 100 \definecolor{mygreen}{rgb}{0,0.6,0}
 101 \definecolor{mygray}{rgb}{0.5,0.5,0.5}
 102 \definecolor{mymauve}{rgb}{0.58,0,0.82}
 103 \definecolor{mylightgray}{gray}{0.95}
 104
 105 \lstset{ %
 106   backgroundcolor=\color{mylightgray},   % choose the background color; you must add \usepackage{color} or \usepackage{xcolor}
 107   basicstyle=\footnotesize\ttfamily,        % the size of the fonts that are used for the code
 108   breakatwhitespace=false,         % sets if automatic breaks should only happen at whitespace
 109   breaklines=true,                 % sets automatic line breaking
 110   captionpos=b,                    % sets the caption-position to bottom
 111   commentstyle=\color{mygreen},    % comment style
 112   deletekeywords={...},            % if you want to delete keywords from the given language
 113   escapeinside={\%*}{*)},          % if you want to add LaTeX within your code
 114   extendedchars=true,              % lets you use non-ASCII characters; for 8-bits encodings only, does not work with UTF-8
 115   %frame=single,                    % adds a frame around the code
 116   keepspaces=true,                 % keeps spaces in text, useful for keeping indentation of code (possibly needs columns=flexible)
 117   keywordstyle=\color{blue},       % keyword style
 118   language=Python,                 % the language of the code
 119   morekeywords={*,...},            % if you want to add more keywords to the set
 120   %numbers=left,                    % where to put the line-numbers; possible values are (none, left, right)
 121   %numbersep=5pt,                   % how far the line-numbers are from the code
 122   %numberstyle=\tiny\color{mygray}, % the style that is used for the line-numbers
 123   %stepnumber=1,                    % the step between two line-numbers. If it's 1, each line will be numbered
 124   rulecolor=\color{black},         % if not set, the frame-color may be changed on line-breaks within not-black text (e.g. comments (green here))
 125   showspaces=false,                % show spaces everywhere adding particular underscores; it overrides 'showstringspaces'
 126   showstringspaces=false,          % underline spaces within strings only
 127   showtabs=false,                  % show tabs within strings adding particular underscores
 128   stringstyle=\color{mymauve},     % string literal style
 129   tabsize=2,                       % sets default tabsize to 2 spaces
 130   title=\lstname                   % show the filename of files included with \lstinputlisting; also try caption instead of title
 131 }
 132
 133 \title{NEPI v3.0 User Manual}
 134 \date{}
 135 \author{}
 136 \renewcommand{\maketitlehookd}{%
 137   \begin{center}
 138     \includegraphics[width=6cm]{nepi_logo.png}
 139 \end{center}}
 140
 141 \begin{document}
 142
 143 % clear numbering from first page
 144 \clearpage\maketitle
 145 \thispagestyle{empty}
 146
 147 \pagebreak
 148 \tableofcontents
 149
 150 \chapter{FAQ}
 151 \label{faq}
 152 \input{faq.tex}
 153
 154 \chapter{Getting started}
 155 \label{getting_started}
 156 \input{getting_started.tex}
 157
 158 \chapter{Introduction to NEPI}
 159 \label{introduction}
 160 \input{introduction.tex}
 161
 162 \chapter{The ExperimentController API}
 163 \label{ec_api}
 164 \input{ec_api.tex}
 165
 166 \chapter{Supported resources}
 167 \label{supported_resources}
 168 \input{supported_resources.tex}
 169
 170 %%\chapter{ExperimentController internals}
 171 %%\label{ec_internals}
 172 %%\input{ec_internals.tex}
 173
 174 %%\chapter{ResourceManager internals}
 175 %%\label{rm_internals}
 176 %%\input{rm_internals.tex}
 177
 178 %%\chapter{Extending NEPI: The CCNx case}
 179 %%\label{extending_nepi}
 180 %%\input{extending_nepi.tex}
 181
 182 \chapter{Debbuging}
 183 \label{debugging}
 184 \input{debugging.tex}
 185
 186 %%\chapter{Unit testing}
 187 %%\label{unit_testing}
 188 %%\input{unit_testing.tex}
 189
 190 \chapter{Release Cycle}
 191 \label{release_cycle}
 192 \input{release_cycle.tex}
 193
 194 %%\chapter{Coding Style}
 195 %%\label{coding_style}
 196 %%\input{coding_style.tex}
 197
 198 \end{document}