path: root/doc
diff options
authortilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2008-05-23 12:59:16 +0000
committertilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2008-05-23 12:59:16 +0000
commitc24462a477dd9dd4cd2295dad9f8594ea2d91f20 (patch)
treec028ce4497be77e211794b57c54fa6596608fbc9 /doc
parentfc3f3eb46fb2213e764c7b15c0e52bc479b92417 (diff)
Add information on using the Asterisk console, including tab command line
completion. (Closes issue #12681) git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@118052 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
2 files changed, 34 insertions, 0 deletions
diff --git a/doc/00README.1st b/doc/00README.1st
index c006d56a8..ef4b326a7 100644
--- a/doc/00README.1st
+++ b/doc/00README.1st
@@ -8,6 +8,7 @@ Start here
hardware.txt Hardware supported by Asterisk
+cli.txt Information on using the Asterisk console
diff --git a/doc/cli.txt b/doc/cli.txt
new file mode 100644
index 000000000..9d3f9dbfe
--- /dev/null
+++ b/doc/cli.txt
@@ -0,0 +1,33 @@
+In addition to being the console for Asterisk, the CLI also sports several
+features that make it very helpful to use for obtaining information and
+affecting system configuration. The console can also be seen by starting
+a remote console, which connects to the running daemon and shows much of
+the same information as if using the daemon in foreground mode.
+Connecting a remote console is as easy as using the -r or -R flags. The only
+difference between these flags is that the uppercase variation (-R) will
+automatically reconnect to the daemon (or at least retry) if the daemon
+restarts. To exit a remote console, simply type 'quit' or 'exit'. Please note
+that you can differentiate between a remote console and the Asterisk console,
+as 'quit' or 'exit' will not function on the main console, which prevents an
+accidental shutdown of the daemon. If you would like to shutdown the Asterisk
+daemon, you can use the 'stop' set of commands, such as 'stop now',
+'stop gracefully', or 'stop when convenient'.
+Once on the console, the 'help' command may be used to see a list of commands
+available for use. Note that in addition to the 'help' command, the Asterisk
+CLI sports tab command line completion on all commands, including many
+arguments. To use tab command line completion, simply press the <Tab> key at
+any time while entering the beginning of any command. If the command can be
+completed unambiguously, it will do so, otherwise it will complete as much of
+the command as possible. Additionally, Asterisk will print a list of all
+possible matches, if possible.
+The 'help' command may also be used to obtain more detailed information on
+how to use a particular command. For example, if you type 'help core show',
+Asterisk will respond with a list of all commands that start with that string.
+If you type 'help core show version', specifying a complete command, Asterisk
+will respond with a usage message which describes how to use that command. As
+with other commands on the Asterisk console, the help command also responds to
+tab command line completion.