doc: Add simavr manual
[simavr] / doc / manual / manual.tex
1 \documentclass[12pt,a4paper,oneside]{scrreprt}
2
3 \usepackage{graphicx}                       % includegraphics-command
4 \usepackage{fancyheadings}
5 \usepackage[pdfborder={0 0 0}]{hyperref}
6 \usepackage[english,germanb]{babel}
7 \usepackage[latin1]{inputenc}               % Support direct writing of German Umlauts
8 \usepackage{dcolumn}                        % Decimal column formatting
9 \usepackage[usenames,dvipsnames]{color}
10 \usepackage{listings}
11 \usepackage{acronym}
12 \usepackage{fancyvrb}                       % Verbatim environment with samepage option
13 \usepackage{xspace}                         % Better handling of spaces after custom commands
14 \usepackage{chngcntr}                       % Footnote counter settings
15 \usepackage[super]{nth}                     % 9th formatting
16 \usepackage{booktabs}
17
18 \counterwithout{footnote}{chapter}          % Do not reset footnote counter between chapters
19
20
21 %%
22 %% -------------------------listings configuration----------------------
23 %%
24
25 \definecolor{Brown}{cmyk}{0,0.81,1,0.60}
26 \definecolor{OliveGreen}{cmyk}{0.64,0,0.95,0.40}
27 \definecolor{CadetBlue}{cmyk}{0.62,0.57,0.23,0}
28 \definecolor{gray}{gray}{0.5}
29
30 \lstset{
31     language=C,                             % Code langugage
32     basicstyle=\ttfamily,                   % Code font, Examples:
33                                             % \footnotesize, \ttfamily
34     keywordstyle=\color{OliveGreen},        % Keywords font ('*' = uppercase)
35     commentstyle=\color{gray},              % Comments font
36     captionpos=b,                           % Caption-position = bottom
37     breaklines=true,                        % Automatic line breaking?
38     breakatwhitespace=false,                % Automatic breaks only at
39                                             % whitespace?
40     showspaces=false,                       % Dont make spaces visible
41     showtabs=false,                         % Dont make tabs visible
42     morekeywords={__attribute__},           % Specific keywords
43 }
44
45 %%
46 %% -------------------------Custom commands-----------------------------
47 %%
48
49 \newcommand{\simavr}{\emph{simavr}\xspace}
50 \newcommand{\qsimavr}{\emph{qsimavr}\xspace}
51
52 %%
53 %% ---------------------------------------------------------------------
54 %%
55
56 \sloppy
57
58 \oddsidemargin 1cm \evensidemargin 1cm \topmargin 0pt
59
60 \headsep 50pt \textheight 21.4cm \textwidth 14.1cm
61 \setlength{\parskip}{5pt plus2pt minus2pt}
62
63 \renewcommand{\floatpagefraction}{0.9}
64 \renewcommand{\textfraction}{0.05}
65 \renewcommand{\topfraction}{1.0}
66 \renewcommand{\bottomfraction}{1.0}
67
68 \setcounter{totalnumber}{5}
69 \setcounter{bottomnumber}{5}
70 \setcounter{topnumber}{5}
71
72 \setcounter{tocdepth}{2}
73 \addtolength{\abovecaptionskip}{-10pt}
74
75 %%
76 %% ---------------------------------------------------------------------
77 %%
78
79 \input{acronyms.tex}
80
81 %%
82 %% ---------------------------------------------------------------------
83 %%
84
85 \title{simavr Manual}
86 \author{Jakob Gruber \\
87         jakob.gruber@gmail.com}
88
89 %%
90 %% ---------------------------------------------------------------------
91 %%
92
93 \begin{document}
94
95     \pagestyle{empty}
96     \maketitle
97     \cleardoublepage
98
99     \pagestyle{plain}
100     \pagenumbering{roman}
101     \setlength{\parskip}{5pt plus2pt minus2pt}
102
103     \setcounter{page}{1}
104
105     \selectlanguage{english}
106
107     \setlength{\parskip}{1mm}
108     \linespread{0.0}
109
110     \tableofcontents
111     \linespread{1}
112     \clearpage
113     \cleardoublepage
114     \setlength{\parskip}{5pt plus2pt minus2pt}
115
116     \pagestyle{fancy}
117     \renewcommand{\chaptermark}[1]{\markboth{\thechapter\ #1}{}}
118     \renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}{}}
119     \addtolength{\headheight}{2pt}
120
121     \acresetall
122
123     \pagenumbering{arabic}
124     \setcounter{page} {1}
125
126     \cleardoublepage
127     \include{introduction}
128     \cleardoublepage
129     \include{simavr}
130
131     \appendix
132
133     \cleardoublepage
134     \include{setupguide}
135     \cleardoublepage
136
137 \end{document}
138
139 %%
140 %% = eof =====================================================================
141 %%