2005-09-15 00:12:36 +00:00
|
|
|
.\" This manpage has been automatically generated by docbook2man
|
|
|
|
.\" from a DocBook document. This tool can be found at:
|
|
|
|
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
|
|
|
|
.\" Please send any bug reports, improvements, comments, patches,
|
|
|
|
.\" etc. to Steve Cheng <steve@ggi-project.org>.
|
2005-10-26 03:58:32 +00:00
|
|
|
.TH "ASTERISK" "8" "25 October 2005" "asterisk 1.2" ""
|
2005-09-15 00:12:36 +00:00
|
|
|
|
|
|
|
.SH NAME
|
|
|
|
asterisk \- All-purpose telephony server.
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
2010-04-10 08:33:57 +00:00
|
|
|
\fBasterisk\fR [ \fB\-tThfdvVqpRgciIn\fR ] [ \fB\-C \fIfile\fB\fR ] [ \fB\-U \fIuser\fB\fR ] [ \fB\-G \fIgroup\fB\fR ] [ \fB\-x \fIcommand\fB\fR ] [ \fB\-M \fIvalue\fB\fR ]
|
2005-09-15 00:12:36 +00:00
|
|
|
|
|
|
|
|
2010-04-10 08:33:57 +00:00
|
|
|
\fBasterisk \-r\fR [ \fB\-v\fR ] [ \fB\-x \fIcommand\fB\fR ] [ \fB\-s \fIsocket\fB\fR ]
|
2005-09-15 00:12:36 +00:00
|
|
|
|
|
|
|
.SH "DESCRIPTION"
|
|
|
|
.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
|
2005-10-18 21:06:38 +00:00
|
|
|
range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
|
2005-09-15 00:12:36 +00:00
|
|
|
H.323) 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
|
2005-10-18 21:06:38 +00:00
|
|
|
At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
|
|
|
|
file and locates the rest of the configuration files from the configuration
|
2010-07-23 16:07:53 +00:00
|
|
|
in that file. The \-C option specifies an alternate main configuration file.
|
2005-10-18 21:06:38 +00:00
|
|
|
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.
|
2005-09-15 00:12:36 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
When running with \fB\-c\fR, \fB\-r\fR or \fB\-R\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
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.
|
2005-10-18 21:06:38 +00:00
|
|
|
.PP
|
|
|
|
Asterisk is a trademark of Digium, Inc.
|
2005-09-15 00:12:36 +00:00
|
|
|
.SH "OPTIONS"
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-C \fIfile\fB\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Use \fIfile\fR as master configuration file
|
|
|
|
instead of the default, /etc/asterisk/asterisk.conf
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-c\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Provide a control console on the calling terminal.
|
2010-07-23 16:07:53 +00:00
|
|
|
Specifying this option implies \fB\-f\fR and will cause
|
2005-09-15 00:12:36 +00:00
|
|
|
asterisk to no longer fork or detach from the controlling terminal.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-d\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Enable extra debugging statements.
|
2005-10-18 21:06:38 +00:00
|
|
|
|
|
|
|
Note: This always sets the debug level in the asterisk process,
|
|
|
|
even if it is running in the background. This will affect the size
|
|
|
|
of your log files.
|
2005-09-15 00:12:36 +00:00
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-f\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Do not fork or detach from controlling terminal.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-g\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
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
|
2010-04-10 08:33:57 +00:00
|
|
|
with the \fB\-U\fR or \fB\-G\fR flags.
|
2005-09-15 00:12:36 +00:00
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-G \fIgroup\fB\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
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.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-h\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Provide brief summary of command line arguments and terminate.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-i\fR
|
2006-01-16 17:37:44 +00:00
|
|
|
Prompt user to initialize any encrypted private keys for IAX2
|
2005-10-18 21:06:38 +00:00
|
|
|
secure authentication during startup.
|
2005-09-15 00:12:36 +00:00
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-L \fIloadaverage\fB\fR
|
2005-10-26 03:58:32 +00:00
|
|
|
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.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-m\fR
|
|
|
|
Disable log and verbose output to remote (\-r) consoles.
|
2006-05-26 21:47:52 +00:00
|
|
|
.TP
|
2010-07-23 16:07:53 +00:00
|
|
|
\fB\-M \fIvalue\fB\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
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.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-n\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Disable ANSI colors even on terminals capable of displaying them.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-p\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
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.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-q\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Reduce default console output when running in conjunction with
|
2010-04-10 08:33:57 +00:00
|
|
|
console mode (\fB\-c\fR).
|
2005-09-15 00:12:36 +00:00
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-r\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Instead of running a new Asterisk process, attempt to connect
|
|
|
|
to a running Asterisk process and provide a console interface
|
|
|
|
for controlling it.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-R\fR
|
|
|
|
Much like \fB\-r\fR\&. Instead of running a new Asterisk process, attempt to connect
|
2005-09-15 00:12:36 +00:00
|
|
|
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.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-s \fIsocket\fB\fR
|
2007-12-27 23:28:01 +00:00
|
|
|
Allows to specify the socket file to be used to connect to the
|
2010-07-23 16:07:53 +00:00
|
|
|
Asterisk console. Used in conjunction with \fB\-r\fR or \fB\-R\fR.
|
2007-12-27 23:28:01 +00:00
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-I\fR
|
2008-06-12 17:27:55 +00:00
|
|
|
Enable internal timing if DAHDI timer is available
|
2006-03-30 06:07:04 +00:00
|
|
|
The default behaviour is that outbound packets are phase locked
|
|
|
|
to inbound packets. Enabling this switch causes them to be
|
2008-06-12 17:27:55 +00:00
|
|
|
locked to the internal DAHDI timer instead.
|
2006-03-30 06:07:04 +00:00
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-t\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
When recording files, write them first into a temporary holding directory,
|
|
|
|
then move them into the final location when done.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-T\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Add timestamp to all non-command related output going to the console
|
|
|
|
when running with verbose and/or logging to the console.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-U \fIuser\fB\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
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.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-v\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Increase the level of verboseness on the console. The more times
|
2010-07-23 16:07:53 +00:00
|
|
|
\fB\-v\fR is specified, the more verbose the output is.
|
2010-04-10 08:33:57 +00:00
|
|
|
Specifying this option implies \fB\-f\fR and will cause
|
2005-09-15 00:12:36 +00:00
|
|
|
asterisk to no longer fork or detach from the controlling terminal.
|
2010-04-10 08:33:57 +00:00
|
|
|
This option may also be used in conjunction with \fB\-r\fR
|
|
|
|
and \fB\-R\fR\&.
|
2005-10-18 21:06:38 +00:00
|
|
|
|
|
|
|
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.
|
2005-09-15 00:12:36 +00:00
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-V\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
Display version information and exit immediately.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-W\fR
|
2008-08-25 23:13:32 +00:00
|
|
|
Change the terminal colors to compensate for a light background,
|
|
|
|
rather than a dark background, as is the default.
|
|
|
|
.TP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-x \fIcommand\fB\fR
|
2005-09-15 00:12:36 +00:00
|
|
|
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
|
2010-04-10 08:33:57 +00:00
|
|
|
\fB\-r\fR when \fB\-R\fR is not explicitly
|
2005-09-15 00:12:36 +00:00
|
|
|
supplied.
|
|
|
|
.SH "EXAMPLES"
|
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fBasterisk\fR \- Begin Asterisk as a daemon
|
2005-09-15 00:12:36 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fBasterisk \-vvvgc\fR \- Run on controlling terminal
|
2005-09-15 00:12:36 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
\fBasterisk \-rx "core show channels"\fR \- Display channels on running server
|
2005-09-15 00:12:36 +00:00
|
|
|
.SH "BUGS"
|
|
|
|
.PP
|
2009-05-28 21:50:27 +00:00
|
|
|
Bug reports and feature requests may be filed at https://issues.asterisk.org
|
2005-09-15 00:12:36 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
*CLI> \fBhelp\fR \- Help on Asterisk CLI
|
2005-09-15 00:12:36 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
*CLI> \fBcore show applications\fR \- Show loaded dialplan applications
|
2005-10-18 21:06:38 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
*CLI> \fBcore show functions\fR \- Show loaded dialplan functions
|
2007-05-31 23:04:32 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
*CLI> \fBdialplan show\fR \- Show current dialplan
|
2005-09-15 00:12:36 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
http://www.asterisk.org \- The Asterisk Home Page
|
2005-09-15 00:12:36 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
http://www.asteriskdocs.org \- The Asterisk Documentation Project
|
2005-09-15 00:12:36 +00:00
|
|
|
.PP
|
2010-07-23 16:07:53 +00:00
|
|
|
http://www.voip\-info.org/wiki\-Asterisk \- The Asterisk Wiki
|
2005-09-15 00:12:36 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
http://www.digium.com/ \- Asterisk sponsor and hardware supplier
|
2005-09-15 00:12:36 +00:00
|
|
|
.PP
|
2010-04-10 08:33:57 +00:00
|
|
|
http://www.markocam.com/ \- Asterisk author's web cam
|
2005-09-15 00:12:36 +00:00
|
|
|
.SH "AUTHOR"
|
|
|
|
.PP
|
|
|
|
Mark Spencer <markster@digium.com>
|
|
|
|
.PP
|
2007-05-31 23:04:32 +00:00
|
|
|
Countless other contributors, see CREDITS with distribution for more information
|