[Asterisk-doc] docs cli-ref.xml,1.1,1.2
blitzrage
cvs at sohoskyway.net
Fri Aug 27 10:54:34 CDT 2004
Comments:
Update of /cvsroot/asterisk/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv4744/docs
Modified Files:
cli-ref.xml
Log Message:
blitzrage
- start documenting the Asterisk CLI
- information on "show application" and "show applications"
- Document Corydon-76's "show applications like" and "show applications
describing" additions to CVS 08/27/2004
Index: cli-ref.xml
===================================================================
RCS file: /cvsroot/asterisk/docs/cli-ref.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** cli-ref.xml 11 Jan 2004 07:48:26 -0000 1.1
--- cli-ref.xml 27 Aug 2004 15:54:28 -0000 1.2
***************
*** 1,4 ****
<appendix>
<title>CLI Command Reference</title>
! <para/>
</appendix>
--- 1,246 ----
<appendix>
<title>CLI Command Reference</title>
! <para>
! The Asterisk Command Line Interface (CLI) has many commands which you can run
! to help diagnose and maintain your system. This chapter will be dedicated to
! explain the usage of those commands and when you might use them.
! </para>
!
! <sect1>
! <title>Which Commands Can I Use?</title>
! <para>
! There are many commands which can be used to show you information about the
! current state of your system. The Asterisk CLI works very similar to many
! managed switches and routers CLI interfaces. You will find it fairly intuitive
! if you have used these CLI systems before, but we will assume you have not.
! </para>
!
! <para>
! The first thing we need to know is what commands can we use? The Asterisk CLI
! allows the usage of <emphasis>tab completion</emphasis> which can be quite handy
! to reduce the amount of typing and help find a command. Pressing <keycap>Tab</keycap>
! twice will give a listing of available commands. If we press <keycap>Tab</keycap>
! twice at a new CLI prompt, we get the following listing of commands.
! </para>
!
! <screen>
! <prompt>*CLI> </prompt>
! ! abort add database debug dont dump extensions help iax2 include
! init load local logger meetme no pri reload remove restart save
! set show sip soft stop unload zap
! </screen>
!
! <para>
! Asterisk will show you all the commands available at that level. Since we haven't
! started typing any commands, Asterisk will show us the very first level. Lets
! start with the <command>show</command> command as it can be very useful to show us
! the state of our system. For a listing of the sub-commands we can use with
! <command>show</command>, we can type <command>show</command> at the CLI and press
! the <keycap>Tab</keycap> key twice. Doing this will give the following listing of
! commands.
! </para>
!
! <screen>
! <prompt>*CLI> </prompt> <command>show</command>
! agents agi application applications audio channel channels codec codecs conferences config
! dialplan file image indications keys manager modules parkedcalls queue queues switches
! translation uptime version video voicemail
! </screen>
!
! <para>
! As we can see, there are a wide range of things that <command>show</command> can
! tell us about our system. We won't go into details here, but we now have an idea of
! how we can find a listing of the commands we can use.
! </para>
! </sect1>
!
! <sect1>
! <title>Obtaining Help About a Command</title>
! <para>
! You can obtain information about a command by typing the word <command>help
! </command> from the CLI. This will give you a listing of all the possible
! command combinations plus a short description of what it will do.
! </para>
!
! <screen>
! <prompt>*CLI> </prompt> <command>help</command>
! ! Execute a shell command
! abort halt Cancel a running halt
! add extension Add new extension into context
! add ignorepat Add new ignore pattern
! add indication Add the given indication to the country
! add queue member Add a channel to a specified queue
! ...etc...
! </screen>
!
! <para>
! There are over 100 commands listed in the help - that's quite a number of commands!
! </para>
! </sect1>
!
! <sect1>
! <title>The <command>show</command> Command</title>
! <para/>
! <sect2>
! <title><command>show agents</command></title>
! <para/>
! </sect2>
!
! <sect2>
! <title><command>show agi</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show application</command></title>
! <para>
! You can view information about the applications available within your dialplan
! by using the <command>show application</command> command. The format is
! </para>
!
! <informalexample>
! <programlisting>
! <command>show application</command> <emphasis>application_name</emphasis>
! </programlisting>
! </informalexample>
!
! <para>
! If you press the <keycap>Tab</keycap> key twice after typing <command>show
! application</command> you will get a listing of all the applications, without
! a description, available to you for use within your dialplan. When viewing each
! specific application, the Asterisk CLI will give you a brief description about the
! application, its usage within the dialplan and a listing of any options/flags which
! it may support. This is arguably one of the most useful commands in the Asterisk CLI.
! </para>
!
! <para>
! The <command>show applications</command> command compliments this command nicely.
! </para>
!
! </sect2>
! <sect2>
! <title><command>show applications</command></title>
! <para>
! The <command>show applications</command> command will give you a listing of
! all the available applications with a brief description for use within your
! dialplan. The <command>show applications</command> command will give you
! output like the following example.
! </para>
!
! <screen>
! <prompt>*CLI> </prompt> <command>show applications</command>
! -= Registered Asterisk Applications =-
! AbsoluteTimeout: Set absolute maximum time of call
! AddQueueMember: Dynamically adds queue members
! ADSIProg: Load Asterisk ADSI Scripts into phone
! AgentCallbackLogin: Call agent callback login
! AgentLogin: Call agent login
! AgentMonitorOutgoing: Record agent's outgoing call
! AGI: Executes an AGI compliant application
! ...etc...
! </screen>
!
! <note>
! <para>
! As of CVS HEAD 08/27/2004 there is a new command which let you search for
! applications which contain a word you specify. <command>show applications
! like</command> <emphasis>text</emphasis> will search for the sub-string <emphasis>
! text</emphasis> within the application name. <command>show applications
! describing</command> <emphasis>text</emphasis> will search the descriptions
! for the sub-string <emphasis>text</emphasis>.
! </para>
! </note>
! </sect2>
! <sect2>
! <title><command>show audio</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show channel</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show channels</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show codec</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show codecs</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show conferences</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show config</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show dialplan</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show file</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show image</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show indications</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show keys</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show manager</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show modules</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show parkedcalls</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show queue</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show queues</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show switches</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show translation</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show uptime</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show version</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show video</command></title>
! <para/>
! </sect2>
! <sect2>
! <title><command>show voicemail</command></title>
! <para/>
! </sect2>
! </sect1>
</appendix>
More information about the Asterisk-Doc
mailing list