aboutsummaryrefslogtreecommitdiffstats
path: root/prompt_info/uberprompt.pl
diff options
context:
space:
mode:
authorTom Feist <shabble@metavore.org>2011-04-18 15:33:46 +0000
committerTom Feist <shabble@metavore.org>2011-04-18 15:33:46 +0000
commit344287c95bb566ac158d8986dac97c533bc33a78 (patch)
tree83b84841f7bbc24f0f453310f55aac977d0dd8e2 /prompt_info/uberprompt.pl
parentadded uberprompt readme (diff)
downloadirssi-scripts-344287c95bb566ac158d8986dac97c533bc33a78.tar.gz
irssi-scripts-344287c95bb566ac158d8986dac97c533bc33a78.zip
moved older scripts out of prompt-info to ensure uberprompt readme is correctly generated
Diffstat (limited to 'prompt_info/uberprompt.pl')
-rw-r--r--prompt_info/uberprompt.pl39
1 files changed, 26 insertions, 13 deletions
diff --git a/prompt_info/uberprompt.pl b/prompt_info/uberprompt.pl
index adafee7..6a750ad 100644
--- a/prompt_info/uberprompt.pl
+++ b/prompt_info/uberprompt.pl
@@ -27,22 +27,35 @@ uberprompt_format setting. See below for details.
Although the script is designed primarily for other scripts to set
status information into the prompt, the following commands are available:
-TODO: Document positional settings.
+=over 4
+
+=item * C</prompt set [-inner|-pre|-post|only] E<lt>msgE<gt>>
+
+Sets the prompt to the given argument. Any use of C<$p> in the argument will
+be replaced by the original prompt content.
+
+A parameter corresponding to the C<UP_*> constants listed below is required, in
+the format C</prompt set -inner Hello!>
+
+=item * C</prompt clear>
-/prompt set - sets the prompt to the given argument. $p in the argument will
- 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!'
+Clears the additional data provided to the prompt.
-/prompt set [-inner|-pre|-post|only] <msg>
+=item * C</prompt on>
-/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)
-/prompt off - restore the original irssi prompt and prompt_empty statusbars.
- unloading the script has the same effect.
+Eenables the uberprompt (things may get confused if this is used
+whilst the prompt is already enabled)
-/help prompt - show help for uberprompt commands
+=item * C</prompt off>
+
+Restore the original irssi prompt and prompt_empty statusbars. unloading the
+script has the same effect.
+
+=item * C</help prompt>
+
+show help for uberprompt commands
+
+=back
=head1 UBERPROMPT FORMAT:
@@ -54,7 +67,7 @@ F<default.theme>.
Changing this setting will update the prompt immediately, unlike editing your theme.
An additional variable available within this format is C<$uber>, which expands to
-the content of prompt data provided with the C<UP_INNER> or </prompt set -inner>
+the content of prompt data provided with the C<UP_INNER> or C</prompt set -inner>
placement argument.
For all other placement arguments, it will expand to the empty string.