asterisk.sgml 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885
  1. <refentry>
  2. <<<<<<< .working
  3. <refentryinfo>
  4. <date>2011-02-08</date>
  5. </refentryinfo>
  6. <refmeta>
  7. <refentrytitle>
  8. <application>asterisk</application>
  9. </refentrytitle>
  10. <manvolnum>8</manvolnum>
  11. <refmiscinfo>asterisk Trunk</refmiscinfo>
  12. </refmeta>
  13. <refnamediv>
  14. <refname>
  15. <application>asterisk</application>
  16. </refname>
  17. <refpurpose>
  18. All-purpose telephony server.
  19. </refpurpose>
  20. </refnamediv>
  21. <refsynopsisdiv>
  22. <cmdsynopsis>
  23. <command>asterisk</command>
  24. <arg><option>-BcdfFghiImnpqRtTvVW</option></arg>
  25. <arg><option>-C </option><replaceable class="parameter">file</replaceable></arg>
  26. <arg><option>-e </option><replaceable class="parameter">memory</replaceable></arg>
  27. <arg><option>-G </option><replaceable class="parameter">group</replaceable></arg>
  28. <arg><option>-L </option><replaceable class="parameter">loadaverage</replaceable></arg>
  29. <arg><option>-M </option><replaceable class="parameter">value</replaceable></arg>
  30. <arg><option>-U </option><replaceable class="parameter">user</replaceable></arg>
  31. <arg><option>-s </option><replaceable class="parameter">socket-file</replaceable></arg>
  32. <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
  33. </cmdsynopsis>
  34. <cmdsynopsis>
  35. <command>asterisk -r</command>
  36. <arg><option>-v</option></arg>
  37. <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
  38. </cmdsynopsis>
  39. </refsynopsisdiv>
  40. <refsect1>
  41. <refsect1info>
  42. <date>2011-02-08</date>
  43. </refsect1info>
  44. <title>DESCRIPTION</title>
  45. <para>
  46. <command>asterisk</command> is a full-featured telephony server which
  47. provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
  48. Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying,
  49. Conferencing, and a plethora of other telephony applications to a broad
  50. range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
  51. H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM
  52. hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
  53. ISDN BRI and many more.
  54. </para>
  55. <para>
  56. At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
  57. file and locates the rest of the configuration files from the configuration
  58. in that file. The -C option specifies an alternate main configuration file.
  59. Virtually all aspects of the operation of asterisk's configuration files
  60. can be found in the sample configuration files. The format for those files
  61. is generally beyond the scope of this man page.
  62. </para>
  63. <para>
  64. When running with <command>-c</command>, <command>-r</command> or <command>-R</command>
  65. options, Asterisk supplies a powerful command line, including command
  66. completion, which may be used to monitors its status, perform a variety
  67. of administrative actions and even explore the applications that are
  68. currently loaded into the system.
  69. </para>
  70. <para>
  71. Asterisk is a trademark of Digium, Inc.
  72. </para>
  73. </refsect1>
  74. <refsect1>
  75. <title>OPTIONS</title>
  76. <variablelist>
  77. <varlistentry>
  78. <term>-B</term>
  79. <listitem>
  80. <para>
  81. Force the background of the terminal to be black, in order for
  82. terminal colors to show up properly.
  83. </para>
  84. </listitem>
  85. </varlistentry>
  86. <varlistentry>
  87. <term>-C <replaceable class="parameter">file</replaceable></term>
  88. <listitem>
  89. <para>
  90. Use <filename>file</filename> as master configuration file
  91. instead of the default, /etc/asterisk/asterisk.conf
  92. </para>
  93. </listitem>
  94. </varlistentry>
  95. <varlistentry>
  96. <term>-c</term>
  97. <listitem>
  98. <para>
  99. Provide a control console on the calling terminal.
  100. Specifying this option implies <command>-f</command> and will cause
  101. asterisk to no longer fork or detach from the controlling terminal.
  102. </para>
  103. </listitem>
  104. </varlistentry>
  105. <varlistentry>
  106. <term>-d</term>
  107. <listitem>
  108. <para>
  109. Enable extra debugging statements.
  110. </para>
  111. <para>
  112. Note: This always sets the debug level in the asterisk process,
  113. even if it is running in the background. This may affect the size
  114. of your log files, if the debug level is specified in logger.conf.
  115. </para>
  116. </listitem>
  117. </varlistentry>
  118. <varlistentry>
  119. <term>-e <replaceable class="parameter">memory</replaceable></term>
  120. <listitem>
  121. <para>
  122. Limit the generation of new channels when the amount of free memory has decreased to under <replaceable>memory</replaceable> megabytes.
  123. </para>
  124. </listitem>
  125. </varlistentry>
  126. <varlistentry>
  127. <term>-f</term>
  128. <listitem>
  129. <para>
  130. Do not fork or detach from controlling terminal. Overrides any preceding specification of <command>-F</command> on the command line.
  131. </para>
  132. </listitem>
  133. </varlistentry>
  134. <varlistentry>
  135. <term>-F</term>
  136. <listitem>
  137. <para>
  138. Always fork and detach from controlling terminal. Overrides any preceding specification of <command>-f</command> on the command line.
  139. </para>
  140. </listitem>
  141. </varlistentry>
  142. <varlistentry>
  143. <term>-g</term>
  144. <listitem>
  145. <para>
  146. Remove resource limit on core size, thus forcing Asterisk to dump
  147. core in the unlikely event of a segmentation fault or abort signal.
  148. <command>NOTE:</command> in some cases this may be incompatible
  149. with the <command>-U</command> or <command>-G</command> flags.
  150. </para>
  151. </listitem>
  152. </varlistentry>
  153. <varlistentry>
  154. <term>-G <replaceable class="parameter">group</replaceable></term>
  155. <listitem>
  156. <para>
  157. Run as group <replaceable>group</replaceable> instead of the
  158. calling group. <command>NOTE:</command> 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. </para>
  163. </listitem>
  164. </varlistentry>
  165. <varlistentry>
  166. <term>-h</term>
  167. <listitem>
  168. <para>
  169. Provide brief summary of command line arguments and terminate.
  170. </para>
  171. </listitem>
  172. </varlistentry>
  173. <varlistentry>
  174. <term>-i</term>
  175. <listitem>
  176. <para>
  177. Prompt user to intialize any encrypted private keys for IAX2
  178. secure authentication during startup.
  179. </para>
  180. </listitem>
  181. </varlistentry>
  182. <varlistentry>
  183. <term>-I</term>
  184. <listitem>
  185. <para>
  186. Enable internal timing if DAHDI timing is available.
  187. The default behaviour is that outbound packets are phase locked
  188. to inbound packets. Enabling this switch causes them to be
  189. locked to the internal DAHDI timer instead.
  190. </para>
  191. </listitem>
  192. </varlistentry>
  193. <varlistentry>
  194. <term>-L <replaceable class="parameter">loadaverage</replaceable></term>
  195. <listitem>
  196. <para>
  197. Limits the maximum load average before rejecting new calls. This can
  198. be useful to prevent a system from being brought down by terminating
  199. too many simultaneous calls.
  200. </para>
  201. </listitem>
  202. </varlistentry>
  203. <varlistentry>
  204. <term>-m</term>
  205. <listitem>
  206. <para>
  207. Temporarily mutes output to the console and logs. To return to normal,
  208. use <command>logger mute</command>.
  209. </para>
  210. </listitem>
  211. </varlistentry>
  212. <varlistentry>
  213. <term>-M <replaceable class="parameter">value</replaceable></term>
  214. <listitem>
  215. <para>
  216. Limits the maximum number of calls to the specified value. This can
  217. be useful to prevent a system from being brought down by terminating
  218. too many simultaneous calls.
  219. </para>
  220. </listitem>
  221. </varlistentry>
  222. <varlistentry>
  223. <term>-n</term>
  224. <listitem>
  225. <para>
  226. Disable ANSI colors even on terminals capable of displaying them.
  227. </para>
  228. </listitem>
  229. </varlistentry>
  230. <varlistentry>
  231. <term>-p</term>
  232. <listitem>
  233. <para>
  234. If supported by the operating system (and executing as root),
  235. attempt to run with realtime priority for increased performance and
  236. responsiveness within the Asterisk process, at the expense of other
  237. programs running on the same machine.
  238. </para>
  239. <para>
  240. Note: <command>astcanary</command> will run concurrently with
  241. <command>asterisk</command>. If <command>astcanary</command> stops
  242. running or is killed, <command>asterisk</command> will slow down to
  243. normal process priority, to avoid locking up the machine.
  244. </para>
  245. </listitem>
  246. </varlistentry>
  247. <varlistentry>
  248. <term>-q</term>
  249. <listitem>
  250. <para>
  251. Reduce default console output when running in conjunction with
  252. console mode (<command>-c</command>).
  253. </para>
  254. </listitem>
  255. </varlistentry>
  256. <varlistentry>
  257. <term>-r</term>
  258. <listitem>
  259. <para>
  260. Instead of running a new Asterisk process, attempt to connect
  261. to a running Asterisk process and provide a console interface
  262. for controlling it.
  263. </para>
  264. </listitem>
  265. </varlistentry>
  266. <varlistentry>
  267. <term>-R</term>
  268. <listitem>
  269. <para>
  270. Much like <command>-r</command>. Instead of running a new Asterisk process, attempt to connect
  271. to a running Asterisk process and provide a console interface
  272. for controlling it. Additionally, if connection to the Asterisk
  273. process is lost, attempt to reconnect for as long as 30 seconds.
  274. </para>
  275. </listitem>
  276. </varlistentry>
  277. <varlistentry>
  278. <term>-s <replaceable class="parameter">socket file name</replaceable></term>
  279. <listitem>
  280. <para>
  281. In combination with <command>-r</command>, connect directly to a specified
  282. Asterisk server socket.
  283. </para>
  284. </listitem>
  285. </varlistentry>
  286. <varlistentry>
  287. <term>-t</term>
  288. <listitem>
  289. <para>
  290. When recording files, write them first into a temporary holding directory,
  291. then move them into the final location when done.
  292. </para>
  293. </listitem>
  294. </varlistentry>
  295. <varlistentry>
  296. <term>-T</term>
  297. <listitem>
  298. <para>
  299. Add timestamp to all non-command related output going to the console
  300. when running with verbose and/or logging to the console.
  301. </para>
  302. </listitem>
  303. </varlistentry>
  304. <varlistentry>
  305. <term>-U <replaceable class="parameter">user</replaceable></term>
  306. <listitem>
  307. <para>
  308. Run as user <replaceable>user</replaceable> instead of the
  309. calling user. <command>NOTE:</command> this requires substantial work
  310. to be sure that Asterisk's environment has permission to write
  311. the files required for its operation, including logs, its comm
  312. socket, the asterisk database, etc.
  313. </para>
  314. </listitem>
  315. </varlistentry>
  316. <varlistentry>
  317. <term>-v</term>
  318. <listitem>
  319. <para>
  320. Increase the level of verboseness on the console. The more times
  321. <command>-v</command> is specified, the more verbose the output is.
  322. Specifying this option implies <command>-f</command> and will cause
  323. asterisk to no longer fork or detach from the controlling terminal.
  324. This option may also be used in conjunction with <command>-r</command>
  325. and <command>-R</command>.
  326. </para>
  327. <para>
  328. Note: This always sets the verbose level in the asterisk process,
  329. even if it is running in the background. This will affect the size
  330. of your log files.
  331. </para>
  332. </listitem>
  333. </varlistentry>
  334. <varlistentry>
  335. <term>-V</term>
  336. <listitem>
  337. <para>
  338. Display version information and exit immediately.
  339. </para>
  340. </listitem>
  341. </varlistentry>
  342. <varlistentry>
  343. <term>-W</term>
  344. <listitem>
  345. <para>
  346. Display colored terminal text as if the background were white
  347. or otherwise light in color. Normally, terminal text is displayed
  348. as if the background were black or otherwise dark in color.
  349. </para>
  350. </listitem>
  351. </varlistentry>
  352. <varlistentry>
  353. <term>-x <replaceable class="parameter">command</replaceable></term>
  354. <listitem>
  355. <para>
  356. Connect to a running Asterisk process and execute a command on
  357. a command line, passing any output through to standard out and
  358. then terminating when the command execution completes. Implies
  359. <command>-r</command> when <command>-R</command> is not explicitly
  360. supplied.
  361. </para>
  362. </listitem>
  363. </varlistentry>
  364. <varlistentry>
  365. <term>-X</term>
  366. <listitem>
  367. <para>
  368. Enables executing of includes via <command>#exec</command> directive.
  369. This can be useful if You want to do <command>#exec</command> inside
  370. <filename>asterisk.conf</filename>
  371. </para>
  372. </listitem>
  373. </varlistentry>
  374. </variablelist>
  375. </refsect1>
  376. <refsect1>
  377. <title>EXAMPLES</title>
  378. <para>
  379. <command>asterisk</command> - Begin Asterisk as a daemon
  380. </para>
  381. <para>
  382. <command>asterisk -vvvgc</command> - Run on controlling terminal
  383. </para>
  384. <para>
  385. <command>asterisk -rx "core show channels"</command> - Display channels on running server
  386. </para>
  387. </refsect1>
  388. <refsect1>
  389. <title>BUGS</title>
  390. <para>
  391. Bug reports and feature requests may be filed at https://issues.asterisk.org
  392. </para>
  393. </refsect1>
  394. <refsect1>
  395. <title>SEE ALSO</title>
  396. <para>
  397. *CLI&gt; <command>help</command> - Help on Asterisk CLI
  398. </para>
  399. <para>
  400. *CLI&gt; <command>core show applications</command> - Show loaded dialplan applications
  401. </para>
  402. <para>
  403. *CLI&gt; <command>core show functions</command> - Show loaded dialplan functions
  404. </para>
  405. <para>
  406. *CLI&gt; <command>dialplan show</command> - Show current dialplan
  407. </para>
  408. <para>
  409. http://www.asterisk.org - The Asterisk Home Page
  410. </para>
  411. <para>
  412. http://www.asteriskdocs.org - The Asterisk Documentation Project
  413. </para>
  414. <para>
  415. http://wiki.asterisk.org - The Asterisk Wiki
  416. </para>
  417. <para>
  418. http://www.digium.com/ - Asterisk sponsor and hardware supplier
  419. </para>
  420. </refsect1>
  421. <refsect1>
  422. <title>AUTHOR</title>
  423. <para>
  424. <author>
  425. <firstname>Mark Spencer &lt;markster@digium.com&gt;</firstname>
  426. </author>
  427. </para>
  428. <para>
  429. <author>
  430. <firstname>Countless other contributors, see CREDITS with distribution for more information.</firstname>
  431. </author>
  432. </para>
  433. </refsect1>
  434. =======
  435. <refentryinfo>
  436. <date>2011-02-08</date>
  437. </refentryinfo>
  438. <refmeta>
  439. <refentrytitle>
  440. <application>asterisk</application>
  441. </refentrytitle>
  442. <manvolnum>8</manvolnum>
  443. <refmiscinfo>asterisk 1.8</refmiscinfo>
  444. </refmeta>
  445. <refnamediv>
  446. <refname>
  447. <application>asterisk</application>
  448. </refname>
  449. <refpurpose>
  450. All-purpose telephony server.
  451. </refpurpose>
  452. </refnamediv>
  453. <refsynopsisdiv>
  454. <cmdsynopsis>
  455. <command>asterisk</command>
  456. <arg><option>-BcdfFghiImnpqRtTvVW</option></arg>
  457. <arg><option>-C </option><replaceable class="parameter">file</replaceable></arg>
  458. <arg><option>-e </option><replaceable class="parameter">memory</replaceable></arg>
  459. <arg><option>-G </option><replaceable class="parameter">group</replaceable></arg>
  460. <arg><option>-L </option><replaceable class="parameter">loadaverage</replaceable></arg>
  461. <arg><option>-M </option><replaceable class="parameter">value</replaceable></arg>
  462. <arg><option>-U </option><replaceable class="parameter">user</replaceable></arg>
  463. <arg><option>-s </option><replaceable class="parameter">socket-file</replaceable></arg>
  464. </cmdsynopsis>
  465. <cmdsynopsis>
  466. <command>asterisk -r</command>
  467. <arg><option>-v</option></arg>
  468. <arg><option>-d</option></arg>
  469. <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
  470. </cmdsynopsis>
  471. <cmdsynopsis>
  472. <command>asterisk -R</command>
  473. <arg><option>-v</option></arg>
  474. <arg><option>-d</option></arg>
  475. <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
  476. </cmdsynopsis>
  477. </refsynopsisdiv>
  478. <refsect1>
  479. <refsect1info>
  480. <date>2011-02-08</date>
  481. </refsect1info>
  482. <title>DESCRIPTION</title>
  483. <para>
  484. <command>asterisk</command> is a full-featured telephony server which
  485. provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
  486. Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying,
  487. Conferencing, and a plethora of other telephony applications to a broad
  488. range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
  489. H.323, Unistim) devices (both endpoints and proxies), as well as traditional TDM
  490. hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
  491. ISDN BRI and many more.
  492. </para>
  493. <para>
  494. At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
  495. file and locates the rest of the configuration files from the configuration
  496. in that file. The -C option specifies an alternate main configuration file.
  497. Virtually all aspects of the operation of asterisk's configuration files
  498. can be found in the sample configuration files. The format for those files
  499. is generally beyond the scope of this man page.
  500. </para>
  501. <para>
  502. When running with <command>-c</command>, <command>-r</command> or <command>-R</command>
  503. options, Asterisk supplies a powerful command line, including command
  504. completion, which may be used to monitors its status, perform a variety
  505. of administrative actions and even explore the applications that are
  506. currently loaded into the system.
  507. </para>
  508. <para>
  509. Asterisk is a trademark of Digium, Inc.
  510. </para>
  511. </refsect1>
  512. <refsect1>
  513. <title>OPTIONS</title>
  514. <para>
  515. Running Asterisk starts the asterisk daemon (optionally running it
  516. in the foreground). However running it with <option>-r</option> or
  517. <option>-R</option> connects to an existing Asterisk instance through
  518. a remote console.
  519. </para>
  520. <variablelist>
  521. <varlistentry>
  522. <term>-B</term>
  523. <listitem>
  524. <para>
  525. Force the background of the terminal to be black, in order for
  526. terminal colors to show up properly. Equivalent to
  527. <option>forceblackbackground = yes</option> in
  528. <filename>asterisk.conf</filename>. See also
  529. <option>-n</option> and <option>-W</option>.
  530. </para>
  531. </listitem>
  532. </varlistentry>
  533. <varlistentry>
  534. <term>-C <replaceable class="parameter">file</replaceable></term>
  535. <listitem>
  536. <para>
  537. Use <filename>file</filename> as master configuration file
  538. instead of the default, /etc/asterisk/asterisk.conf
  539. </para>
  540. </listitem>
  541. </varlistentry>
  542. <varlistentry>
  543. <term>-c</term>
  544. <listitem>
  545. <para>
  546. Provide a control console on the calling terminal. The
  547. console is similar to the remote console provided by
  548. <option>-r</option>. Specifying this option implies
  549. <command>-f</command> and will cause asterisk to no longer
  550. fork or detach from the controlling terminal. Equivalent
  551. to <option>console = yes</option> in <filename>asterisk.conf</filename>.
  552. </para>
  553. </listitem>
  554. </varlistentry>
  555. <varlistentry>
  556. <term>-d</term>
  557. <listitem>
  558. <para>
  559. Enable extra debugging statements. This parameter may be used several
  560. times, and each increases the debug level. Equivalent to <option>debug = <replaceable>num</replaceable></option>
  561. in <filename>asterisk.conf</filename> to explicitly set the initian debug
  562. level to <replaceable>num</replaceable>. When given at startup, this
  563. option also implies <option>-f</option> (no forking). However when
  564. connecting to an existing Asterisk instance (<option>-r</option> or
  565. <option>-R</option>), it may only increase the debug level.
  566. </para>
  567. </listitem>
  568. </varlistentry>
  569. <varlistentry>
  570. <term>-e <replaceable class="parameter">memory</replaceable></term>
  571. <listitem>
  572. <para>
  573. Limit the generation of new channels when the amount of free memory
  574. has decreased to under <replaceable>memory</replaceable> megabytes.
  575. Equivalent to <option>minmemfree = <replaceable>memory</replaceable></option> in
  576. <filename>asterisk.conf</filename>.
  577. </para>
  578. </listitem>
  579. </varlistentry>
  580. <varlistentry>
  581. <term>-f</term>
  582. <listitem>
  583. <para>
  584. Do not fork or detach from controlling terminal. Overrides any
  585. preceding specification of <command>-F</command> on the command line.
  586. Equivalent to <option>nofork = yes</option> in <filename>asterisk.conf</filename>.
  587. See also <option>-c</option>.
  588. </para>
  589. </listitem>
  590. </varlistentry>
  591. <varlistentry>
  592. <term>-F</term>
  593. <listitem>
  594. <para>
  595. Always fork and detach from controlling terminal. Overrides any
  596. preceding specification of <command>-f</command> on the command line.
  597. May also be used to prevent <option>-d</option> and <option>-v</option> to imply
  598. no forking. Equivalent to <option>alwaysfork = yes</option> in <filename>asterisk.conf</filename>.
  599. </para>
  600. </listitem>
  601. </varlistentry>
  602. <varlistentry>
  603. <term>-g</term>
  604. <listitem>
  605. <para>
  606. Remove resource limit on core size, thus forcing Asterisk to dump
  607. core in the unlikely event of a segmentation fault or abort signal.
  608. <command>NOTE:</command> in some cases this may be incompatible
  609. with the <command>-U</command> or <command>-G</command> flags.
  610. </para>
  611. </listitem>
  612. </varlistentry>
  613. <varlistentry>
  614. <term>-G <replaceable class="parameter">group</replaceable></term>
  615. <listitem>
  616. <para>
  617. Run as group <replaceable>group</replaceable> instead of the
  618. calling group. <command>NOTE:</command> this requires substantial work
  619. to be sure that Asterisk's environment has permission to write
  620. the files required for its operation, including logs, its comm
  621. socket, the asterisk database, etc.
  622. </para>
  623. </listitem>
  624. </varlistentry>
  625. <varlistentry>
  626. <term>-h</term>
  627. <listitem>
  628. <para>
  629. Provide brief summary of command line arguments and terminate.
  630. </para>
  631. </listitem>
  632. </varlistentry>
  633. <varlistentry>
  634. <term>-i</term>
  635. <listitem>
  636. <para>
  637. Prompt user to intialize any encrypted private keys for IAX2
  638. secure authentication during startup.
  639. </para>
  640. </listitem>
  641. </varlistentry>
  642. <varlistentry>
  643. <term>-I</term>
  644. <listitem>
  645. <para>
  646. Enable internal timing if DAHDI timing is available.
  647. The default behaviour is that outbound packets are phase locked
  648. to inbound packets. Enabling this switch causes them to be
  649. locked to the internal DAHDI timer instead.
  650. </para>
  651. </listitem>
  652. </varlistentry>
  653. <varlistentry>
  654. <term>-L <replaceable class="parameter">loadaverage</replaceable></term>
  655. <listitem>
  656. <para>
  657. Limits the maximum load average before rejecting new calls. This can
  658. be useful to prevent a system from being brought down by terminating
  659. too many simultaneous calls.
  660. </para>
  661. </listitem>
  662. </varlistentry>
  663. <varlistentry>
  664. <term>-m</term>
  665. <listitem>
  666. <para>
  667. Temporarily mutes output to the console and logs. To return to normal,
  668. use <command>logger mute</command>.
  669. </para>
  670. </listitem>
  671. </varlistentry>
  672. <varlistentry>
  673. <term>-M <replaceable class="parameter">value</replaceable></term>
  674. <listitem>
  675. <para>
  676. Limits the maximum number of calls to the specified value. This can
  677. be useful to prevent a system from being brought down by terminating
  678. too many simultaneous calls.
  679. </para>
  680. </listitem>
  681. </varlistentry>
  682. <varlistentry>
  683. <term>-n</term>
  684. <listitem>
  685. <para>
  686. Disable ANSI colors even on terminals capable of displaying them.
  687. </para>
  688. </listitem>
  689. </varlistentry>
  690. <varlistentry>
  691. <term>-p</term>
  692. <listitem>
  693. <para>
  694. If supported by the operating system (and executing as root),
  695. attempt to run with realtime priority for increased performance and
  696. responsiveness within the Asterisk process, at the expense of other
  697. programs running on the same machine.
  698. </para>
  699. <para>
  700. Note: <command>astcanary</command> will run concurrently with
  701. <command>asterisk</command>. If <command>astcanary</command> stops
  702. running or is killed, <command>asterisk</command> will slow down to
  703. normal process priority, to avoid locking up the machine.
  704. </para>
  705. </listitem>
  706. </varlistentry>
  707. <varlistentry>
  708. <term>-q</term>
  709. <listitem>
  710. <para>
  711. Reduce default console output when running in conjunction with
  712. console mode (<command>-c</command>).
  713. </para>
  714. </listitem>
  715. </varlistentry>
  716. <varlistentry>
  717. <term>-r</term>
  718. <listitem>
  719. <para>
  720. Instead of running a new Asterisk process, attempt to connect
  721. to a running Asterisk process and provide a console interface
  722. for controlling it.
  723. </para>
  724. </listitem>
  725. </varlistentry>
  726. <varlistentry>
  727. <term>-R</term>
  728. <listitem>
  729. <para>
  730. Much like <command>-r</command>. Instead of running a new Asterisk process, attempt to connect
  731. to a running Asterisk process and provide a console interface
  732. for controlling it. Additionally, if connection to the Asterisk
  733. process is lost, attempt to reconnect for as long as 30 seconds.
  734. </para>
  735. </listitem>
  736. </varlistentry>
  737. <varlistentry>
  738. <term>-s <replaceable class="parameter">socket file name</replaceable></term>
  739. <listitem>
  740. <para>
  741. In combination with <command>-r</command>, connect directly to a specified
  742. Asterisk server socket.
  743. </para>
  744. </listitem>
  745. </varlistentry>
  746. <varlistentry>
  747. <term>-t</term>
  748. <listitem>
  749. <para>
  750. When recording files, write them first into a temporary holding directory,
  751. then move them into the final location when done.
  752. </para>
  753. </listitem>
  754. </varlistentry>
  755. <varlistentry>
  756. <term>-T</term>
  757. <listitem>
  758. <para>
  759. Add timestamp to all non-command related output going to the console
  760. when running with verbose and/or logging to the console.
  761. </para>
  762. </listitem>
  763. </varlistentry>
  764. <varlistentry>
  765. <term>-U <replaceable class="parameter">user</replaceable></term>
  766. <listitem>
  767. <para>
  768. Run as user <replaceable>user</replaceable> instead of the
  769. calling user. <command>NOTE:</command> this requires substantial work
  770. to be sure that Asterisk's environment has permission to write
  771. the files required for its operation, including logs, its comm
  772. socket, the asterisk database, etc.
  773. </para>
  774. </listitem>
  775. </varlistentry>
  776. <varlistentry>
  777. <term>-v</term>
  778. <listitem>
  779. <para>
  780. Increase the level of verboseness on the console. The more times
  781. <command>-v</command> is specified, the more verbose the output is.
  782. Specifying this option implies <command>-f</command> and will cause
  783. asterisk to no longer fork or detach from the controlling terminal.
  784. This option may also be used in conjunction with <command>-r</command>
  785. and <command>-R</command>.
  786. </para>
  787. <para>
  788. Note: This always sets the verbose level in the asterisk process,
  789. even if it is running in the background. This will affect the size
  790. of your log files.
  791. </para>
  792. </listitem>
  793. </varlistentry>
  794. <varlistentry>
  795. <term>-V</term>
  796. <listitem>
  797. <para>
  798. Display version information and exit immediately.
  799. </para>
  800. </listitem>
  801. </varlistentry>
  802. <varlistentry>
  803. <term>-W</term>
  804. <listitem>
  805. <para>
  806. Display colored terminal text as if the background were white
  807. or otherwise light in color. Normally, terminal text is displayed
  808. as if the background were black or otherwise dark in color.
  809. </para>
  810. </listitem>
  811. </varlistentry>
  812. <varlistentry>
  813. <term>-x <replaceable class="parameter">command</replaceable></term>
  814. <listitem>
  815. <para>
  816. Connect to a running Asterisk process and execute a command on
  817. a command line, passing any output through to standard out and
  818. then terminating when the command execution completes. Implies
  819. <command>-r</command> when <command>-R</command> is not explicitly
  820. supplied.
  821. </para>
  822. </listitem>
  823. </varlistentry>
  824. <varlistentry>
  825. <term>-X</term>
  826. <listitem>
  827. <para>
  828. Enables executing of includes via <command>#exec</command> directive.
  829. This can be useful if You want to do <command>#exec</command> inside
  830. <filename>asterisk.conf</filename>
  831. </para>
  832. </listitem>
  833. </varlistentry>
  834. </variablelist>
  835. </refsect1>
  836. <refsect1>
  837. <title>EXAMPLES</title>
  838. <para>
  839. <command>asterisk</command> - Begin Asterisk as a daemon
  840. </para>
  841. <para>
  842. <command>asterisk -vvvgc</command> - Run on controlling terminal
  843. </para>
  844. <para>
  845. <command>asterisk -rx "core show channels"</command> - Display channels on running server
  846. </para>
  847. </refsect1>
  848. <refsect1>
  849. <title>BUGS</title>
  850. <para>
  851. Bug reports and feature requests may be filed at https://issues.asterisk.org
  852. </para>
  853. </refsect1>
  854. <refsect1>
  855. <title>SEE ALSO</title>
  856. <para>
  857. http://www.asterisk.org - The Asterisk Home Page
  858. </para>
  859. <para>
  860. http://www.asteriskdocs.org - The Asterisk Documentation Project
  861. </para>
  862. <para>
  863. http://wiki.asterisk.org - The Asterisk Wiki
  864. </para>
  865. <para>
  866. http://www.digium.com/ - Asterisk is sponsored by Digium
  867. </para>
  868. </refsect1>
  869. <refsect1>
  870. <title>AUTHOR</title>
  871. <para>
  872. <author>
  873. <firstname>Mark Spencer &lt;markster@digium.com&gt;</firstname>
  874. </author>
  875. </para>
  876. <para>
  877. <author>
  878. <firstname>Countless other contributors, see CREDITS with distribution for more information.</firstname>
  879. </author>
  880. </para>
  881. </refsect1>
  882. >>>>>>> .merge-right.r306999
  883. </refentry>