Add misdn.txt to doxygen docs
[asterisk/asterisk.git] / include / asterisk / doxyref.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /* \file This file generates Doxygen pages from files in the /doc
20  directory of the Asterisk source code tree 
21  */
22
23 /* The following is for Doxygen Developer's documentation generated
24  * by running "make progdocs" with doxygen installed on your
25  * system.
26  */
27 /*! \page DevDoc Asterisk Developer's Documentation - appendices
28  *  \arg \ref CodeGuide : The must-read document for all developer's
29  *  \arg \ref AstAPI
30  *  \arg \ref Def_Channel : What's a channel, anyway?
31  *  \arg \ref channel_drivers : Existing channel drivers
32  *  \arg \ref AstDebug : Hints on debugging
33  *  \arg \ref AstAMI : The Call management socket API
34  *  \arg \ref AstARA : A generic data storage and retrieval API for Asterisk
35  *  \arg \ref AstDUNDi : A way to find phone services dynamically by using the DUNDi protocol
36  *  \arg \ref AstCDR
37  *  \arg \ref AstREADME
38  *  \arg \ref AstVar
39  *  \arg \ref AstENUM : The IETF way to redirect from phone numbers to VoIP calls
40  *  \arg \ref AstHTTP
41  *  \arg \ref ConfigFiles
42  *  \arg \ref SoundFiles included in the Asterisk distribution
43  *  \arg \ref AstCREDITS : A Thank You to contributors
44  \n\n
45  * \section weblinks Web sites
46  * \arg \b Main:  Asterisk Developer's website http://www.asterisk.org/developers/
47  * \arg \b Bugs: The Issue tracker http://bugs.digium.com
48  * \arg \b Lists: List server http://lists.digium.com
49  * \arg \b Wiki: The Asterisk Wiki      http://www.voip-info.org
50  * \arg \b Docs: The Asterisk Documentation Project http://www.asteriskdocs.org
51  * \arg \b Digium: The Asterisk company http://www.digium.com
52  *
53  */
54
55 /*! \page CodeGuide Coding Guidelines
56  *  \section Coding Guidelines
57  *  This file is in the /doc directory in your Asterisk source tree.
58  *  Make sure to stay up to date with the latest guidelines.
59  *  \verbinclude CODING-GUIDELINES
60  */
61
62 /*! \page AstAPI Asterisk API
63  *  \section Asteriskapi Asterisk API
64  *  Some generic documents on the Asterisk architecture
65  *  \subsection model_txt Generic Model
66  *  \verbinclude model.txt
67  *  \subsection channel_txt Channels
68  *  \arg See \ref Def_Channel
69  */
70
71 /*! \page AstDebug Debugging
72  *  \section debug Debugging
73  *  \verbinclude backtrace.txt
74  */
75
76 /*! \page AstAMI AMI - The Manager Interface
77  *  \section ami AMI - The manager Interface
78  *  \arg \link Config_ami Configuration file \endlink
79  * \arg \ref manager.c
80  *  \verbinclude manager.txt
81  */
82
83 /*!  \page AstARA ARA - The Asterisk Realtime Interface
84  *  \section realtime ARA - a generic API to storage and retrieval
85  *  Implemented in \ref config.c 
86  *  Implemented in \ref pbx_realtime.c 
87  *  \verbinclude realtime.txt
88  *  \verbinclude extconfig.txt
89  */
90
91 /*!  \page AstDUNDi DUNDi
92 DUNDi is a peer-to-peer system for locating Internet gateways to telephony services. Unlike traditional centralized services (such as the remarkably simple and concise ENUM standard), DUNDi is fully-distributed with no centralized authority whatsoever.
93
94 DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it publishes routes which are in turn accessed via industry standard protocols such as IAX, SIP and H.323. 
95
96         \par References
97         \arg DUNDi is documented at http://www.dundi.com
98         \arg Implemented in \ref pbx_dundi.c and \ref dundi-parser.c
99         \arg Configuration in \link Config_dun dundi.conf \endlink
100  */
101
102 /*! \page AstCDR CDR - Call Data Records and billing
103  * \section cdr Call Data Records
104  * \par See also
105  * \arg \ref cdr.c
106  * \arg \ref cdr_drivers
107  * \arg \ref Config_cdr CDR configuration files
108  *
109  *  \verbinclude cdr.txt
110  */
111
112 /*! \page AstREADME README - the general administrator introduction
113  *  \verbinclude README
114  */
115  
116 /*! \page AstCREDITS CREDITS
117  *  \verbinclude CREDITS
118  */
119
120 /*! \page AstVar Global channel variables
121  * \section globchan Global Channel Variables
122  *  \verbinclude variables.txt
123  */
124
125 /*! \page AstENUM ENUM
126  * \section enumreadme ENUM
127  * \arg Configuration: \ref Config_enum
128  * \arg \ref enum.c
129  * \arg \ref func_enum.c
130  *
131  * \verbinclude enum.txt
132  */
133
134 /*! \page ConfigFiles Configuration files
135  * \section config Main configuration files
136  * \arg \link Config_ast asterisk.conf - the main configuration file \endlink
137  * \arg \link Config_ext extensions.conf - The Dial Plan \endlink
138  * \arg \link Config_mod modules.conf - which modules to load and not to load \endlink
139  * \arg \link Config_fea features.conf - call features (transfer, parking, etc) \endlink
140  * \section chanconf Channel configuration files
141  * \arg \link Config_iax IAX2 configuration  \endlink
142  * \arg \link Config_sip SIP configuration  \endlink
143  * \arg \link Config_mgcp MGCP configuration  \endlink
144  * \arg \link Config_rtp RTP configuration  \endlink
145  * \arg \link Config_zap Zaptel configuration  \endlink
146  * \arg \link Config_oss OSS (sound card) configuration  \endlink
147  * \arg \link Config_alsa ALSA (sound card) configuration  \endlink
148  * \arg \link Config_agent Agent (proxy channel) configuration  \endlink
149  * \arg \link Config_misdn MISDN Experimental ISDN BRI channel configuration  \endlink
150  * \arg \link Config_h323 H.323 configuration  \endlink
151  * \section appconf Application configuration files
152  * \arg \link Config_mm Meetme (conference bridge) configuration  \endlink
153  * \arg \link Config_qu Queue system configuration  \endlink
154  * \arg \link Config_vm Voicemail configuration  \endlink
155  * \section cdrconf CDR configuration files
156  * \arg \link Config_cdr CDR configuration  \endlink
157  * \arg \link cdr_custom Custom CDR driver configuration \endlink
158  * \arg \link cdr_ami Manager CDR driver configuration \endlink
159  * \arg \link cdr_odbc ODBC CDR driver configuration \endlink
160  * \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
161  * \arg \link cdr_sqlite SQLite CDR driver configuration \endlink
162  * \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
163  * \section miscconf Miscellenaous configuration files
164  * \arg \link Config_adsi ADSI configuration  \endlink
165  * \arg \link Config_ami AMI - Manager configuration  \endlink
166  * \arg \link Config_ara Realtime configuration  \endlink
167  * \arg \link Config_codec Codec configuration  \endlink
168  * \arg \link Config_dun DUNDi configuration  \endlink
169  * \arg \link Config_enum ENUM configuration  \endlink
170  * \arg \link Config_moh Music on Hold configuration  \endlink
171  * \arg \link Config_vm Voicemail configuration  \endlink
172  */
173
174 /*! \page Config_ast Asterisk.conf
175  * \verbinclude asterisk-conf.txt
176  */
177 /*! \page Config_mod Modules configuration
178  * All res_ resource modules are loaded with globals on, which means
179  * that non-static functions are callable from other modules.
180  *
181  * If you want your non res_* module to export functions to other modules
182  * you have to include it in the [global] section.
183  * \verbinclude modules.conf.sample
184  */
185
186 /*! \page Config_fea Call features configuration
187  * \par See also
188  * \arg \ref res_features.c : Call feature implementation
189  * \section featconf features.conf
190  * \verbinclude features.conf.sample
191  */
192
193 /*! \page Config_ext Extensions.conf - the Dial Plan
194  * \section dialplan Extensions.conf 
195  * \verbinclude extensions.conf.sample
196  */
197
198 /*! \page Config_iax IAX2 configuration
199  * IAX2 is implemented in \ref chan_iax2.c
200  * \arg \link Config_iax iax.conf Configuration file example \endlink
201  * \section iaxreadme IAX readme file
202  * \verbinclude iax.txt
203  * \section Config_iax IAX Configuration example
204  * \verbinclude iax.conf.sample
205  * \section iaxjitter IAX Jitterbuffer information
206  * \verbinclude jitterbuffer.txt
207  */
208
209 /*! \page Config_iax IAX configuration
210  * \arg Implemented in \ref chan_iax2.c
211  * \section iaxconf iax.conf
212  * \verbinclude iax.conf.sample
213  */
214
215 /*! \page Config_sip SIP configuration
216  * Also see \ref Config_rtp RTP configuration
217  * \arg Implemented in \ref chan_sip.c
218  * \section sipconf sip.conf
219  * \verbinclude sip.conf.sample
220  *
221  * \arg \b Back \ref chanconf
222  */
223
224 /*! \page Config_mgcp MGCP configuration
225  * Also see \ref Config_rtp RTP configuration
226  * \arg Implemented in \ref chan_mgcp.c
227  * \section mgcpconf mgcp.conf
228  * \verbinclude mgcp.conf.sample
229  */
230
231 /*! \page README_misdn MISDN documentation
232  * \arg See \ref Config_misdn
233  * \section mISDN configuration
234  * \verbinclude misdn.txt
235  */
236
237 /*! \page Config_misdn MISDN configuration
238  * \arg Implemented in \ref chan_misdn.c
239  * \arg \ref README_misdn
240  * \arg See the mISDN home page: http://www.isdn4linux.de/mISDN/
241  * \section misdnconf misdn.conf
242  * \verbinclude misdn.conf.sample
243  */
244
245 /*! \page Config_vm VoiceMail configuration
246  * \section vmconf voicemail.conf
247  * \arg Implemented in \ref app_voicemail.c
248  * \verbinclude voicemail.conf.sample
249  */
250
251 /*! \page Config_zap Zaptel configuration
252  * \section zapconf zapata.conf
253  * \arg Implemented in \ref chan_zap.c
254  * \verbinclude zapata.conf.sample
255  */
256
257 /*! \page Config_h323 H.323 channel driver information
258  * This is the configuration of the H.323 channel driver within the Asterisk
259  * distribution. There's another one, called OH323, in asterisk-addons
260  * \arg Implemented in \ref chan_h323.c
261  * \section h323conf h323.conf
262  * \ref chan_h323.c
263  * \verbinclude h323.txt
264  */
265
266 /*! \page Config_oss OSS configuration
267  * \section ossconf oss.conf
268  * \arg Implemented in \ref chan_oss.c
269  * \verbinclude oss.conf.sample
270  */
271
272 /*! \page Config_alsa ALSA configuration
273  * \section alsaconf alsa.conf
274  * \arg Implemented in \ref chan_alsa.c
275  * \verbinclude alsa.conf.sample
276  */
277
278 /*! \page Config_agent Agent configuration
279  * \section agentconf agents.conf
280  * The agent channel is a proxy channel for queues
281  * \arg Implemented in \ref chan_agent.c
282  * \verbinclude agents.conf.sample
283  */
284
285 /*! \page Config_rtp RTP configuration
286  * \arg Implemented in \ref rtp.c
287  * Used in \ref chan_sip.c and \ref chan_mgcp.c (and various H.323 channels)
288  * \section rtpconf rtp.conf
289  * \verbinclude rtp.conf.sample
290  */
291
292 /*! \page Config_dun DUNDi Configuration
293  * \arg See also \ref AstDUNDi
294  * \section dundiconf dundi.conf
295  * \verbinclude dundi.conf.sample
296  */
297
298 /*! \page Config_enum ENUM Configuration
299  * \section enumconf enum.conf
300  * \arg See also \ref enumreadme
301  * \arg Implemented in \ref func_enum.c and \ref enum.c
302  * \verbinclude enum.conf.sample
303  */
304
305 /*! \page cdr_custom Custom CDR Configuration
306  * \par See also 
307  * \arg \ref cdrconf
308  * \arg \ref cdr_custom.c
309  * \verbinclude cdr_custom.conf.sample
310  */
311
312 /*! \page cdr_ami Manager CDR driver configuration
313  * \par See also 
314  * \arg \ref cdrconf
315  * \arg \ref AstAMI
316  * \arg \ref cdr_manager.c
317  * \verbinclude cdr_manager.conf.sample
318  */
319
320 /*! \page cdr_odbc ODBC CDR driver configuration
321  * \arg See also \ref cdrconf
322  * \arg \ref cdr_odbc.c
323  * \verbinclude cdr_odbc.conf.sample
324  * See also:
325  * \arg http://www.unixodbc.org
326  */
327
328 /*! \page cdr_pgsql PostgreSQL CDR driver configuration
329  * \arg See also \ref cdrconf
330  * \arg \ref cdr_pgsql.c
331  * See also:
332  * \arg http://www.postgresql.org
333  * \verbinclude cdr_pgsql.conf.sample
334  */
335
336 /*! \page cdr_sqlite SQLite CDR driver configuration
337  * \arg See also \ref cdrconf
338  * \arg \ref cdr_sqlite.c
339  * See also:
340  * \arg http://www.sqlite.org
341  */
342
343 /*! \page cdr_tds FreeTDS CDR driver configuration
344  * \arg See also \ref cdrconf
345  * See also:
346  * \arg http://www.freetds.org
347  * \verbinclude cdr_tds.conf.sample
348  */
349
350 /*! \page Config_cdr CDR configuration
351  * \par See also
352  * \arg \ref cdr_drivers
353  * \arg \link Config_cdr CDR configuration  \endlink  
354  * \arg \link cdr_custom Custom CDR driver configuration \endlink
355  * \arg \link cdr_ami Manager CDR driver configuration \endlink
356  * \arg \link cdr_odbc ODBC CDR driver configuration \endlink
357  * \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
358  * \arg \link cdr_sqlite SQLite CDR driver configuration \endlink
359  * \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
360  * \verbinclude cdr.conf.sample
361  */
362
363 /*! \page Config_moh Music on Hold Configuration
364  * \arg Implemented in \ref res_musiconhold.c
365  * \section mohconf musiconhold.conf
366  * \verbinclude musiconhold.conf.sample
367  */
368
369 /*! \page Config_adsi ADSI Configuration
370  * \section adsiconf adsi.conf
371  * \verbinclude adsi.conf.sample
372  */
373
374 /*! \page Config_codec CODEC Configuration
375  * \section codecsconf codecs.conf
376  * \verbinclude codecs.conf.sample
377  */
378
379 /*! \page Config_ara REALTIME Configuration
380  * \arg See also: \arg \link AstARA \endlink
381  * \section extconf extconfig.conf
382  * \verbinclude extconfig.conf.sample
383  */
384
385 /*! \page Config_ami AMI configuration
386  * \arg See also: \arg \link AstAMI \endlink
387  * \section amiconf manager.conf
388  * \verbinclude manager.conf.sample
389  */
390
391 /*! \page Config_qu ACD - Queue system configuration
392  * \arg Implemented in \ref app_queue.c
393  * \section quconf queues.conf
394  * \verbinclude queues.conf.sample
395  */
396
397 /*! \page Config_mm Meetme - The conference bridge configuration
398  * \arg Implemented in \ref app_meetme.c
399  * \section mmconf meetme.conf
400  * \verbinclude meetme.conf.sample
401  */
402
403 /*! \page SoundFiles Sound files
404  *  \section SecSound Asterisk Sound files
405  *  Asterisk includes a large amount of sound files. Many of these
406  *  are used by applications and demo scripts within asterisk.
407  *
408  *  Additional sound files are available in the asterisk-addons
409  *  repository on cvs.digium.com
410  * 
411  *  \section SoundList List of included sound files
412  *  \verbinclude sounds.txt
413  */
414
415 /*! \addtogroup cdr_drivers Module: CDR Drivers
416  *  \section CDR_generic Asterisk CDR Drivers
417  *  \brief CDR drivers are loaded dynamically (see \ref Config_mod "Modules Configuration"). Each loaded CDR driver produce a billing record for each call.
418  *  \arg \ref Config_cdr "CDR Configuration"
419  */
420
421
422 /*! \addtogroup channel_drivers Module: Asterisk Channel Drivers
423  *  \section channel_generic Asterisk Channel Drivers
424  *  \brief Channel drivers are loaded dynamically (see \ref Config_mod "Modules Configuration"). 
425  */
426
427 /*! \addtogroup applications Module: Dial plan applications
428  *  \section app_generic Asterisk Dial Plan Applications
429  *  \brief Applications support the dialplan. They register dynamically with \ref ast_register_application() and unregister with ast_unregister_application()
430  * \par See also
431  * \arg \ref functions
432  *  
433  */
434
435 /*! \addtogroup functions Module: Dial plan functions
436  *  \section func_generic Asterisk Dial Plan Functions
437  *  \brief Functions support the dialplan.  They do not change any property of a channel
438  *  or touch a channel in any way.
439  * \par See also
440  * \arg \ref applications
441  *  
442  */
443
444 /*! \addtogroup codecs Module: Codecs
445  *  \section codec_generic Asterisk Codec Modules
446  *  Codecs are referenced in configuration files by name 
447  *  \par See also 
448  *  \arg \ref formats 
449  *
450  */
451
452 /*! \addtogroup formats Module: Media File Formats 
453  *  \section codec_generic Asterisk Format drivers
454  *  Formats are modules that read or write media files to disk.
455  *  \par See also
456  *  \arg \ref codecs 
457  */
458
459 /*! \page AstHTTP AMI over HTTP support
460  * The http.c file includes support for manager transactions over
461  * http.
462  *  \section ami AMI - The manager Interface
463  *  \arg \link Config_ami Configuration file \endlink
464  *  \verbinclude http.txt
465  */
466