10ad7f039773c6ac2cf8ffd37a354caafd302362
[asterisk/asterisk.git] / doc / 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 \usepackage{hyperref}
10
11 \author{Asterisk Development Team \\ Asterisk.org}
12 \title{Asterisk Reference Information \\ Version SVN-trunk-r72921M}
13
14 \begin{document}
15 \maketitle
16
17 \tableofcontents
18
19 \chapter{Introduction}
20
21 This document contains various pieces of information that are useful for
22 reference purposes.
23
24   \section{License Information}
25   \input{../LICENSE}
26      \subsection{Hold Music}
27        Digium has licensed the music included with
28        the Asterisk distribution From FreePlayMusic
29        for use and distribution with Asterisk.  It
30        is licensed ONLY for use as hold music within
31        an Asterisk based PBX.
32   \section{Security}
33   \input{security.tex}
34   \section{Hardware}
35   \input{hardware.tex}
36
37 \chapter{Configuration}
38   \section{General Configuration Information}
39     \subsection{Configuration Parser}
40     \input{configuration.tex}
41     \subsection{Asterisk.conf}
42     \input{asterisk-conf.tex}
43     \subsection{CLI Prompt}
44     \input{cliprompt.tex}
45     \subsection{Extensions}
46     \input{extensions.tex}
47     \subsection{IP Quality of Service}
48     \input{qos.tex}
49     \subsection{MP3 Support}
50     \input{mp3.tex}
51     \subsection{ICES}
52     \input{ices.tex}
53   \section{Database Support}
54     \subsection{Realtime Database Configuration}
55     \input{realtime.tex}
56     \subsection{FreeTDS}
57     \input{freetds.tex}
58   \section{Privacy}
59   \input{privacy.tex}
60
61 \chapter{Channel Variables}
62 \input{channelvariables.tex}
63
64 \chapter{AEL, Asterisk Extension Language}
65 \input{ael.tex}
66
67 \chapter{SLA (Shared Line Appearances)}
68 \input{sla.tex}
69
70 \chapter{Channel Drivers}
71   \section{IAX2}
72   \input{chaniax.tex}
73     \subsection{IAX2 Jitterbuffer}
74     \input{jitterbuffer.tex}
75   \section{mISDN}
76   \input{misdn.tex}
77   \section{Local}
78   \input{localchannel.tex}
79
80 \chapter{Distributed Universal Number Discovery (DUNDi)}
81   \section{Introduction}
82   \input{dundi.tex}
83   \section{Peering Agreement}
84   \input{PEERING}
85
86 \chapter{ENUM}
87 \input{enum.tex}
88
89 \chapter{AMI: Asterisk Manager Interface}
90   \input{manager.tex}
91   \input{ajam.tex}
92
93 \chapter{CDR: Call Detail Records}
94 \input{billing.tex}
95 \input{cdrdriver.tex}
96
97 \chapter{Voicemail}
98   \section{ODBC Storage}
99   \input{odbcstorage.tex}
100   \section{IMAP Storage}
101   \input{imapstorage.tex}
102
103 \chapter{SMS}
104 \input{app-sms.tex}
105
106 \chapter{Queues}
107   \input{queues-with-callback-members.tex}
108   \section{Queue Logs}
109   \input{queuelog.tex}
110
111 % Generate this using the "core dump clidocs" CLI command that is present
112 % when Asterisk is built with dev-mode enabled.
113 \chapter{CLI Command Reference}
114 \input{ast_cli_commands.tex}
115
116 % Generate this using the "core dump appdocs" CLI command that is present
117 % when Asterisk is built with dev-mode enabled.
118 \chapter{Dialplan Application Reference}
119 \input{ast_appdocs.tex}
120
121 % Generate this using the "core dump funcdocs" CLI command that is present
122 % when Asterisk is built with dev-mode enabled.
123 \chapter{Dialplan Function Reference}
124 \input{ast_funcdocs.tex}
125
126 % Generate this using the "manager dump actiondocs" CLI command that is present
127 % when Asterisk is built with dev-mode enabled.
128 \chapter{Manager Action Reference}
129 \input{ast_manager_actiondocs.tex}
130
131 % Generate this using the "agi dump commanddocs" CLI command that is present
132 % when Asterisk is built with dev-mode enabled.
133 \chapter{AGI Command Reference}
134 \input{ast_agi_commands.tex}
135
136 % This is a list of files not yet integrated into this document:
137 %
138 %Misc
139 %----
140 %asterisk-mib.txt       SNMP mib for Asterisk (net-snmp)
141 %digium-mib.txt         SNMP mib for Asterisk (net-snmp)
142 %
143 %For developers
144 %--------------
145 %See http://www.asterisk.org/developers for more information
146 %
147 %backtrace.txt          How to produce a backtrace when Asterisk crashes
148 %CODING-GUIDELINES      Guidelines for developers
149 %externalivr.txt        Documentation of the protocol used in externalivr()
150 %modules.txt            How Asterisk modules work
151 %datastores.txt         About channel data stores
152 %speechrec.txt          The Generic Speech Recognition API
153
154 \enddocument