File: guide.tex

package info (click to toggle)
faumachine 20180503-4
  • links: PTS
  • area: main
  • in suites: buster
  • size: 61,272 kB
  • sloc: ansic: 272,290; makefile: 6,199; asm: 4,251; sh: 3,022; perl: 886; xml: 563; pascal: 311; lex: 214; vhdl: 204
file content (234 lines) | stat: -rw-r--r-- 8,383 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
%
% Copyright (C) 2002-2009 FAUmachine Team <info@faumachine.org>.
% This program is free software. You can redistribute it and/or modify it
% under the terms of the GNU General Public License, either version 2 of
% the License, or (at your option) any later version. See COPYING.
%

\documentclass[a4paper,10pt,pointlessnumbers]{scrbook}  
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% README
%% There are a number of definitions before the content start. If you
%% are looking for content, search for '\begin{document}'.
\usepackage{times}
\usepackage{graphicx}
\usepackage{alltt}
\usepackage{flafter}
\usepackage{makeidx} % use makeindex -g -s <*.ist> <filename> on linux
\usepackage{xspace} %spacing after command names
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage{anysize}
%% pagesize
%% left right top bottom
\marginsize{30mm}{30mm}{10mm}{10mm}
%% leaves \textwidth of ...mm
\setlength{\headheight}{5mm}
\setlength{\headsep}{5mm}
%\setlength{\topskip}{3mm plus3mm minus1mm}
\setlength{\footskip}{9mm}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% definitions for headers and footers ---------------------------------
\usepackage{fancyhdr}
\pagestyle{fancyplain}
\renewcommand{\headrulewidth}{0.5pt}
\renewcommand{\plainheadrulewidth}{0.5pt}
\renewcommand{\footrulewidth}{0.5pt}
\renewcommand{\plainfootrulewidth}{0.5pt}
\renewcommand{\chaptermark}[1]{\markboth{\thechapter\ #1}{}}
\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}}
\lhead[\fancyplain{\leftmark}{\leftmark}]{\fancyplain{}{}}
\chead{}
\rhead[\fancyplain{}{}]{\fancyplain{}{\rightmark}}
\lfoot{}
\cfoot[\fancyplain{\thepage}{\thepage}]%
      {\fancyplain{\thepage}{\thepage}}
