kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-05 04:11:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged revisions 331139 via svnmerge from

Browse Source 
https://origsvn.digium.com/svn/asterisk/branches/10

................
  r331139 | qwell | 2011-08-09 10:50:07 -0500 (Tue, 09 Aug 2011) | 19 lines
  
  Merged revisions 306999 via svnmerge from 
  https://origsvn.digium.com/svn/asterisk/branches/1.8
  
  ........
    r306999 | lathama | 2011-02-08 14:22:35 -0600 (Tue, 08 Feb 2011) | 12 lines
    
    Documentation Updates
    
    Note default polling setting in voicemail.conf
    Add missing config to asterisk.conf
    Update manpage
    
    (issue #16505)
    Reported by: tzafrir
    Patches: 
          asterisk_sgml_fixes_demo.diff uploaded by tzafrir (license 46)
    Tested by: lathama, tzafrir
  ........
................


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@331141 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Jason Parker
2011-08-09 15:53:26 +00:00
parent 19c8278815
commit 873962f772
4 changed files with 716 additions and 667 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
configs/asterisk.conf.sample
View File

@@ -61,6 +61,10 @@ astlogdir => /var/log/asterisk
;rungroup = asterisk ; The group to run as. ;rungroup = asterisk ; The group to run as.
;lightbackground = yes ; If your terminal is set for a light-colored ;lightbackground = yes ; If your terminal is set for a light-colored
; background. ; background.
;forceblackbackground = yes ; Force the background of the terminal to be
; black, in order for terminal colors to show
; up properly.
;defaultlanguage = en ; Default language
documentation_language = en_US ; Set the language you want documentation documentation_language = en_US ; Set the language you want documentation
; displayed in. Value is in the same format as ; displayed in. Value is in the same format as
; locale names. ; locale names.

2
configs/voicemail.conf.sample
View File

@@ -181,7 +181,7 @@ pagerdateformat=%A, %B %d, %Y at %r
; ; Examples of situations that would require this option are ; ; Examples of situations that would require this option are
; ; web interfaces to voicemail or an email client in the case ; ; web interfaces to voicemail or an email client in the case
; ; of using IMAP storage. ; ; of using IMAP storage.
; ; ; Default: no
;pollfreq=30 ; If the "pollmailboxes" option is enabled, this option ;pollfreq=30 ; If the "pollmailboxes" option is enabled, this option
; ; sets the polling frequency. The default is once every ; ; sets the polling frequency. The default is once every
; ; 30 seconds. ; ; 30 seconds.

498
doc/asterisk.8
View File

@@ -1,234 +1,264 @@
'\" -*- coding: us-ascii -*- .TH " \fBasterisk\fP " "8"
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]] .SH "NAME"
.de URL \fBasterisk\fP \(em All-purpose telephony server.
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac .SH "SYNOPSIS"
.TH &#10;&#9;&#9;asterisk&#10;&#9; 8 2010-08-03 "asterisk 1.6" ""
.SH NAME .PP
asterisk \fBasterisk\fR \fB-BcdfFghiImnpqRtTvVW\fP \fB-C \fP\fIfile\fR \fB-e \fP\fImemory\fR \fB-G \fP\fIgroup\fR \fB-L \fP\fIloadaverage\fR \fB-M \fP\fIvalue\fR \fB-U \fP\fIuser\fR \fB-s \fP\fIsocket-file\fR
\- All-purpose telephony server.
.SH SYNOPSIS .PP
'nh \fBasterisk \-r\fR \fB-v\fP \fB-d\fP \fB-x \fP\fIcommand\fR
.fi
.ad l .PP
\fBasterisk\fR \kx \fBasterisk \-R\fR \fB-v\fP \fB-d\fP \fB-x \fP\fIcommand\fR
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[\fB-BcdfFghiImnpqRtTvVW\fR] [\fB-C \fR\fIfile\fR] [\fB-e \fR\fImemory\fR] [\fB-G \fR\fIgroup\fR] [\fB-L \fR\fIloadaverage\fR] [\fB-M \fR\fIvalue\fR] [\fB-U \fR\fIuser\fR] [\fB-s \fR\fIsocket-file\fR] [\fB-x \fR\fIcommand\fR] .SH "DESCRIPTION"
'in \n(.iu-\nxu 2011-02-08;
.ad b .PP
'hy \fBasterisk\fR is a full-featured telephony server which
'nh provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
.fi Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying,
.ad l Conferencing, and a plethora of other telephony applications to a broad
\fBasterisk -r\fR \kx range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM
'in \n(.iu+\nxu hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
[\fB-v\fR] [\fB-x \fR\fIcommand\fR] ISDN BRI and many more.
'in \n(.iu-\nxu
.ad b .PP
'hy At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
.SH DESCRIPTION file and locates the rest of the configuration files from the configuration
\fBasterisk\fR is a full-featured telephony server which in that file. The \-C option specifies an alternate main configuration file.
provides Private Branch eXchange (PBX), Interactive Voice Response (IVR), Virtually all aspects of the operation of asterisk's configuration files
Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying, can be found in the sample configuration files. The format for those files
Conferencing, and a plethora of other telephony applications to a broad is generally beyond the scope of this man page.
range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM .PP
hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart, When running with \fB-c\fR, \fB-r\fR or \fB-R\fR options, Asterisk supplies a powerful command line, including command
ISDN BRI and many more. completion, which may be used to monitors its status, perform a variety
.PP of administrative actions and even explore the applications that are
At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration currently loaded into the system.
file and locates the rest of the configuration files from the configuration
in that file. The -C option specifies an alternate main configuration file. .PP
Virtually all aspects of the operation of asterisk's configuration files Asterisk is a trademark of Digium, Inc.
can be found in the sample configuration files. The format for those files
is generally beyond the scope of this man page.
.PP .SH "OPTIONS"
When running with \fB-c\fR, \fB-r\fR or \fB-R\fR
options, Asterisk supplies a powerful command line, including command .PP
completion, which may be used to monitors its status, perform a variety Running Asterisk starts the asterisk daemon (optionally running it
of administrative actions and even explore the applications that are in the foreground). However running it with \fB-r\fP or
currently loaded into the system. \fB-R\fP connects to an existing Asterisk instance through
.PP a remote console.
Asterisk is a trademark of Digium, Inc.
.SH OPTIONS .IP "\-B" 10
.TP Force the background of the terminal to be black, in order for
-B terminal colors to show up properly. Equivalent to
Force the background of the terminal to be black, in order for \fBforceblackbackground = yes\fP in
terminal colors to show up properly. \fBasterisk.conf\fP. See also
.TP \fB-n\fP and \fB-W\fP.
-C \fIfile\fR
Use \*(T<\fIfile\fR\*(T> as master configuration file .IP "\-C \fIfile\fR" 10
instead of the default, /etc/asterisk/asterisk.conf Use \fBfile\fP as master configuration file
.TP instead of the default, /etc/asterisk/asterisk.conf
-c
Provide a control console on the calling terminal. .IP "\-c" 10
Specifying this option implies \fB-f\fR and will cause Provide a control console on the calling terminal. The
asterisk to no longer fork or detach from the controlling terminal. console is similar to the remote console provided by
.TP \fB-r\fP. Specifying this option implies
-d \fB-f\fR and will cause asterisk to no longer
Enable extra debugging statements. fork or detach from the controlling terminal. Equivalent
to \fBconsole = yes\fP in \fBasterisk.conf\fP.
Note: This always sets the debug level in the asterisk process,
even if it is running in the background. This may affect the size .IP "\-d" 10
of your log files, if the debug level is specified in logger.conf. Enable extra debugging statements. This parameter may be used several
.TP times, and each increases the debug level. Equivalent to \fBdebug = \fInum\fR\fP in \fBasterisk.conf\fP to explicitly set the initian debug
-e \fImemory\fR level to \fInum\fR. When given at startup, this
Limit the generation of new channels when the amount of free memory has decreased to under \fImemory\fR megabytes. option also implies \fB-f\fP (no forking). However when
.TP connecting to an existing Asterisk instance (\fB-r\fP or
-f \fB-R\fP), it may only increase the debug level.
Do not fork or detach from controlling terminal. Overrides any preceding specification of \fB-F\fR on the command line.
.TP .IP "\-e \fImemory\fR" 10
-F Limit the generation of new channels when the amount of free memory
Always fork and detach from controlling terminal. Overrides any preceding specification of \fB-f\fR on the command line. has decreased to under \fImemory\fR megabytes.
.TP Equivalent to \fBminmemfree = \fImemory\fR\fP in
-g \fBasterisk.conf\fP.
Remove resource limit on core size, thus forcing Asterisk to dump
core in the unlikely event of a segmentation fault or abort signal. .IP "\-f" 10
\fBNOTE:\fR in some cases this may be incompatible Do not fork or detach from controlling terminal. Overrides any
with the \fB-U\fR or \fB-G\fR flags. preceding specification of \fB-F\fR on the command line.
.TP Equivalent to \fBnofork = yes\fP in \fBasterisk.conf\fP.
-G \fIgroup\fR See also \fB-c\fP.
Run as group \fIgroup\fR instead of the
calling group. \fBNOTE:\fR this requires substantial work .IP "\-F" 10
to be sure that Asterisk's environment has permission to write Always fork and detach from controlling terminal. Overrides any
the files required for its operation, including logs, its comm preceding specification of \fB-f\fR on the command line.
socket, the asterisk database, etc. May also be used to prevent \fB-d\fP and \fB-v\fP to imply
.TP no forking. Equivalent to \fBalwaysfork = yes\fP in \fBasterisk.conf\fP.
-h
Provide brief summary of command line arguments and terminate. .IP "\-g" 10
.TP Remove resource limit on core size, thus forcing Asterisk to dump
-i core in the unlikely event of a segmentation fault or abort signal.
Prompt user to intialize any encrypted private keys for IAX2 \fBNOTE:\fR in some cases this may be incompatible
secure authentication during startup. with the \fB-U\fR or \fB-G\fR flags.
.TP
-I .IP "\-G \fIgroup\fR" 10
Enable internal timing if DAHDI timing is available. Run as group \fIgroup\fR instead of the
The default behaviour is that outbound packets are phase locked calling group. \fBNOTE:\fR this requires substantial work
to inbound packets. Enabling this switch causes them to be to be sure that Asterisk's environment has permission to write
locked to the internal DAHDI timer instead. the files required for its operation, including logs, its comm
.TP socket, the asterisk database, etc.
-L \fIloadaverage\fR
Limits the maximum load average before rejecting new calls. This can .IP "\-h" 10
be useful to prevent a system from being brought down by terminating Provide brief summary of command line arguments and terminate.
too many simultaneous calls.
.TP .IP "\-i" 10
-m Prompt user to intialize any encrypted private keys for IAX2
Temporarily mutes output to the console and logs. To return to normal, secure authentication during startup.
use \fBlogger mute\fR.
.TP .IP "\-I" 10
-M \fIvalue\fR Enable internal timing if DAHDI timing is available.
Limits the maximum number of calls to the specified value. This can The default behaviour is that outbound packets are phase locked
be useful to prevent a system from being brought down by terminating to inbound packets. Enabling this switch causes them to be
too many simultaneous calls. locked to the internal DAHDI timer instead.
.TP
-n .IP "\-L \fIloadaverage\fR" 10
Disable ANSI colors even on terminals capable of displaying them. Limits the maximum load average before rejecting new calls. This can
.TP be useful to prevent a system from being brought down by terminating
-p too many simultaneous calls.
If supported by the operating system (and executing as root),
attempt to run with realtime priority for increased performance and .IP "\-m" 10
responsiveness within the Asterisk process, at the expense of other Temporarily mutes output to the console and logs. To return to normal,
programs running on the same machine. use \fBlogger mute\fR.
Note: \fBastcanary\fR will run concurrently with .IP "\-M \fIvalue\fR" 10
\fBasterisk\fR. If \fBastcanary\fR stops Limits the maximum number of calls to the specified value. This can
running or is killed, \fBasterisk\fR will slow down to be useful to prevent a system from being brought down by terminating
normal process priority, to avoid locking up the machine. too many simultaneous calls.
.TP
-q .IP "\-n" 10
Reduce default console output when running in conjunction with Disable ANSI colors even on terminals capable of displaying them.
console mode (\fB-c\fR).
.TP .IP "\-p" 10
-r If supported by the operating system (and executing as root),
Instead of running a new Asterisk process, attempt to connect attempt to run with realtime priority for increased performance and
to a running Asterisk process and provide a console interface responsiveness within the Asterisk process, at the expense of other
for controlling it. programs running on the same machine.
.TP
-R .IP "" 10
Much like \fB-r\fR. Instead of running a new Asterisk process, attempt to connect Note: \fBastcanary\fR will run concurrently with
to a running Asterisk process and provide a console interface \fBasterisk\fR. If \fBastcanary\fR stops
for controlling it. Additionally, if connection to the Asterisk running or is killed, \fBasterisk\fR will slow down to
process is lost, attempt to reconnect for as long as 30 seconds. normal process priority, to avoid locking up the machine.
.TP
-s \fIsocket file name\fR .IP "\-q" 10
In combination with \fB-r\fR, connect directly to a specified Reduce default console output when running in conjunction with
Asterisk server socket. console mode (\fB-c\fR).
.TP
-t .IP "\-r" 10
When recording files, write them first into a temporary holding directory, Instead of running a new Asterisk process, attempt to connect
then move them into the final location when done. to a running Asterisk process and provide a console interface
.TP for controlling it.
-T
Add timestamp to all non-command related output going to the console .IP "\-R" 10
when running with verbose and/or logging to the console. Much like \fB-r\fR. Instead of running a new Asterisk process, attempt to connect
.TP to a running Asterisk process and provide a console interface
-U \fIuser\fR for controlling it. Additionally, if connection to the Asterisk
Run as user \fIuser\fR instead of the process is lost, attempt to reconnect for as long as 30 seconds.
calling user. \fBNOTE:\fR this requires substantial work
to be sure that Asterisk's environment has permission to write .IP "\-s \fIsocket file name\fR" 10
the files required for its operation, including logs, its comm In combination with \fB-r\fR, connect directly to a specified
socket, the asterisk database, etc. Asterisk server socket.
.TP
-v .IP "\-t" 10
Increase the level of verboseness on the console. The more times When recording files, write them first into a temporary holding directory,
\fB-v\fR is specified, the more verbose the output is. then move them into the final location when done.
Specifying this option implies \fB-f\fR and will cause
asterisk to no longer fork or detach from the controlling terminal. .IP "\-T" 10
This option may also be used in conjunction with \fB-r\fR Add timestamp to all non-command related output going to the console
and \fB-R\fR. when running with verbose and/or logging to the console.
Note: This always sets the verbose level in the asterisk process, .IP "\-U \fIuser\fR" 10
even if it is running in the background. This will affect the size Run as user \fIuser\fR instead of the
of your log files. calling user. \fBNOTE:\fR this requires substantial work
.TP to be sure that Asterisk's environment has permission to write
-V the files required for its operation, including logs, its comm
Display version information and exit immediately. socket, the asterisk database, etc.
.TP
-W .IP "\-v" 10
Display colored terminal text as if the background were white Increase the level of verboseness on the console. The more times
or otherwise light in color. Normally, terminal text is displayed \fB-v\fR is specified, the more verbose the output is.
as if the background were black or otherwise dark in color. Specifying this option implies \fB-f\fR and will cause
.TP asterisk to no longer fork or detach from the controlling terminal.
-x \fIcommand\fR This option may also be used in conjunction with \fB-r\fR and \fB-R\fR.
Connect to a running Asterisk process and execute a command on
a command line, passing any output through to standard out and .IP "" 10
then terminating when the command execution completes. Implies Note: This always sets the verbose level in the asterisk process,
\fB-r\fR when \fB-R\fR is not explicitly even if it is running in the background. This will affect the size
supplied. of your log files.
.TP
-X .IP "\-V" 10
Enables executing of includes via \fB#exec\fR directive. Display version information and exit immediately.
This can be useful if You want to do \fB#exec\fR inside
\*(T<\fIasterisk.conf\fR\*(T> .IP "\-W" 10
.SH EXAMPLES Display colored terminal text as if the background were white
\fBasterisk\fR - Begin Asterisk as a daemon or otherwise light in color. Normally, terminal text is displayed
.PP as if the background were black or otherwise dark in color.
\fBasterisk -vvvgc\fR - Run on controlling terminal
.PP .IP "\-x \fIcommand\fR" 10
\fBasterisk -rx "core show channels"\fR - Display channels on running server Connect to a running Asterisk process and execute a command on
.SH BUGS a command line, passing any output through to standard out and
Bug reports and feature requests may be filed at https://issues.asterisk.org then terminating when the command execution completes. Implies
.SH "SEE ALSO" \fB-r\fR when \fB-R\fR is not explicitly
*CLI> \fBhelp\fR - Help on Asterisk CLI supplied.
.PP
*CLI> \fBcore show applications\fR - Show loaded dialplan applications .IP "\-X" 10
.PP Enables executing of includes via \fB#exec\fR directive.
*CLI> \fBcore show functions\fR - Show loaded dialplan functions This can be useful if You want to do \fB#exec\fR inside
.PP \fBasterisk.conf\fP
*CLI> \fBdialplan show\fR - Show current dialplan
.PP .SH "EXAMPLES"
http://www.asterisk.org - The Asterisk Home Page
.PP .PP
http://www.asteriskdocs.org - The Asterisk Documentation Project \fBasterisk\fR \- Begin Asterisk as a daemon
.PP
http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki .PP
.PP \fBasterisk \-vvvgc\fR \- Run on controlling terminal
http://www.digium.com/ - Asterisk sponsor and hardware supplier
.SH AUTHOR .PP
Mark Spencer <markster@digium.com> \fBasterisk \-rx "core show channels"\fR \- Display channels on running server
.PP
Countless other contributors, see CREDITS with distribution for more information.
.SH "BUGS"
.PP
Bug reports and feature requests may be filed at https://issues.asterisk.org
.SH "SEE ALSO"
.PP
http://www.asterisk.org \- The Asterisk Home Page
.PP
http://www.asteriskdocs.org \- The Asterisk Documentation Project
.PP
http://wiki.asterisk.org \- The Asterisk Wiki
.PP
http://www.digium.com/ \- Asterisk is sponsored by Digium
.SH "AUTHOR"
.PP
Mark Spencer markster@digium.com
.PP
Countless other contributors, see CREDITS with distribution for more information.
.\" created by instant / docbook-to-man, Tue 08 Feb 2011, 12:17

879
doc/asterisk.sgml
View File

@@ -1,434 +1,449 @@
<refentry> <refentry>
<refentryinfo> <refentryinfo>
<date>2011-02-08</date> <date>2011-02-08</date>
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
<refentrytitle> <refentrytitle>
<application>asterisk</application> <application>asterisk</application>
</refentrytitle> </refentrytitle>
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
<refmiscinfo>asterisk Trunk</refmiscinfo> <refmiscinfo>asterisk Trunk</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname> <refname>
<application>asterisk</application> <application>asterisk</application>
</refname> </refname>
<refpurpose> <refpurpose>
All-purpose telephony server. All-purpose telephony server.
</refpurpose> </refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>asterisk</command> <command>asterisk</command>
<arg><option>-BcdfFghiImnpqRtTvVW</option></arg> <arg><option>-BcdfFghiImnpqRtTvVW</option></arg>
<arg><option>-C </option><replaceable class="parameter">file</replaceable></arg> <arg><option>-C </option><replaceable class="parameter">file</replaceable></arg>
<arg><option>-e </option><replaceable class="parameter">memory</replaceable></arg> <arg><option>-e </option><replaceable class="parameter">memory</replaceable></arg>
<arg><option>-G </option><replaceable class="parameter">group</replaceable></arg> <arg><option>-G </option><replaceable class="parameter">group</replaceable></arg>
<arg><option>-L </option><replaceable class="parameter">loadaverage</replaceable></arg> <arg><option>-L </option><replaceable class="parameter">loadaverage</replaceable></arg>
<arg><option>-M </option><replaceable class="parameter">value</replaceable></arg> <arg><option>-M </option><replaceable class="parameter">value</replaceable></arg>
<arg><option>-U </option><replaceable class="parameter">user</replaceable></arg> <arg><option>-U </option><replaceable class="parameter">user</replaceable></arg>
<arg><option>-s </option><replaceable class="parameter">socket-file</replaceable></arg> <arg><option>-s </option><replaceable class="parameter">socket-file</replaceable></arg>
<arg><option>-x </option><replaceable class="parameter">command</replaceable></arg> </cmdsynopsis>
</cmdsynopsis> <cmdsynopsis>
<cmdsynopsis> <command>asterisk -r</command>
<arg><option>-v</option></arg>
<command>asterisk -r</command> <arg><option>-d</option></arg>
<arg><option>-v</option></arg> <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
<arg><option>-x </option><replaceable class="parameter">command</replaceable></arg> </cmdsynopsis>
</cmdsynopsis> <cmdsynopsis>
</refsynopsisdiv> <command>asterisk -R</command>
<refsect1> <arg><option>-v</option></arg>
<refsect1info> <arg><option>-d</option></arg>
<date>2011-02-08</date> <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
</refsect1info> </cmdsynopsis>
<title>DESCRIPTION</title> </refsynopsisdiv>
<para> <refsect1>
<command>asterisk</command> is a full-featured telephony server which <refsect1info>
provides Private Branch eXchange (PBX), Interactive Voice Response (IVR), <date>2011-02-08</date>
Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying, </refsect1info>
Conferencing, and a plethora of other telephony applications to a broad <title>DESCRIPTION</title>
range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny, <para>
H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM <command>asterisk</command> is a full-featured telephony server which
hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart, provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
ISDN BRI and many more. Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying,
</para> Conferencing, and a plethora of other telephony applications to a broad
<para> range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM
file and locates the rest of the configuration files from the configuration hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
in that file. The -C option specifies an alternate main configuration file. ISDN BRI and many more.
Virtually all aspects of the operation of asterisk's configuration files </para>
can be found in the sample configuration files. The format for those files <para>
is generally beyond the scope of this man page. At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
</para> file and locates the rest of the configuration files from the configuration
<para> in that file. The -C option specifies an alternate main configuration file.
When running with <command>-c</command>, <command>-r</command> or <command>-R</command> Virtually all aspects of the operation of asterisk's configuration files
options, Asterisk supplies a powerful command line, including command can be found in the sample configuration files. The format for those files
completion, which may be used to monitors its status, perform a variety is generally beyond the scope of this man page.
of administrative actions and even explore the applications that are </para>
currently loaded into the system. <para>
</para> When running with <command>-c</command>, <command>-r</command> or <command>-R</command>
<para> options, Asterisk supplies a powerful command line, including command
Asterisk is a trademark of Digium, Inc. completion, which may be used to monitors its status, perform a variety
</para> of administrative actions and even explore the applications that are
</refsect1> currently loaded into the system.
<refsect1> </para>
<title>OPTIONS</title> <para>
<variablelist> Asterisk is a trademark of Digium, Inc.
<varlistentry> </para>
<term>-B</term> </refsect1>
<listitem> <refsect1>
<para> <title>OPTIONS</title>
Force the background of the terminal to be black, in order for <para>
terminal colors to show up properly. Running Asterisk starts the asterisk daemon (optionally running it
</para> in the foreground). However running it with <option>-r</option> or
</listitem> <option>-R</option> connects to an existing Asterisk instance through
</varlistentry> a remote console.
<varlistentry> </para>
<term>-C <replaceable class="parameter">file</replaceable></term> <variablelist>
<listitem> <varlistentry>
<para> <term>-B</term>
Use <filename>file</filename> as master configuration file <listitem>
instead of the default, /etc/asterisk/asterisk.conf <para>
</para> Force the background of the terminal to be black, in order for
</listitem> terminal colors to show up properly. Equivalent to
</varlistentry> <option>forceblackbackground = yes</option> in
<varlistentry> <filename>asterisk.conf</filename>. See also
<term>-c</term> <option>-n</option> and <option>-W</option>.
<listitem> </para>
<para> </listitem>
Provide a control console on the calling terminal. </varlistentry>
Specifying this option implies <command>-f</command> and will cause <varlistentry>
asterisk to no longer fork or detach from the controlling terminal. <term>-C <replaceable class="parameter">file</replaceable></term>
</para> <listitem>
</listitem> <para>
</varlistentry> Use <filename>file</filename> as master configuration file
<varlistentry> instead of the default, /etc/asterisk/asterisk.conf
<term>-d</term> </para>
<listitem> </listitem>
<para> </varlistentry>
Enable extra debugging statements. <varlistentry>
</para> <term>-c</term>
<para> <listitem>
Note: This always sets the debug level in the asterisk process, <para>
even if it is running in the background. This may affect the size Provide a control console on the calling terminal. The
of your log files, if the debug level is specified in logger.conf. console is similar to the remote console provided by
</para> <option>-r</option>. Specifying this option implies
</listitem> <command>-f</command> and will cause asterisk to no longer
</varlistentry> fork or detach from the controlling terminal. Equivalent
<varlistentry> to <option>console = yes</option> in <filename>asterisk.conf</filename>.
<term>-e <replaceable class="parameter">memory</replaceable></term> </para>
<listitem> </listitem>
<para> </varlistentry>
Limit the generation of new channels when the amount of free memory has decreased to under <replaceable>memory</replaceable> megabytes. <varlistentry>
</para> <term>-d</term>
</listitem> <listitem>
</varlistentry> <para>
<varlistentry> Enable extra debugging statements. This parameter may be used several
<term>-f</term> times, and each increases the debug level. Equivalent to <option>debug = <replaceable>num</replaceable></option>
<listitem> in <filename>asterisk.conf</filename> to explicitly set the initian debug
<para> level to <replaceable>num</replaceable>. When given at startup, this
Do not fork or detach from controlling terminal. Overrides any preceding specification of <command>-F</command> on the command line. option also implies <option>-f</option> (no forking). However when
</para> connecting to an existing Asterisk instance (<option>-r</option> or
</listitem> <option>-R</option>), it may only increase the debug level.
</varlistentry> </para>
<varlistentry> </listitem>
<term>-F</term> </varlistentry>
<listitem> <varlistentry>
<para> <term>-e <replaceable class="parameter">memory</replaceable></term>
Always fork and detach from controlling terminal. Overrides any preceding specification of <command>-f</command> on the command line. <listitem>
</para> <para>
</listitem> Limit the generation of new channels when the amount of free memory
</varlistentry> has decreased to under <replaceable>memory</replaceable> megabytes.
<varlistentry> Equivalent to <option>minmemfree = <replaceable>memory</replaceable></option> in
<term>-g</term> <filename>asterisk.conf</filename>.
<listitem> </para>
<para> </listitem>
Remove resource limit on core size, thus forcing Asterisk to dump </varlistentry>
core in the unlikely event of a segmentation fault or abort signal. <varlistentry>
<command>NOTE:</command> in some cases this may be incompatible <term>-f</term>
with the <command>-U</command> or <command>-G</command> flags. <listitem>
</para> <para>
</listitem> Do not fork or detach from controlling terminal. Overrides any
</varlistentry> preceding specification of <command>-F</command> on the command line.
<varlistentry> Equivalent to <option>nofork = yes</option> in <filename>asterisk.conf</filename>.
<term>-G <replaceable class="parameter">group</replaceable></term> See also <option>-c</option>.
<listitem> </para>
<para> </listitem>
Run as group <replaceable>group</replaceable> instead of the </varlistentry>
calling group. <command>NOTE:</command> this requires substantial work <varlistentry>
to be sure that Asterisk's environment has permission to write <term>-F</term>
the files required for its operation, including logs, its comm <listitem>
socket, the asterisk database, etc. <para>
</para> Always fork and detach from controlling terminal. Overrides any
</listitem> preceding specification of <command>-f</command> on the command line.
</varlistentry> May also be used to prevent <option>-d</option> and <option>-v</option> to imply
<varlistentry> no forking. Equivalent to <option>alwaysfork = yes</option> in <filename>asterisk.conf</filename>.
<term>-h</term> </para>
<listitem> </listitem>
<para> </varlistentry>
Provide brief summary of command line arguments and terminate. <varlistentry>
</para> <term>-g</term>
</listitem> <listitem>
</varlistentry> <para>
<varlistentry> Remove resource limit on core size, thus forcing Asterisk to dump
<term>-i</term> core in the unlikely event of a segmentation fault or abort signal.
<listitem> <command>NOTE:</command> in some cases this may be incompatible
<para> with the <command>-U</command> or <command>-G</command> flags.
Prompt user to intialize any encrypted private keys for IAX2 </para>
secure authentication during startup. </listitem>
</para> </varlistentry>
</listitem> <varlistentry>
</varlistentry> <term>-G <replaceable class="parameter">group</replaceable></term>
<varlistentry> <listitem>
<term>-I</term> <para>
<listitem> Run as group <replaceable>group</replaceable> instead of the
<para> calling group. <command>NOTE:</command> this requires substantial work
Enable internal timing if DAHDI timing is available. to be sure that Asterisk's environment has permission to write
The default behaviour is that outbound packets are phase locked the files required for its operation, including logs, its comm
to inbound packets. Enabling this switch causes them to be socket, the asterisk database, etc.
locked to the internal DAHDI timer instead. </para>
</para> </listitem>
</listitem> </varlistentry>
</varlistentry> <varlistentry>
<varlistentry> <term>-h</term>
<term>-L <replaceable class="parameter">loadaverage</replaceable></term> <listitem>
<listitem> <para>
<para> Provide brief summary of command line arguments and terminate.
Limits the maximum load average before rejecting new calls. This can </para>
be useful to prevent a system from being brought down by terminating </listitem>
too many simultaneous calls. </varlistentry>
</para> <varlistentry>
</listitem> <term>-i</term>
</varlistentry> <listitem>
<varlistentry> <para>
<term>-m</term> Prompt user to intialize any encrypted private keys for IAX2
<listitem> secure authentication during startup.
<para> </para>
Temporarily mutes output to the console and logs. To return to normal, </listitem>
use <command>logger mute</command>. </varlistentry>
</para> <varlistentry>
</listitem> <term>-I</term>
</varlistentry> <listitem>
<varlistentry> <para>
<term>-M <replaceable class="parameter">value</replaceable></term> Enable internal timing if DAHDI timing is available.
<listitem> The default behaviour is that outbound packets are phase locked
<para> to inbound packets. Enabling this switch causes them to be
Limits the maximum number of calls to the specified value. This can locked to the internal DAHDI timer instead.
be useful to prevent a system from being brought down by terminating </para>
too many simultaneous calls. </listitem>
</para> </varlistentry>
</listitem> <varlistentry>
</varlistentry> <term>-L <replaceable class="parameter">loadaverage</replaceable></term>
<varlistentry> <listitem>
<term>-n</term> <para>
<listitem> Limits the maximum load average before rejecting new calls. This can
<para> be useful to prevent a system from being brought down by terminating
Disable ANSI colors even on terminals capable of displaying them. too many simultaneous calls.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>-p</term> <term>-m</term>
<listitem> <listitem>
<para> <para>
If supported by the operating system (and executing as root), Temporarily mutes output to the console and logs. To return to normal,
attempt to run with realtime priority for increased performance and use <command>logger mute</command>.
responsiveness within the Asterisk process, at the expense of other </para>
programs running on the same machine. </listitem>
</para> </varlistentry>
<para> <varlistentry>
Note: <command>astcanary</command> will run concurrently with <term>-M <replaceable class="parameter">value</replaceable></term>
<command>asterisk</command>. If <command>astcanary</command> stops <listitem>
running or is killed, <command>asterisk</command> will slow down to <para>
normal process priority, to avoid locking up the machine. Limits the maximum number of calls to the specified value. This can
</para> be useful to prevent a system from being brought down by terminating
</listitem> too many simultaneous calls.
</varlistentry> </para>
<varlistentry> </listitem>
<term>-q</term> </varlistentry>
<listitem> <varlistentry>
<para> <term>-n</term>
Reduce default console output when running in conjunction with <listitem>
console mode (<command>-c</command>). <para>
</para> Disable ANSI colors even on terminals capable of displaying them.
</listitem> </para>
</varlistentry> </listitem>
<varlistentry> </varlistentry>
<term>-r</term> <varlistentry>
<listitem> <term>-p</term>
<para> <listitem>
Instead of running a new Asterisk process, attempt to connect <para>
to a running Asterisk process and provide a console interface If supported by the operating system (and executing as root),
for controlling it. attempt to run with realtime priority for increased performance and
</para> responsiveness within the Asterisk process, at the expense of other
</listitem> programs running on the same machine.
</varlistentry> </para>
<varlistentry> <para>
<term>-R</term> Note: <command>astcanary</command> will run concurrently with
<listitem> <command>asterisk</command>. If <command>astcanary</command> stops
<para> running or is killed, <command>asterisk</command> will slow down to
Much like <command>-r</command>. Instead of running a new Asterisk process, attempt to connect normal process priority, to avoid locking up the machine.
to a running Asterisk process and provide a console interface </para>
for controlling it. Additionally, if connection to the Asterisk </listitem>
process is lost, attempt to reconnect for as long as 30 seconds. </varlistentry>
</para> <varlistentry>
</listitem> <term>-q</term>
</varlistentry> <listitem>
<varlistentry> <para>
<term>-s <replaceable class="parameter">socket file name</replaceable></term> Reduce default console output when running in conjunction with
<listitem> console mode (<command>-c</command>).
<para> </para>
In combination with <command>-r</command>, connect directly to a specified </listitem>
Asterisk server socket. </varlistentry>
</para> <varlistentry>
</listitem> <term>-r</term>
</varlistentry> <listitem>
<varlistentry> <para>
<term>-t</term> Instead of running a new Asterisk process, attempt to connect
<listitem> to a running Asterisk process and provide a console interface
<para> for controlling it.
When recording files, write them first into a temporary holding directory, </para>
then move them into the final location when done. </listitem>
</para> </varlistentry>
</listitem> <varlistentry>
</varlistentry> <term>-R</term>
<varlistentry> <listitem>
<term>-T</term> <para>
<listitem> Much like <command>-r</command>. Instead of running a new Asterisk process, attempt to connect
<para> to a running Asterisk process and provide a console interface
Add timestamp to all non-command related output going to the console for controlling it. Additionally, if connection to the Asterisk
when running with verbose and/or logging to the console. process is lost, attempt to reconnect for as long as 30 seconds.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>-U <replaceable class="parameter">user</replaceable></term> <term>-s <replaceable class="parameter">socket file name</replaceable></term>
<listitem> <listitem>
<para> <para>
Run as user <replaceable>user</replaceable> instead of the In combination with <command>-r</command>, connect directly to a specified
calling user. <command>NOTE:</command> this requires substantial work Asterisk server socket.
to be sure that Asterisk's environment has permission to write </para>
the files required for its operation, including logs, its comm </listitem>
socket, the asterisk database, etc. </varlistentry>
</para> <varlistentry>
</listitem> <term>-t</term>
</varlistentry> <listitem>
<varlistentry> <para>
<term>-v</term> When recording files, write them first into a temporary holding directory,
<listitem> then move them into the final location when done.
<para> </para>
Increase the level of verboseness on the console. The more times </listitem>
<command>-v</command> is specified, the more verbose the output is. </varlistentry>
Specifying this option implies <command>-f</command> and will cause <varlistentry>
asterisk to no longer fork or detach from the controlling terminal. <term>-T</term>
This option may also be used in conjunction with <command>-r</command> <listitem>
and <command>-R</command>. <para>
</para> Add timestamp to all non-command related output going to the console
<para> when running with verbose and/or logging to the console.
Note: This always sets the verbose level in the asterisk process, </para>
even if it is running in the background. This will affect the size </listitem>
of your log files. </varlistentry>
</para> <varlistentry>
</listitem> <term>-U <replaceable class="parameter">user</replaceable></term>
</varlistentry> <listitem>
<varlistentry> <para>
<term>-V</term> Run as user <replaceable>user</replaceable> instead of the
<listitem> calling user. <command>NOTE:</command> this requires substantial work
<para> to be sure that Asterisk's environment has permission to write
Display version information and exit immediately. the files required for its operation, including logs, its comm
</para> socket, the asterisk database, etc.
</listitem> </para>
</varlistentry> </listitem>
<varlistentry> </varlistentry>
<term>-W</term> <varlistentry>
<listitem> <term>-v</term>
<para> <listitem>
Display colored terminal text as if the background were white <para>
or otherwise light in color. Normally, terminal text is displayed Increase the level of verboseness on the console. The more times
as if the background were black or otherwise dark in color. <command>-v</command> is specified, the more verbose the output is.
</para> Specifying this option implies <command>-f</command> and will cause
</listitem> asterisk to no longer fork or detach from the controlling terminal.
</varlistentry> This option may also be used in conjunction with <command>-r</command>
<varlistentry> and <command>-R</command>.
<term>-x <replaceable class="parameter">command</replaceable></term> </para>
<listitem> <para>
<para> Note: This always sets the verbose level in the asterisk process,
Connect to a running Asterisk process and execute a command on even if it is running in the background. This will affect the size
a command line, passing any output through to standard out and of your log files.
then terminating when the command execution completes. Implies </para>
<command>-r</command> when <command>-R</command> is not explicitly </listitem>
supplied. </varlistentry>
</para> <varlistentry>
</listitem> <term>-V</term>
</varlistentry> <listitem>
<varlistentry> <para>
<term>-X</term> Display version information and exit immediately.
<listitem> </para>
<para> </listitem>
Enables executing of includes via <command>#exec</command> directive. </varlistentry>
This can be useful if You want to do <command>#exec</command> inside <varlistentry>
<filename>asterisk.conf</filename> <term>-W</term>
</para> <listitem>
</listitem> <para>
</varlistentry> Display colored terminal text as if the background were white
</variablelist> or otherwise light in color. Normally, terminal text is displayed
</refsect1> as if the background were black or otherwise dark in color.
<refsect1> </para>
<title>EXAMPLES</title> </listitem>
<para> </varlistentry>
<command>asterisk</command> - Begin Asterisk as a daemon <varlistentry>
</para> <term>-x <replaceable class="parameter">command</replaceable></term>
<para> <listitem>
<command>asterisk -vvvgc</command> - Run on controlling terminal <para>
</para> Connect to a running Asterisk process and execute a command on
<para> a command line, passing any output through to standard out and
<command>asterisk -rx "core show channels"</command> - Display channels on running server then terminating when the command execution completes. Implies
</para> <command>-r</command> when <command>-R</command> is not explicitly
</refsect1> supplied.
<refsect1> </para>
<title>BUGS</title> </listitem>
<para> </varlistentry>
Bug reports and feature requests may be filed at https://issues.asterisk.org <varlistentry>
</para> <term>-X</term>
</refsect1> <listitem>
<refsect1> <para>
<title>SEE ALSO</title> Enables executing of includes via <command>#exec</command> directive.
<para> This can be useful if You want to do <command>#exec</command> inside
*CLI&gt; <command>help</command> - Help on Asterisk CLI <filename>asterisk.conf</filename>
</para> </para>
<para> </listitem>
*CLI&gt; <command>core show applications</command> - Show loaded dialplan applications </varlistentry>
</para> </variablelist>
<para> </refsect1>
*CLI&gt; <command>core show functions</command> - Show loaded dialplan functions <refsect1>
</para> <title>EXAMPLES</title>
<para> <para>
*CLI&gt; <command>dialplan show</command> - Show current dialplan <command>asterisk</command> - Begin Asterisk as a daemon
</para> </para>
<para> <para>
http://www.asterisk.org - The Asterisk Home Page <command>asterisk -vvvgc</command> - Run on controlling terminal
</para> </para>
<para> <para>
http://www.asteriskdocs.org - The Asterisk Documentation Project <command>asterisk -rx "core show channels"</command> - Display channels on running server
</para> </para>
<para> </refsect1>
http://wiki.asterisk.org - The Asterisk Wiki <refsect1>
</para> <title>BUGS</title>
<para> <para>
http://www.digium.com/ - Asterisk sponsor and hardware supplier Bug reports and feature requests may be filed at https://issues.asterisk.org
</para> </para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>AUTHOR</title> <title>SEE ALSO</title>
<para> <para>
<author> http://www.asterisk.org - The Asterisk Home Page
<firstname>Mark Spencer &lt;markster@digium.com&gt;</firstname> </para>
</author> <para>
</para> http://www.asteriskdocs.org - The Asterisk Documentation Project
<para> </para>
<author> <para>
<firstname>Countless other contributors, see CREDITS with distribution for more information.</firstname> http://wiki.asterisk.org - The Asterisk Wiki
</author> </para>
</para> <para>
</refsect1> http://www.digium.com/ - Asterisk is sponsored by Digium
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
<author>
<firstname>Mark Spencer &lt;markster@digium.com&gt;</firstname>
</author>
</para>
<para>
<author>
<firstname>Countless other contributors, see CREDITS with distribution for more information.</firstname>
</author>
</para>
</refsect1>
</refentry> </refentry>