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