update the dump of application docs
[asterisk/asterisk.git] / doc / cliprompt.tex
1 \subsubsection{Changing the CLI Prompt}
2
3 The CLI prompt is set with the ASTERISK\_PROMPT UNIX environment variable that
4 you set from the Unix shell before starting Asterisk
5
6 You may include the following variables, that will be replaced by
7 the current value by Asterisk:
8
9 \begin{verbatim}
10 %d      Date (year-month-date)
11 %s      Asterisk system name (from asterisk.conf)
12 %h      Full hostname
13 %H      Short hostname
14 %t      Time
15 %%      Percent sign
16 %#      '#' if Asterisk is run in console mode, '>' if running as remote console
17 %Cn[;n] Change terminal foreground (and optional background) color to specified
18 \end{verbatim}
19
20 A full list of colors may be found in include/asterisk/term.h
21
22 On Linux systems, you may also use:
23
24 \begin{verbatim}
25 %l1     Load average over past minute
26 %l2     Load average over past 5 minutes
27 %l3     Load average over past 15 minutes
28 %l4     Process fraction (processes running / total processes)
29 %l5     The most recently allocated pid
30 \end{verbatim}