From 6deca692390e63157de0f5682020d65e4e3567f7 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Tue, 1 Mar 2011 20:27:13 +0000 Subject: uberprompt: updated docs to clarify $uber variable, and polish help stirngs. --- prompt_info/uberprompt.pl | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) (limited to 'prompt_info') diff --git a/prompt_info/uberprompt.pl b/prompt_info/uberprompt.pl index 0706d29..70d083d 100644 --- a/prompt_info/uberprompt.pl +++ b/prompt_info/uberprompt.pl @@ -25,6 +25,9 @@ # be replaced by the original prompt content. # A parameter corresponding to the UP_* constants listed below # is required, in the format `/prompt set -inner Hello!' +# +# /prompt set [-inner|-pre|-post|only] +# # /prompt clear - clears the additional data provided to the prompt. # /prompt on - enables the uberprompt (things may get confused if this is used # whilst the prompt is already enabled) @@ -39,7 +42,9 @@ # # /set uberprompt_format # -# The default is [$*], which is the same as the default provided in default.theme. +# The default is [$*$uber], which is the same as the default provided in +# default.theme. $uber is a placeholder variable to contain your additions +# to the prompt when using the -inner mode. # Changing this setting will update the prompt immediately, unlike editing your theme. # # An additional variable available within this format is '$uber', which expands to @@ -198,11 +203,11 @@ sub _print_help { " or a script", "/PROMPT SET changes the contents of the prompt, according to the mode", " and content provided.", - " -inner sets the value of the \$uber psuedo-variable in the", + " { -inner sets the value of the \$uber psuedo-variable in the", " /set uberprompt_format setting.", - " -pre places the content before the current prompt string", - " -post places the content after the prompt string", - " -only replaces the entire prompt contents with the given string", + " | -pre places the content before the current prompt string", + " | -post places the content after the prompt string", + " | -only replaces the entire prompt contents with the given string }", "", "See Also:", '', -- cgit v1.2.3