Documentation update
[asterisk/asterisk.git] / 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
12 Configuration
13 -------------
14 configuration.txt       Features in the configuration parser
15 extensions.txt          Basics about the dialplan
16 extconfig.txt           How to use databases for configuration of Asterisk (ARA)
17 realtime.txt            The Asterisk Realtime Architecture - database support
18 freetds.txt             Information about the FreeTDS support
19 ael.txt                 Information about the Asterisk Extension Language
20
21 Misc
22 ----
23 PEERING                 The General Peering Agreement for Dundi
24 app_sms.txt             How to configure the SMS application
25 asterisk.conf.txt       Documentation of various options in asterisk.conf
26 callingpres.txt         Settings for Caller ID presentation
27 billing.txt             Call Data Record information
28 cliprompt.txt           How to change the Asterisk CLI prompt
29 dundi.txt               Dundi - a discovery protocol
30 enum.txt                Enum support in Asterisk
31 ices.txt                Integrating ICEcast streaming in Asterisk
32 jitterbuffer.txt        About the IAX2 jitterbuffer implementation
33 math.txt                About the math() application
34 mp3.txt                 About MP3 support in Asterisk
35 musiconhold-fpm.txt     Free Music On Hold music
36 mysql.txt               About MYSQL support in Asterisk
37 odbcstorage.txt         Voicemail storage of messages in UnixODBC
38 privacy.txt             Privacy enhancements in Asterisk
39 queuelog.txt            Agent and queue logging
40 channelvariables.txt    Channel variables
41 cdrdrivers.txt          About CDR storage in various databases (needs update)
42 asterisk-mib.txt        SNMP mib for Asterisk (net-snmp)
43 digium-mib.txt          SNMP mib for Asterisk (net-snmp)
44
45 Channel drivers
46 ---------------
47 misdn.txt               The mISDN channel driver for ISDN BRI cards
48 h323.txt                How to compile and configure the H.323 channel
49 chaniax.txt             About the IAX2 protocol support in Asterisk
50 localchannel.txt        The local channel is a "gosub" in the dialplan
51
52 Portability
53 -----------
54 cygwin.txt              Compiling Asterisk on CygWin platforms (Windows)
55
56 For developers
57 --------------
58 See http://www.asterisk.org/developers for more information
59
60 manager.txt             About the AMI - Asterisk Manager Interface
61                         for third party call control and PBX management
62 backtrace.txt           How to produce a backtrace when Asterisk crashes
63 CODING-GUIDELINES       Guidelines for developers
64 channels.txt            What is a channel?
65 externalivr.txt         Documentation of the protocol used in externalivr()
66 linkedlists.txt         How to develop linked lists in Asterisk (old)
67 iax.txt                 About the IAX protocol
68 apps.txt                About application development
69 model.txt               About the call model in Asterisk (old)
70 modules.txt             How Asterisk modules work