doc/asterisk.8

   1 .TH "           \fBasterisk\fP  " "8"
   2 <<<<<<< .working
   3 .SH "NAME"
   4 \fBasterisk\fP           \(em   All-purpose telephony server.
   5
   6 .SH "SYNOPSIS"
   7
   8 .PP
   9 \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 \fB-x \fP\fIcommand\fR
  10
  11 .PP
  12 \fBasterisk \-r\fR      \fB-v\fP \fB-x \fP\fIcommand\fR
  13 .SH "DESCRIPTION"
  14 2011-02-08;
  15 .PP
  16 \fBasterisk\fR is a full-featured telephony server which
  17 provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
  18 Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying,
  19 Conferencing, and a plethora of other telephony applications to a broad
  20 range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
  21 H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM
  22 hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
  23 ISDN BRI and many more.
  24
  25 .PP
  26 At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
  27 file and locates the rest of the configuration files from the configuration
  28 in that file. The \-C option specifies an alternate main configuration file.
  29 Virtually all aspects of the operation of asterisk's configuration files
  30 can be found in the sample configuration files.  The format for those files
  31 is generally beyond the scope of this man page.
  32
  33 .PP
  34 When running with \fB-c\fR, \fB-r\fR or \fB-R\fR        options, Asterisk supplies a powerful command line, including command
  35 completion, which may be used to monitors its status, perform a variety
  36 of administrative actions and even explore the applications that are
  37 currently loaded into the system.
  38
  39 .PP
  40 Asterisk is a trademark of Digium, Inc.
  41
  42 .SH "OPTIONS"
  43
  44 .IP "\-B" 10
  45 Force the background of the terminal to be black, in order for
  46 terminal colors to show up properly.
  47
  48 .IP "\-C \fIfile\fR" 10
  49 Use \fBfile\fP as master configuration file
  50 instead of the default, /etc/asterisk/asterisk.conf
  51
  52 .IP "\-c" 10
  53 Provide a control console on the calling terminal.
  54 Specifying this option implies \fB-f\fR and will cause
  55 asterisk to no longer fork or detach from the controlling terminal.
  56
  57 .IP "\-d" 10
  58 Enable extra debugging statements.
  59
  60 .IP "" 10
  61 Note: This always sets the debug level in the asterisk process,
  62 even if it is running in the background. This may affect the size
  63 of your log files, if the debug level is specified in logger.conf.
  64
  65 .IP "\-e \fImemory\fR" 10
  66 Limit the generation of new channels when the amount of free memory has decreased to under \fImemory\fR megabytes.
  67
  68 .IP "\-f" 10
  69 Do not fork or detach from controlling terminal.  Overrides any preceding specification of \fB-F\fR on the command line.
  70
  71 .IP "\-F" 10
  72 Always fork and detach from controlling terminal.  Overrides any preceding specification of \fB-f\fR on the command line.
  73
  74 .IP "\-g" 10
  75 Remove resource limit on core size, thus forcing Asterisk to dump
  76 core in the unlikely event of a segmentation fault or abort signal.
  77 \fBNOTE:\fR in some cases this may be incompatible
  78 with the \fB-U\fR or \fB-G\fR flags.
  79
  80 .IP "\-G \fIgroup\fR" 10
  81 Run as group \fIgroup\fR instead of the
  82 calling group.  \fBNOTE:\fR this requires substantial work
  83 to be sure that Asterisk's environment has permission to write
  84 the files required for its operation, including logs, its comm
  85 socket, the asterisk database, etc.
  86
  87 .IP "\-h" 10
  88 Provide brief summary of command line arguments and terminate.
  89
  90 .IP "\-i" 10
  91 Prompt user to intialize any encrypted private keys for IAX2
  92 secure authentication during startup.
  93
  94 .IP "\-I" 10
  95 Enable internal timing if DAHDI timing is available.
  96 The default behaviour is that outbound packets are phase locked
  97 to inbound packets. Enabling this switch causes them to be
  98 locked to the internal DAHDI timer instead.
  99
 100 .IP "\-L \fIloadaverage\fR" 10
 101 Limits the maximum load average before rejecting new calls.  This can
 102 be useful to prevent a system from being brought down by terminating
 103 too many simultaneous calls.
 104
 105 .IP "\-m" 10
 106 Temporarily mutes output to the console and logs.  To return to normal,
 107 use \fBlogger mute\fR.
 108
 109 .IP "\-M \fIvalue\fR" 10
 110 Limits the maximum number of calls to the specified value.  This can
 111 be useful to prevent a system from being brought down by terminating
 112 too many simultaneous calls.
 113
 114 .IP "\-n" 10
 115 Disable ANSI colors even on terminals capable of displaying them.
 116
 117 .IP "\-p" 10
 118 If supported by the operating system (and executing as root),
 119 attempt to run with realtime priority for increased performance and
 120 responsiveness within the Asterisk process, at the expense of other
 121 programs running on the same machine.
 122
 123 .IP "" 10
 124 Note: \fBastcanary\fR will run concurrently with
 125 \fBasterisk\fR. If \fBastcanary\fR stops
 126 running or is killed, \fBasterisk\fR will slow down to
 127 normal process priority, to avoid locking up the machine.
 128
 129 .IP "\-q" 10
 130 Reduce default console output when running in conjunction with
 131 console mode (\fB-c\fR).
 132
 133 .IP "\-r" 10
 134 Instead of running a new Asterisk process, attempt to connect
 135 to a running Asterisk process and provide a console interface
 136 for controlling it.
 137
 138 .IP "\-R" 10
 139 Much like \fB-r\fR.  Instead of running a new Asterisk process, attempt to connect
 140 to a running Asterisk process and provide a console interface
 141 for controlling it. Additionally, if connection to the Asterisk
 142 process is lost, attempt to reconnect for as long as 30 seconds.
 143
 144 .IP "\-s \fIsocket file name\fR" 10
 145 In combination with \fB-r\fR, connect directly to a specified
 146 Asterisk server socket.
 147
 148 .IP "\-t" 10
 149 When recording files, write them first into a temporary holding directory,
 150 then move them into the final location when done.
 151
 152 .IP "\-T" 10
 153 Add timestamp to all non-command related output going to the console
 154 when running with verbose and/or logging to the console.
 155
 156 .IP "\-U \fIuser\fR" 10
 157 Run as user \fIuser\fR instead of the
 158 calling user.  \fBNOTE:\fR this requires substantial work
 159 to be sure that Asterisk's environment has permission to write
 160 the files required for its operation, including logs, its comm
 161 socket, the asterisk database, etc.
 162
 163 .IP "\-v" 10
 164 Increase the level of verboseness on the console.  The more times
 165 \fB-v\fR is specified, the more verbose the output is.
 166 Specifying this option implies \fB-f\fR and will cause
 167 asterisk to no longer fork or detach from the controlling terminal.
 168 This option may also be used in conjunction with \fB-r\fR                       and \fB-R\fR.
 169
 170 .IP "" 10
 171 Note: This always sets the verbose level in the asterisk process,
 172 even if it is running in the background. This will affect the size
 173 of your log files.
 174
 175 .IP "\-V" 10
 176 Display version information and exit immediately.
 177
 178 .IP "\-W" 10
 179 Display colored terminal text as if the background were white
 180 or otherwise light in color.  Normally, terminal text is displayed
 181 as if the background were black or otherwise dark in color.
 182
 183 .IP "\-x \fIcommand\fR" 10
 184 Connect to a running Asterisk process and execute a command on
 185 a command line, passing any output through to standard out and
 186 then terminating when the command execution completes.  Implies
 187 \fB-r\fR when \fB-R\fR is not explicitly
 188 supplied.
 189
 190 .IP "\-X" 10
 191 Enables executing of includes via \fB#exec\fR directive.
 192 This can be useful if You want to do \fB#exec\fR inside
 193 \fBasterisk.conf\fP
 194 .SH "EXAMPLES"
 195
 196 .PP
 197 \fBasterisk\fR \- Begin Asterisk as a daemon
 198
 199 .PP
 200 \fBasterisk \-vvvgc\fR \- Run on controlling terminal
 201
 202 .PP
 203 \fBasterisk \-rx "core show channels"\fR \- Display channels on running server
 204
 205 .SH "BUGS"
 206
 207 .PP
 208 Bug reports and feature requests may be filed at https://issues.asterisk.org
 209
 210 .SH "SEE ALSO"
 211
 212 .PP
 213 *CLI \fBhelp\fR \- Help on Asterisk CLI
 214
 215 .PP
 216 *CLI \fBcore show applications\fR \- Show loaded dialplan applications
 217
 218 .PP
 219 *CLI \fBcore show functions\fR \- Show loaded dialplan functions
 220
 221 .PP
 222 *CLI \fBdialplan show\fR \- Show current dialplan
 223
 224 .PP
 225 http://www.asterisk.org \- The Asterisk Home Page
 226
 227 .PP
 228 http://www.asteriskdocs.org \- The Asterisk Documentation Project
 229
 230 .PP
 231 http://wiki.asterisk.org \- The Asterisk Wiki
 232
 233 .PP
 234 http://www.digium.com/ \- Asterisk sponsor and hardware supplier
 235
 236 .SH "AUTHOR"
 237
 238 .PP
 239 Mark Spencer markster@digium.com
 240
 241 .PP
 242 Countless other contributors, see CREDITS with distribution for more information.
 243
 244 =======
 245
 246 .SH "NAME"
 247 ,    \fBasterisk\fP      \fBasterisk\fP       \(em    All-purpose telephony server.
 248
 249
 250 .SH "SYNOPSIS"
 251
 252 .PP
 253 \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
 254
 255 .PP
 256 \fBasterisk \-r\fR    \fB-v\fP     \fB-d\fP     \fB-x \fP\fIcommand\fR
 257
 258 .PP
 259 \fBasterisk \-R\fR    \fB-v\fP     \fB-d\fP     \fB-x \fP\fIcommand\fR
 260
 261
 262 .SH "DESCRIPTION"
 263 2011-02-08;
 264 .PP
 265 \fBasterisk\fR is a full-featured telephony server which
 266 provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
 267 Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying,
 268 Conferencing, and a plethora of other telephony applications to a broad
 269 range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
 270 H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM
 271 hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
 272 ISDN BRI and many more.
 273
 274 .PP
 275 At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
 276 file and locates the rest of the configuration files from the configuration
 277 in that file. The \-C option specifies an alternate main configuration file.
 278 Virtually all aspects of the operation of asterisk's configuration files
 279 can be found in the sample configuration files.  The format for those files
 280 is generally beyond the scope of this man page.
 281
 282 .PP
 283 When running with \fB-c\fR, \fB-r\fR or \fB-R\fR    options, Asterisk supplies a powerful command line, including command
 284 completion, which may be used to monitors its status, perform a variety
 285 of administrative actions and even explore the applications that are
 286 currently loaded into the system.
 287
 288 .PP
 289 Asterisk is a trademark of Digium, Inc.
 290
 291
 292 .SH "OPTIONS"
 293
 294 .PP
 295 Running Asterisk starts the asterisk daemon (optionally running it
 296 in the foreground). However running it with \fB-r\fP or
 297 \fB-R\fP connects to an existing Asterisk instance through
 298 a remote console.
 299
 300 .IP "\-B" 10
 301 Force the background of the terminal to be black, in order for
 302 terminal colors to show up properly. Equivalent to
 303 \fBforceblackbackground = yes\fP in
 304 \fBasterisk.conf\fP. See also
 305 \fB-n\fP and \fB-W\fP.
 306
 307 .IP "\-C \fIfile\fR" 10
 308 Use \fBfile\fP as master configuration file
 309 instead of the default, /etc/asterisk/asterisk.conf
 310
 311 .IP "\-c" 10
 312 Provide a control console on the calling terminal. The
 313 console is similar to the remote console provided by
 314 \fB-r\fP. Specifying this option implies
 315 \fB-f\fR and will cause asterisk to no longer
 316 fork or detach from the controlling terminal. Equivalent
 317 to \fBconsole = yes\fP in \fBasterisk.conf\fP.
 318
 319 .IP "\-d" 10
 320 Enable extra debugging statements. This parameter may be used several
 321 times, and each increases the debug level.  Equivalent to \fBdebug = \fInum\fR\fP       in \fBasterisk.conf\fP to explicitly set the initian debug
 322 level to \fInum\fR. When given at startup, this
 323 option also implies \fB-f\fP (no forking). However when
 324 connecting to an existing Asterisk instance (\fB-r\fP or
 325 \fB-R\fP), it may only increase the debug level.
 326
 327 .IP "\-e \fImemory\fR" 10
 328 Limit the generation of new channels when the amount of free memory
 329 has decreased to under \fImemory\fR megabytes.
 330 Equivalent to \fBminmemfree = \fImemory\fR\fP in
 331 \fBasterisk.conf\fP.
 332
 333 .IP "\-f" 10
 334 Do not fork or detach from controlling terminal.  Overrides any
 335 preceding specification of \fB-F\fR on the command line.
 336 Equivalent to \fBnofork = yes\fP in \fBasterisk.conf\fP.
 337 See also \fB-c\fP.
 338
 339 .IP "\-F" 10
 340 Always fork and detach from controlling terminal.  Overrides any
 341 preceding specification of \fB-f\fR on the command line.
 342 May also be used to prevent \fB-d\fP and \fB-v\fP to imply
 343 no forking. Equivalent to \fBalwaysfork = yes\fP in \fBasterisk.conf\fP.
 344
 345 .IP "\-g" 10
 346 Remove resource limit on core size, thus forcing Asterisk to dump
 347 core in the unlikely event of a segmentation fault or abort signal.
 348 \fBNOTE:\fR in some cases this may be incompatible
 349 with the \fB-U\fR or \fB-G\fR flags.
 350
 351 .IP "\-G \fIgroup\fR" 10
 352 Run as group \fIgroup\fR instead of the
 353 calling group.  \fBNOTE:\fR this requires substantial work
 354 to be sure that Asterisk's environment has permission to write
 355 the files required for its operation, including logs, its comm
 356 socket, the asterisk database, etc.
 357
 358 .IP "\-h" 10
 359 Provide brief summary of command line arguments and terminate.
 360
 361 .IP "\-i" 10
 362 Prompt user to intialize any encrypted private keys for IAX2
 363 secure authentication during startup.
 364
 365 .IP "\-I" 10
 366 Enable internal timing if DAHDI timing is available.
 367 The default behaviour is that outbound packets are phase locked
 368 to inbound packets. Enabling this switch causes them to be
 369 locked to the internal DAHDI timer instead.
 370
 371 .IP "\-L \fIloadaverage\fR" 10
 372 Limits the maximum load average before rejecting new calls.  This can
 373 be useful to prevent a system from being brought down by terminating
 374 too many simultaneous calls.
 375
 376 .IP "\-m" 10
 377 Temporarily mutes output to the console and logs.  To return to normal,
 378 use \fBlogger mute\fR.
 379
 380 .IP "\-M \fIvalue\fR" 10
 381 Limits the maximum number of calls to the specified value.  This can
 382 be useful to prevent a system from being brought down by terminating
 383 too many simultaneous calls.
 384
 385 .IP "\-n" 10
 386 Disable ANSI colors even on terminals capable of displaying them.
 387
 388 .IP "\-p" 10
 389 If supported by the operating system (and executing as root),
 390 attempt to run with realtime priority for increased performance and
 391 responsiveness within the Asterisk process, at the expense of other
 392 programs running on the same machine.
 393
 394 .IP "" 10
 395 Note: \fBastcanary\fR will run concurrently with
 396 \fBasterisk\fR. If \fBastcanary\fR stops
 397 running or is killed, \fBasterisk\fR will slow down to
 398 normal process priority, to avoid locking up the machine.
 399
 400 .IP "\-q" 10
 401 Reduce default console output when running in conjunction with
 402 console mode (\fB-c\fR).
 403
 404 .IP "\-r" 10
 405 Instead of running a new Asterisk process, attempt to connect
 406 to a running Asterisk process and provide a console interface
 407 for controlling it.
 408
 409 .IP "\-R" 10
 410 Much like \fB-r\fR.  Instead of running a new Asterisk process, attempt to connect
 411 to a running Asterisk process and provide a console interface
 412 for controlling it. Additionally, if connection to the Asterisk
 413 process is lost, attempt to reconnect for as long as 30 seconds.
 414
 415 .IP "\-s \fIsocket file name\fR" 10
 416 In combination with \fB-r\fR, connect directly to a specified
 417 Asterisk server socket.
 418
 419 .IP "\-t" 10
 420 When recording files, write them first into a temporary holding directory,
 421 then move them into the final location when done.
 422
 423 .IP "\-T" 10
 424 Add timestamp to all non-command related output going to the console
 425 when running with verbose and/or logging to the console.
 426
 427 .IP "\-U \fIuser\fR" 10
 428 Run as user \fIuser\fR instead of the
 429 calling user.  \fBNOTE:\fR this requires substantial work
 430 to be sure that Asterisk's environment has permission to write
 431 the files required for its operation, including logs, its comm
 432 socket, the asterisk database, etc.
 433
 434 .IP "\-v" 10
 435 Increase the level of verboseness on the console.  The more times
 436 \fB-v\fR is specified, the more verbose the output is.
 437 Specifying this option implies \fB-f\fR and will cause
 438 asterisk to no longer fork or detach from the controlling terminal.
 439 This option may also be used in conjunction with \fB-r\fR       and \fB-R\fR.
 440
 441 .IP "" 10
 442 Note: This always sets the verbose level in the asterisk process,
 443 even if it is running in the background. This will affect the size
 444 of your log files.
 445
 446 .IP "\-V" 10
 447 Display version information and exit immediately.
 448
 449 .IP "\-W" 10
 450 Display colored terminal text as if the background were white
 451 or otherwise light in color.  Normally, terminal text is displayed
 452 as if the background were black or otherwise dark in color.
 453
 454 .IP "\-x \fIcommand\fR" 10
 455 Connect to a running Asterisk process and execute a command on
 456 a command line, passing any output through to standard out and
 457 then terminating when the command execution completes.  Implies
 458 \fB-r\fR when \fB-R\fR is not explicitly
 459 supplied.
 460
 461 .IP "\-X" 10
 462 Enables executing of includes via \fB#exec\fR directive.
 463 This can be useful if You want to do \fB#exec\fR inside
 464 \fBasterisk.conf\fP
 465
 466 .SH "EXAMPLES"
 467
 468 .PP
 469 \fBasterisk\fR \- Begin Asterisk as a daemon
 470
 471 .PP
 472 \fBasterisk \-vvvgc\fR \- Run on controlling terminal
 473
 474 .PP
 475 \fBasterisk \-rx "core show channels"\fR \- Display channels on running server
 476
 477
 478 .SH "BUGS"
 479
 480 .PP
 481 Bug reports and feature requests may be filed at https://issues.asterisk.org
 482
 483
 484 .SH "SEE ALSO"
 485
 486 .PP
 487 http://www.asterisk.org \- The Asterisk Home Page
 488
 489 .PP
 490 http://www.asteriskdocs.org \- The Asterisk Documentation Project
 491
 492 .PP
 493 http://wiki.asterisk.org \- The Asterisk Wiki
 494
 495 .PP
 496 http://www.digium.com/ \- Asterisk is sponsored by Digium
 497
 498
 499 .SH "AUTHOR"
 500
 501 .PP
 502 Mark Spencer markster@digium.com
 503
 504 .PP
 505 Countless other contributors, see CREDITS with distribution for more information.
 506
 507 >>>>>>> .merge-right.r306999
 508 .\" created by instant / docbook-to-man, Tue 08 Feb 2011, 17:30