[svn-commits] russell: trunk r72938 - in /trunk/doc: ast_cli_commands.tex asterisk.tex

SVN commits to the Digium repositories svn-commits at lists.digium.com
Mon Jul 2 15:42:41 CDT 2007


Author: russell
Date: Mon Jul  2 15:42:40 2007
New Revision: 72938

URL: http://svn.digium.com/view/asterisk?view=rev&rev=72938
Log:
Add CLI commands to the docs

Added:
    trunk/doc/ast_cli_commands.tex   (with props)
Modified:
    trunk/doc/asterisk.tex

Added: trunk/doc/ast_cli_commands.tex
URL: http://svn.digium.com/view/asterisk/trunk/doc/ast_cli_commands.tex?view=auto&rev=72938
==============================================================================
--- trunk/doc/ast_cli_commands.tex (added)
+++ trunk/doc/ast_cli_commands.tex Mon Jul  2 15:42:40 2007
@@ -1,0 +1,3505 @@
+% This file is automatically generated by the "core dump clidocs" CLI command.  Any manual edits will be lost.
+\section{!}
+\subsection{Summary}
+\begin{verbatim}
+Execute a shell command
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: !<command>
+       Executes a given shell command
+
+\end{verbatim}
+
+
+\section{abort halt}
+\subsection{Summary}
+\begin{verbatim}
+Cancel a running halt
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: abort shutdown
+       Causes Asterisk to abort an executing shutdown or restart, and resume normal
+       call operations.
+
+\end{verbatim}
+
+
+\section{ael debug contexts}
+\subsection{Summary}
+\begin{verbatim}
+Enable AEL contexts debug (does nothing)
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{ael debug macros}
+\subsection{Summary}
+\begin{verbatim}
+Enable AEL macros debug (does nothing)
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{ael debug read}
+\subsection{Summary}
+\begin{verbatim}
+Enable AEL read debug (does nothing)
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{ael debug tokens}
+\subsection{Summary}
+\begin{verbatim}
+Enable AEL tokens debug (does nothing)
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{ael nodebug}
+\subsection{Summary}
+\begin{verbatim}
+Disable AEL debug messages
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{ael reload}
+\subsection{Summary}
+\begin{verbatim}
+Reload AEL configuration
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{agent logoff}
+\subsection{Summary}
+\begin{verbatim}
+Sets an agent offline
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: agent logoff <channel> [soft]
+       Sets an agent as no longer logged in.
+       If 'soft' is specified, do not hangup existing calls.
+
+\end{verbatim}
+
+
+\section{agent show}
+\subsection{Summary}
+\begin{verbatim}
+Show status of agents
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: agent show
+       Provides summary information on agents.
+
+\end{verbatim}
+
+
+\section{agent show online}
+\subsection{Summary}
+\begin{verbatim}
+Show all online agents
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: agent show online
+	Provides a list of all online agents.
+
+\end{verbatim}
+
+
+\section{agi debug}
+\subsection{Summary}
+\begin{verbatim}
+Enable AGI debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: agi debug
+       Enables dumping of AGI transactions for debugging purposes
+
+\end{verbatim}
+
+
+\section{agi debug off}
+\subsection{Summary}
+\begin{verbatim}
+Disable AGI debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: agi debug off
+       Disables dumping of AGI transactions for debugging purposes
+
+\end{verbatim}
+
+
+\section{agi dump commanddocs}
+\subsection{Summary}
+\begin{verbatim}
+Dump agi command documentation in LaTeX format
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: agi dump commanddocs [command]
+       Dump manager action documentation to /tmp/ast_agi_commands.tex.
+
+\end{verbatim}
+
+
+\section{agi dumphtml}
+\subsection{Summary}
+\begin{verbatim}
+Dumps a list of agi commands in html format
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: agi dumphtml <filename>
+	Dumps the agi command list in html format to given filename
+
+\end{verbatim}
+
+
+\section{agi show}
+\subsection{Summary}
+\begin{verbatim}
+List AGI commands or specific help
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: agi show [topic]
+       When called with a topic as an argument, displays usage
+       information on the given command.  If called without a
+       topic, it provides a list of AGI commands.
+
+\end{verbatim}
+
+
+\section{cdr status}
+\subsection{Summary}
+\begin{verbatim}
+Display the CDR status
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: cdr status
+	Displays the Call Detail Record engine system status.
+
+\end{verbatim}
+
+
+\section{console active}
+\subsection{Summary}
+\begin{verbatim}
+Sets/displays active console
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: console active [device]
+       If used without a parameter, displays which device is the current
+console.  If a device is specified, the console sound device is changed to
+the device specified.
+
+\end{verbatim}
+
+
+\section{console answer}
+\subsection{Summary}
+\begin{verbatim}
+Answer an incoming console call
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: console answer
+       Answers an incoming call on the console (OSS) channel.
+
+\end{verbatim}
+
+
+\section{console autoanswer [on|off]}
+\subsection{Summary}
+\begin{verbatim}
+Sets/displays autoanswer
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: console autoanswer [on|off]
+       Enables or disables autoanswer feature.  If used without
+       argument, displays the current on/off status of autoanswer.
+       The default value of autoanswer is in 'oss.conf'.
+
+\end{verbatim}
+
+
+\section{console boost}
+\subsection{Summary}
+\begin{verbatim}
+Sets/displays mic boost in dB
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{console dial}
+\subsection{Summary}
+\begin{verbatim}
+Dial an extension on the console
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: console dial [extension[@context]]
+       Dials a given extension (and context if specified)
+
+\end{verbatim}
+
+
+\section{console flash}
+\subsection{Summary}
+\begin{verbatim}
+Flash a call on the console
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: console flash
+       Flashes the call currently placed on the console.
+
+\end{verbatim}
+
+
+\section{console hangup}
+\subsection{Summary}
+\begin{verbatim}
+Hangup a call on the console
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: console hangup
+       Hangs up any call currently placed on the console.
+
+\end{verbatim}
+
+
+\section{console {mute|unmute}}
+\subsection{Summary}
+\begin{verbatim}
+Disable/Enable mic input
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: console {mute|unmute}
+       Mute/unmute the microphone.
+
+\end{verbatim}
+
+
+\section{console send text}
+\subsection{Summary}
+\begin{verbatim}
+Send text to the remote device
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: console send text <message>
+       Sends a text message for display on the remote terminal.
+
+\end{verbatim}
+
+
+\section{console transfer}
+\subsection{Summary}
+\begin{verbatim}
+Transfer a call to a different extension
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: console transfer <extension>[@context]
+       Transfers the currently connected call to the given extension (and
+context if specified)
+
+\end{verbatim}
+
+
+\section{core clear profile}
+\subsection{Summary}
+\begin{verbatim}
+Clear profiling info
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{core dump appdocs}
+\subsection{Summary}
+\begin{verbatim}
+Dump application documentation in LaTeX format
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core dump appdocs [application]
+       Dump Application documentation to /tmp/ast_appdocs.tex.
+
+\end{verbatim}
+
+
+\section{core dump clidocs}
+\subsection{Summary}
+\begin{verbatim}
+Dump CLI command documentation in LaTeX format
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core dump clidocs
+       Dump CLI command documentation to /tmp/ast_cli_commands.tex.
+
+\end{verbatim}
+
+
+\section{core dump funcdocs}
+\subsection{Summary}
+\begin{verbatim}
+Dump function documentation in LaTeX format
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core dump funcdocs [function]
+       Dump Application documentation to /tmp/ast_funcdocs.tex.
+
+\end{verbatim}
+
+
+\section{core set debug channel}
+\subsection{Summary}
+\begin{verbatim}
+Enable/disable debugging on a channel
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core set debug channel <all|channel> [off]
+       Enables/disables debugging on all or on a specific channel.
+
+\end{verbatim}
+
+
+\section{core set {debug|verbose} [off|atleast]}
+\subsection{Summary}
+\begin{verbatim}
+Set level of debug/verbose chattiness
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core set {debug|verbose} [atleast] <level>
+       core set {debug|verbose} off
+       Sets level of debug or verbose messages to be displayed.
+	0 or off means no messages should be displayed.
+	Equivalent to -d[d[...]] or -v[v[v...]] on startup
+
+\end{verbatim}
+
+
+\section{core set global}
+\subsection{Summary}
+\begin{verbatim}
+Set global dialplan variable
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core set global <name> <value>
+       Set global dialplan variable <name> to <value>
+
+\end{verbatim}
+
+
+\section{core show applications}
+\subsection{Summary}
+\begin{verbatim}
+Shows registered dialplan applications
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show applications [{like|describing} <text>]
+       List applications which are currently available.
+       If 'like', <text> will be a substring of the app name
+       If 'describing', <text> will be a substring of the description
+
+\end{verbatim}
+
+
+\section{core show application}
+\subsection{Summary}
+\begin{verbatim}
+Describe a specific dialplan application
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show application <application> [<application> [<application> [...]]]
+       Describes a particular application.
+
+\end{verbatim}
+
+
+\section{core show channels [concise|verbose|count]}
+\subsection{Summary}
+\begin{verbatim}
+Display information on channels
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show channels [concise|verbose|count]
+       Lists currently defined channels and some information about them. If
+       'concise' is specified, the format is abridged and in a more easily
+       machine parsable format. If 'verbose' is specified, the output includes
+       more and longer fields. If 'count' is specified only the channel and call
+       count is output.
+
+\end{verbatim}
+
+
+\section{core show channel}
+\subsection{Summary}
+\begin{verbatim}
+Display information on a specific channel
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show channel <channel>
+       Shows lots of information about the specified channel.
+
+\end{verbatim}
+
+
+\section{core show channeltypes}
+\subsection{Summary}
+\begin{verbatim}
+List available channel types
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show channeltypes
+       Lists available channel types registered in your Asterisk server.
+
+\end{verbatim}
+
+
+\section{core show channeltype}
+\subsection{Summary}
+\begin{verbatim}
+Give more details on that channel type
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show channeltype <name>
+	Show details about the specified channel type, <name>.
+
+\end{verbatim}
+
+
+\section{core show codecs}
+\subsection{Summary}
+\begin{verbatim}
+Displays a list of codecs
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show codecs [audio|video|image]
+       Displays codec mapping
+
+\end{verbatim}
+
+
+\section{core show codecs audio}
+\subsection{Summary}
+\begin{verbatim}
+Displays a list of audio codecs
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show codecs [audio|video|image]
+       Displays codec mapping
+
+\end{verbatim}
+
+
+\section{core show codecs image}
+\subsection{Summary}
+\begin{verbatim}
+Displays a list of image codecs
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show codecs [audio|video|image]
+       Displays codec mapping
+
+\end{verbatim}
+
+
+\section{core show codecs video}
+\subsection{Summary}
+\begin{verbatim}
+Displays a list of video codecs
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show codecs [audio|video|image]
+       Displays codec mapping
+
+\end{verbatim}
+
+
+\section{core show codec}
+\subsection{Summary}
+\begin{verbatim}
+Shows a specific codec
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show codec <number>
+       Displays codec mapping
+
+\end{verbatim}
+
+
+\section{core show config mappings}
+\subsection{Summary}
+\begin{verbatim}
+Display config mappings (file names to config engines)
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show config mappings
+	Shows the filenames to config engines.
+
+\end{verbatim}
+
+
+\section{core show file formats}
+\subsection{Summary}
+\begin{verbatim}
+Displays file formats
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show file formats
+       Displays currently registered file formats (if any)
+
+\end{verbatim}
+
+
+\section{core show file version}
+\subsection{Summary}
+\begin{verbatim}
+List versions of files used to build Asterisk
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show file version [like <pattern>]
+       Lists the revision numbers of the files used to build this copy of Asterisk.
+       Optional regular expression pattern is used to filter the file list.
+
+\end{verbatim}
+
+
+\section{core show functions}
+\subsection{Summary}
+\begin{verbatim}
+Shows registered dialplan functions
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show functions [like <text>]
+       List builtin functions, optionally only those matching a given string
+
+\end{verbatim}
+
+
+\section{core show function}
+\subsection{Summary}
+\begin{verbatim}
+Describe a specific dialplan function
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show function <function>
+       Describe a particular dialplan function.
+
+\end{verbatim}
+
+
+\section{core show globals}
+\subsection{Summary}
+\begin{verbatim}
+Show global dialplan variables
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show globals
+       List current global dialplan variables and their values
+
+\end{verbatim}
+
+
+\section{core show hints}
+\subsection{Summary}
+\begin{verbatim}
+Show dialplan hints
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show hints
+       List registered hints
+
+\end{verbatim}
+
+
+\section{core show image formats}
+\subsection{Summary}
+\begin{verbatim}
+Displays image formats
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show image formats
+       displays currently registered image formats (if any)
+
+\end{verbatim}
+
+
+\section{core show license}
+\subsection{Summary}
+\begin{verbatim}
+Show the license(s) for this copy of Asterisk
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show license
+       Shows the license(s) for this copy of Asterisk.
+
+\end{verbatim}
+
+
+\section{core show profile}
+\subsection{Summary}
+\begin{verbatim}
+Display profiling info
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{core show settings}
+\subsection{Summary}
+\begin{verbatim}
+Show some core settings
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+(null)
+\end{verbatim}
+
+
+\section{core show switches}
+\subsection{Summary}
+\begin{verbatim}
+Show alternative switches
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show switches
+       List registered switches
+
+\end{verbatim}
+
+
+\section{core show sysinfo}
+\subsection{Summary}
+\begin{verbatim}
+Show System Information
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show sysinfo
+       List current system information.
+
+\end{verbatim}
+
+
+\section{core show threads}
+\subsection{Summary}
+\begin{verbatim}
+Show running threads
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show threads
+       List threads currently active in the system.
+
+\end{verbatim}
+
+
+\section{core show translation}
+\subsection{Summary}
+\begin{verbatim}
+Display translation matrix
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show translation [recalc] [<recalc seconds>]
+       Displays known codec translators and the cost associated
+with each conversion.  If the argument 'recalc' is supplied along
+with optional number of seconds to test a new test will be performed
+as the chart is being displayed.
+
+\end{verbatim}
+
+
+\section{core show uptime [seconds]}
+\subsection{Summary}
+\begin{verbatim}
+Show uptime information
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show uptime [seconds]
+       Shows Asterisk uptime information.
+       The seconds word returns the uptime in seconds only.
+
+\end{verbatim}
+
+
+\section{core show version}
+\subsection{Summary}
+\begin{verbatim}
+Display version info
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show version
+       Shows Asterisk version information.
+
+\end{verbatim}
+
+
+\section{core show warranty}
+\subsection{Summary}
+\begin{verbatim}
+Show the warranty (if any) for this copy of Asterisk
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show warranty
+       Shows the warranty (if any) for this copy of Asterisk.
+
+\end{verbatim}
+
+
+\section{database del}
+\subsection{Summary}
+\begin{verbatim}
+Removes database key/value
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: database del <family> <key>
+       Deletes an entry in the Asterisk database for a given
+family and key.
+
+\end{verbatim}
+
+
+\section{database deltree}
+\subsection{Summary}
+\begin{verbatim}
+Removes database keytree/values
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: database deltree <family> [keytree]
+       Deletes a family or specific keytree within a family
+in the Asterisk database.
+
+\end{verbatim}
+
+
+\section{database get}
+\subsection{Summary}
+\begin{verbatim}
+Gets database value
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: database get <family> <key>
+       Retrieves an entry in the Asterisk database for a given
+family and key.
+
+\end{verbatim}
+
+
+\section{database put}
+\subsection{Summary}
+\begin{verbatim}
+Adds/updates database value
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: database put <family> <key> <value>
+       Adds or updates an entry in the Asterisk database for
+a given family, key, and value.
+
+\end{verbatim}
+
+
+\section{database show}
+\subsection{Summary}
+\begin{verbatim}
+Shows database contents
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: database show [family [keytree]]
+       Shows Asterisk database contents, optionally restricted
+to a given family, or family and keytree.
+
+\end{verbatim}
+
+
+\section{database showkey}
+\subsection{Summary}
+\begin{verbatim}
+Shows database contents
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: database showkey <keytree>
+       Shows Asterisk database contents, restricted to a given key.
+
+\end{verbatim}
+
+
+\section{dialplan add extension}
+\subsection{Summary}
+\begin{verbatim}
+Add new extension into context
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dialplan add extension <exten>,<priority>,<app>,<app-data>
+       into <context> [replace]
+
+       This command will add new extension into <context>. If there is an
+       existence of extension with the same priority and last 'replace'
+       arguments is given here we simply replace this extension.
+
+Example: dialplan add extension 6123,1,Dial,IAX/216.207.245.56/6123 into local
+         Now, you can dial 6123 and talk to Markster :)
+
+\end{verbatim}
+
+
+\section{dialplan add ignorepat}
+\subsection{Summary}
+\begin{verbatim}
+Add new ignore pattern
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dialplan add ignorepat <pattern> into <context>
+       This command adds a new ignore pattern into context <context>
+
+Example: dialplan add ignorepat _3XX into local
+
+\end{verbatim}
+
+
+\section{dialplan add include}
+\subsection{Summary}
+\begin{verbatim}
+Include context in other context
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dialplan add include <context> into <context>
+       Include a context in another context.
+
+\end{verbatim}
+
+
+\section{dialplan reload}
+\subsection{Summary}
+\begin{verbatim}
+Reload extensions and *only* extensions
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dialplan reload
+       reload extensions.conf without reloading any other modules
+       This command does not delete global variables unless
+       clearglobalvars is set to yes in extensions.conf
+
+\end{verbatim}
+
+
+\section{dialplan remove extension}
+\subsection{Summary}
+\begin{verbatim}
+Remove a specified extension
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dialplan remove extension exten at context [priority]
+       Remove an extension from a given context. If a priority
+       is given, only that specific priority from the given extension
+       will be removed.
+
+\end{verbatim}
+
+
+\section{dialplan remove ignorepat}
+\subsection{Summary}
+\begin{verbatim}
+Remove ignore pattern from context
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dialplan remove ignorepat <pattern> from <context>
+       This command removes an ignore pattern from context <context>
+
+Example: dialplan remove ignorepat _3XX from local
+
+\end{verbatim}
+
+
+\section{dialplan remove include}
+\subsection{Summary}
+\begin{verbatim}
+Remove a specified include from context
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dialplan remove include <context> from <context>
+       Remove an included context from another context.
+
+\end{verbatim}
+
+
+\section{dialplan save}
+\subsection{Summary}
+\begin{verbatim}
+Save dialplan
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dialplan save [/path/to/extension/file]
+       Save dialplan created by pbx_config module.
+
+Example: dialplan save                 (/etc/asterisk/extensions.conf)
+         dialplan save /home/markster  (/home/markster/extensions.conf)
+
+\end{verbatim}
+
+
+\section{dialplan show}
+\subsection{Summary}
+\begin{verbatim}
+Show dialplan
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: core show dialplan [exten@][context]
+       Show dialplan
+
+\end{verbatim}
+
+
+\section{dnsmgr reload}
+\subsection{Summary}
+\begin{verbatim}
+Reloads the DNS manager configuration
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dnsmgr reload
+       Reloads the DNS manager configuration.
+
+\end{verbatim}
+
+
+\section{dnsmgr status}
+\subsection{Summary}
+\begin{verbatim}
+Display the DNS manager status
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dnsmgr status
+       Displays the DNS manager status.
+
+\end{verbatim}
+
+
+\section{dundi debug}
+\subsection{Summary}
+\begin{verbatim}
+Enable DUNDi debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi debug
+       Enables dumping of DUNDi packets for debugging purposes
+
+\end{verbatim}
+
+
+\section{dundi flush}
+\subsection{Summary}
+\begin{verbatim}
+Flush DUNDi cache
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi flush [stats]
+       Flushes DUNDi answer cache, used primarily for debug.  If
+'stats' is present, clears timer statistics instead of normal
+operation.
+
+\end{verbatim}
+
+
+\section{dundi lookup}
+\subsection{Summary}
+\begin{verbatim}
+Lookup a number in DUNDi
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi lookup <number>[@context] [bypass]
+       Lookup the given number within the given DUNDi context
+(or e164 if none is specified).  Bypasses cache if 'bypass'
+keyword is specified.
+
+\end{verbatim}
+
+
+\section{dundi no debug}
+\subsection{Summary}
+\begin{verbatim}
+Disable DUNDi debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi no debug
+       Disables dumping of DUNDi packets for debugging purposes
+
+\end{verbatim}
+
+
+\section{dundi no store history}
+\subsection{Summary}
+\begin{verbatim}
+Disable DUNDi historic records
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi no store history
+       Disables storing of DUNDi requests and times for debugging
+purposes
+
+\end{verbatim}
+
+
+\section{dundi precache}
+\subsection{Summary}
+\begin{verbatim}
+Precache a number in DUNDi
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi precache <number>[@context]
+       Lookup the given number within the given DUNDi context
+(or e164 if none is specified) and precaches the results to any
+upstream DUNDi push servers.
+
+\end{verbatim}
+
+
+\section{dundi query}
+\subsection{Summary}
+\begin{verbatim}
+Query a DUNDi EID
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi query <entity>[@context]
+       Attempts to retrieve contact information for a specific
+DUNDi entity identifier (EID) within a given DUNDi context (or
+e164 if none is specified).
+
+\end{verbatim}
+
+
+\section{dundi show entityid}
+\subsection{Summary}
+\begin{verbatim}
+Display Global Entity ID
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi show entityid
+       Displays the global entityid for this host.
+
+\end{verbatim}
+
+
+\section{dundi show mappings}
+\subsection{Summary}
+\begin{verbatim}
+Show DUNDi mappings
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi show mappings
+       Lists all known DUNDi mappings.
+
+\end{verbatim}
+
+
+\section{dundi show peers}
+\subsection{Summary}
+\begin{verbatim}
+Show defined DUNDi peers
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi show peers
+       Lists all known DUNDi peers.
+
+\end{verbatim}
+
+
+\section{dundi show peer}
+\subsection{Summary}
+\begin{verbatim}
+Show info on a specific DUNDi peer
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi show peer [peer]
+       Provide a detailed description of a specifid DUNDi peer.
+
+\end{verbatim}
+
+
+\section{dundi show precache}
+\subsection{Summary}
+\begin{verbatim}
+Show DUNDi precache
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi show precache
+       Lists all known DUNDi scheduled precache updates.
+
+\end{verbatim}
+
+
+\section{dundi show requests}
+\subsection{Summary}
+\begin{verbatim}
+Show DUNDi requests
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi show requests
+       Lists all known pending DUNDi requests.
+
+\end{verbatim}
+
+
+\section{dundi show trans}
+\subsection{Summary}
+\begin{verbatim}
+Show active DUNDi transactions
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi show trans
+       Lists all known DUNDi transactions.
+
+\end{verbatim}
+
+
+\section{dundi store history}
+\subsection{Summary}
+\begin{verbatim}
+Enable DUNDi historic records
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: dundi store history
+       Enables storing of DUNDi requests and times for debugging
+purposes
+
+\end{verbatim}
+
+
+\section{feature show}
+\subsection{Summary}
+\begin{verbatim}
+Lists configured features
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: feature list
+       Lists currently configured features.
+
+\end{verbatim}
+
+
+\section{file convert}
+\subsection{Summary}
+\begin{verbatim}
+Convert audio file
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: file convert <file_in> <file_out>
+    Convert from file_in to file_out. If an absolute path is not given, the
+default Asterisk sounds directory will be used.
+
+Example:
+    file convert tt-weasels.gsm tt-weasels.ulaw
+
+\end{verbatim}
+
+
+\section{funcdevstate list}
+\subsection{Summary}
+\begin{verbatim}
+List currently known custom device states
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: funcdevstate list
+       List all custom device states that have been set by using
+       the DEVSTATE dialplan function.
+
+\end{verbatim}
+
+
+\section{group show channels}
+\subsection{Summary}
+\begin{verbatim}
+Display active channels with group(s)
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: group show channels [pattern]
+       Lists all currently active channels with channel group(s) specified.
+       Optional regular expression pattern is matched to group names for each
+       channel.
+
+\end{verbatim}
+
+
+\section{gtalk reload}
+\subsection{Summary}
+\begin{verbatim}
+Enable Jabber debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: gtalk reload
+       Reload gtalk channel driver.
+
+\end{verbatim}
+
+
+\section{gtalk show channels}
+\subsection{Summary}
+\begin{verbatim}
+Show GoogleTalk Channels
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: gtalk show channels
+       Shows current state of the Gtalk channels.
+
+\end{verbatim}
+
+
+\section{h323 cycle gk}
+\subsection{Summary}
+\begin{verbatim}
+Manually re-register with the Gatekeper
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: h323 gk cycle
+       Manually re-register with the Gatekeper (Currently Disabled)
+
+\end{verbatim}
+
+
+\section{h323 hangup}
+\subsection{Summary}
+\begin{verbatim}
+Manually try to hang up a call
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: h323 hangup <token>
+       Manually try to hang up call identified by <token>
+
+\end{verbatim}
+
+
+\section{h323 reload}
+\subsection{Summary}
+\begin{verbatim}
+Reload H.323 configuration
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: h323 reload
+       Reloads H.323 configuration from h323.conf
+
+\end{verbatim}
+
+
+\section{h323 set debug}
+\subsection{Summary}
+\begin{verbatim}
+Enable H.323 debug
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: h323 debug
+       Enables H.323 debug output
+
+\end{verbatim}
+
+
+\section{h323 set debug off}
+\subsection{Summary}
+\begin{verbatim}
+Disable H.323 debug
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: h323 no debug
+       Disables H.323 debug output
+
+\end{verbatim}
+
+
+\section{h323 set trace}
+\subsection{Summary}
+\begin{verbatim}
+Enable H.323 Stack Tracing
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: h323 trace <level num>
+       Enables H.323 stack tracing for debugging purposes
+
+\end{verbatim}
+
+
+\section{h323 set trace off}
+\subsection{Summary}
+\begin{verbatim}
+Disable H.323 Stack Tracing
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: h323 no trace
+       Disables H.323 stack tracing for debugging purposes
+
+\end{verbatim}
+
+
+\section{h323 show tokens}
+\subsection{Summary}
+\begin{verbatim}
+Show all active call tokens
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: h323 show tokens
+       Print out all active call tokens
+
+\end{verbatim}
+
+
+\section{help}
+\subsection{Summary}
+\begin{verbatim}
+Display help list, or specific help on a command
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: help [topic]
+       When called with a topic as an argument, displays usage
+       information on the given command. If called without a
+       topic, it provides a list of commands.
+
+\end{verbatim}
+
+
+\section{http show status}
+\subsection{Summary}
+\begin{verbatim}
+Display HTTP server status
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: http show status
+       Lists status of internal HTTP engine
+
+\end{verbatim}
+
+
+\section{iax2 provision}
+\subsection{Summary}
+\begin{verbatim}
+Provision an IAX device
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 provision <host> <template> [forced]
+       Provisions the given peer or IP address using a template
+       matching either 'template' or '*' if the template is not
+       found.  If 'forced' is specified, even empty provisioning
+       fields will be provisioned as empty fields.
+
+\end{verbatim}
+
+
+\section{iax2 prune realtime}
+\subsection{Summary}
+\begin{verbatim}
+Prune a cached realtime lookup
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 prune realtime [<peername>|all]
+       Prunes object(s) from the cache
+
+\end{verbatim}
+
+
+\section{iax2 reload}
+\subsection{Summary}
+\begin{verbatim}
+Reload IAX configuration
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 reload
+       Reloads IAX configuration from iax.conf
+
+\end{verbatim}
+
+
+\section{iax2 set debug}
+\subsection{Summary}
+\begin{verbatim}
+Enable IAX debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 set debug
+       Enables dumping of IAX packets for debugging purposes
+
+\end{verbatim}
+
+
+\section{iax2 set debug jb}
+\subsection{Summary}
+\begin{verbatim}
+Enable IAX jitterbuffer debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 set debug jb
+       Enables jitterbuffer debugging information
+
+\end{verbatim}
+
+
+\section{iax2 set debug jb off}
+\subsection{Summary}
+\begin{verbatim}
+Disable IAX jitterbuffer debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 set debug jb off
+       Disables jitterbuffer debugging information
+
+\end{verbatim}
+
+
+\section{iax2 set debug off}
+\subsection{Summary}
+\begin{verbatim}
+Disable IAX debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 set debug off
+       Disables dumping of IAX packets for debugging purposes
+
+\end{verbatim}
+
+
+\section{iax2 set debug trunk}
+\subsection{Summary}
+\begin{verbatim}
+Enable IAX trunk debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 set debug trunk
+       Requests current status of IAX trunking
+
+\end{verbatim}
+
+
+\section{iax2 set debug trunk off}
+\subsection{Summary}
+\begin{verbatim}
+Disable IAX trunk debugging
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 set debug trunk off
+       Requests current status of IAX trunking
+
+\end{verbatim}
+
+
+\section{iax2 set mtu}
+\subsection{Summary}
+\begin{verbatim}
+Set the IAX systemwide trunking MTU
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 set mtu <value>
+       Set the system-wide IAX IP mtu to <value> bytes net or zero to disable.
+       Disabling means that the operating system must handle fragmentation of UDP packets
+       when the IAX2 trunk packet exceeds the UDP payload size.
+       This is substantially below the IP mtu. Try 1240 on ethernets.
+       Must be 172 or greater for G.711 samples.
+
+\end{verbatim}
+
+
+\section{iax2 show cache}
+\subsection{Summary}
+\begin{verbatim}
+Display IAX cached dialplan
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show cache
+       Display currently cached IAX Dialplan results.
+
+\end{verbatim}
+
+
+\section{iax2 show channels}
+\subsection{Summary}
+\begin{verbatim}
+List active IAX channels
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show channels
+       Lists all currently active IAX channels.
+
+\end{verbatim}
+
+
+\section{iax2 show firmware}
+\subsection{Summary}
+\begin{verbatim}
+List available IAX firmwares
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show firmware
+       Lists all known IAX firmware images.
+
+\end{verbatim}
+
+
+\section{iax2 show netstats}
+\subsection{Summary}
+\begin{verbatim}
+List active IAX channel netstats
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show netstats
+       Lists network status for all currently active IAX channels.
+
+\end{verbatim}
+
+
+\section{iax2 show peers}
+\subsection{Summary}
+\begin{verbatim}
+List defined IAX peers
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show peers [registered] [like <pattern>]
+       Lists all known IAX2 peers.
+       Optional 'registered' argument lists only peers with known addresses.
+       Optional regular expression pattern is used to filter the peer list.
+
+\end{verbatim}
+
+
+\section{iax2 show peer}
+\subsection{Summary}
+\begin{verbatim}
+Show details on specific IAX peer
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show peer <name>
+       Display details on specific IAX peer
+
+\end{verbatim}
+
+
+\section{iax2 show provisioning}
+\subsection{Summary}
+\begin{verbatim}
+Display iax provisioning
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax list provisioning [template]
+       Lists all known IAX provisioning templates or a
+       specific one if specified.
+
+\end{verbatim}
+
+
+\section{iax2 show registry}
+\subsection{Summary}
+\begin{verbatim}
+Display IAX registration status
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show registry
+       Lists all registration requests and status.
+
+\end{verbatim}
+
+
+\section{iax2 show stats}
+\subsection{Summary}
+\begin{verbatim}
+Display IAX statistics
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show stats
+       Display statistics on IAX channel driver.
+
+\end{verbatim}
+
+
+\section{iax2 show threads}
+\subsection{Summary}
+\begin{verbatim}
+Display IAX helper thread info
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show threads
+       Lists status of IAX helper threads
+
+\end{verbatim}
+
+
+\section{iax2 show users}
+\subsection{Summary}
+\begin{verbatim}
+List defined IAX users
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 show users [like <pattern>]
+       Lists all known IAX2 users.
+       Optional regular expression pattern is used to filter the user list.
+
+\end{verbatim}
+
+
+\section{iax2 test losspct}
+\subsection{Summary}
+\begin{verbatim}
+Set IAX2 incoming frame loss percentage
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 test losspct <percentage>
+       For testing, throws away <percentage> percent of incoming packets
+
+\end{verbatim}
+
+
+\section{iax2 unregister}
+\subsection{Summary}
+\begin{verbatim}
+Unregister (force expiration) an IAX2 peer from the registry
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: iax2 unregister <peername>
+       Unregister (force expiration) an IAX2 peer from the registry.
+
+\end{verbatim}
+
+
+\section{indication add}
+\subsection{Summary}
+\begin{verbatim}
+Add the given indication to the country
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: indication add <country> <indication> "<tonelist>"
+       Add the given indication to the country.
+
+\end{verbatim}
+
+
+\section{indication remove}
+\subsection{Summary}
+\begin{verbatim}
+Remove the given indication from the country
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: indication remove <country> <indication>
+       Remove the given indication from the country.
+
+\end{verbatim}
+
+
+\section{indication show}
+\subsection{Summary}
+\begin{verbatim}
+Display a list of all countries/indications
+\end{verbatim}
+\subsection{Usage}
+\begin{verbatim}
+Usage: indication show [<country> ...]
+       Display either a condensed for of all country/indications, or the

[... 1702 lines stripped ...]



More information about the svn-commits mailing list