Issue #5637 - Realtime driver for PostgreSQL (mguesdon)
[asterisk/asterisk.git] / asterisk.sgml
old mode 100755 (executable)
new mode 100644 (file)
index fb569d5..ff257ff
@@ -1,14 +1,14 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
 <refentry>
 <refentryinfo>
-       <date>2004-07-18</date>
+       <date>2005-10-18</date>
 </refentryinfo>
 <refmeta>
        <refentrytitle>
                <application>asterisk</application>
        </refentrytitle>
        <manvolnum>8</manvolnum>
-       <refmiscinfo>asterisk 1.0</refmiscinfo>
+       <refmiscinfo>asterisk 1.2</refmiscinfo>
 </refmeta>
 <refnamediv>
        <refname>
 <refsynopsisdiv>
        <cmdsynopsis>
        <command>asterisk</command>
-<arg><option>-hfdvVqpRgcin</option></arg>
+<arg><option>-tThfdvVqpRgciIn</option></arg>
 <arg><option>-C </option><replaceable class="parameter">file</replaceable></arg>
 <arg><option>-U </option><replaceable class="parameter">user</replaceable></arg>
 <arg><option>-G </option><replaceable class="parameter">group</replaceable></arg>
 <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
+<arg><option>-M </option><replaceable class="parameter">value</replaceable></arg>
+<arg><option>-L </option><replaceable class="parameter">loadaverage</replaceable></arg>
        </cmdsynopsis>
        <cmdsynopsis>
 
@@ -36,7 +38,7 @@
 </refsynopsisdiv>
 <refsect1>
        <refsect1info>
-               <date>2004-07-01</date>
+               <date>2006-03-29</date>
        </refsect1info>
        <title>DESCRIPTION</title>
        <para>
        provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
        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, IAX, MGCP, Skinny,
+       range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
        H.323) devices (both endpoints and proxies), as well as traditional TDM
        hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
        ISDN BRI, and many more.
        </para>
        <para>
-       Asterisk reads most of its configuration files from configuration files
-       located in /etc/asterisk.  Virtually all aspects of the operation of
-       asterisk's configuration files can be found in the sample configuration
-       files.  The format for those files is generally beyond the scope of this
-       man page.
+       At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
+       file and locates the rest of the configuration files from the configuration
+       in that file. The -C option specifies an alternate main configuration file.
+       Virtually all aspects of the operation of asterisk's configuration files
+       can be found in the sample configuration files.  The format for those files
+       is generally beyond the scope of this man page.
        </para>
        <para>
        When running with <command>-c</command>, <command>-r</command> or <command>-R</command>
@@ -63,6 +66,9 @@
        of administrative actions and even explore the applications that are
        currently loaded into the system.
        </para>
+       <para>
+       Asterisk is a trademark of Digium, Inc.
+       </para>
 </refsect1>
 <refsect1>
        <title>OPTIONS</title>
                        <para>
                        Enable extra debugging statements.
                        </para>
+                       <para>
+                       Note: This always sets the debug level in the asterisk process,
+                       even if it is running in the background. This will affect the size
+                       of your log files.
+                       </para>
                </listitem>
        </varlistentry>
        <varlistentry>
                <term>-i</term>
                <listitem>
                        <para>
-                       Prompt user to intialize any encrypted private keys during startup.
+                       Prompt user to intialize any encrypted private keys for IAX2
+                       secure authentication during startup.
+                       </para>
+               </listitem>
+       </varlistentry>
+       <varlistentry>
+               <term>-I</term>
+               <listitem>
+                       <para>
+                       Enable internal timing if Zaptel timing is available.
+                       The default behaviour is that outbound packets are phase locked
+                       to inbound packets. Enabling this switch causes them to be
+                       locked to the internal Zaptel timer instead.
+                       </para>
+               </listitem>
+       </varlistentry>
+       <varlistentry>
+               <term>-L <replaceable class="parameter">loadaverage</replaceable></term>
+               <listitem>
+                       <para>
+                       Limits the maximum load average before rejecting new calls.  This can
+                       be useful to prevent a system from being brought down by terminating
+                       too many simultaneous calls.
+                       </para>
+               </listitem>
+       </varlistentry>
+       <varlistentry>
+               <term>-M <replaceable class="parameter">value</replaceable></term>
+               <listitem>
+                       <para>
+                       Limits the maximum number of calls to the specified value.  This can
+                       be useful to prevent a system from being brought down by terminating
+                       too many simultaneous calls.
                        </para>
                </listitem>
        </varlistentry>
                </listitem>
        </varlistentry>
        <varlistentry>
+               <term>-t</term>
+               <listitem>
+                       <para>
+                       When recording files, write them first into a temporary holding directory, 
+                       then move them into the final location when done.
+                       </para>
+               </listitem>
+       </varlistentry>
+       <varlistentry>
+               <term>-T</term>
+               <listitem>
+                       <para>
+                       Add timestamp to all non-command related output going to the console
+                       when running with verbose and/or logging to the console.
+                       </para>
+               </listitem>
+       </varlistentry>
+       <varlistentry>
                <term>-U <replaceable class="parameter">user</replaceable></term>
                <listitem>
                        <para>
                        Specifying this option implies <command>-f</command> and will cause
                        asterisk to no longer fork or detach from the controlling terminal.
                        This option may also be used in conjunction with <command>-r</command>
-                       and <command>-R</command>
+                       and <command>-R</command>.
+                       </para>
+                       <para>
+                       Note: This always sets the verbose level in the asterisk process,
+                       even if it is running in the background. This will affect the size
+                       of your log files.
                        </para>
                </listitem>
        </varlistentry>
        *CLI&gt; <command>help</command> - Help on Asterisk CLI
        </para>
        <para>
-       *CLI&gt; <command>show applications</command> - Show loaded applications
+       *CLI&gt; <command>show applications</command> - Show loaded dialplan applications
+       </para>
+       <para>
+       *CLI&gt; <command>show functions</command> - Show loaded dialplan functions
        </para>
        <para>
        http://www.asterisk.org - The Asterisk Home Page