Documentation Updates
[asterisk/asterisk.git] / doc / asterisk.sgml
1 <refentry>
2 <<<<<<< .working
3 <refentryinfo>
4         <date>2011-02-08</date>
5 </refentryinfo>
6 <refmeta>
7         <refentrytitle>
8                 <application>asterisk</application>
9         </refentrytitle>
10         <manvolnum>8</manvolnum>
11         <refmiscinfo>asterisk Trunk</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>-BcdfFghiImnpqRtTvVW</option></arg>
25 <arg><option>-C </option><replaceable class="parameter">file</replaceable></arg>
26 <arg><option>-e </option><replaceable class="parameter">memory</replaceable></arg>
27 <arg><option>-G </option><replaceable class="parameter">group</replaceable></arg>
28 <arg><option>-L </option><replaceable class="parameter">loadaverage</replaceable></arg>
29 <arg><option>-M </option><replaceable class="parameter">value</replaceable></arg>
30 <arg><option>-U </option><replaceable class="parameter">user</replaceable></arg>
31 <arg><option>-s </option><replaceable class="parameter">socket-file</replaceable></arg>
32 <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
33         </cmdsynopsis>
34         <cmdsynopsis>
35
36         <command>asterisk -r</command>
37         <arg><option>-v</option></arg>
38 <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
39         </cmdsynopsis>
40 </refsynopsisdiv>
41 <refsect1>
42         <refsect1info>
43                 <date>2011-02-08</date>
44         </refsect1info>
45         <title>DESCRIPTION</title>
46         <para>
47         <command>asterisk</command> is a full-featured telephony server which
48         provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
49         Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying, 
50         Conferencing, and a plethora of other telephony applications to a broad
51         range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
52         H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM
53         hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
54         ISDN BRI and many more.
55         </para>
56         <para>
57         At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
58         file and locates the rest of the configuration files from the configuration
59         in that file. The -C option specifies an alternate main configuration file.
60         Virtually all aspects of the operation of asterisk's configuration files
61         can be found in the sample configuration files.  The format for those files
62         is generally beyond the scope of this man page.
63         </para>
64         <para>
65         When running with <command>-c</command>, <command>-r</command> or <command>-R</command>
66         options, Asterisk supplies a powerful command line, including command
67         completion, which may be used to monitors its status, perform a variety
68         of administrative actions and even explore the applications that are
69         currently loaded into the system.
70         </para>
71         <para>
72         Asterisk is a trademark of Digium, Inc.
73         </para>
74 </refsect1>
75 <refsect1>
76         <title>OPTIONS</title>
77         <variablelist>
78         <varlistentry>
79                 <term>-B</term>
80                 <listitem>
81                         <para>
82                         Force the background of the terminal to be black, in order for
83                         terminal colors to show up properly.
84                         </para>
85                 </listitem>
86         </varlistentry>
87         <varlistentry>
88                 <term>-C <replaceable class="parameter">file</replaceable></term>
89                 <listitem>
90                         <para>
91                         Use <filename>file</filename> as master configuration file
92                         instead of the default, /etc/asterisk/asterisk.conf
93                         </para>
94                 </listitem>
95         </varlistentry>
96         <varlistentry>
97                 <term>-c</term>
98                 <listitem>
99                         <para>
100                         Provide a control console on the calling terminal.
101                         Specifying this option implies <command>-f</command> and will cause
102                         asterisk to no longer fork or detach from the controlling terminal.
103                         </para>
104                 </listitem>
105         </varlistentry>
106         <varlistentry>
107                 <term>-d</term>
108                 <listitem>
109                         <para>
110                         Enable extra debugging statements.
111                         </para>
112                         <para>
113                         Note: This always sets the debug level in the asterisk process,
114                         even if it is running in the background. This may affect the size
115                         of your log files, if the debug level is specified in logger.conf.
116                         </para>
117                 </listitem>
118         </varlistentry>
119         <varlistentry>
120                 <term>-e <replaceable class="parameter">memory</replaceable></term>
121                 <listitem>
122                         <para>
123                         Limit the generation of new channels when the amount of free memory has decreased to under <replaceable>memory</replaceable> megabytes.
124                         </para>
125                 </listitem>
126         </varlistentry>
127         <varlistentry>
128                 <term>-f</term>
129                 <listitem>
130                         <para>
131                         Do not fork or detach from controlling terminal.  Overrides any preceding specification of <command>-F</command> on the command line.
132                         </para>
133                 </listitem>
134         </varlistentry>
135         <varlistentry>
136                 <term>-F</term>
137                 <listitem>
138                         <para>
139                         Always fork and detach from controlling terminal.  Overrides any preceding specification of <command>-f</command> on the command line.
140                         </para>
141                 </listitem>
142         </varlistentry>
143         <varlistentry>
144                 <term>-g</term>
145                 <listitem>
146                         <para>
147                         Remove resource limit on core size, thus forcing Asterisk to dump
148                         core in the unlikely event of a segmentation fault or abort signal.
149                         <command>NOTE:</command> in some cases this may be incompatible
150                         with the <command>-U</command> or <command>-G</command> flags.
151                         </para>
152                 </listitem>
153         </varlistentry>
154         <varlistentry>
155                 <term>-G <replaceable class="parameter">group</replaceable></term>
156                 <listitem>
157                         <para>
158                         Run as group <replaceable>group</replaceable> instead of the
159                         calling group.  <command>NOTE:</command> this requires substantial work
160                         to be sure that Asterisk's environment has permission to write
161                         the files required for its operation, including logs, its comm
162                         socket, the asterisk database, etc.
163                         </para>
164                 </listitem>
165         </varlistentry>
166         <varlistentry>
167                 <term>-h</term>
168                 <listitem>
169                         <para>
170                         Provide brief summary of command line arguments and terminate.
171                         </para>
172                 </listitem>
173         </varlistentry>
174         <varlistentry>
175                 <term>-i</term>
176                 <listitem>
177                         <para>
178                         Prompt user to intialize any encrypted private keys for IAX2
179                         secure authentication during startup.
180                         </para>
181                 </listitem>
182         </varlistentry>
183         <varlistentry>
184                 <term>-I</term>
185                 <listitem>
186                         <para>
187                         Enable internal timing if DAHDI timing is available.
188                         The default behaviour is that outbound packets are phase locked
189                         to inbound packets. Enabling this switch causes them to be
190                         locked to the internal DAHDI timer instead.
191                         </para>
192                 </listitem>
193         </varlistentry>
194         <varlistentry>
195                 <term>-L <replaceable class="parameter">loadaverage</replaceable></term>
196                 <listitem>
197                         <para>
198                         Limits the maximum load average before rejecting new calls.  This can
199                         be useful to prevent a system from being brought down by terminating
200                         too many simultaneous calls.
201                         </para>
202                 </listitem>
203         </varlistentry>
204         <varlistentry>
205                 <term>-m</term>
206                 <listitem>
207                         <para>
208                         Temporarily mutes output to the console and logs.  To return to normal,
209                         use <command>logger mute</command>.
210                         </para>
211                 </listitem>
212         </varlistentry>
213         <varlistentry>
214                 <term>-M <replaceable class="parameter">value</replaceable></term>
215                 <listitem>
216                         <para>
217                         Limits the maximum number of calls to the specified value.  This can
218                         be useful to prevent a system from being brought down by terminating
219                         too many simultaneous calls.
220                         </para>
221                 </listitem>
222         </varlistentry>
223         <varlistentry>
224                 <term>-n</term>
225                 <listitem>
226                         <para>
227                         Disable ANSI colors even on terminals capable of displaying them.
228                         </para>
229                 </listitem>
230         </varlistentry>
231         <varlistentry>
232                 <term>-p</term>
233                 <listitem>
234                         <para>
235                         If supported by the operating system (and executing as root),
236                         attempt to run with realtime priority for increased performance and
237                         responsiveness within the Asterisk process, at the expense of other
238                         programs running on the same machine.
239                         </para>
240                         <para>
241                         Note: <command>astcanary</command> will run concurrently with
242                         <command>asterisk</command>. If <command>astcanary</command> stops
243                         running or is killed, <command>asterisk</command> will slow down to
244                         normal process priority, to avoid locking up the machine.
245                         </para>
246                 </listitem>
247         </varlistentry>
248         <varlistentry>
249                 <term>-q</term>
250                 <listitem>
251                         <para>
252                         Reduce default console output when running in conjunction with
253                         console mode (<command>-c</command>).
254                         </para>
255                 </listitem>
256         </varlistentry>
257         <varlistentry>
258                 <term>-r</term>
259                 <listitem>
260                         <para>
261                         Instead of running a new Asterisk process, attempt to connect
262                         to a running Asterisk process and provide a console interface
263                         for controlling it.
264                         </para>
265                 </listitem>
266         </varlistentry>
267         <varlistentry>
268                 <term>-R</term>
269                 <listitem>
270                         <para>
271                         Much like <command>-r</command>.  Instead of running a new Asterisk process, attempt to connect
272                         to a running Asterisk process and provide a console interface
273                         for controlling it. Additionally, if connection to the Asterisk 
274                         process is lost, attempt to reconnect for as long as 30 seconds.
275                         </para>
276                 </listitem>
277         </varlistentry>
278         <varlistentry>
279                 <term>-s <replaceable class="parameter">socket file name</replaceable></term>
280                 <listitem>
281                         <para>
282                         In combination with <command>-r</command>, connect directly to a specified
283                         Asterisk server socket.
284                         </para>
285                 </listitem>
286         </varlistentry>
287         <varlistentry>
288                 <term>-t</term>
289                 <listitem>
290                         <para>
291                         When recording files, write them first into a temporary holding directory, 
292                         then move them into the final location when done.
293                         </para>
294                 </listitem>
295         </varlistentry>
296         <varlistentry>
297                 <term>-T</term>
298                 <listitem>
299                         <para>
300                         Add timestamp to all non-command related output going to the console
301                         when running with verbose and/or logging to the console.
302                         </para>
303                 </listitem>
304         </varlistentry>
305         <varlistentry>
306                 <term>-U <replaceable class="parameter">user</replaceable></term>
307                 <listitem>
308                         <para>
309                         Run as user <replaceable>user</replaceable> instead of the
310                         calling user.  <command>NOTE:</command> this requires substantial work
311                         to be sure that Asterisk's environment has permission to write
312                         the files required for its operation, including logs, its comm
313                         socket, the asterisk database, etc.
314                         </para>
315                 </listitem>
316         </varlistentry>
317         <varlistentry>
318                 <term>-v</term>
319                 <listitem>
320                         <para>
321                         Increase the level of verboseness on the console.  The more times
322                         <command>-v</command> is specified, the more verbose the output is.
323                         Specifying this option implies <command>-f</command> and will cause
324                         asterisk to no longer fork or detach from the controlling terminal.
325                         This option may also be used in conjunction with <command>-r</command>
326                         and <command>-R</command>.
327                         </para>
328                         <para>
329                         Note: This always sets the verbose level in the asterisk process,
330                         even if it is running in the background. This will affect the size
331                         of your log files.
332                         </para>
333                 </listitem>
334         </varlistentry>
335         <varlistentry>
336                 <term>-V</term>
337                 <listitem>
338                         <para>
339                         Display version information and exit immediately.
340                         </para>
341                 </listitem>
342         </varlistentry>
343         <varlistentry>
344                 <term>-W</term>
345                 <listitem>
346                         <para>
347                         Display colored terminal text as if the background were white
348                         or otherwise light in color.  Normally, terminal text is displayed
349                         as if the background were black or otherwise dark in color.
350                         </para>
351                 </listitem>
352         </varlistentry>
353         <varlistentry>
354                 <term>-x <replaceable class="parameter">command</replaceable></term>
355                 <listitem>
356                         <para>
357                         Connect to a running Asterisk process and execute a command on
358                         a command line, passing any output through to standard out and
359                         then terminating when the command execution completes.  Implies
360                         <command>-r</command> when <command>-R</command> is not explicitly
361                         supplied.
362                         </para>
363                 </listitem>
364         </varlistentry>
365         <varlistentry>
366                 <term>-X</term>
367                 <listitem>
368                         <para>
369                         Enables executing of includes via <command>#exec</command> directive.
370                         This can be useful if You want to do <command>#exec</command> inside
371                         <filename>asterisk.conf</filename>
372                         </para>
373                 </listitem>
374         </varlistentry>
375         </variablelist>
376 </refsect1>
377 <refsect1>
378         <title>EXAMPLES</title>
379         <para>
380         <command>asterisk</command> - Begin Asterisk as a daemon
381         </para>
382         <para>
383         <command>asterisk -vvvgc</command> - Run on controlling terminal
384         </para>
385         <para>
386         <command>asterisk -rx "core show channels"</command> - Display channels on running server
387         </para>
388 </refsect1>
389 <refsect1>
390         <title>BUGS</title>
391         <para>
392         Bug reports and feature requests may be filed at https://issues.asterisk.org
393         </para>
394 </refsect1>
395 <refsect1>
396         <title>SEE ALSO</title>
397         <para>
398         *CLI&gt; <command>help</command> - Help on Asterisk CLI
399         </para>
400         <para>
401         *CLI&gt; <command>core show applications</command> - Show loaded dialplan applications
402         </para>
403         <para>
404         *CLI&gt; <command>core show functions</command> - Show loaded dialplan functions
405         </para>
406         <para>
407         *CLI&gt; <command>dialplan show</command> - Show current dialplan
408         </para>
409         <para>
410         http://www.asterisk.org - The Asterisk Home Page
411         </para>
412         <para>
413         http://www.asteriskdocs.org - The Asterisk Documentation Project
414         </para>
415         <para>
416         http://wiki.asterisk.org - The Asterisk Wiki
417         </para>
418         <para>
419         http://www.digium.com/ - Asterisk sponsor and hardware supplier
420         </para>
421 </refsect1>
422 <refsect1>
423         <title>AUTHOR</title>
424         <para>
425         <author>
426                 <firstname>Mark Spencer &lt;markster@digium.com&gt;</firstname> 
427         </author>
428         </para>
429         <para>
430         <author>
431                 <firstname>Countless other contributors, see CREDITS with distribution for more information.</firstname> 
432         </author>
433         </para>
434 </refsect1>
435 =======
436  <refentryinfo>
437   <date>2011-02-08</date>
438  </refentryinfo>
439  <refmeta>
440   <refentrytitle>
441    <application>asterisk</application>
442   </refentrytitle>
443   <manvolnum>8</manvolnum>
444   <refmiscinfo>asterisk 1.8</refmiscinfo>
445  </refmeta>
446  <refnamediv>
447   <refname>
448    <application>asterisk</application>
449   </refname>
450   <refpurpose>
451    All-purpose telephony server.
452   </refpurpose>
453  </refnamediv>
454  <refsynopsisdiv>
455   <cmdsynopsis>
456    <command>asterisk</command>
457    <arg><option>-BcdfFghiImnpqRtTvVW</option></arg>
458    <arg><option>-C </option><replaceable class="parameter">file</replaceable></arg>
459    <arg><option>-e </option><replaceable class="parameter">memory</replaceable></arg>
460    <arg><option>-G </option><replaceable class="parameter">group</replaceable></arg>
461    <arg><option>-L </option><replaceable class="parameter">loadaverage</replaceable></arg>
462    <arg><option>-M </option><replaceable class="parameter">value</replaceable></arg>
463    <arg><option>-U </option><replaceable class="parameter">user</replaceable></arg>
464    <arg><option>-s </option><replaceable class="parameter">socket-file</replaceable></arg>
465   </cmdsynopsis>
466   <cmdsynopsis>
467    <command>asterisk -r</command>
468    <arg><option>-v</option></arg>
469    <arg><option>-d</option></arg>
470    <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
471   </cmdsynopsis>
472   <cmdsynopsis>
473    <command>asterisk -R</command>
474    <arg><option>-v</option></arg>
475    <arg><option>-d</option></arg>
476    <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
477   </cmdsynopsis>
478  </refsynopsisdiv>
479  <refsect1>
480   <refsect1info>
481    <date>2011-02-08</date>
482   </refsect1info>
483   <title>DESCRIPTION</title>
484   <para>
485    <command>asterisk</command> is a full-featured telephony server which
486    provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
487    Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying, 
488    Conferencing, and a plethora of other telephony applications to a broad
489    range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
490    H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM
491    hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
492    ISDN BRI and many more.
493   </para>
494   <para>
495    At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
496    file and locates the rest of the configuration files from the configuration
497    in that file. The -C option specifies an alternate main configuration file.
498    Virtually all aspects of the operation of asterisk's configuration files
499    can be found in the sample configuration files.  The format for those files
500    is generally beyond the scope of this man page.
501   </para>
502   <para>
503    When running with <command>-c</command>, <command>-r</command> or <command>-R</command>
504    options, Asterisk supplies a powerful command line, including command
505    completion, which may be used to monitors its status, perform a variety
506    of administrative actions and even explore the applications that are
507    currently loaded into the system.
508   </para>
509   <para>
510    Asterisk is a trademark of Digium, Inc.
511   </para>
512  </refsect1>
513  <refsect1>
514   <title>OPTIONS</title>
515   <para>
516    Running Asterisk starts the asterisk daemon (optionally running it
517    in the foreground). However running it with <option>-r</option> or
518    <option>-R</option> connects to an existing Asterisk instance through
519    a remote console.
520   </para>
521   <variablelist>
522    <varlistentry>
523     <term>-B</term>
524     <listitem>
525      <para>
526       Force the background of the terminal to be black, in order for
527       terminal colors to show up properly. Equivalent to
528       <option>forceblackbackground = yes</option> in
529       <filename>asterisk.conf</filename>. See also
530       <option>-n</option> and <option>-W</option>.
531      </para>
532     </listitem>
533    </varlistentry>
534    <varlistentry>
535     <term>-C <replaceable class="parameter">file</replaceable></term>
536     <listitem>
537      <para>
538       Use <filename>file</filename> as master configuration file
539       instead of the default, /etc/asterisk/asterisk.conf
540      </para>
541     </listitem>
542    </varlistentry>
543    <varlistentry>
544     <term>-c</term>
545     <listitem>
546      <para>
547       Provide a control console on the calling terminal. The
548       console is similar to the remote console provided by
549       <option>-r</option>. Specifying this option implies 
550       <command>-f</command> and will cause asterisk to no longer 
551       fork or detach from the controlling terminal. Equivalent 
552       to <option>console = yes</option> in <filename>asterisk.conf</filename>.
553      </para>
554     </listitem>
555    </varlistentry>
556    <varlistentry>
557     <term>-d</term>
558     <listitem>
559      <para>
560       Enable extra debugging statements. This parameter may be used several
561       times, and each increases the debug level.  Equivalent to <option>debug = <replaceable>num</replaceable></option>
562       in <filename>asterisk.conf</filename> to explicitly set the initian debug
563       level to <replaceable>num</replaceable>. When given at startup, this
564       option also implies <option>-f</option> (no forking). However when
565       connecting to an existing Asterisk instance (<option>-r</option> or
566       <option>-R</option>), it may only increase the debug level.
567      </para>
568     </listitem>
569    </varlistentry>
570    <varlistentry>
571     <term>-e <replaceable class="parameter">memory</replaceable></term>
572     <listitem>
573      <para>
574       Limit the generation of new channels when the amount of free memory 
575       has decreased to under <replaceable>memory</replaceable> megabytes.
576       Equivalent to <option>minmemfree = <replaceable>memory</replaceable></option> in
577       <filename>asterisk.conf</filename>.
578      </para>
579     </listitem>
580    </varlistentry>
581    <varlistentry>
582     <term>-f</term>
583     <listitem>
584      <para>
585       Do not fork or detach from controlling terminal.  Overrides any
586       preceding specification of <command>-F</command> on the command line.
587       Equivalent to <option>nofork = yes</option> in <filename>asterisk.conf</filename>.
588       See also <option>-c</option>.
589      </para>
590     </listitem>
591    </varlistentry>
592    <varlistentry>
593     <term>-F</term>
594     <listitem>
595      <para>
596       Always fork and detach from controlling terminal.  Overrides any
597       preceding specification of <command>-f</command> on the command line.
598       May also be used to prevent <option>-d</option> and <option>-v</option> to imply
599       no forking. Equivalent to <option>alwaysfork = yes</option> in <filename>asterisk.conf</filename>.
600      </para>
601     </listitem>
602    </varlistentry>
603    <varlistentry>
604     <term>-g</term>
605     <listitem>
606      <para>
607       Remove resource limit on core size, thus forcing Asterisk to dump
608       core in the unlikely event of a segmentation fault or abort signal.
609       <command>NOTE:</command> in some cases this may be incompatible
610       with the <command>-U</command> or <command>-G</command> flags.
611      </para>
612     </listitem>
613    </varlistentry>
614    <varlistentry>
615     <term>-G <replaceable class="parameter">group</replaceable></term>
616     <listitem>
617      <para>
618       Run as group <replaceable>group</replaceable> instead of the
619       calling group.  <command>NOTE:</command> this requires substantial work
620       to be sure that Asterisk's environment has permission to write
621       the files required for its operation, including logs, its comm
622       socket, the asterisk database, etc.
623      </para>
624     </listitem>
625    </varlistentry>
626    <varlistentry>
627     <term>-h</term>
628     <listitem>
629      <para>
630       Provide brief summary of command line arguments and terminate.
631      </para>
632     </listitem>
633    </varlistentry>
634    <varlistentry>
635     <term>-i</term>
636     <listitem>
637      <para>
638       Prompt user to intialize any encrypted private keys for IAX2
639       secure authentication during startup.
640      </para>
641     </listitem>
642    </varlistentry>
643    <varlistentry>
644     <term>-I</term>
645     <listitem>
646      <para>
647       Enable internal timing if DAHDI timing is available.
648       The default behaviour is that outbound packets are phase locked
649       to inbound packets. Enabling this switch causes them to be
650       locked to the internal DAHDI timer instead.
651      </para>
652     </listitem>
653    </varlistentry>
654    <varlistentry>
655     <term>-L <replaceable class="parameter">loadaverage</replaceable></term>
656     <listitem>
657      <para>
658       Limits the maximum load average before rejecting new calls.  This can
659       be useful to prevent a system from being brought down by terminating
660       too many simultaneous calls.
661      </para>
662     </listitem>
663    </varlistentry>
664    <varlistentry>
665     <term>-m</term>
666     <listitem>
667      <para>
668       Temporarily mutes output to the console and logs.  To return to normal,
669       use <command>logger mute</command>.
670      </para>
671     </listitem>
672    </varlistentry>
673    <varlistentry>
674     <term>-M <replaceable class="parameter">value</replaceable></term>
675     <listitem>
676      <para>
677       Limits the maximum number of calls to the specified value.  This can
678       be useful to prevent a system from being brought down by terminating
679       too many simultaneous calls.
680      </para>
681     </listitem>
682    </varlistentry>
683    <varlistentry>
684     <term>-n</term>
685     <listitem>
686      <para>
687       Disable ANSI colors even on terminals capable of displaying them.
688      </para>
689     </listitem>
690    </varlistentry>
691    <varlistentry>
692     <term>-p</term>
693     <listitem>
694      <para>
695       If supported by the operating system (and executing as root),
696       attempt to run with realtime priority for increased performance and
697       responsiveness within the Asterisk process, at the expense of other
698       programs running on the same machine.
699      </para>
700      <para>
701       Note: <command>astcanary</command> will run concurrently with
702       <command>asterisk</command>. If <command>astcanary</command> stops
703       running or is killed, <command>asterisk</command> will slow down to
704       normal process priority, to avoid locking up the machine.
705      </para>
706     </listitem>
707    </varlistentry>
708    <varlistentry>
709     <term>-q</term>
710     <listitem>
711      <para>
712       Reduce default console output when running in conjunction with
713       console mode (<command>-c</command>).
714      </para>
715     </listitem>
716    </varlistentry>
717    <varlistentry>
718     <term>-r</term>
719     <listitem>
720      <para>
721       Instead of running a new Asterisk process, attempt to connect
722       to a running Asterisk process and provide a console interface
723       for controlling it.
724      </para>
725     </listitem>
726    </varlistentry>
727    <varlistentry>
728     <term>-R</term>
729     <listitem>
730      <para>
731       Much like <command>-r</command>.  Instead of running a new Asterisk process, attempt to connect
732       to a running Asterisk process and provide a console interface
733       for controlling it. Additionally, if connection to the Asterisk 
734       process is lost, attempt to reconnect for as long as 30 seconds.
735      </para>
736     </listitem>
737    </varlistentry>
738    <varlistentry>
739     <term>-s <replaceable class="parameter">socket file name</replaceable></term>
740     <listitem>
741      <para>
742       In combination with <command>-r</command>, connect directly to a specified
743       Asterisk server socket.
744      </para>
745     </listitem>
746    </varlistentry>
747    <varlistentry>
748     <term>-t</term>
749     <listitem>
750      <para>
751       When recording files, write them first into a temporary holding directory, 
752       then move them into the final location when done.
753      </para>
754     </listitem>
755    </varlistentry>
756    <varlistentry>
757     <term>-T</term>
758     <listitem>
759      <para>
760       Add timestamp to all non-command related output going to the console
761       when running with verbose and/or logging to the console.
762      </para>
763     </listitem>
764    </varlistentry>
765    <varlistentry>
766     <term>-U <replaceable class="parameter">user</replaceable></term>
767     <listitem>
768      <para>
769       Run as user <replaceable>user</replaceable> instead of the
770       calling user.  <command>NOTE:</command> this requires substantial work
771       to be sure that Asterisk's environment has permission to write
772       the files required for its operation, including logs, its comm
773       socket, the asterisk database, etc.
774      </para>
775     </listitem>
776    </varlistentry>
777    <varlistentry>
778     <term>-v</term>
779     <listitem>
780      <para>
781       Increase the level of verboseness on the console.  The more times
782       <command>-v</command> is specified, the more verbose the output is.
783       Specifying this option implies <command>-f</command> and will cause
784       asterisk to no longer fork or detach from the controlling terminal.
785       This option may also be used in conjunction with <command>-r</command>
786       and <command>-R</command>.
787      </para>
788      <para>
789       Note: This always sets the verbose level in the asterisk process,
790       even if it is running in the background. This will affect the size
791       of your log files.
792      </para>
793     </listitem>
794    </varlistentry>
795    <varlistentry>
796     <term>-V</term>
797     <listitem>
798      <para>
799       Display version information and exit immediately.
800      </para>
801     </listitem>
802    </varlistentry>
803    <varlistentry>
804     <term>-W</term>
805     <listitem>
806      <para>
807       Display colored terminal text as if the background were white
808       or otherwise light in color.  Normally, terminal text is displayed
809       as if the background were black or otherwise dark in color.
810      </para>
811     </listitem>
812    </varlistentry>
813    <varlistentry>
814     <term>-x <replaceable class="parameter">command</replaceable></term>
815     <listitem>
816      <para>
817       Connect to a running Asterisk process and execute a command on
818       a command line, passing any output through to standard out and
819       then terminating when the command execution completes.  Implies
820       <command>-r</command> when <command>-R</command> is not explicitly
821       supplied.
822      </para>
823     </listitem>
824    </varlistentry>
825    <varlistentry>
826     <term>-X</term>
827     <listitem>
828      <para>
829       Enables executing of includes via <command>#exec</command> directive.
830       This can be useful if You want to do <command>#exec</command> inside
831       <filename>asterisk.conf</filename>
832      </para>
833     </listitem>
834    </varlistentry>
835   </variablelist>
836  </refsect1>
837  <refsect1>
838   <title>EXAMPLES</title>
839   <para>
840    <command>asterisk</command> - Begin Asterisk as a daemon
841   </para>
842   <para>
843    <command>asterisk -vvvgc</command> - Run on controlling terminal
844   </para>
845   <para>
846    <command>asterisk -rx "core show channels"</command> - Display channels on running server
847   </para>
848  </refsect1>
849  <refsect1>
850   <title>BUGS</title>
851   <para>
852   Bug reports and feature requests may be filed at https://issues.asterisk.org
853   </para>
854  </refsect1>
855  <refsect1>
856   <title>SEE ALSO</title>
857   <para>
858    http://www.asterisk.org - The Asterisk Home Page
859   </para>
860   <para>
861    http://www.asteriskdocs.org - The Asterisk Documentation Project
862   </para>
863   <para>
864    http://wiki.asterisk.org - The Asterisk Wiki
865   </para>
866   <para>
867    http://www.digium.com/ - Asterisk is sponsored by Digium
868   </para>
869  </refsect1>
870  <refsect1>
871   <title>AUTHOR</title>
872   <para>
873    <author>
874     <firstname>Mark Spencer &lt;markster@digium.com&gt;</firstname> 
875    </author>
876   </para>
877   <para>
878    <author>
879     <firstname>Countless other contributors, see CREDITS with distribution for more information.</firstname> 
880    </author>
881   </para>
882  </refsect1>
883 >>>>>>> .merge-right.r306999
884 </refentry>