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