1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
4 <date>2005-10-18</date>
8 <application>asterisk</application>
10 <manvolnum>8</manvolnum>
11 <refmiscinfo>asterisk 1.2</refmiscinfo>
15 <application>asterisk</application>
18 All-purpose telephony server.
23 <command>asterisk</command>
24 <arg><option>-tThfdvVqpRgcin</option></arg>
25 <arg><option>-C </option><replaceable class="parameter">file</replaceable></arg>
26 <arg><option>-U </option><replaceable class="parameter">user</replaceable></arg>
27 <arg><option>-G </option><replaceable class="parameter">group</replaceable></arg>
28 <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
29 <arg><option>-M </option><replaceable class="parameter">value</replaceable></arg>
30 <arg><option>-L </option><replaceable class="parameter">value</replaceable></arg>
34 <command>asterisk -r</command>
35 <arg><option>-v</option></arg>
36 <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
41 <date>2004-07-01</date>
43 <title>DESCRIPTION</title>
45 <command>asterisk</command> is a full-featured telephony server which
46 provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
47 Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying,
48 Conferencing, and a plethora of other telephony applications to a broad
49 range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
50 H.323) devices (both endpoints and proxies), as well as traditional TDM
51 hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
52 ISDN BRI, and many more.
55 At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
56 file and locates the rest of the configuration files from the configuration
57 in that file. The -C option specifies an alternate main configuration file.
58 Virtually all aspects of the operation of asterisk's configuration files
59 can be found in the sample configuration files. The format for those files
60 is generally beyond the scope of this man page.
63 When running with <command>-c</command>, <command>-r</command> or <command>-R</command>
64 options, Asterisk supplies a powerful command line, including command
65 completion, which may be used to monitors its status, perform a variety
66 of administrative actions and even explore the applications that are
67 currently loaded into the system.
70 Asterisk is a trademark of Digium, Inc.
74 <title>OPTIONS</title>
77 <term>-C <replaceable class="parameter">file</replaceable></term>
80 Use <filename>file</filename> as master configuration file
81 instead of the default, /etc/asterisk/asterisk.conf
89 Provide a control console on the calling terminal.
90 Specifying this option implies <command>-f</command> and will cause
91 asterisk to no longer fork or detach from the controlling terminal.
99 Enable extra debugging statements.
102 Note: This always sets the debug level in the asterisk process,
103 even if it is running in the background. This will affect the size
112 Do not fork or detach from controlling terminal.
120 Remove resource limit on core size, thus forcing Asterisk to dump
121 core in the unlikely event of a segmentation fault or abort signal.
122 <command>NOTE:</command> in some cases this may be incompatible
123 with the <command>-U</command> or <command>-G</command> flags.
128 <term>-G <replaceable class="parameter">group</replaceable></term>
131 Run as group <replaceable>group</replaceable> instead of the
132 calling group. <command>NOTE:</command> this requires substantial work
133 to be sure that Asterisk's environment has permission to write
134 the files required for its operation, including logs, its comm
135 socket, the asterisk database, etc.
143 Provide brief summary of command line arguments and terminate.
151 Prompt user to intialize any encrypted private keys for IAX2
152 secure authentication during startup.
157 <term>-L <replaceable class="parameter">loadaverage</replaceable></term>
160 Limits the maximum load average before rejecting new calls. This can
161 be useful to prevent a system from being brought down by terminating
162 too many simultaneous calls.
167 <term>-M <replaceable class="parameter">value</replaceable></term>
170 Limits the maximum number of calls to the specified value. This can
171 be useful to prevent a system from being brought down by terminating
172 too many simultaneous calls.
180 Disable ANSI colors even on terminals capable of displaying them.
188 If supported by the operating system (and executing as root),
189 attempt to run with realtime priority for increased performance and
190 responsiveness within the Asterisk process, at the expense of other
191 programs running on the same machine.
199 Reduce default console output when running in conjunction with
200 console mode (<command>-c</command>).
208 Instead of running a new Asterisk process, attempt to connect
209 to a running Asterisk process and provide a console interface
218 Much like <command>-r</command>. Instead of running a new Asterisk process, attempt to connect
219 to a running Asterisk process and provide a console interface
220 for controlling it. Additionally, if connection to the Asterisk
221 process is lost, attempt to reconnect for as long as 30 seconds.
229 When recording files, write them first into a temporary holding directory,
230 then move them into the final location when done.
238 Add timestamp to all non-command related output going to the console
239 when running with verbose and/or logging to the console.
244 <term>-U <replaceable class="parameter">user</replaceable></term>
247 Run as user <replaceable>user</replaceable> instead of the
248 calling user. <command>NOTE:</command> this requires substantial work
249 to be sure that Asterisk's environment has permission to write
250 the files required for its operation, including logs, its comm
251 socket, the asterisk database, etc.
259 Increase the level of verboseness on the console. The more times
260 <command>-v</command> is specified, the more verbose the output is.
261 Specifying this option implies <command>-f</command> and will cause
262 asterisk to no longer fork or detach from the controlling terminal.
263 This option may also be used in conjunction with <command>-r</command>
264 and <command>-R</command>.
267 Note: This always sets the verbose level in the asterisk process,
268 even if it is running in the background. This will affect the size
277 Display version information and exit immediately.
282 <term>-x <replaceable class="parameter">command</replaceable></term>
285 Connect to a running Asterisk process and execute a command on
286 a command line, passing any output through to standard out and
287 then terminating when the command execution completes. Implies
288 <command>-r</command> when <command>-R</command> is not explicitly
296 <title>EXAMPLES</title>
298 <command>asterisk</command> - Begin Asterisk as a daemon
301 <command>asterisk -vvvgc</command> - Run on controlling terminal
304 <command>asterisk -rx "show channels"</command> - Display channels on running server
310 Bug reports and feature requests may be filed at http://bugs.digium.com
314 <title>SEE ALSO</title>
316 *CLI> <command>help</command> - Help on Asterisk CLI
319 *CLI> <command>show applications</command> - Show loaded dialplan applications
322 *CLI> <command>show functions</command> - Show loaded dialplan functions
325 http://www.asterisk.org - The Asterisk Home Page
328 http://www.asteriskdocs.org - The Asterisk Documentation Project
331 http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
334 http://www.digium.com/ - Asterisk sponsor and hardware supplier
337 http://www.markocam.com/ - Asterisk author's web cam
341 <title>AUTHOR</title>
344 <firstname>Mark Spencer <markster@digium.com></firstname>
349 <firstname>Countless other contributers, see CREDITS with distribution for more information</firstname>