8181d6e36c00b89bb1352d9f84f2bb4fe7300f1a
[asterisk/asterisk.git] / doc / asterisk.8
1 '\" -*- coding: us-ascii -*-
2 .if \n(.g .ds T< \\FC
3 .if \n(.g .ds T> \\F[\n[.fam]]
4 .de URL
5 \\$2 \(la\\$1\(ra\\$3
6 ..
7 .if \n(.g .mso www.tmac
8 .TH &#10;&#9;&#9;asterisk&#10;&#9; 8 2010-08-03 "asterisk 1.6" ""
9 .SH NAME
10 asterisk
11 \- All-purpose telephony server. 
12 .SH SYNOPSIS
13 'nh
14 .fi
15 .ad l
16 \fBasterisk\fR \kx
17 .if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
18 'in \n(.iu+\nxu
19 [\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]
20 'in \n(.iu-\nxu
21 .ad b
22 'hy
23 'nh
24 .fi
25 .ad l
26 \fBasterisk -r\fR \kx
27 .if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
28 'in \n(.iu+\nxu
29 [\fB-v\fR] [\fB-x \fR\fIcommand\fR]
30 'in \n(.iu-\nxu
31 .ad b
32 'hy
33 .SH DESCRIPTION
34 \fBasterisk\fR is a full-featured telephony server which
35 provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
36 Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying, 
37 Conferencing, and a plethora of other telephony applications to a broad
38 range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
39 H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM
40 hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
41 ISDN BRI and many more.
42 .PP
43 At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
44 file and locates the rest of the configuration files from the configuration
45 in that file. The -C option specifies an alternate main configuration file.
46 Virtually all aspects of the operation of asterisk's configuration files
47 can be found in the sample configuration files. The format for those files
48 is generally beyond the scope of this man page.
49 .PP
50 When running with \fB-c\fR, \fB-r\fR or \fB-R\fR
51 options, Asterisk supplies a powerful command line, including command
52 completion, which may be used to monitors its status, perform a variety
53 of administrative actions and even explore the applications that are
54 currently loaded into the system.
55 .PP
56 Asterisk is a trademark of Digium, Inc.
57 .SH OPTIONS
58 .TP 
59 -B
60 Force the background of the terminal to be black, in order for
61 terminal colors to show up properly.
62 .TP 
63 -C \fIfile\fR
64 Use \*(T<\fIfile\fR\*(T> as master configuration file
65 instead of the default, /etc/asterisk/asterisk.conf
66 .TP 
67 -c
68 Provide a control console on the calling terminal.
69 Specifying this option implies \fB-f\fR and will cause
70 asterisk to no longer fork or detach from the controlling terminal.
71 .TP 
72 -d
73 Enable extra debugging statements.
74
75 Note: This always sets the debug level in the asterisk process,
76 even if it is running in the background. This may affect the size
77 of your log files, if the debug level is specified in logger.conf.
78 .TP 
79 -e \fImemory\fR
80 Limit the generation of new channels when the amount of free memory has decreased to under \fImemory\fR megabytes.
81 .TP 
82 -f
83 Do not fork or detach from controlling terminal. Overrides any preceding specification of \fB-F\fR on the command line.
84 .TP 
85 -F
86 Always fork and detach from controlling terminal. Overrides any preceding specification of \fB-f\fR on the command line.
87 .TP 
88 -g
89 Remove resource limit on core size, thus forcing Asterisk to dump
90 core in the unlikely event of a segmentation fault or abort signal.
91 \fBNOTE:\fR in some cases this may be incompatible
92 with the \fB-U\fR or \fB-G\fR flags.
93 .TP 
94 -G \fIgroup\fR
95 Run as group \fIgroup\fR instead of the
96 calling group. \fBNOTE:\fR this requires substantial work
97 to be sure that Asterisk's environment has permission to write
98 the files required for its operation, including logs, its comm
99 socket, the asterisk database, etc.
100 .TP 
101 -h
102 Provide brief summary of command line arguments and terminate.
103 .TP 
104 -i
105 Prompt user to intialize any encrypted private keys for IAX2
106 secure authentication during startup.
107 .TP 
108 -I
109 Enable internal timing if DAHDI timing is available.
110 The default behaviour is that outbound packets are phase locked
111 to inbound packets. Enabling this switch causes them to be
112 locked to the internal DAHDI timer instead.
113 .TP 
114 -L \fIloadaverage\fR
115 Limits the maximum load average before rejecting new calls. This can
116 be useful to prevent a system from being brought down by terminating
117 too many simultaneous calls.
118 .TP 
119 -m
120 Temporarily mutes output to the console and logs. To return to normal,
121 use \fBlogger mute\fR.
122 .TP 
123 -M \fIvalue\fR
124 Limits the maximum number of calls to the specified value. This can
125 be useful to prevent a system from being brought down by terminating
126 too many simultaneous calls.
127 .TP 
128 -n
129 Disable ANSI colors even on terminals capable of displaying them.
130 .TP 
131 -p
132 If supported by the operating system (and executing as root),
133 attempt to run with realtime priority for increased performance and
134 responsiveness within the Asterisk process, at the expense of other
135 programs running on the same machine.
136
137 Note: \fBastcanary\fR will run concurrently with
138 \fBasterisk\fR. If \fBastcanary\fR stops
139 running or is killed, \fBasterisk\fR will slow down to
140 normal process priority, to avoid locking up the machine.
141 .TP 
142 -q
143 Reduce default console output when running in conjunction with
144 console mode (\fB-c\fR).
145 .TP 
146 -r
147 Instead of running a new Asterisk process, attempt to connect
148 to a running Asterisk process and provide a console interface
149 for controlling it.
150 .TP 
151 -R
152 Much like \fB-r\fR. Instead of running a new Asterisk process, attempt to connect
153 to a running Asterisk process and provide a console interface
154 for controlling it. Additionally, if connection to the Asterisk 
155 process is lost, attempt to reconnect for as long as 30 seconds.
156 .TP 
157 -s \fIsocket file name\fR
158 In combination with \fB-r\fR, connect directly to a specified
159 Asterisk server socket.
160 .TP 
161 -t
162 When recording files, write them first into a temporary holding directory, 
163 then move them into the final location when done.
164 .TP 
165 -T
166 Add timestamp to all non-command related output going to the console
167 when running with verbose and/or logging to the console.
168 .TP 
169 -U \fIuser\fR
170 Run as user \fIuser\fR instead of the
171 calling user. \fBNOTE:\fR this requires substantial work
172 to be sure that Asterisk's environment has permission to write
173 the files required for its operation, including logs, its comm
174 socket, the asterisk database, etc.
175 .TP 
176 -v
177 Increase the level of verboseness on the console. The more times
178 \fB-v\fR is specified, the more verbose the output is.
179 Specifying this option implies \fB-f\fR and will cause
180 asterisk to no longer fork or detach from the controlling terminal.
181 This option may also be used in conjunction with \fB-r\fR
182 and \fB-R\fR.
183
184 Note: This always sets the verbose level in the asterisk process,
185 even if it is running in the background. This will affect the size
186 of your log files.
187 .TP 
188 -V
189 Display version information and exit immediately.
190 .TP 
191 -W
192 Display colored terminal text as if the background were white
193 or otherwise light in color. Normally, terminal text is displayed
194 as if the background were black or otherwise dark in color.
195 .TP 
196 -x \fIcommand\fR
197 Connect to a running Asterisk process and execute a command on
198 a command line, passing any output through to standard out and
199 then terminating when the command execution completes. Implies
200 \fB-r\fR when \fB-R\fR is not explicitly
201 supplied.
202 .TP 
203 -X
204 Enables executing of includes via \fB#exec\fR directive.
205 This can be useful if You want to do \fB#exec\fR inside
206 \*(T<\fIasterisk.conf\fR\*(T>
207 .SH EXAMPLES
208 \fBasterisk\fR - Begin Asterisk as a daemon
209 .PP
210 \fBasterisk -vvvgc\fR - Run on controlling terminal
211 .PP
212 \fBasterisk -rx "core show channels"\fR - Display channels on running server
213 .SH BUGS
214 Bug reports and feature requests may be filed at https://issues.asterisk.org
215 .SH "SEE ALSO"
216 *CLI> \fBhelp\fR - Help on Asterisk CLI
217 .PP
218 *CLI> \fBcore show applications\fR - Show loaded dialplan applications
219 .PP
220 *CLI> \fBcore show functions\fR - Show loaded dialplan functions
221 .PP
222 *CLI> \fBdialplan show\fR - Show current dialplan
223 .PP
224 http://www.asterisk.org - The Asterisk Home Page
225 .PP
226 http://www.asteriskdocs.org - The Asterisk Documentation Project
227 .PP
228 http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
229 .PP
230 http://www.digium.com/ - Asterisk sponsor and hardware supplier
231 .SH AUTHOR
232 Mark Spencer <markster@digium.com>
233 .PP
234 Countless other contributors, see CREDITS with distribution for more information.