kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-06 12:36:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged revisions 280740 via svnmerge from

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

................
  r280740 | tilghman | 2010-08-03 13:42:24 -0500 (Tue, 03 Aug 2010) | 9 lines
  
  Merged revisions 280739 via svnmerge from 
  https://origsvn.digium.com/svn/asterisk/branches/1.6.2
  
  ........
    r280739 | tilghman | 2010-08-03 13:39:28 -0500 (Tue, 03 Aug 2010) | 2 lines
    
    Document -B and -W flags and regenerate manpage from sgml
  ........
................


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@280741 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Tilghman Lesher
2010-08-03 18:43:37 +00:00
parent b641ad14a4
commit ee6592684b
3 changed files with 227 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/Makefile Normal file
View File

@@ -0,0 +1,6 @@
all: asterisk.8
asterisk.8: asterisk.sgml
docbook2x-man asterisk.sgml

275
doc/asterisk.8
View File

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

85
doc/asterisk.sgml
View File

@@ -1,7 +1,6 @@
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry> <refentry>
<refentryinfo> <refentryinfo>
<date>2005-10-18</date> <date>2010-08-03</date>
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
<refentrytitle> <refentrytitle>
@@ -21,13 +20,15 @@
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>asterisk</command> <command>asterisk</command>
<arg><option>-tThfdvVqpRgciIns</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>-U </option><replaceable class="parameter">user</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>-x </option><replaceable class="parameter">command</replaceable></arg>
<arg><option>-M </option><replaceable class="parameter">value</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>-U </option><replaceable class="parameter">user</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>
@@ -38,7 +39,7 @@
</refsynopsisdiv> </refsynopsisdiv>
<refsect1> <refsect1>
<refsect1info> <refsect1info>
<date>2007-12-19</date> <date>2010-08-03</date>
</refsect1info> </refsect1info>
<title>DESCRIPTION</title> <title>DESCRIPTION</title>
<para> <para>
@@ -73,6 +74,15 @@
<refsect1> <refsect1>
<title>OPTIONS</title> <title>OPTIONS</title>
<variablelist> <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.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term>-C <replaceable class="parameter">file</replaceable></term> <term>-C <replaceable class="parameter">file</replaceable></term>
<listitem> <listitem>
@@ -100,8 +110,16 @@
</para> </para>
<para> <para>
Note: This always sets the debug level in the asterisk process, Note: This always sets the debug level in the asterisk process,
even if it is running in the background. This will affect the size even if it is running in the background. This may affect the size
of your log files. of your log files, if the debug level is specified in logger.conf.
</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.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -109,7 +127,15 @@
<term>-f</term> <term>-f</term>
<listitem> <listitem>
<para> <para>
Do not fork or detach from controlling terminal. Do not fork or detach from controlling terminal. Overrides any preceding specification of <command>-F</command> on the command line.
</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.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -174,6 +200,15 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </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> <varlistentry>
<term>-M <replaceable class="parameter">value</replaceable></term> <term>-M <replaceable class="parameter">value</replaceable></term>
<listitem> <listitem>
@@ -201,6 +236,12 @@
responsiveness within the Asterisk process, at the expense of other responsiveness within the Asterisk process, at the expense of other
programs running on the same machine. programs running on the same machine.
</para> </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> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@@ -298,6 +339,16 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </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> <varlistentry>
<term>-x <replaceable class="parameter">command</replaceable></term> <term>-x <replaceable class="parameter">command</replaceable></term>
<listitem> <listitem>
@@ -331,7 +382,7 @@
<command>asterisk -vvvgc</command> - Run on controlling terminal <command>asterisk -vvvgc</command> - Run on controlling terminal
</para> </para>
<para> <para>
<command>asterisk -rx "show channels"</command> - Display channels on running server <command>asterisk -rx "core show channels"</command> - Display channels on running server
</para> </para>
</refsect1> </refsect1>
<refsect1> <refsect1>
@@ -346,10 +397,13 @@
*CLI&gt; <command>help</command> - Help on Asterisk CLI *CLI&gt; <command>help</command> - Help on Asterisk CLI
</para> </para>
<para> <para>
*CLI&gt; <command>show applications</command> - Show loaded dialplan applications *CLI&gt; <command>core show applications</command> - Show loaded dialplan applications
</para> </para>
<para> <para>
*CLI&gt; <command>show functions</command> - Show loaded dialplan functions *CLI&gt; <command>core show functions</command> - Show loaded dialplan functions
</para>
<para>
*CLI&gt; <command>dialplan show</command> - Show current dialplan
</para> </para>
<para> <para>
http://www.asterisk.org - The Asterisk Home Page http://www.asterisk.org - The Asterisk Home Page
@@ -363,9 +417,6 @@
<para> <para>
http://www.digium.com/ - Asterisk sponsor and hardware supplier http://www.digium.com/ - Asterisk sponsor and hardware supplier
</para> </para>
<para>
http://www.markocam.com/ - Asterisk author's web cam
</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>AUTHOR</title> <title>AUTHOR</title>
@@ -376,7 +427,7 @@
</para> </para>
<para> <para>
<author> <author>
<firstname>Countless other contributers, see CREDITS with distribution for more information</firstname> <firstname>Countless other contributors, see CREDITS with distribution for more information.</firstname>
</author> </author>
</para> </para>
</refsect1> </refsect1>