Grammar hax from Qwell
[asterisk/asterisk.git] / doc / tex / asterisk.tex
1 % To generate a PDF from this, install the "rubber" tool, and the LaTeX
2 % dependencies for it.  Then, run:
3 %
4 % rubber asterisk.tex
5 %
6 % http://www.pps.jussieu.fr/~beffara/soft/rubber/
7
8 \documentclass[12pt,a4]{report}
9
10 \usepackage{hyperref}
11
12 \usepackage{url}
13 \makeatletter
14 \def\url@aststyle{%
15   \@ifundefined{selectfont}{\def\UrlFont{\sf}}{\def\UrlFont{\small\ttfamily}}}
16 \makeatother
17 \urlstyle{ast}
18
19 \usepackage[titles]{tocloft}
20 \renewcommand{\cftchapfont}{%
21   \fontsize{11}{13}\usefont{OT1}{phv}{bc}{n}\selectfont
22 }
23
24 \newenvironment{astlisting}
25 {\begin{list}{}{\setlength{\leftmargin}{1em}}\item\scriptsize\bfseries}
26 {\end{list}}
27
28 \usepackage{sectsty}
29 \allsectionsfont{\usefont{OT1}{phv}{bc}{n}\selectfont}
30
31 \usepackage[Lenny]{fncychap}
32
33
34 \author{Asterisk Development Team \\ Asterisk.org}
35 \title{Asterisk Reference Information \\ Version ASTERISKVERSION}
36
37 \begin{document}
38 \maketitle
39
40 \tableofcontents
41
42 \chapter{Introduction}
43
44 This document contains various pieces of information that are useful for
45 reference purposes.
46
47   \section{License Information}
48   \input{../../LICENSE}
49      \subsection{Hold Music}
50        Digium has licensed the music included with
51        the Asterisk distribution From FreePlayMusic
52        for use and distribution with Asterisk.  It
53        is licensed ONLY for use as hold music within
54        an Asterisk based PBX.
55   \section{Security}
56   \input{security.tex}
57   \section{Hardware}
58   \input{hardware.tex}
59
60 \chapter{Configuration}
61   \section{General Configuration Information}
62     \subsection{Configuration Parser}
63     \input{configuration.tex}
64     \subsection{Asterisk.conf}
65     \input{asterisk-conf.tex}
66     \subsection{CLI Prompt}
67     \input{cliprompt.tex}
68     \subsection{Extensions}
69     \input{extensions.tex}
70     \subsection{IP Quality of Service}
71     \input{qos.tex}
72     \subsection{MP3 Support}
73     \input{mp3.tex}
74     \subsection{ICES}
75     \input{ices.tex}
76   \section{Database Support}
77     \subsection{Realtime Database Configuration}
78     \input{realtime.tex}
79     \subsection{FreeTDS}
80     \input{freetds.tex}
81   \section{Privacy}
82   \input{privacy.tex}
83
84 \chapter{Channel Variables}
85 \input{channelvariables.tex}
86
87 \chapter{AEL: Asterisk Extension Language}
88 \input{ael.tex}
89
90 \chapter{SLA: Shared Line Appearances}
91 \input{sla.tex}
92
93 \chapter{Channel Drivers}
94   \section{IAX2}
95   \input{chaniax.tex}
96     \subsection{IAX2 Jitterbuffer}
97     \input{jitterbuffer.tex}
98   \section{mISDN}
99   \input{misdn.tex}
100   \section{Local}
101   \input{localchannel.tex}
102
103 \chapter{Distributed Universal Number Discovery (DUNDi)}
104   \section{Introduction}
105   \input{dundi.tex}
106   \section{Peering Agreement}
107   \input{../PEERING}
108
109 \chapter{ENUM}
110 \input{enum.tex}
111
112 \chapter{AMI: Asterisk Manager Interface}
113   \input{manager.tex}
114   \input{ajam.tex}
115
116 \chapter{CDR: Call Detail Records}
117 \input{billing.tex}
118 \input{cdrdriver.tex}
119
120 \chapter{Voicemail}
121   \section{ODBC Storage}
122   \label{odbcstorage}
123   \input{odbcstorage.tex}
124   \section{IMAP Storage}
125   \input{imapstorage.tex}
126
127 \chapter{SMS}
128 \input{app-sms.tex}
129
130 \chapter{Queues}
131   \input{queues-with-callback-members.tex}
132   \section{Queue Logs}
133   \input{queuelog.tex}
134
135 \chapter{Phone Provisioning}
136   \input{phoneprov.tex}
137
138 \chapter{Development}
139   \section{Backtrace}
140   \input{backtrace.tex}
141
142
143
144 % This is a list of files not yet integrated into this document:
145 %
146 %Misc
147 %----
148 %asterisk-mib.txt   SNMP mib for Asterisk (net-snmp)
149 %digium-mib.txt     SNMP mib for Asterisk (net-snmp)
150 %
151 % Note that there is some developer documentation in the doc directory, but
152 % the goal is to have developer documentation all integrated into the doxygen
153 % documentation.
154
155 \end{document}