02fd9bd609c091d5820cc97929507cd46b28a610
[Faustine.git] / interpretor / faust-0.9.47mr3 / documentation / faust-quick-reference-src / faust-quick-reference.tex
1 \documentclass[a4paper,10pt]{book}
2
3 %\usepackage{latexsym, amssymb}
4 \usepackage{latexsym}
5 \usepackage{graphicx}
6 %\usepackage{longtable}
7 \usepackage{supertabular}
8 %\usepackage{tabularx}
9 %\usepackage{tabulary}
10 \usepackage{xspace}
11 \usepackage{pdfpages}
12 %\usepackage[rounded]{syntax}
13 \usepackage{hyperref}
14 \usepackage{listings}
15 \usepackage{color}
16
17 \usepackage[cc]{titlepic}
18 \usepackage{sectsty}
19 % \usepackage{times}
20 \usepackage[T1]{fontenc}
21 \usepackage[urw-garamond]{mathdesign}
22 \usepackage{fncychap}
23 \usepackage{fancyhdr}
24
25 \usepackage{rail}
26 \railoptions{-t -h}
27
28 \fancyhead{} % clear all header fields
29 \fancyheadoffset[LE,RO]{\marginparsep+\marginparwidth}
30 \fancyhead[RO,LE]{\thepage}
31 \fancyhead[LO]{\rightmark}
32 \fancyhead[RE]{\leftmark}
33 \renewcommand{\headrulewidth}{0.1pt}
34
35 \fancyfoot{}
36
37
38 \hypersetup{%
39 colorlinks = true, %true, false
40 linkcolor = black,
41 citecolor = blue,
42 urlcolor = blue,
43 }
44 \urlstyle{sf} %rm
45 \newcommand{\myurl}[1]{\textcolor{blue}{\underbar{\url{#1}}}}
46
47
48 %%%%%%%%%%%%%%%%%%%command imported from lac paper
49 \newcommand{\code}[1] {\lstinline'#1'}
50 \newcommand{\OSTab}[1] {\multicolumn{3}{|l|}{\hspace{14mm}\emph{#1}}}
51 \newcommand{\htab} {\hspace*{3mm}}
52
53 %%\newcommand{\faust} {\textsc{Faust}\xspace}
54 %\newcommand{\astree} {\textsc{Astree}\xspace}
55 \newcommand{\grame} {\textsc{Grame}\xspace}
56 \newcommand{\cierec} {\textsc{Cierec}\xspace}
57 %\newcommand{\ircam} {\textsc{Ircam}\xspace}
58 \newcommand{\ccrma} {\textsc{Ccrma}\xspace}
59 \newcommand{\cnmat} {\textsc{Cnmat}\xspace}
60 \newcommand{\create} {\textsc{Create}\xspace}
61 \newcommand{\mines} {\textsc{Mines} ParisTech\xspace}
62 %\newcommand{\svg} {\textsc{Svg}\xspace}
63 \newcommand{\pdf} {\textsc{Pdf}\xspace}
64 %%\newcommand{\latex} {\LaTeX\xspace}
65 \newcommand{\ie} {i.e.\ }
66 %%\newcommand{\myurl}[1] {\textcolor{blue}{\underbar{\url{#1}}}}
67
68
69 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
70
71
72 %%% MY COLORS
73 \definecolor{yoheader}{rgb}{0.71,0.01,0.0}
74
75 %%%% margin par
76 \definecolor{margincolor}{rgb}{0.52,0.02,0.02} % grey red.
77 \definecolor{yobg}{rgb}{0.9,0.9,1}
78 \definecolor{yotxt}{rgb}{0.01,0.01,0.52}
79 \definecolor{mylstcmt}{rgb}{0.01,0.52,0.01} % a dark green.
80 %\definecolor{mylstdoc}{rgb}{0.60,0.60,0.60} % a medium grey.
81 \definecolor{mylstdoc}{rgb}{0.80,0.30,0.80} % a medium pink.
82 %\definecolor{mylsteqn}{rgb}{0.80,0.80,0.30} % a medium pink.
83 \definecolor{mylstkey}{rgb}{0.52,0.01,0.01} % a dark red.
84 %%\newcommand{\farg}[1]{\textrm{\textit{#1}}}
85
86 \setlength{\marginparwidth}{1.2in}
87 \let\oldmarginpar\marginpar
88 \renewcommand\marginpar[1]{\-\oldmarginpar[\raggedleft\color{margincolor}\footnotesize #1]%
89 {\raggedright\color{margincolor}\footnotesize #1}}
90
91
92
93 % \relax
94
95 \begin{document}
96 \ChRuleWidth{1pt}
97 % \ChNumVar{\raggedleft\fontsize{80}{82}\sffamily\bfseries\color{yoheader}}
98 \ChNumVar{\raggedleft\Huge\color{yoheader}}
99 %\ChTitleVar{\raggedleft\fontsize{60}{62}\sffamily\it\color{yoheader}}
100 \ChTitleVar{\raggedleft\sffamily\fontsize{30}{32}\bf\color{yoheader}}
101
102 %\chapterfont{\sffamily\color{yoheader}}
103 %\sectionfont{\sffamily\color{yoheader}}
104 %\subsectionfont{\sffamily\color{yoheader}}
105 %\subsubsectionfont{\sffamily\color{yoheader}}
106
107 \chapterfont{\color{yoheader}}
108 \sectionfont{\color{yoheader}}
109 \subsectionfont{\color{yoheader}}
110 \subsubsectionfont{\color{yoheader}}
111
112
113 % parameters for listings
114 \lstset{
115 tabsize=4,
116 showspaces=false,
117 showstringspaces=false,
118 language=C++,
119 basicstyle=\ttfamily\color{yotxt},
120 numbers=none,
121 stepnumber=2,
122 commentstyle=\slshape\color{mylstcmt},
123 breaklines=true,
124 emph={component, declare, environment, import, library, process},
125 emph={[2]ffunction, fconstant, fvariable},
126 emph={[3]button, checkbox, vslider, hslider, nentry, vgroup, hgroup, tgroup, vbargraph, hbargraph, attach},
127 emphstyle=\color{mylstkey},
128 % morecomment=[s][\color{mylsteqn}]{<equation>}{</equation>},
129 morecomment=[s][\color{mylstdoc}]{<mdoc>}{</mdoc>},
130 %% frame=single,
131 backgroundcolor=\color{yobg},
132 captionpos=b
133 }
134
135 \lstloadlanguages{C++,[LaTeX]TeX}
136
137 % \titlepic{
138 % \includegraphics[width=15cm]{images/bandeau-faust}
139 % }
140 \title{\Huge\color{yoheader}FAUST Quick Reference\\\Large(version 0.9.46 with multirate extensions)}
141 \author{\textsc{Grame}\\Centre National de Cr\'eation Musicale}
142 \date{February 2012}
143
144
145 \railalias{recur}{$\sim$}
146 \railalias{lbrace}{\{}
147 \railalias{rbrace}{\}}
148 \railalias{dollar}{\$}
149 \railalias{mod}{\%}
150 \railalias{arobase}{@}
151 \railalias{ampersand}{\&}
152 \railalias{hat}{$\land$}
153 \railalias{kot}{'}
154 \railalias{pipe}{$|$}
155 \railalias{fdelay}{}
156 \railalias{backslash}{\char"5C}
157 \railterm{recur,lbrace,rbrace,dollar,mod,kot,arobase,ampersand,backslash,fdelay, pipe, hat}
158
159 \newcommand{\farg}[1]{\textrm{\textit{#1}}}
160 \newcommand{\ldbrack}{[\![ \,}
161 \newcommand{\rdbrack}{\, ]\!] }
162 \newcommand{\rdbrackC}{\rdbrack_{\mathrm{C}}\,}
163 \newcommand{\dbrack}[1]{\ldbrack #1 \rdbrack}
164 \newcommand{\semantic}[1]{\ldbrack #1 \rdbrack}
165 \newcommand{\dbrackC}[1]{\ldbrack #1 \rdbrackC}
166
167 \newcommand{\faust}{\textsc{Faust}\xspace}
168 \newcommand{\latex}{\LaTeX\xspace}
169 \newcommand{\ircam}{\textsc{Ircam}\xspace}
170 \newcommand{\astree}{\textsc{Astree}\xspace}
171 \newcommand{\svg}{\textsc{Svg}\xspace}
172
173
174 \setlength{\parindent}{0pt}
175 \setlength{\parskip}{1ex plus 0.5ex minus 0.2ex}
176
177 \maketitle
178
179 \tableofcontents
180
181
182
183
184 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
185 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
186 % CHAPTERS %
187 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
188 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
189
190 \input{chapters/introduction}
191 \input{chapters/installation}
192 \input{chapters/syntax}
193 \input{chapters/compiler}
194 \input{chapters/architectures}
195 \input{chapters/codegeneration}
196 \input{chapters/mathdoc}
197 \input{chapters/acknowledgments}
198
199
200 \end{document}