aboutsummaryrefslogtreecommitdiffstats
path: root/trunk/doc/tex/cliprompt.tex
diff options
context:
space:
mode:
Diffstat (limited to 'trunk/doc/tex/cliprompt.tex')
-rw-r--r--trunk/doc/tex/cliprompt.tex29
1 files changed, 29 insertions, 0 deletions
diff --git a/trunk/doc/tex/cliprompt.tex b/trunk/doc/tex/cliprompt.tex
new file mode 100644
index 000000000..42e6b4bd1
--- /dev/null
+++ b/trunk/doc/tex/cliprompt.tex
@@ -0,0 +1,29 @@
+\subsubsection{Changing the CLI Prompt}
+
+The CLI prompt is set with the ASTERISK\_PROMPT UNIX environment variable that
+you set from the Unix shell before starting Asterisk
+
+You may include the following variables, that will be replaced by
+the current value by Asterisk:
+
+\begin{itemize}
+ \item \%d - Date (year-month-date)
+ \item \%s - Asterisk system name (from asterisk.conf)
+ \item \%h - Full hostname
+ \item \%H - Short hostname
+ \item \%t - Time
+ \item \%\% - Percent sign
+ \item \%\# - '\#' if Asterisk is run in console mode, '$>$' if running as remote console
+ \item \%Cn[;n] - Change terminal foreground (and optional background) color to specified
+ A full list of colors may be found in \path{include/asterisk/term.h}
+\end{itemize}
+
+On Linux systems, you may also use:
+
+\begin{itemize}
+ \item \%l1 - Load average over past minute
+ \item \%l2 - Load average over past 5 minutes
+ \item \%l3 - Load average over past 15 minutes
+ \item \%l4 - Process fraction (processes running / total processes)
+ \item \%l5 - The most recently allocated pid
+\end{itemize}