aboutsummaryrefslogtreecommitdiffstats
path: root/doc/cliprompt.txt
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2007-03-16 01:41:00 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2007-03-16 01:41:00 +0000
commitdbddd24443348c19c79e9d85f40d2aa429d0d885 (patch)
treef88f0d9ea78ee8991946a97d9f7bfb720132ec4f /doc/cliprompt.txt
parentb2830ad62612116f801a7ea10e8584a1bef42af0 (diff)
Making these documentation changes in the 1.4 branch upset various people, so
these chanes will only be done in the trunk. git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@58955 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc/cliprompt.txt')
-rw-r--r--doc/cliprompt.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/cliprompt.txt b/doc/cliprompt.txt
new file mode 100644
index 000000000..fbd7dd99f
--- /dev/null
+++ b/doc/cliprompt.txt
@@ -0,0 +1,29 @@
+* 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:
+
+%d Date (year-month-date)
+%s Asterisk system name (from asterisk.conf)
+%h Full hostname
+%H Short hostname
+%t Time
+%% Percent sign
+%# '#' if Asterisk is run in console mode, '>' if running as remote console
+%Cn[;n] Change terminal foreground (and optional background) color to specified
+ A full list of colors may be found in include/asterisk/term.h
+
+On Linux systems, you may also use
+%l1 Load average over past minute
+%l2 Load average over past 5 minutes
+%l3 Load average over past 15 minutes
+%l4 Process fraction (processes running / total processes)
+%l5 The most recently allocated pid
+
+
+-----
+04-03-26