Mercurial > pub > dyncall > dyncall
annotate doc/manual/manual.tex @ 210:087373e6adb3
- "
author | Tassilo Philipp |
---|---|
date | Tue, 28 Mar 2017 15:27:21 +0200 |
parents | b0cca984c740 |
children | 4e9d3cb9870f |
rev | line source |
---|---|
0 | 1 %////////////////////////////////////////////////////////////////////////////// |
2 % | |
3 % Copyright (c) 2007-2014 Daniel Adler <dadler@uni-goettingen.de>, | |
4 % Tassilo Philipp <tphilipp@potion-studios.com> | |
5 % | |
6 % Permission to use, copy, modify, and distribute this software for any | |
7 % purpose with or without fee is hereby granted, provided that the above | |
8 % copyright notice and this permission notice appear in all copies. | |
9 % | |
10 % THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
11 % WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
12 % MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
13 % ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
14 % WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
15 % ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
16 % OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
17 % | |
18 %////////////////////////////////////////////////////////////////////////////// | |
19 | |
20 % Set the normal line height for the entire document (some command depend on it). | |
21 \newcommand{\normallineheight}{10pt} | |
22 \documentclass[\normallineheight,a4paper]{article} | |
23 | |
24 | |
25 % Value multiplier. | |
26 \newlength\mrbraceheight | |
27 \newcommand{\tassimultiply}[2]{% | |
28 \setlength{\mrbraceheight}{0pt}% | |
29 \newcount\qq% | |
30 \qq=1 % Subtract 1 by starting at 1 . | |
31 \loop% | |
32 \addtolength\mrbraceheight{#2}% | |
33 \advance\qq by 1% | |
34 \ifnum\qq < #1 \repeat% | |
35 } | |
36 | |
37 | |
38 % Conditional if tex4ht is on or not | |
39 \newcommand{\ifhtml}[1]{% | |
40 \ifx\HCode\Undef \else% | |
41 #1% | |
42 \fi% | |
43 } | |
44 \newcommand{\ifnhtml}[1]{% | |
45 \ifx\HCode\Undef% | |
46 #1% | |
47 \fi% | |
48 } | |
72 | 49 \newcommand{\casehtml}[2]{% |
50 \ifx\HCode\Undef% | |
51 #2% | |
52 \else% | |
53 #1% | |
54 \fi% | |
55 } | |
0 | 56 |
57 | |
58 % Packages. | |
59 \usepackage{a4wide} | |
60 \usepackage{multirow} | |
61 \usepackage{hhline} | |
62 \usepackage{color} | |
63 \usepackage{colortbl} | |
64 \usepackage{bigdelim} | |
65 \usepackage{rotating} | |
66 \usepackage{graphicx} | |
67 \usepackage{moreverb} | |
68 \usepackage{listings} | |
69 \usepackage{hyperref} | |
70 \ifnhtml{\usepackage{watermark}} | |
71 | |
72 | |
73 % Define own commands and style. | |
74 \newcommand{\dc}{\emph{dyncall}} | |
75 \newcommand{\capi}[1]{% | |
76 \noindent% | |
77 {\tt #1}% | |
78 } | |
79 \newcommand{\tab}{\indent} | |
80 | |
81 \newcommand{\shell}[1]{\noindent{\tt #1}} | |
82 | |
83 % Multiline table row with left or right curly brace. | |
84 %\newcommand{\mrrbrace}[2]{\tassimultiply{#1}{5pt} \multirow{#1}{*}{$\smash{\left. {\vrule height 0pt depth \mrbraceheight width 0pt}\right\}}$#2}} | |
85 \newcommand{\mrrbrace}[2]{\rdelim\}{#1}{\normallineheight} \multirow{#1}{*}{#2} } | |
86 \newcommand{\mrlbrace}[2]{ \multirow{#1}{*}{#2} \ldelim\{{#1}{\normallineheight}} | |
87 | |
88 | |
89 \newcommand{\tablewidth}{130mm} | |
90 %\setlength{\oddsidemargin}{10mm} | |
91 %\setlength{\textwidth}{140mm} | |
92 %\setlength{\parindent}{0mm} | |
93 %\setlength{\parskip}{1ex plus 0.5ex minus 0.2ex} | |
94 | |
132
b0cca984c740
- manual update, started splitting platform overview in EP and EL for some platforms
cslag
parents:
73
diff
changeset
|
95 \newcommand{\ninety}[1]{\begin{sideways}#1\end{sideways}} |
0 | 96 |
97 \renewcommand{\paragraph}[1]{% | |
98 \par\vspace{12pt}% | |
99 \noindent% | |
73 | 100 \textbf{#1}% |
0 | 101 \par% |
102 \vspace{6pt}% | |
103 }% | |
104 | |
105 % Set a watermark, but not when running htlatex | |
106 \ifnhtml{% | |
107 \watermark{% | |
108 \begingroup% | |
109 \setlength{\unitlength}{1mm}% | |
110 \begin{picture}(0,0)(32,300)% | |
111 \includegraphics[scale=1.0]{dyncall_watermark}% | |
112 \end{picture}% | |
113 \endgroup% | |
114 }% | |
115 } | |
116 | |
117 | |
118 % Use a sans-serif font. | |
119 \renewcommand{\familydefault}{\sfdefault} | |
120 | |
121 | |
122 \definecolor{defbkgd}{gray}{1.0} | |
123 \definecolor{gray1}{gray}{0.9} | |
124 \definecolor{gray2}{gray}{0.8} | |
125 \definecolor{gray3}{gray}{0.7} | |
126 \definecolor{gray4}{gray}{0.6} | |
127 \definecolor{lightgreen}{rgb}{0.0,1.0,0.0} | |
128 \definecolor{darkgreen}{rgb}{0.0,0.6,0.0} | |
129 | |
130 % Define some column types for our colortables | |
131 \usepackage{array} | |
132 | |
133 \newcommand{\cellcA}{} | |
134 \newcommand{\cellcB}{} | |
135 \newcommand{\cellcC}{} | |
136 \newcommand{\cellcD}{} | |
137 \newcolumntype{1}{l} | |
138 \newcolumntype{2}{l} | |
139 \newcolumntype{3}{l} | |
140 \newcolumntype{4}{l} | |
141 \newcolumntype{5}{r} | |
142 \newcolumntype{6}{r} | |
143 \newcolumntype{7}{r} | |
144 \newcolumntype{8}{r} | |
145 \newcolumntype{A}{p{\tablewidth}} | |
146 \newcolumntype{B}{p{\tablewidth}} | |
147 \newcolumntype{C}{p{\tablewidth}} | |
148 \newcolumntype{D}{p{\tablewidth}} | |
149 | |
150 % listings package related settings | |
151 | |
152 \lstset{captionpos=b} | |
153 \lstset{frame=tblr} | |
154 \lstset{frameround=tttt} | |
155 \lstset{basicstyle=\ttfamily} | |
156 | |
157 % text building blocks | |
73 | 158 \newcommand{\group}[1]{\textit{$<$#1$>$}} |
0 | 159 \newcommand{\sigchar}[1]{'{\tt #1}'} |
160 \newcommand{\sigstr}[1]{"{\tt #1}"} | |
161 \newcommand{\cenum}[1]{#1} | |
162 \newcommand{\product}[1]{\emph{#1}} | |
163 | |
164 % colors used to signalize undefined, not used, supported, etc. states. | |
165 \newcommand{\marknull}{\cellcolor{white}} | |
166 \newcommand{\markcmpl}{\cellcolor{lightgreen}} | |
167 \newcommand{\markimpl}{\cellcolor{darkgreen}} | |
168 \newcommand{\marknimp}{\cellcolor{red}} | |
169 \newcommand{\markunkn}{\cellcolor{yellow}} | |
170 \newcommand{\marknotx}{\cellcolor{gray1}} | |
171 | |
172 | |
173 % table of contents config | |
174 \setcounter{tocdepth}{3} | |
175 | |
176 | |
177 \begin{document} | |
178 | |
179 % html output options (that need to come after \begin{document}).. | |
180 \ifhtml{ | |
181 \Configure{tableofcontents*}{chapter} | |
182 } | |
183 | |
184 % main document content --> | |
185 \input{manual_title} | |
186 \newpage | |
187 \tableofcontents | |
188 \newpage | |
189 \ifnhtml{ | |
190 \listoftables | |
191 \listoffigures | |
192 \lstlistoflistings | |
193 } | |
194 \newpage | |
195 \input{manual_motivation} | |
196 \input{manual_overview} | |
197 \input{manual_build} | |
198 \input{manual_bindings} | |
199 \input{manual_design} | |
200 \input{manual_devel} | |
201 \input{manual_epilog} | |
202 \appendix | |
203 \addtocontents{toc}{\protect\pagebreak} | |
204 \input{manual_dyncall_api} | |
205 \input{manual_dyncallback_api} | |
206 \input{manual_dynload_api} | |
207 \input{manual_cc} | |
208 \input{manual_literature} | |
209 \end{document} |