doc/00README.1st

   1 Files in the /doc directory:
   2 ----------------------------
   3 In addition to these files, there is a lot of documentation of various
   4 configuration options in the sample configuration files, in the /configs
   5 directory of your source code
   6
   7 Start here
   8 ----------
   9 security.txt            IMPORTANT INFORMATION ABOUT ASTERISK SECURITY
  10 hardware.txt            Hardware supported by Asterisk
  11 cli.txt                 Information on using the Asterisk console
  12
  13 Configuration
  14 -------------
  15 configuration.txt       Features in the configuration parser
  16 extensions.txt          Basics about the dialplan
  17 extconfig.txt           How to use databases for configuration of Asterisk (ARA)
  18 ip-tos.txt              About the IP Type Of Service settings
  19 realtime.txt            The Asterisk Realtime Architecture - database support
  20 freetds.txt             Information about the FreeTDS support
  21 ael.txt                 Information about the Asterisk Extension Language
  22
  23 Misc
  24 ----
  25 PEERING                 The General Peering Agreement for Dundi
  26 ajam.txt                About the HTTP-based manager interface
  27 app_sms.txt             How to configure the SMS application
  28 asterisk.conf.txt       Documentation of various options in asterisk.conf
  29 callingpres.txt         Settings for Caller ID presentation
  30 billing.txt             Call Data Record information
  31 cliprompt.txt           How to change the Asterisk CLI prompt
  32 dundi.txt               Dundi - a discovery protocol
  33 enum.txt                Enum support in Asterisk
  34 ices.txt                Integrating ICEcast streaming in Asterisk
  35 jitterbuffer.txt        About the IAX2 jitterbuffer implementation
  36 math.txt                About the math() application
  37 mp3.txt                 About MP3 support in Asterisk
  38 musiconhold-fpm.txt     Free Music On Hold music
  39 mysql.txt               About MYSQL support in Asterisk
  40 odbcstorage.txt         Voicemail storage of messages in UnixODBC
  41 privacy.txt             Privacy enhancements in Asterisk
  42 queuelog.txt            Agent and queue logging
  43 channelvariables.txt    Channel variables
  44 cdrdrivers.txt          About CDR storage in various databases (needs update)
  45 asterisk-mib.txt        SNMP mib for Asterisk (net-snmp)
  46 digium-mib.txt          SNMP mib for Asterisk (net-snmp)
  47
  48 Channel drivers
  49 ---------------
  50 misdn.txt               The mISDN channel driver for ISDN BRI cards
  51 h323.txt                How to compile and configure the H.323 channel
  52 chaniax.txt             About the IAX2 protocol support in Asterisk
  53 localchannel.txt        The local channel is a "gosub" in the dialplan
  54
  55 Portability
  56 -----------
  57 cygwin.txt              Compiling Asterisk on CygWin platforms (Windows)
  58
  59 For developers
  60 --------------
  61 See http://www.asterisk.org/developers for more information
  62
  63 manager.txt             About the AMI - Asterisk Manager Interface
  64                         for third party call control and PBX management
  65 backtrace.txt           How to produce a backtrace when Asterisk crashes
  66 CODING-GUIDELINES       Guidelines for developers
  67 channels.txt            What is a channel?
  68 externalivr.txt         Documentation of the protocol used in externalivr()
  69 linkedlists.txt         How to develop linked lists in Asterisk (old)
  70 iax.txt                 About the IAX protocol
  71 apps.txt                About application development
  72 model.txt               About the call model in Asterisk (old)
  73 modules.txt             How Asterisk modules work
  74 datastores.txt          About channel data stores
  75 speechrec.txt           The Generic Speech Recognition API