7ae7ce5e67d66b3daec621cc3705191bc760c4a9
[asterisk/asterisk.git] / include / asterisk / doxyref.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2008, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! 
18  * \file 
19  * \brief This file generates Doxygen pages from files in the /doc
20  *        directory of the Asterisk source code tree 
21  */
22
23 /* 
24  * The following is for Doxygen Developer's documentation generated
25  * by running "make progdocs" with doxygen installed on your
26  * system.
27  */
28
29 /*! 
30  * \page DevDoc Asterisk Developer's Documentation - Appendices
31  *
32  * \section devpolicy Development and Release Policies
33  * \arg \ref CodeGuide : The must-read document for all developers
34  * \arg \ref ReleaseStatus : The current support level for various Asterisk releases
35  * \arg \ref ReleasePolicies : Asterisk Release and Commit Policies
36  * \arg \ref AstCREDITS : A Thank You to contributors (unfortunately out of date)
37  *
38  * \section apisandinterfaces Asterisk APIs and Interfaces
39  * \arg \ref AstAPI
40  * \arg \ref Def_Channel : What's a channel, anyway?
41  * \arg \ref channel_drivers : Existing channel drivers
42  * \arg \ref AstAMI : The Call management socket API
43  * \arg \ref AstARA : A generic data storage and retrieval API for Asterisk
44  * \arg \ref AstDUNDi : A way to find phone services dynamically by using the DUNDi protocol
45  * \arg \ref AJI_intro : The Asterisk Jabber Interface
46  * \arg \ref AstCDR
47  * \arg \ref AstVar
48  * \arg \ref AstVideo
49  * \arg \ref AstENUM : The IETF way to redirect from phone numbers to VoIP calls
50  * \arg \ref AstHTTP
51  * \arg \ref AstSpeech
52  *
53  * \section debugconfig Debugging and Configuration References
54  * \arg \ref AstREADME : General Administrator README file
55  * \arg \ref AstDebug : Hints on debugging
56  * \arg \ref extref 
57  * \arg \ref ConfigFiles
58  * \arg \ref SoundFiles included in the Asterisk distribution
59  *
60  * \section weblinks Web sites
61  * \arg \b Main:  Asterisk Developer's website http://www.asterisk.org/developers/
62  * \arg \b Bugs: The Issue Tracker http://bugs.digium.com
63  * \arg \b Lists: List Server http://lists.digium.com
64  * \arg \b Wiki: The Asterisk Wiki      http://www.voip-info.org
65  * \arg \b Docs: The Asterisk Documentation Project http://www.asteriskdocs.org
66  * \arg \b Digium: The Asterisk Company http://www.digium.com
67  */
68
69 /*!
70  * \page ReleaseStatus Asterisk Release Status
71  *
72  * @AsteriskTrunkWarning
73  *
74  * \section warranty Warranty
75  * The following warranty applies to all open source releases of Asterisk:
76  *
77  * NO WARRANTY
78  *
79  * BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
80  * FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
81  * OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
82  * PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
83  * OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
84  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
85  * TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
86  * PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
87  * REPAIR OR CORRECTION.
88
89  * IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
90  * WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
91  * REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
92  * INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
93  * OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
94  * TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
95  * YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
96  * PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
97  * POSSIBILITY OF SUCH DAMAGES.
98  *
99  * \section releasestatustypes Release Status Types
100  *
101  * Release management is a essentially an agreement between the development
102  * community and the user community on what kind of updates can be expected
103  * for Asterisk releases, and what types of changes these updates will contain.
104  * Once these policies are established, the development community works very
105  * hard to adhere to them.  However, the development community does reserve
106  * the right to make exceptions to these rules for special cases as the need
107  * arises.
108  *
109  * Asterisk releases are in various states of maintenance.  The states are
110  * defined here:
111  *
112  * \arg <b>None</b> - This release series is receiving no updates whatsoever.
113  * \arg <b>Security-Only</b> - This release series is receiving updates, but
114  *      only to address security issues.  Security issues found and fixed in
115  *      this release series will be accompanied by a published security advisory
116  *      from the Asterisk project.
117  * \arg <b>Full-Support</b> - This release series is receiving updates for all
118  *      types of bugs.
119  * \arg <b>Full-Development</b> - Changes in this part of Asterisk include bug
120  *      fixes, as well as new features and architectural improvements.
121  *
122  * \section AsteriskReleases Asterisk Maintenance Levels
123  *
124  * \htmlonly
125  * <table border="1">
126  *  <tr>
127  *   <td><b>Name</b></td>
128  *   <td><b>SVN Branch</b></td>
129  *   <td><b>Status</b></td>
130  *   <td><b>Notes</b></td>
131  *  </tr>
132  *  <tr>
133  *   <td>Asterisk 1.0</td>
134  *   <td>/branches/1.0</td>
135  *   <td>None</td>
136  *  </tr>
137  *  <tr>
138  *   <td>Asterisk 1.2</td>
139  *   <td>/branches/1.2</td>
140  *   <td>Security-Only</td>
141  *  </tr>
142  *  <tr>
143  *   <td>Asterisk 1.4</td>
144  *   <td>/branches/1.4</td>
145  *   <td>Full-Support</td>
146  *  </tr>
147  *  <tr>
148  *   <td>Asterisk 1.6.0</td>
149  *   <td>/branches/1.6.0</td>
150  *   <td>Full-Support</td>
151  *  </tr>
152  *  <tr>
153  *   <td>Asterisk 1.6.1</td>
154  *   <td>/branches/1.6.1</td>
155  *   <td>Full-Support</td>
156  *   <td>Still in beta</td>
157  *  </tr>
158  *  <tr>
159  *   <td>Asterisk trunk</td>
160  *   <td>/trunk</td>
161  *   <td>Full-Development</td>
162  *   <td>No releases are made directly from trunk.</td>
163  *  </tr>
164  * </table>
165  * \endhtmlonly
166  *
167  * For more information on how and when Asterisk releases are made, see the
168  * release policies page:
169  * \arg \ref ReleasePolicies
170  */
171
172 /*!
173  * \page ReleasePolicies Asterisk Release and Commit Policies
174  *
175  * \AsteriskTrunkWarning
176  *
177  * \section releasestatus Asterisk Release Status
178  *
179  * For more information on the current status of each Asterisk release series,
180  * please see the Asterisk Release Status page:
181  *
182  * \arg \ref ReleaseStatus
183  *
184  * <hr/>
185  *
186  * \section commitmonitoring Commit Monitoring
187  *
188  * To monitor commits to Asterisk and related projects, visit 
189  * <a href="http://lists.digium.com/">http://lists.digium.com</a>.  The Digium
190  * mailing list server hosts a number of mailing lists for commits.
191  *
192  * <hr/>
193  *
194  * \section ast10policy Asterisk 1.0
195  *
196  * \subsection svnbranch SVN Branch
197  *
198  * \arg /branches/1.0
199  *
200  * \subsection ast10releases Release and Commit Policy
201  * No more releases of Asterisk 1.0 will be made for any reason.
202  *
203  * No commits should be made to the Asterisk 1.0 branch.
204  * 
205  * <hr/>
206  *
207  * \section ast12policy Asterisk 1.2
208  *
209  * \subsection svnbranch SVN Branch
210  *
211  * \arg /branches/1.2
212  *
213  * \subsection ast12releases Release and Commit Policy
214  *
215  * There will be no more scheduled releases of Asterisk 1.2.
216  * 
217  * Commits to the Asterisk 1.2 branch should only address security issues or
218  * regressions introduced by previous security fixes.  For a security issue, the
219  * commit should be accompanied by an 
220  * <a href="http://downloads.digium.com/pub/security/">Asterisk Security Advisory</a>
221  * and an immediate release.  When a commit goes in to fix a regression, the previous
222  * security advisory that is related to the change that introduced the bug should get
223  * updated to indicate that there is an updated version of the fix.  A release should
224  * be made immediately for these regression fixes, as well.
225  *
226  * <hr/>
227  *
228  * \section ast14policy Asterisk 1.4
229  *
230  * \subsection svnbranch SVN Branch
231  *
232  * \arg /branches/1.4
233  *
234  * \subsection ast14releases Release and Commit Policy
235  *
236  * Asterisk 1.4 is receiving regular bug fix release updates.  An attempt is made to
237  * make releases of every four to six weeks.  Since this release series is receiving
238  * changes for all types of bugs, the number of changes in a single release can be
239  * significant.  1.4.X releases go through a release candidate testing cycle to help
240  * catch any regressions that may have been introduced.
241  *
242  * Commits to Asterisk 1.4 must be to address bugs only.  No new features should be
243  * introduced into Asterisk 1.4 to reduce the number of changes to this established
244  * release series.  The only exceptions to this rule are for cases where something
245  * that may be considered a feature is needed to address a bug or security issue.
246  *
247  * <hr/>
248  *
249  * \section ast16policy Asterisk 1.6
250  *
251  * \subsection svnbranch SVN Branch
252  *
253  * \arg /branches/1.6.*
254  *
255  * \subsection ast16releases Release and Commit Policy
256  *
257  * Asterisk 1.6 is managed in a different way than previous Asterisk release series.
258  * From a high level, it was inspired by the release model used for Linux 2.6.
259  * The intended time frame for 1.6.X releases is every 2 or 3 months.  Each 1.6.X
260  * release gets its own branch.  The 1.6.X branches are branches off of trunk.
261  * Once the branch is created, it only receives bug fixes.  Each 1.6.X release goes
262  * through a beta and release candidate testing cycle.
263  *
264  * After a 1.6.X release is published, it will be maintained until 1.6.[X + 3] is
265  * released.  While a 1.6.X release branch is still maintained, it will receive only
266  * bug fixes.  Periodic maintenance releases will be made and labeled as 1.6.X.Y.
267  * 1.6.X.Y releases should go through a release candidate test cycle before being
268  * published.
269  *
270  * For now, all previous 1.6 release will be maintained for security issues.  Once
271  * we have more 1.6 releases to deal with, this part of the policy will likely change.
272  * 
273  * For some history on the motivations for Asterisk 1.6 release management, see the
274  * first two sections of this
275  * <a href="http://lists.digium.com/pipermail/asterisk-dev/2007-October/030083.html">mailing list post</a>.
276  *
277  * <hr/>
278  *
279  * \section asttrunk Asterisk Trunk
280  *
281  * \subsection svnbranch SVN Branch
282  *
283  * \arg /trunk
284  *
285  * \subsection asttrunkpolicy Release and Commit Policy
286  *
287  * No releases are ever made directly from Asterisk trunk.
288  *
289  * Asterisk trunk is used as the main development area for upcoming Asterisk 1.6 
290  * releases.  Commits to Asterisk trunk are not limited.  They can be bug fixes,
291  * new features, and architectural improvements.  However, for larger sets
292  * of changes, developers should work with the Asterisk project leaders to
293  * schedule them for inclusion.  Care is taken not to include too many invasive
294  * sets of changes for each new Asterisk 1.6 release.
295  *
296  * No changes should go into Asterisk trunk that are not ready to go into a
297  * release.  While the upcoming release will go through a beta and release
298  * candidate test cycle, code should not be in trunk until the code has been
299  * tested and reviewed such that there is reasonable belief that the code
300  * is ready to go.
301  *
302  * <hr/>
303  *
304  * \section astteam Asterisk Team Branches
305  *
306  * \subsection svnbranch SVN Branch
307  *
308  * \arg /team/&lt;developername&gt;
309  *
310  * \subsection astteampolicy Release and Commit Policy
311  *
312  * The Asterisk subversion repository has a special directory called "team"
313  * where developers can make their own personal development branches.  This is
314  * where new features, bug fixes, and architectural improvements are developed
315  * while they are in progress.
316  *
317  * Just about anything goes as far as commits to this area goes.  However,
318  * developers should keep in mind that anything committed here, as well as
319  * anywhere else on Digium's SVN server, falls under the contributor license
320  * agreement.
321  *
322  * In addition to each developer having their own space for working on projects,
323  * there is also a team/group folder where group development efforts take place.
324  *
325  * Finally, in each developer folder, there is a folder called "private".  This
326  * is where developers can create branches for working on things that they are
327  * not ready for the whole world to see.
328  */
329
330 /*! 
331  * \page CodeGuide Coding Guidelines
332  * \AsteriskTrunkWarning
333  * \section Coding Guidelines
334  * This file is in the /doc directory in your Asterisk source tree.
335  * Make sure to stay up to date with the latest guidelines.
336  * \verbinclude CODING-GUIDELINES
337  */
338
339 /*! 
340  * \page AstAPI Asterisk API
341  * \section Asteriskapi Asterisk API
342  * Some generic documents on the Asterisk architecture
343  *
344  * \arg \ref AstThreadStorage
345  * \arg \ref DataStores
346  * \arg \ref AstExtState
347  *
348  * \subsection model_txt Generic Model
349  * \verbinclude model.txt
350  * \subsection channel_txt Channels
351  * \arg See \ref Def_Channel
352  */
353
354 /*! 
355  * \page AstDebug Debugging
356  * \section debug Debugging
357  * \verbinclude backtrace.txt
358  */
359
360 /*!
361  * \page AstSpeech The Generic Speech Recognition API
362  * \section debug The Generic Speech Recognition API
363  * \verbinclude speechrec.txt
364  */
365
366 /*! 
367  * \page DataStores Channel Data Stores
368  * \section debug Channel Data Stores
369  * \verbinclude datastores.txt
370  */
371
372 /*! 
373  * \page AstAMI AMI - The Manager Interface
374  * \section ami AMI - The manager Interface
375  * \arg \link Config_ami Configuration file \endlink
376  * \arg \ref manager.c
377  * \verbinclude manager.txt
378  */
379
380 /*!
381  * \page AstARA ARA - The Asterisk Realtime Interface
382  * \section realtime ARA - a generic API to storage and retrieval
383  * Implemented in \ref config.c 
384  * Implemented in \ref pbx_realtime.c 
385  * \verbinclude realtime.txt
386  * \verbinclude extconfig.txt
387  */
388
389 /*! 
390  * \page AstDUNDi DUNDi
391  *
392  * DUNDi is a peer-to-peer system for locating Internet gateways to telephony 
393  * services. Unlike traditional centralized services (such as the remarkably 
394  * simple and concise ENUM standard), DUNDi is fully-distributed with no 
395  * centralized authority whatsoever.
396  *
397  * DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, 
398  * it publishes routes which are in turn accessed via industry standard 
399  * protocols such as IAX, SIP and H.323. 
400  *
401  * \par References
402  * \arg DUNDi is documented at http://www.dundi.com
403  * \arg Implemented in \ref pbx_dundi.c and \ref dundi-parser.c
404  * \arg Configuration in \link Config_dun dundi.conf \endlink
405  */
406
407 /*! 
408  * \page AstCDR CDR - Call Data Records and billing
409  * \section cdr Call Data Records
410  * \par See also
411  * \arg \ref cdr.c
412  * \arg \ref cdr_drivers
413  * \arg \ref Config_cdr CDR configuration files
414  *
415  * \verbinclude cdrdriver.txt
416  */
417
418 /*! 
419  * \page AstREADME README
420  * \verbinclude README
421  */
422  
423 /*! 
424  * \page AstCREDITS CREDITS
425  * \verbinclude CREDITS
426  */
427
428 /*! 
429  * \page AstVideo Video support in Asterisk
430  * \section sectAstVideo Video support in Asterisk
431  * \verbinclude video.txt
432  */
433
434 /*! 
435  * \page AstVar Globally predefined channel variables
436  * \section globchan Globally predefined channel variables
437  *
438  * More and more of these variables are being replaced by dialplan functions.
439  * Some still exist though and some that does still exist needs to move to
440  * dialplan functions.
441  *
442  * See also
443  * - \ref pbx_retrieve_variable()
444  * - \ref AstChanVar
445  *
446  *  \verbinclude channelvariables.tex
447  */
448
449 /*! 
450  * \page AstChanVar Asterisk Dialplan Variables
451  *      Asterisk Dialplan variables are divided into three groups:
452  *      - Predefined global variables, handled by the PBX core
453  *      - Global variables, that exist for the duration of the pbx execution
454  *      - Channel variables, that exist during a channel
455  *
456  * Global variables are reachable in all channels, all of the time.
457  * Channel variables are only reachable within the channel.
458  *
459  * For more information on the predefined variables, see \ref AstVar
460  * 
461  * Global and Channel variables:
462  * - Names are Case insensitive
463  * - Names that start with a character, but are alphanumeric
464  * - Global variables are defined and reached with the GLOBAL() dialplan function
465  *   and the set application, like
466  *
467  *      exten => 1234,1,set(GLOBAL(myvariable)=tomteluva)
468  *
469  *      - \ref func_global.c
470  *
471  * - Channel variables are defined with the set() dialplan application
472  *
473  *      exten => 1234,1,set(xmasattribute=tomtegröt)
474  *
475  * - Some channels also supports setting channel variables with the \b setvar=
476  *   configuraiton option for a device or line.
477  *
478  * \section AstChanVar_globalvars Global Variables
479  * Global variables can also be set in the [globals] section of extensions.conf. The
480  * setting \b clearglobalvars in extensions.conf [general] section affects whether
481  * or not the global variables defined in \b globals are reset at dialplan reload.
482  * 
483  * There are CLI commands to change and read global variables. This can be handy
484  * to reset counters at midnight from an external script.
485  *
486  * \section AstChanVar_devnotes Developer notes
487  * Variable handling is managed within \ref pbx.c
488  * You need to include pbx.h to reach these functions.
489  *      - \ref pbx_builtin_setvar_helper()
490  *      - \ref pbx_builtin_getvar_helper()
491  *
492  * The variables is a linked list stored in the channel data structure
493  * with the list starting at varshead in struct ast_channel
494  */
495
496 /*! 
497  * \page AstENUM ENUM
498  * \section enumreadme ENUM
499  * \arg Configuration: \ref Config_enum
500  * \arg \ref enum.c
501  * \arg \ref func_enum.c
502  *
503  * \verbinclude enum.txt
504  */
505
506 /*! 
507  * \page ConfigFiles Configuration files
508  * \section config Main configuration files
509  * \arg \link Config_ast asterisk.conf - the main configuration file \endlink
510  * \arg \link Config_ext extensions.conf - The Dial Plan \endlink
511  * \arg \link Config_mod modules.conf - which modules to load and not to load \endlink
512  * \arg \link Config_fea features.conf - call features (transfer, parking, etc) \endlink
513  * \section chanconf Channel configuration files
514  * \arg \link Config_iax IAX2 configuration  \endlink
515  * \arg \link Config_sip SIP configuration  \endlink
516  * \arg \link Config_mgcp MGCP configuration  \endlink
517  * \arg \link Config_rtp RTP configuration  \endlink
518  * \arg \link Config_dahdi DAHDI configuration  \endlink
519  * \arg \link Config_oss OSS (sound card) configuration  \endlink
520  * \arg \link Config_alsa ALSA (sound card) configuration  \endlink
521  * \arg \link Config_agent Agent (proxy channel) configuration  \endlink
522  * \arg \link Config_misdn MISDN Experimental ISDN BRI channel configuration  \endlink
523  * \arg \link Config_h323 H.323 configuration  \endlink
524  * \section appconf Application configuration files
525  * \arg \link Config_mm Meetme (conference bridge) configuration  \endlink
526  * \arg \link Config_qu Queue system configuration  \endlink
527  * \arg \link Config_vm Voicemail configuration  \endlink
528  * \arg \link Config_followme Followme configuration  \endlink
529  * \section cdrconf CDR configuration files
530  * \arg \link Config_cdr CDR configuration  \endlink
531  * \arg \link cdr_custom Custom CDR driver configuration \endlink
532  * \arg \link cdr_ami Manager CDR driver configuration \endlink
533  * \arg \link cdr_odbc ODBC CDR driver configuration \endlink
534  * \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
535  * \arg \link cdr_sqlite SQLite CDR driver configuration \endlink
536  * \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
537  * \section miscconf Miscellenaous configuration files
538  * \arg \link Config_adsi ADSI configuration  \endlink
539  * \arg \link Config_ami AMI - Manager configuration  \endlink
540  * \arg \link Config_ara Realtime configuration  \endlink
541  * \arg \link Config_codec Codec configuration  \endlink
542  * \arg \link Config_dun DUNDi configuration  \endlink
543  * \arg \link Config_enum ENUM configuration  \endlink
544  * \arg \link Config_moh Music on Hold configuration  \endlink
545  * \arg \link Config_vm Voicemail configuration  \endlink
546  * \arg \link res_config_sqlite SQLite Resource driver configuration \endlink
547  */
548
549 /*! 
550  * \page Config_ast Asterisk.conf
551  * \verbinclude asterisk-conf.txt
552  */
553
554 /*! 
555  * \page Config_mod Modules configuration
556  * All res_ resource modules are loaded with globals on, which means
557  * that non-static functions are callable from other modules.
558  *
559  * If you want your non res_* module to export functions to other modules
560  * you have to include it in the [global] section.
561  * \verbinclude modules.conf.sample
562  */
563
564 /*! 
565  * \page Config_fea Call features configuration
566  * \par See also
567  * \arg \ref res_features.c : Call feature implementation
568  * \section featconf features.conf
569  * \verbinclude features.conf.sample
570  */
571
572 /*! 
573  * \page Config_followme Followme: An application for simple follow-me calls
574  * \section followmeconf Followme.conf
575  * - See app_followme.c
576  * \verbinclude followme.conf.sample
577  */
578
579 /*! 
580  * \page Config_ext Extensions.conf - the Dial Plan
581  * \section dialplan Extensions.conf 
582  * \verbinclude extensions.conf.sample
583  */
584
585 /*! 
586  * \page Config_iax IAX2 configuration
587  * IAX2 is implemented in \ref chan_iax2.c
588  * \arg \link Config_iax iax.conf Configuration file example \endlink
589  * \section iaxreadme IAX readme file
590  * \verbinclude iax.txt
591  * \section Config_iax IAX Configuration example
592  * \verbinclude iax.conf.sample
593  * \section iaxjitter IAX Jitterbuffer information
594  * \verbinclude jitterbuffer.txt
595  */
596
597 /*! 
598  * \page Config_iax IAX configuration
599  * \arg Implemented in \ref chan_iax2.c
600  * \section iaxconf iax.conf
601  * \verbinclude iax.conf.sample
602  */
603
604 /*! 
605  * \page Config_sip SIP configuration
606  * Also see \ref Config_rtp RTP configuration
607  * \arg Implemented in \ref chan_sip.c
608  * \section sipconf sip.conf
609  * \verbinclude sip.conf.sample
610  *
611  * \arg \b Back \ref chanconf
612  */
613
614 /*! 
615  * \page Config_mgcp MGCP configuration
616  * Also see \ref Config_rtp RTP configuration
617  * \arg Implemented in \ref chan_mgcp.c
618  * \section mgcpconf mgcp.conf
619  * \verbinclude mgcp.conf.sample
620  */
621
622 /*! 
623  * \page README_misdn MISDN documentation
624  * \arg See \ref Config_misdn
625  * \section mISDN configuration
626  * \verbinclude misdn.txt
627  */
628
629 /*! 
630  * \page Config_misdn MISDN configuration
631  * \arg Implemented in \ref chan_misdn.c
632  * \arg \ref README_misdn
633  * \arg See the mISDN home page: http://www.isdn4linux.de/mISDN/
634  * \section misdnconf misdn.conf
635  * \verbinclude misdn.conf.sample
636  */
637
638 /*! 
639  * \page Config_vm VoiceMail configuration
640  * \section vmconf voicemail.conf
641  * \arg Implemented in \ref app_voicemail.c
642  * \verbinclude voicemail.conf.sample
643  */
644
645 /*! 
646  * \page Config_dahdi DAHDI configuration
647  * \section dahdiconf dahdi.conf
648  * \arg Implemented in \ref chan_dahdi.c
649  * \verbinclude dahdi.conf.sample
650  */
651
652 /*! 
653  * \page Config_h323 H.323 channel driver information
654  * This is the configuration of the H.323 channel driver within the Asterisk
655  * distribution. There's another one, called OH323, in asterisk-addons
656  * \arg Implemented in \ref chan_h323.c
657  * \section h323conf h323.conf
658  * \ref chan_h323.c
659  */
660
661 /*! 
662  * \page Config_oss OSS configuration
663  * \section ossconf oss.conf
664  * \arg Implemented in \ref chan_oss.c
665  * \verbinclude oss.conf.sample
666  */
667
668 /*! 
669  * \page Config_alsa ALSA configuration
670  * \section alsaconf alsa.conf
671  * \arg Implemented in \ref chan_alsa.c
672  * \verbinclude alsa.conf.sample
673  */
674
675 /*! 
676  * \page Config_agent Agent configuration
677  * \section agentconf agents.conf
678  * The agent channel is a proxy channel for queues
679  * \arg Implemented in \ref chan_agent.c
680  * \verbinclude agents.conf.sample
681  */
682
683 /*! 
684  * \page Config_rtp RTP configuration
685  * \arg Implemented in \ref rtp.c
686  * Used in \ref chan_sip.c and \ref chan_mgcp.c (and various H.323 channels)
687  * \section rtpconf rtp.conf
688  * \verbinclude rtp.conf.sample
689  */
690
691 /*! 
692  * \page Config_dun DUNDi Configuration
693  * \arg See also \ref AstDUNDi
694  * \section dundiconf dundi.conf
695  * \verbinclude dundi.conf.sample
696  */
697
698 /*! 
699  * \page Config_enum ENUM Configuration
700  * \section enumconf enum.conf
701  * \arg See also \ref enumreadme
702  * \arg Implemented in \ref func_enum.c and \ref enum.c
703  * \verbinclude enum.conf.sample
704  */
705
706 /*! 
707  * \page cdr_custom Custom CDR Configuration
708  * \par See also 
709  * \arg \ref cdrconf
710  * \arg \ref cdr_custom.c
711  * \verbinclude cdr_custom.conf.sample
712  */
713
714 /*! 
715  * \page cdr_ami Manager CDR driver configuration
716  * \par See also 
717  * \arg \ref cdrconf
718  * \arg \ref AstAMI
719  * \arg \ref cdr_manager.c
720  * \verbinclude cdr_manager.conf.sample
721  */
722
723 /*! 
724  * \page cdr_odbc ODBC CDR driver configuration
725  * \arg See also \ref cdrconf
726  * \arg \ref cdr_odbc.c
727  * \verbinclude cdr_odbc.conf.sample
728  * See also:
729  * \arg http://www.unixodbc.org
730  */
731
732 /*! 
733  * \page cdr_pgsql PostgreSQL CDR driver configuration
734  * \arg See also \ref cdrconf
735  * \arg \ref cdr_pgsql.c
736  * See also:
737  * \arg http://www.postgresql.org
738  * \verbinclude cdr_pgsql.conf.sample
739  */
740
741 /*! 
742  * \page cdr_sqlite SQLite CDR driver configuration
743  * \arg See also \ref cdrconf
744  * \arg \ref cdr_sqlite.c
745  * See also:
746  * \arg http://www.sqlite.org
747  */
748
749 /*! 
750  * \page cdr_tds FreeTDS CDR driver configuration
751  * \arg See also \ref cdrconf
752  * See also:
753  * \arg http://www.freetds.org
754  * \verbinclude cdr_tds.conf.sample
755  */
756
757 /*! 
758  * \page Config_cdr CDR configuration
759  * \par See also
760  * \arg \ref cdr_drivers
761  * \arg \link Config_cdr CDR configuration  \endlink  
762  * \arg \link cdr_custom Custom CDR driver configuration \endlink
763  * \arg \link cdr_ami Manager CDR driver configuration \endlink
764  * \arg \link cdr_odbc ODBC CDR driver configuration \endlink
765  * \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
766  * \arg \link cdr_sqlite SQLite CDR driver configuration \endlink
767  * \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
768  * \verbinclude cdr.conf.sample
769  */
770
771 /*! 
772  * \page Config_moh Music on Hold Configuration
773  * \arg Implemented in \ref res_musiconhold.c
774  * \section mohconf musiconhold.conf
775  * \verbinclude musiconhold.conf.sample
776  */
777
778 /*! 
779  * \page Config_adsi ADSI Configuration
780  * \section adsiconf adsi.conf
781  * \verbinclude adsi.conf.sample
782  */
783
784 /*! 
785  * \page Config_codec CODEC Configuration
786  * \section codecsconf codecs.conf
787  * \verbinclude codecs.conf.sample
788  */
789
790 /*! 
791  * \page Config_ara REALTIME Configuration
792  * \arg See also: \arg \link AstARA \endlink
793  * \section extconf extconfig.conf
794  * \verbinclude extconfig.conf.sample
795  */
796
797 /*! 
798  * \page Config_ami AMI configuration
799  * \arg See also: \arg \link AstAMI \endlink
800  * \section amiconf manager.conf
801  * \verbinclude manager.conf.sample
802  */
803
804 /*! 
805  * \page Config_qu ACD - Queue system configuration
806  * \arg Implemented in \ref app_queue.c
807  * \section quconf queues.conf
808  * \verbinclude queues.conf.sample
809  */
810
811 /*! 
812  * \page Config_mm Meetme - The conference bridge configuration
813  * \arg Implemented in \ref app_meetme.c
814  * \section mmconf meetme.conf
815  * \verbinclude meetme.conf.sample
816  */
817
818 /*! 
819  * \page SoundFiles Sound files
820  * \section SecSound Asterisk Sound files
821  * Asterisk includes a large number of sound files. Many of these
822  * are used by applications and demo scripts within asterisk.
823  *
824  * Additional sound files are available in the asterisk-addons
825  * repository on svn.digium.com
826  */
827
828 /*! 
829  * \addtogroup cdr_drivers Module: CDR Drivers
830  * \section CDR_generic Asterisk CDR Drivers
831  * \brief CDR drivers are loaded dynamically, each loaded CDR driver produce 
832  *        a billing record for each call.
833  * \arg \ref Config_mod "Modules Configuration"
834  * \arg \ref Config_cdr "CDR Configuration"
835  */
836
837
838 /*! 
839  * \addtogroup channel_drivers Module: Asterisk Channel Drivers
840  * \section channel_generic Asterisk Channel Drivers
841  * \brief Channel drivers are loaded dynamically. 
842  * \arg \ref Config_mod "Modules Configuration"
843  */
844
845 /*! 
846  * \addtogroup applications Module: Dial plan applications
847  * \section app_generic Asterisk Dial Plan Applications
848  * \brief Applications support the dialplan. They register dynamically with 
849  *        \see ast_register_application() and unregister with 
850  *        \see ast_unregister_application()
851  * \par See also
852  * \arg \ref functions
853  */
854
855 /*! 
856  * \addtogroup functions Module: Dial plan functions
857  * \section func_generic Asterisk Dial Plan Functions
858  * \brief Functions support the dialplan.  They do not change any property of a channel
859  *        or touch a channel in any way.
860  * \par See also
861  * \arg \ref applications
862  *  
863  */
864
865 /*! 
866  * \addtogroup codecs Module: Codecs
867  * \section codec_generic Asterisk Codec Modules
868  * Codecs are referenced in configuration files by name 
869  * \par See also 
870  * \arg \ref formats 
871  */
872
873 /*! 
874  * \addtogroup formats Module: Media File Formats 
875  * \section codec_generic Asterisk Format drivers
876  * Formats are modules that read or write media files to disk.
877  * \par See also
878  * \arg \ref codecs 
879  */
880
881 /*! 
882  * \page AstHTTP AMI over HTTP support
883  * The http.c file includes support for manager transactions over
884  * http.
885  * \section ami AMI - The manager Interface
886  * \arg \link Config_ami Configuration file \endlink
887  */
888
889 /*! 
890  * \page res_config_sqlite SQLite Resource driver configuration
891  * \arg Implemented in \ref res_config_sqlite.c
892  * \arg Configuration file:
893  * \verbinclude res_config_sqlite.conf
894  * \arg SQL tables:
895  * \verbinclude res_config_sqlite.txt
896  * \arg See also:
897  * http://www.sqlite.org
898  */
899
900 /*!
901  * \page Licensing Asterisk Licensing Information
902  *
903  * \section license Asterisk License
904  * \verbinclude LICENSE
905  *
906  * \section otherlicenses Licensing of 3rd Party Code
907  *
908  * This section contains a (not yet complete) list of libraries that are used
909  * by various parts of Asterisk, including related licensing information.
910  *
911  * \subsection alsa_lib ALSA Library
912  * \arg <b>Library</b>: libasound
913  * \arg <b>Website</b>: http://www.alsa-project.org
914  * \arg <b>Used by</b>: chan_alsa
915  * \arg <b>License</b>: LGPL
916  *
917  * \subsection openssl_lib OpenSSL
918  * \arg <b>Library</b>: libcrypto, libssl
919  * \arg <b>Website</b>: http://www.openssl.org
920  * \arg <b>Used by</b>: Asterisk core (TLS for manager and HTTP), res_crypto
921  * \arg <b>License</b>: Apache 2.0
922  * \arg <b>Note</b>:    An exception has been granted to allow linking of 
923  *                      OpenSSL with Asterisk.
924  *
925  * \subsection curl_lib Curl
926  * \arg <b>Library</b>: libcurl
927  * \arg <b>Website</b>: http://curl.haxx.se
928  * \arg <b>Used by</b>: func_curl, res_config_curl, res_curl
929  * \arg <b>License</b>: BSD
930  *
931  * \subsection portaudio_lib PortAudio
932  * \arg <b>Library</b>: libportaudio
933  * \arg <b>Website</b>: http://www.portaudio.com
934  * \arg <b>Used by</b>: chan_console
935  * \arg <b>License</b>: BSD
936  * \arg <b>Note</b>:    Even though PortAudio is licensed under a BSD style
937  *                      license, PortAudio will make use of some audio interface,
938  *                      depending on how it was built.  That audio interface may
939  *                      introduce additional licensing restrictions.  On Linux,
940  *                      this would most commonly be ALSA: \ref alsa_lib.
941  *
942  * \subsection rawlist Raw list of libraries that used by any part of Asterisk
943  * \li c-client.a (app_voicemail with IMAP support)
944  * \li libSDL-1.2.so.0
945  * \li libSaClm.so.2
946  * \li libSaEvt.so.2
947  * \li libX11.so.6
948  * \li libXau.so.6
949  * \li libXdmcp.so.6
950  * \li libasound.so.2
951  * \li libc.so.6
952  * \li libcom_err.so.2
953  * \li libcrypt.so.1
954  * \li libcrypto.so.0.9.8 (chan_h323)
955  * \li libcurl.so.4
956  * \li libdirect-1.0.so.0
957  * \li libdirectfb-1.0.so.0
958  * \li libdl.so.2
959  * \li libexpat.so (chan_h323)
960  * \li libfusion-1.0.so.0
961  * \li libgcc_s.so (chan_h323)
962  * \li libgcrypt.so.11 (chan_h323)
963  * \li libglib-2.0.so.0
964  * \li libgmime-2.0.so.2
965  * \li libgmodule-2.0.so.0
966  * \li libgnutls.so.13 (chan_h323)
967  * \li libgobject-2.0.so.0
968  * \li libgpg-error.so.0 (chan_h323)
969  * \li libgssapi_krb5.so.2
970  * \li libgthread-2.0.so.0
971  * \li libidn.so.11
972  * \li libiksemel.so.3
973  * \li libisdnnet.so
974  * \li libjack.so.0
975  * \li libjpeg.so.62
976  * \li libk5crypto.so.3
977  * \li libkeyutils.so.1
978  * \li libkrb5.so.3
979  * \li libkrb5support.so.0
980  * \li liblber-2.4.so.2 (chan_h323)
981  * \li libldap_r-2.4.so.2 (chan_h323)
982  * \li libltdl.so.3
983  * \li liblua5.1.so.0
984  * \li libm.so.6
985  * \li libmISDN.so
986  * \li libnbs.so.1
987  * \li libncurses.so.5
988  * \li libnetsnmp.so.15
989  * \li libnetsnmpagent.so.15
990  * \li libnetsnmphelpers.so.15
991  * \li libnetsnmpmibs.so.15
992  * \li libnsl.so.1
993  * \li libodbc.so.1
994  * \li libogg.so.0
995  * \li libopenh323.so (chan_h323)
996  * \li libpcre.so.3
997  * \li libperl.so.5.8
998  * \li libportaudio.so.2
999  * \li libpq.so.5
1000  * \li libpri.so.1.4
1001  * \li libpt.so (chan_h323)
1002  * \li libpthread.so.0
1003  * \li libradiusclient-ng.so.2
1004  * \li libresample.so.1.0
1005  * \li libresolv.so.2 (chan_h323)
1006  * \li librt.so.1
1007  * \li libsasl2.so.2 (chan_h323)
1008  * \li libselinux.so.1
1009  * \li libsensors.so.3
1010  * \li libspandsp.so.1
1011  * \li libspeex.so.1
1012  * \li libsqlite.so.0
1013  * \li libsqlite3.so.0
1014  * \li libss7.so.1
1015  * \li libssl.so.0.9.8 (chan_h323)
1016  * \li libstdc++.so (chan_h323, chan_vpb)
1017  * \li libsuppserv.so
1018  * \li libsybdb.so.5
1019  * \li libsysfs.so.2
1020  * \li libtasn1.so.3 (chan_h323)
1021  * \li libtds.so.4
1022  * \li libtiff.so.4
1023  * \li libtonezone.so.1.0
1024  * \li libvorbis.so.0
1025  * \li libvorbisenc.so.2
1026  * \li libvpb.a (chan_vpb)
1027  * \li libwrap.so.0
1028  * \li libxcb-xlib.so.0
1029  * \li libxcb.so.1
1030  * \li libz.so.1 (chan_h323)
1031  * \li linux-vdso.so.1
1032 */