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