mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-05 20:20:07 +00:00
c474809cdf
* Convert most of the doc directory into a single LaTeX formatted document so that we can generate a PDF, HTML, or other formats from this information. * Add a CLI command to dump the application documentation into LaTeX format which will only be include if the configure script is run with --enable-dev-mode. * The PDF turned out to be close to 1 MB, so it is not included. However, you can simply run "make asterisk.pdf" to generate it yourself. We may include it in release tarballs or have automatically generated ones on the web site, but that has yet to be decided. git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.4@58931 65c4cc65-6c06-0410-ace0-fbb531ad65f3
133 lines
3.2 KiB
TeX
133 lines
3.2 KiB
TeX
% To generate a PDF from this, install the "rubber" tool, and the LaTeX
|
|
% dependencies for it. Then, run:
|
|
%
|
|
% rubber asterisk.tex
|
|
|
|
\documentclass[12pt,a4]{report}
|
|
\usepackage{hyperref}
|
|
|
|
\author{Asterisk Development Team \\ Asterisk.org}
|
|
\title{Asterisk Reference Information}
|
|
|
|
\begin{document}
|
|
\maketitle
|
|
|
|
\tableofcontents
|
|
|
|
\chapter{Introduction}
|
|
|
|
This document contains various pieces of information that are useful for
|
|
reference purposes.
|
|
|
|
\section{License Information}
|
|
\input{../LICENSE}
|
|
\subsection{Hold Music}
|
|
Digium has licensed the music included with
|
|
the Asterisk distribution From FreePlayMusic
|
|
for use and distribution with Asterisk. It
|
|
is licensed ONLY for use as hold music within
|
|
an Asterisk based PBX.
|
|
\section{Security}
|
|
\input{security.tex}
|
|
\section{Hardware}
|
|
\input{hardware.tex}
|
|
|
|
\chapter{Configuration}
|
|
\section{General Configuration Information}
|
|
\subsection{Configuration Parser}
|
|
\input{configuration.tex}
|
|
\subsection{Asterisk.conf}
|
|
\input{asterisk-conf.tex}
|
|
\subsection{CLI Prompt}
|
|
\input{cliprompt.tex}
|
|
\subsection{Extensions}
|
|
\input{extensions.tex}
|
|
\subsection{IP Type of Service}
|
|
\input{ip-tos.tex}
|
|
\subsection{MP3 Support}
|
|
\input{mp3.tex}
|
|
\subsection{ICES}
|
|
\input{ices.tex}
|
|
\section{Database Support}
|
|
\subsection{Realtime Database Configuration}
|
|
\input{realtime.tex}
|
|
\subsection{FreeTDS}
|
|
\input{freetds.tex}
|
|
\section{Privacy}
|
|
\input{privacy.tex}
|
|
|
|
\chapter{Channel Variables}
|
|
\input{channelvariables.tex}
|
|
|
|
\chapter{AEL, Asterisk Extension Language}
|
|
\input{ael.tex}
|
|
|
|
\chapter{SLA (Shared Line Appearances)}
|
|
\input{sla.tex}
|
|
|
|
\chapter{Channel Drivers}
|
|
\section{IAX2}
|
|
\input{chaniax.tex}
|
|
\subsection{IAX2 Jitterbuffer}
|
|
\input{jitterbuffer.tex}
|
|
\section{mISDN}
|
|
\input{misdn.tex}
|
|
\section{Local}
|
|
\input{localchannel.tex}
|
|
|
|
\chapter{Distributed Universal Number Discovery (DUNDi)}
|
|
\section{Introduction}
|
|
\input{dundi.tex}
|
|
\section{Peering Agreement}
|
|
\input{PEERING}
|
|
|
|
\chapter{ENUM}
|
|
\input{enum.tex}
|
|
|
|
\chapter{AMI: Asterisk Manager Interface}
|
|
\input{manager.tex}
|
|
\input{ajam.tex}
|
|
|
|
\chapter{CDR: Call Detail Records}
|
|
\input{billing.tex}
|
|
\input{cdrdriver.tex}
|
|
|
|
\chapter{Voicemail}
|
|
\section{ODBC Storage}
|
|
\input{odbcstorage.tex}
|
|
\section{IMAP Storage}
|
|
\input{imapstorage.tex}
|
|
|
|
\chapter{SMS}
|
|
\input{app-sms.tex}
|
|
|
|
\chapter{Queues}
|
|
\input{queues-with-callback-members.tex}
|
|
\section{Queue Logs}
|
|
\input{queuelog.tex}
|
|
|
|
% Generate this using the "core dumpappdocs" CLI command that is present
|
|
% when Asterisk is built with dev-mode enabled.
|
|
\chapter{Application Reference}
|
|
\input{ast_appdocs.tex}
|
|
|
|
% This is a list of files not yet integrated into this document:
|
|
%
|
|
%Misc
|
|
%----
|
|
%asterisk-mib.txt SNMP mib for Asterisk (net-snmp)
|
|
%digium-mib.txt SNMP mib for Asterisk (net-snmp)
|
|
%
|
|
%For developers
|
|
%--------------
|
|
%See http://www.asterisk.org/developers for more information
|
|
%
|
|
%backtrace.txt How to produce a backtrace when Asterisk crashes
|
|
%CODING-GUIDELINES Guidelines for developers
|
|
%externalivr.txt Documentation of the protocol used in externalivr()
|
|
%modules.txt How Asterisk modules work
|
|
%datastores.txt About channel data stores
|
|
%speechrec.txt The Generic Speech Recognition API
|
|
|
|
\enddocument
|