1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 % NEPI, a framework to manage network experiments
4 % Copyright (C) 2013 INRIA
6 % This program is free software: you can redistribute it and/or modify
7 % it under the terms of the GNU General Public License version 2 as
8 % published by the Free Software Foundation;
10 % This program is distributed in the hope that it will be useful,
11 % but WITHOUT ANY WARRANTY; without even the implied warranty of
12 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 % GNU General Public License for more details.
15 % You should have received a copy of the GNU General Public License
16 % along with this program. If not, see <http://www.gnu.org/licenses/>.
18 % Author: Alina Quereilhac <alina.quereilhac@inria.fr>
20 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
22 %\documentclass[12pt, openright,twoside]{memoir}
23 %% avoid blank page between chapters with openany
24 \documentclass[12pt,openany]{memoir}
25 %% Make margings on even and odd pages equal
26 \setulmarginsandblock{3cm}{3cm}{*}
27 \setlrmarginsandblock{3cm}{3cm}{*}
30 \usepackage[T1]{fontenc}
34 \usepackage{xcolor,calc}
35 \definecolor{chaptercolor}{gray}{0.8}
38 \newcommand\numlifter[1]{\raisebox{-2cm}[0pt][0pt]{\smash{#1}}}
39 \newcommand\numindent{\kern37pt}
40 \newlength\chaptertitleboxheight
42 \makechapterstyle{hansen}{
43 \renewcommand\printchaptername{\raggedleft}
44 \renewcommand\printchapternum{%
49 \numlifter{\thechapter}%
53 \renewcommand*{\printchapternonum}{%
54 \vphantom{\begingroup%
57 \numlifter{\vphantom{9}}%
61 \setlength\midchapskip{0pt}
62 \setlength\beforechapskip{0.5\baselineskip}
63 \setlength{\afterchapskip}{3\baselineskip}
64 \renewcommand\chapnumfont{%
70 \renewcommand\chaptitlefont{%
76 \settototalheight\chaptertitleboxheight{%
77 \parbox{\textwidth}{\chaptitlefont \strut bg\\bg\strut}}
78 \renewcommand\printchaptertitle[1]{%
79 \parbox[t][\chaptertitleboxheight][t]{\textwidth}{%
80 %\microtypesetup{protrusion=false}% add this if you use microtype
81 \chaptitlefont\strut ##1\strut}%
88 %% Remove red squares on top of hyperlinks
96 \usepackage[scaled]{beramono}
98 \definecolor{mygreen}{rgb}{0,0.6,0}
99 \definecolor{mygray}{rgb}{0.5,0.5,0.5}
100 \definecolor{mymauve}{rgb}{0.58,0,0.82}
101 \definecolor{mylightgray}{gray}{0.95}
104 backgroundcolor=\color{mylightgray}, % choose the background color; you must add \usepackage{color} or \usepackage{xcolor}
105 basicstyle=\footnotesize\ttfamily, % the size of the fonts that are used for the code
106 breakatwhitespace=false, % sets if automatic breaks should only happen at whitespace
107 breaklines=true, % sets automatic line breaking
108 captionpos=b, % sets the caption-position to bottom
109 commentstyle=\color{mygreen}, % comment style
110 deletekeywords={...}, % if you want to delete keywords from the given language
111 escapeinside={\%*}{*)}, % if you want to add LaTeX within your code
112 extendedchars=true, % lets you use non-ASCII characters; for 8-bits encodings only, does not work with UTF-8
113 %frame=single, % adds a frame around the code
114 keepspaces=true, % keeps spaces in text, useful for keeping indentation of code (possibly needs columns=flexible)
115 keywordstyle=\color{blue}, % keyword style
116 language=Python, % the language of the code
117 morekeywords={*,...}, % if you want to add more keywords to the set
118 %numbers=left, % where to put the line-numbers; possible values are (none, left, right)
119 %numbersep=5pt, % how far the line-numbers are from the code
120 %numberstyle=\tiny\color{mygray}, % the style that is used for the line-numbers
121 %stepnumber=1, % the step between two line-numbers. If it's 1, each line will be numbered
122 rulecolor=\color{black}, % if not set, the frame-color may be changed on line-breaks within not-black text (e.g. comments (green here))
123 showspaces=false, % show spaces everywhere adding particular underscores; it overrides 'showstringspaces'
124 showstringspaces=false, % underline spaces within strings only
125 showtabs=false, % show tabs within strings adding particular underscores
126 stringstyle=\color{mymauve}, % string literal style
127 tabsize=2, % sets default tabsize to 2 spaces
128 title=\lstname % show the filename of files included with \lstinputlisting; also try caption instead of title
131 \title{NEPI v3.2 User Manual}
134 \renewcommand{\maketitlehookd}{%
136 \includegraphics[width=6cm]{nepi_logo.png}
141 % clear numbering from first page
143 \thispagestyle{empty}
152 \chapter{Getting started}
153 \label{getting_started}
154 \input{getting_started.tex}
156 \chapter{Introduction to NEPI}
158 \input{introduction.tex}
160 \chapter{The ExperimentController API}
164 %\chapter{Supported resources}
165 %\label{supported_resources}
166 %\input{supported_resources.tex}
168 %%\chapter{ExperimentController internals}
169 %%\label{ec_internals}
170 %%\input{ec_internals.tex}
172 %%\chapter{ResourceManager internals}
173 %%\label{rm_internals}
174 %%\input{rm_internals.tex}
176 %%\chapter{Extending NEPI: The CCNx case}
177 %%\label{extending_nepi}
178 %%\input{extending_nepi.tex}
182 \input{debugging.tex}
184 %%\chapter{Unit testing}
185 %%\label{unit_testing}
186 %%\input{unit_testing.tex}
188 %\chapter{Release Cycle}
189 %\label{release_cycle}
190 %\input{release_cycle.tex}
192 %%\chapter{Coding Style}
193 %%\label{coding_style}
194 %%\input{coding_style.tex}