b33fb4737d8e0fa6c185b291b38169c2085519c5
[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>-tThfdvVqpRgcin</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">value</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>2004-07-01</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>-L <replaceable class="parameter">loadaverage</replaceable></term>
158                 <listitem>
159                         <para>
160                         Limits the maximum load average before rejecting new calls.  This can
161                         be useful to prevent a system from being brought down by terminating
162                         too many simultaneous calls.
163                         </para>
164                 </listitem>
165         </varlistentry>
166         <varlistentry>
167                 <term>-M <replaceable class="parameter">value</replaceable></term>
168                 <listitem>
169                         <para>
170                         Limits the maximum number of calls to the specified value.  This can
171                         be useful to prevent a system from being brought down by terminating
172                         too many simultaneous calls.
173                         </para>
174                 </listitem>
175         </varlistentry>
176         <varlistentry>
177                 <term>-n</term>
178                 <listitem>
179                         <para>
180                         Disable ANSI colors even on terminals capable of displaying them.
181                         </para>
182                 </listitem>
183         </varlistentry>
184         <varlistentry>
185                 <term>-p</term>
186                 <listitem>
187                         <para>
188                         If supported by the operating system (and executing as root),
189                         attempt to run with realtime priority for increased performance and
190                         responsiveness within the Asterisk process, at the expense of other
191                         programs running on the same machine.
192                         </para>
193                 </listitem>
194         </varlistentry>
195         <varlistentry>
196                 <term>-q</term>
197                 <listitem>
198                         <para>
199                         Reduce default console output when running in conjunction with
200                         console mode (<command>-c</command>).
201                         </para>
202                 </listitem>
203         </varlistentry>
204         <varlistentry>
205                 <term>-r</term>
206                 <listitem>
207                         <para>
208                         Instead of running a new Asterisk process, attempt to connect
209                         to a running Asterisk process and provide a console interface
210                         for controlling it.
211                         </para>
212                 </listitem>
213         </varlistentry>
214         <varlistentry>
215                 <term>-R</term>
216                 <listitem>
217                         <para>
218                         Much like <command>-r</command>.  Instead of running a new Asterisk process, attempt to connect
219                         to a running Asterisk process and provide a console interface
220                         for controlling it. Additionally, if connection to the Asterisk 
221                         process is lost, attempt to reconnect for as long as 30 seconds.
222                         </para>
223                 </listitem>
224         </varlistentry>
225         <varlistentry>
226                 <term>-t</term>
227                 <listitem>
228                         <para>
229                         When recording files, write them first into a temporary holding directory, 
230                         then move them into the final location when done.
231                         </para>
232                 </listitem>
233         </varlistentry>
234         <varlistentry>
235                 <term>-T</term>
236                 <listitem>
237                         <para>
238                         Add timestamp to all non-command related output going to the console
239                         when running with verbose and/or logging to the console.
240                         </para>
241                 </listitem>
242         </varlistentry>
243         <varlistentry>
244                 <term>-U <replaceable class="parameter">user</replaceable></term>
245                 <listitem>
246                         <para>
247                         Run as user <replaceable>user</replaceable> instead of the
248                         calling user.  <command>NOTE:</command> this requires substantial work
249                         to be sure that Asterisk's environment has permission to write
250                         the files required for its operation, including logs, its comm
251                         socket, the asterisk database, etc.
252                         </para>
253                 </listitem>
254         </varlistentry>
255         <varlistentry>
256                 <term>-v</term>
257                 <listitem>
258                         <para>
259                         Increase the level of verboseness on the console.  The more times
260                         <command>-v</command> is specified, the more verbose the output is.
261                         Specifying this option implies <command>-f</command> and will cause
262                         asterisk to no longer fork or detach from the controlling terminal.
263                         This option may also be used in conjunction with <command>-r</command>
264                         and <command>-R</command>.
265                         </para>
266                         <para>
267                         Note: This always sets the verbose level in the asterisk process,
268                         even if it is running in the background. This will affect the size
269                         of your log files.
270                         </para>
271                 </listitem>
272         </varlistentry>
273         <varlistentry>
274                 <term>-V</term>
275                 <listitem>
276                         <para>
277                         Display version information and exit immediately.
278                         </para>
279                 </listitem>
280         </varlistentry>
281         <varlistentry>
282                 <term>-x <replaceable class="parameter">command</replaceable></term>
283                 <listitem>
284                         <para>
285                         Connect to a running Asterisk process and execute a command on
286                         a command line, passing any output through to standard out and
287                         then terminating when the command execution completes.  Implies
288                         <command>-r</command> when <command>-R</command> is not explicitly
289                         supplied.
290                         </para>
291                 </listitem>
292         </varlistentry>
293         </variablelist>
294 </refsect1>
295 <refsect1>
296         <title>EXAMPLES</title>
297         <para>
298         <command>asterisk</command> - Begin Asterisk as a daemon
299         </para>
300         <para>
301         <command>asterisk -vvvgc</command> - Run on controlling terminal
302         </para>
303         <para>
304         <command>asterisk -rx "show channels"</command> - Display channels on running server
305         </para>
306 </refsect1>
307 <refsect1>
308         <title>BUGS</title>
309         <para>
310         Bug reports and feature requests may be filed at http://bugs.digium.com
311         </para>
312 </refsect1>
313 <refsect1>
314         <title>SEE ALSO</title>
315         <para>
316         *CLI&gt; <command>help</command> - Help on Asterisk CLI
317         </para>
318         <para>
319         *CLI&gt; <command>show applications</command> - Show loaded dialplan applications
320         </para>
321         <para>
322         *CLI&gt; <command>show functions</command> - Show loaded dialplan functions
323         </para>
324         <para>
325         http://www.asterisk.org - The Asterisk Home Page
326         </para>
327         <para>
328         http://www.asteriskdocs.org - The Asterisk Documentation Project
329         </para>
330         <para>
331         http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
332         </para>
333         <para>
334         http://www.digium.com/ - Asterisk sponsor and hardware supplier
335         </para>
336         <para>
337         http://www.markocam.com/ - Asterisk author's web cam
338         </para>
339 </refsect1>
340 <refsect1>
341         <title>AUTHOR</title>
342         <para>
343         <author>
344                 <firstname>Mark Spencer &lt;markster@digium.com&gt;</firstname> 
345         </author>
346         </para>
347         <para>
348         <author>
349                 <firstname>Countless other contributers, see CREDITS with distribution for more information</firstname> 
350         </author>
351         </para>
352 </refsect1>
353 </refentry>