From 3357366474ad27c72b2f26c759f85c5d34dbdc84 Mon Sep 17 00:00:00 2001 From: russell Date: Mon, 2 Jul 2007 22:27:46 +0000 Subject: * Move LaTeX docs into a tex/ subdirectory of the doc/ dir * Add a Makefile in doc/tex/ for generating PDF and HTML * Add a README.txt file to doc/tex/ to document which tools are used and what web sites to visit for getting them. * Update build_tools/prep_tarball to put the proper Asterisk version string in the automatically generated PDF for release tarballs git-svn-id: http://svn.digium.com/svn/asterisk/trunk@72982 f38db490-d61c-443f-a65b-d21fe96a405b --- doc/tex/asterisk.tex | 154 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 154 insertions(+) create mode 100644 doc/tex/asterisk.tex (limited to 'doc/tex/asterisk.tex') diff --git a/doc/tex/asterisk.tex b/doc/tex/asterisk.tex new file mode 100644 index 000000000..e6bbf3820 --- /dev/null +++ b/doc/tex/asterisk.tex @@ -0,0 +1,154 @@ +% To generate a PDF from this, install the "rubber" tool, and the LaTeX +% dependencies for it. Then, run: +% +% rubber asterisk.tex +% +% http://www.pps.jussieu.fr/~beffara/soft/rubber/ + +\documentclass[12pt,a4]{report} +\usepackage{hyperref} + +\author{Asterisk Development Team \\ Asterisk.org} +\title{Asterisk Reference Information \\ Version SVN-trunk-r72921M} + +\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 Quality of Service} + \input{qos.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 dump clidocs" CLI command that is present +% when Asterisk is built with dev-mode enabled. +\chapter{CLI Command Reference} +\input{ast_cli_commands.tex} + +% Generate this using the "core dump appdocs" CLI command that is present +% when Asterisk is built with dev-mode enabled. +\chapter{Dialplan Application Reference} +\input{ast_appdocs.tex} + +% Generate this using the "core dump funcdocs" CLI command that is present +% when Asterisk is built with dev-mode enabled. +\chapter{Dialplan Function Reference} +\input{ast_funcdocs.tex} + +% Generate this using the "manager dump actiondocs" CLI command that is present +% when Asterisk is built with dev-mode enabled. +\chapter{Manager Action Reference} +\input{ast_manager_actiondocs.tex} + +% Generate this using the "agi dump commanddocs" CLI command that is present +% when Asterisk is built with dev-mode enabled. +\chapter{AGI Command Reference} +\input{ast_agi_commands.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 -- cgit v1.2.3