additional checking related to issue 17186
[asterisk/asterisk.git] / doc / cli.txt
1 In addition to being the console for Asterisk, the CLI also sports several
2 features that make it very helpful to use for obtaining information and
3 affecting system configuration.  The console can also be seen by starting
4 a remote console, which connects to the running daemon and shows much of
5 the same information as if using the daemon in foreground mode.
6
7 Connecting a remote console is as easy as using the -r or -R flags.  The only
8 difference between these flags is that the uppercase variation (-R) will
9 automatically reconnect to the daemon (or at least retry) if the daemon
10 restarts.  To exit a remote console, simply type 'quit' or 'exit'.  Please note
11 that you can differentiate between a remote console and the Asterisk console,
12 as 'quit' or 'exit' will not function on the main console, which prevents an
13 accidental shutdown of the daemon.  If you would like to shutdown the Asterisk
14 daemon, you can use the 'stop' set of commands, such as 'stop now',
15 'stop gracefully', or 'stop when convenient'.
16
17 Once on the console, the 'help' command may be used to see a list of commands
18 available for use.  Note that in addition to the 'help' command, the Asterisk
19 CLI sports tab command line completion on all commands, including many
20 arguments.  To use tab command line completion, simply press the <Tab> key at
21 any time while entering the beginning of any command.  If the command can be
22 completed unambiguously, it will do so, otherwise it will complete as much of
23 the command as possible.  Additionally, Asterisk will print a list of all
24 possible matches, if possible.
25
26 The 'help' command may also be used to obtain more detailed information on
27 how to use a particular command.  For example, if you type 'help core show',
28 Asterisk will respond with a list of all commands that start with that string.
29 If you type 'help core show version', specifying a complete command, Asterisk
30 will respond with a usage message which describes how to use that command.  As
31 with other commands on the Asterisk console, the help command also responds to
32 tab command line completion.
33