42e6b4bd13ece81a9b3f799b41e5e2f60ea42277
[asterisk/asterisk.git] / doc / tex / 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{itemize}
10     \item \%d - Date (year-month-date)
11     \item \%s - Asterisk system name (from asterisk.conf)
12     \item \%h - Full hostname
13     \item \%H - Short hostname
14     \item \%t - Time
15     \item \%\% - Percent sign
16     \item \%\# - '\#' if Asterisk is run in console mode, '$>$' if running as remote console
17     \item \%Cn[;n] - Change terminal foreground (and optional background) color to specified
18     A full list of colors may be found in \path{include/asterisk/term.h}
19 \end{itemize}
20
21 On Linux systems, you may also use:
22
23 \begin{itemize}
24     \item \%l1 - Load average over past minute
25     \item \%l2 - Load average over past 5 minutes
26     \item \%l3 - Load average over past 15 minutes
27     \item \%l4 - Process fraction (processes running / total processes)
28     \item \%l5 - The most recently allocated pid
29 \end{itemize}