Merged revisions 331142 via svnmerge from

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

........
  r331142 | qwell | 2011-08-09 10:58:16 -0500 (Tue, 09 Aug 2011) | 1 line
  
  Regenerate asterisk man page from sgml.
........


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/10@331143 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Jason Parker
2011-08-09 15:59:54 +00:00
parent 6f96c25efa
commit da8bd61649

View File

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