\rfoot{}
\flushbottom
\newcommand{\clearemptydoublepage}{\clearpage{\pagestyle{empty}\cleardoublepage}}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% definitions for floats ----------------------------------------------
\setcounter{topnumber}{9} %% see LaTeX-Begleiter pp144
\setcounter{bottomnumber}{9}
\setcounter{totalnumber}{9}
\renewcommand\textfraction{0.0}
\renewcommand\topfraction{0.9}
\renewcommand\bottomfraction{0.9}
\renewcommand\floatpagefraction{0.9}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% definitions for table of contents -----------------------------------
\setcounter{tocdepth}{2} %% numbers up to x.x.x in toc
\setcounter{secnumdepth}{3} %% numbers up to x.x.x.x in text
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\newcommand{\newterm}[1]{\emph{#1}}

%% some commands for formatting different things
%% names are taken from docbook. if you need to introduce
%% more commands, please refer to docbook and use the same
%% names for the same things/categories.
%% http://www.docbook.org/tdg/en/html/docbook.html
%% If you need to know, when to use these commands, please refer
%% to the appropriate descriptions in the docbook page.
\newcommand{\notgb}[1]{#1} %% Leave this here for DBench cross-compilation!
\newcommand{\command}[1]{{\ttfamily #1}}
\newcommand{\option}[1]{{\ttfamily #1}}
\newcommand{\function}[1]{{\ttfamily #1}}
\newcommand{\varname}[1]{{\ttfamily #1}}
\newcommand{\envar}[1]{{\ttfamily #1}}
\newcommand{\keyword}[1]{{\ttfamily\bfseries #1}} %% prog-lang-keyword
\newcommand{\code}[1]{{\ttfamily #1}}
\newcommand{\asis}[1]{``#1''}
\newcommand{\ulink}[1]{{\ttfamily\bfseries #1}} %% URL
\newcommand{\email}[1]{{\ttfamily\bfseries #1}}

\newcommand{\replaceable}[1]{{\itshape #1}}
\newcommand{\Filename}[1]{{\ttfamily #1}}
\newcommand{\GUIMenu}[1]{{\sffamily #1}}
\newcommand{\GUIWindow}[1]{{\sffamily #1}}
\newcommand{\GUILabel}[1]{{\sffamily #1}}
\newcommand{\GUIButton}[1]{{\sffamily #1}}

%% some commands for short things which become long in TeX
\newcommand{\bs}{\ensuremath{\backslash}} %% \
\newcommand{\bsn}{{\bs}n} %% \n
\newcommand{\rArrow}{\ensuremath{\rightarrow}}

%% command to comment out stuff which may later be needed again
%%\newcommand{\removed}[1]{{#1}}
\newcommand{\removed}[1]{{}}

%% command to create an invisible anchor (you might need this to play
%% tricks with LaTeX)
\newcommand{\anchor}{\rule[0pt]{0pt}{1ex}}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\setlength{\parindent}{0pt} %% we don't want parindents
\setlength{\parskip}{1.5ex plus0.5ex minus0.5ex}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage{installpaths}
%% some names
\newcommand{\bugreportpl}{\command{faumachine-bugreport}\xspace}
\newcommand{\wizard}{{\sffamily ConfigWizard}\xspace}
\newcommand{\launcher}{{\sffamily Launcher}\xspace}
\newcommand{\netbridge}{{\sffamily Bridge}\xspace}
\newcommand{\wwwfaum}{\ulink{www.faumachine.org}\xspace}
\newcommand{\mailfaum}{\email{info@faumachine.org}\xspace}
\newcommand{\bugsfaum}{\email{bugs@faumachine.org}\xspace}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pdfinfo{/Title (FAUmachine Usage Guide)
	/Subject (User Guide for FAUmachine Virtual Machines)
	/Author(FAUmachine Team)
	/Keywords (Virtual Machine, Testautomation, Open Source)
	}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\setcounter{tocdepth}{1}
\makeindex
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Chapter-Title-Texts
\newcommand{\chowtouse}{How to Use this Manual}
\newcommand{\cinstallbinary}{Installation of a FAUmachine Binary Distribution}
\newcommand{\cconfigwizard}{Configuring a Virtual Linux Machine Using the \wizard}
\newcommand{\cconfigmanual}{Configuring a Virtual Linux Machine Manually}
\newcommand{\crunning}{Running a Virtual Linux Machine}
\newcommand{\cnetworking}{Connecting a Virtual Machine to the Real Network}
\newcommand{\ctestautomation}{Creating an Automatic Load Generator for a Virtual System}
\newcommand{\cinjectingfaults}{Injecting Faults into the Hardware of a Virtual Machine}
\newcommand{\cexamples}{Automation Examples}
\newcommand{\cbuildfromsource}{Building FAUmachine from the Source Distribution}
\newcommand{\cbugs}{When Things Don't Work}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}
\sloppy  %% don't be so fussy about interword spacing
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagestyle{empty}
\begin{titlepage}
\begin{center}
\huge
FAUmachine Usage Guide
\normalsize\\
Version \version\\
\rule{\textwidth}{0.75pt}
\par
\bigskip
FAUmachine Team
\vfill
\includegraphics{FAUmachineLogo}
\vfill
http://www.faumachine.org\\
email: info@faumachine.org
\end{center}
\end{titlepage}
\clearemptydoublepage %% start next page on right=odd page
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagestyle{plain} % this, together with fancyplain-style puts headers
                  % where they should be for toc, lof, index etc.
\setcounter{page}{1}
\pagenumbering{roman}
%%----------------------------------------------------------------------
\tableofcontents
%%----------------------------------------------------------------------
\listoffigures
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagestyle{fancyplain}
\clearemptydoublepage %% start next page on right=odd page
\pagenumbering{arabic}

\chapter{\chowtouse}
\label{s:howtouse}
\input{howtouse}
\clearemptydoublepage

\chapter{\cinstallbinary}
\label{s:installbinary}
\input{installbinary}
\clearemptydoublepage

\chapter{\cconfigwizard}
\label{s:configwizard}
\input{configwizard}
\clearemptydoublepage

\chapter{\cconfigmanual}
\label{s:configmanual}
\input{configmanual}
\clearemptydoublepage

\chapter{\crunning}
\label{s:running}
\input{running}
\clearemptydoublepage

\chapter{\cnetworking}
\label{s:networking}
\input{networking}
\clearemptydoublepage

\chapter{\ctestautomation}
\label{s:testautomation}
\input{testautomation}
\clearemptydoublepage

\chapter{\cinjectingfaults}
\label{s:injectingfaults}
\input{injectingfaults}
\clearemptydoublepage

\chapter{\cexamples}
\label{s:examples}
\input{examples}
\clearemptydoublepage

\chapter{\cbuildfromsource}
\label{s:buildfromsource}
\input{buildfromsource}
\clearemptydoublepage

\chapter{When Things Don't Work}
\label{s:bugs}
\input{bugs}
\clearemptydoublepage

\addcontentsline{toc}{chapter}{Index}
   \printindex
\end{document}