silly people that don't want to install/run autoconf :-)
[asterisk/asterisk.git] / asterisk.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2 <refentry>
3 <refentryinfo>
4         <date>2005-10-18</date>
5 </refentryinfo>
6 <refmeta>
7         <refentrytitle>
8                 <application>asterisk</application>
9         </refentrytitle>
10         <manvolnum>8</manvolnum>
11         <refmiscinfo>asterisk 1.2</refmiscinfo>
12 </refmeta>
13 <refnamediv>
14         <refname>
15                 <application>asterisk</application>
16         </refname>
17         <refpurpose>
18         All-purpose telephony server.
19         </refpurpose>
20 </refnamediv>
21 <refsynopsisdiv>
22         <cmdsynopsis>
23         <command>asterisk</command>
24 <arg><option>-tThfdvVqpRgciIn</option></arg>
25 <arg><option>-C </option><replaceable class="parameter">file</replaceable></arg>
26 <arg><option>-U </option><replaceable class="parameter">user</replaceable></arg>
27 <arg><option>-G </option><replaceable class="parameter">group</replaceable></arg>
28 <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
29 <arg><option>-M </option><replaceable class="parameter">value</replaceable></arg>
30 <arg><option>-L </option><replaceable class="parameter">loadaverage</replaceable></arg>
31         </cmdsynopsis>
32         <cmdsynopsis>
33
34         <command>asterisk -r</command>
35         <arg><option>-v</option></arg>
36 <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
37         </cmdsynopsis>
38 </refsynopsisdiv>
39 <refsect1>
40         <refsect1info>
41                 <date>2006-03-29</date>
42         </refsect1info>
43         <title>DESCRIPTION</title>
44         <para>
45         <command>asterisk</command> is a full-featured telephony server which
46         provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
47         Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying, 
48         Conferencing, and a plethora of other telephony applications to a broad
49         range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
50         H.323) devices (both endpoints and proxies), as well as traditional TDM
51         hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
52         ISDN BRI, and many more.
53         </para>
54         <para>
55         At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
56         file and locates the rest of the configuration files from the configuration
57         in that file. The -C option specifies an alternate main configuration file.
58         Virtually all aspects of the operation of asterisk's configuration files
59         can be found in the sample configuration files.  The format for those files
60         is generally beyond the scope of this man page.
61         </para>
62         <para>
63         When running with <command>-c</command>, <command>-r</command> or <command>-R</command>
64         options, Asterisk supplies a powerful command line, including command
65         completion, which may be used to monitors its status, perform a variety
66         of administrative actions and even explore the applications that are
67         currently loaded into the system.
68         </para>
69         <para>
70         Asterisk is a trademark of Digium, Inc.
71         </para>
72 </refsect1>
73 <refsect1>
74         <title>OPTIONS</title>
75         <variablelist>
76         <varlistentry>
77                 <term>-C <replaceable class="parameter">file</replaceable></term>
78                 <listitem>
79                         <para>
80                         Use <filename>file</filename> as master configuration file
81                         instead of the default, /etc/asterisk/asterisk.conf
82                         </para>
83                 </listitem>
84         </varlistentry>
85         <varlistentry>
86                 <term>-c</term>
87                 <listitem>
88                         <para>
89                         Provide a control console on the calling terminal.
90                         Specifying this option implies <command>-f</command> and will cause
91                         asterisk to no longer fork or detach from the controlling terminal.
92                         </para>
93                 </listitem>
94         </varlistentry>
95         <varlistentry>
96                 <term>-d</term>
97                 <listitem>
98                         <para>
99                         Enable extra debugging statements.
100                         </para>
101                         <para>
102                         Note: This always sets the debug level in the asterisk process,
103                         even if it is running in the background. This will affect the size
104                         of your log files.
105                         </para>
106                 </listitem>
107         </varlistentry>
108         <varlistentry>
109                 <term>-f</term>
110                 <listitem>
111                         <para>
112                         Do not fork or detach from controlling terminal.
113                         </para>
114                 </listitem>
115         </varlistentry>
116         <varlistentry>
117                 <term>-g</term>
118                 <listitem>
119                         <para>
120                         Remove resource limit on core size, thus forcing Asterisk to dump
121                         core in the unlikely event of a segmentation fault or abort signal.
122                         <command>NOTE:</command> in some cases this may be incompatible
123                         with the <command>-U</command> or <command>-G</command> flags.
124                         </para>
125                 </listitem>
126         </varlistentry>
127         <varlistentry>
128                 <term>-G <replaceable class="parameter">group</replaceable></term>
129                 <listitem>
130                         <para>
131                         Run as group <replaceable>group</replaceable> instead of the
132                         calling group.  <command>NOTE:</command> this requires substantial work
133                         to be sure that Asterisk's environment has permission to write
134                         the files required for its operation, including logs, its comm
135                         socket, the asterisk database, etc.
136                         </para>
137                 </listitem>
138         </varlistentry>
139         <varlistentry>
140                 <term>-h</term>
141                 <listitem>
142                         <para>
143                         Provide brief summary of command line arguments and terminate.
144                         </para>
145                 </listitem>
146         </varlistentry>
147         <varlistentry>
148                 <term>-i</term>
149                 <listitem>
150                         <para>
151                         Prompt user to intialize any encrypted private keys for IAX2
152                         secure authentication during startup.
153                         </para>
154                 </listitem>
155         </varlistentry>
156         <varlistentry>
157                 <term>-I</term>
158                 <listitem>
159                         <para>
160                         Enable internal timing if Zaptel timing is available.
161                         The default behaviour is that outbound packets are phase locked
162                         to inbound packets. Enabling this switch causes them to be
163                         locked to the internal Zaptel timer instead.
164                         </para>
165                 </listitem>
166         </varlistentry>
167         <varlistentry>
168                 <term>-L <replaceable class="parameter">loadaverage</replaceable></term>
169                 <listitem>
170                         <para>
171                         Limits the maximum load average before rejecting new calls.  This can
172                         be useful to prevent a system from being brought down by terminating
173                         too many simultaneous calls.
174                         </para>
175                 </listitem>
176         </varlistentry>
177         <varlistentry>
178                 <term>-M <replaceable class="parameter">value</replaceable></term>
179                 <listitem>
180                         <para>
181                         Limits the maximum number of calls to the specified value.  This can
182                         be useful to prevent a system from being brought down by terminating
183                         too many simultaneous calls.
184                         </para>
185                 </listitem>
186         </varlistentry>
187         <varlistentry>
188                 <term>-n</term>
189                 <listitem>
190                         <para>
191                         Disable ANSI colors even on terminals capable of displaying them.
192                         </para>
193                 </listitem>
194         </varlistentry>
195         <varlistentry>
196                 <term>-p</term>
197                 <listitem>
198                         <para>
199                         If supported by the operating system (and executing as root),
200                         attempt to run with realtime priority for increased performance and
201                         responsiveness within the Asterisk process, at the expense of other
202                         programs running on the same machine.
203                         </para>
204                 </listitem>
205         </varlistentry>
206         <varlistentry>
207                 <term>-q</term>
208                 <listitem>
209                         <para>
210                         Reduce default console output when running in conjunction with
211                         console mode (<command>-c</command>).
212                         </para>
213                 </listitem>
214         </varlistentry>
215         <varlistentry>
216                 <term>-r</term>
217                 <listitem>
218                         <para>
219                         Instead of running a new Asterisk process, attempt to connect
220                         to a running Asterisk process and provide a console interface
221                         for controlling it.
222                         </para>
223                 </listitem>
224         </varlistentry>
225         <varlistentry>
226                 <term>-R</term>
227                 <listitem>
228                         <para>
229                         Much like <command>-r</command>.  Instead of running a new Asterisk process, attempt to connect
230                         to a running Asterisk process and provide a console interface
231                         for controlling it. Additionally, if connection to the Asterisk 
232                         process is lost, attempt to reconnect for as long as 30 seconds.
233                         </para>
234                 </listitem>
235         </varlistentry>
236         <varlistentry>
237                 <term>-t</term>
238                 <listitem>
239                         <para>
240                         When recording files, write them first into a temporary holding directory, 
241                         then move them into the final location when done.
242                         </para>
243                 </listitem>
244         </varlistentry>
245         <varlistentry>
246                 <term>-T</term>
247                 <listitem>
248                         <para>
249                         Add timestamp to all non-command related output going to the console
250                         when running with verbose and/or logging to the console.
251                         </para>
252                 </listitem>
253         </varlistentry>
254         <varlistentry>
255                 <term>-U <replaceable class="parameter">user</replaceable></term>
256                 <listitem>
257                         <para>
258                         Run as user <replaceable>user</replaceable> instead of the
259                         calling user.  <command>NOTE:</command> this requires substantial work
260                         to be sure that Asterisk's environment has permission to write
261                         the files required for its operation, including logs, its comm
262                         socket, the asterisk database, etc.
263                         </para>
264                 </listitem>
265         </varlistentry>
266         <varlistentry>
267                 <term>-v</term>
268                 <listitem>
269                         <para>
270                         Increase the level of verboseness on the console.  The more times
271                         <command>-v</command> is specified, the more verbose the output is.
272                         Specifying this option implies <command>-f</command> and will cause
273                         asterisk to no longer fork or detach from the controlling terminal.
274                         This option may also be used in conjunction with <command>-r</command>
275                         and <command>-R</command>.
276                         </para>
277                         <para>
278                         Note: This always sets the verbose level in the asterisk process,
279                         even if it is running in the background. This will affect the size
280                         of your log files.
281                         </para>
282                 </listitem>
283         </varlistentry>
284         <varlistentry>
285                 <term>-V</term>
286                 <listitem>
287                         <para>
288                         Display version information and exit immediately.
289                         </para>
290                 </listitem>
291         </varlistentry>
292         <varlistentry>
293                 <term>-x <replaceable class="parameter">command</replaceable></term>
294                 <listitem>
295                         <para>
296                         Connect to a running Asterisk process and execute a command on
297                         a command line, passing any output through to standard out and
298                         then terminating when the command execution completes.  Implies
299                         <command>-r</command> when <command>-R</command> is not explicitly
300                         supplied.
301                         </para>
302                 </listitem>
303         </varlistentry>
304         </variablelist>
305 </refsect1>
306 <refsect1>
307         <title>EXAMPLES</title>
308         <para>
309         <command>asterisk</command> - Begin Asterisk as a daemon
310         </para>
311         <para>
312         <command>asterisk -vvvgc</command> - Run on controlling terminal
313         </para>
314         <para>
315         <command>asterisk -rx "show channels"</command> - Display channels on running server
316         </para>
317 </refsect1>
318 <refsect1>
319         <title>BUGS</title>
320         <para>
321         Bug reports and feature requests may be filed at http://bugs.digium.com
322         </para>
323 </refsect1>
324 <refsect1>
325         <title>SEE ALSO</title>
326         <para>
327         *CLI&gt; <command>help</command> - Help on Asterisk CLI
328         </para>
329         <para>
330         *CLI&gt; <command>show applications</command> - Show loaded dialplan applications
331         </para>
332         <para>
333         *CLI&gt; <command>show functions</command> - Show loaded dialplan functions
334         </para>
335         <para>
336         http://www.asterisk.org - The Asterisk Home Page
337         </para>
338         <para>
339         http://www.asteriskdocs.org - The Asterisk Documentation Project
340         </para>
341         <para>
342         http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
343         </para>
344         <para>
345         http://www.digium.com/ - Asterisk sponsor and hardware supplier
346         </para>
347         <para>
348         http://www.markocam.com/ - Asterisk author's web cam
349         </para>
350 </refsect1>
351 <refsect1>
352         <title>AUTHOR</title>
353         <para>
354         <author>
355                 <firstname>Mark Spencer &lt;markster@digium.com&gt;</firstname> 
356         </author>
357         </para>
358         <para>
359         <author>
360                 <firstname>Countless other contributers, see CREDITS with distribution for more information</firstname> 
361         </author>
362         </para>
363 </refsect1>
364 </refentry>