From 6b2832a22318923373bd35a7b18f68f78454edb1 Mon Sep 17 00:00:00 2001 From: tilghman Date: Fri, 23 May 2008 13:00:10 +0000 Subject: Merged revisions 118052 via svnmerge from https://origsvn.digium.com/svn/asterisk/branches/1.4 ........ r118052 | tilghman | 2008-05-23 07:59:16 -0500 (Fri, 23 May 2008) | 3 lines Add information on using the Asterisk console, including tab command line completion. (Closes issue #12681) ........ git-svn-id: http://svn.digium.com/svn/asterisk/trunk@118053 f38db490-d61c-443f-a65b-d21fe96a405b --- doc/cli.txt | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 doc/cli.txt 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 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. + -- cgit v1.2.3