summaryrefslogtreecommitdiff
path: root/docs/help/in/eval.in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-03 21:42:37 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-03 21:42:37 +0200
commitf295a02cdafff01d7b7161f62bf8a2327fbb10fa (patch)
treeb51e93b068ed2931cba35e89dba33ea54eb8e170 /docs/help/in/eval.in
parent037fae0ed567eedefe5550d0688cf5b42a53b6c7 (diff)
downloadirssi-f295a02cdafff01d7b7161f62bf8a2327fbb10fa.zip
Syntax documentation rewrite for E-commands
Rewrote the syntax documentation for commands starting with the letter E.
Diffstat (limited to 'docs/help/in/eval.in')
-rw-r--r--docs/help/in/eval.in23
1 files changed, 21 insertions, 2 deletions
diff --git a/docs/help/in/eval.in b/docs/help/in/eval.in
index 8ea0652a..74a0c536 100644
--- a/docs/help/in/eval.in
+++ b/docs/help/in/eval.in
@@ -1,6 +1,25 @@
+%9Syntax:%9
+
@SYNTAX:eval@
-Evaluates the given commands and executes them. Internal variables
-are expanded. See the special_vars.txt file in the docs-directory.
+%9Parameters:%9
+
+ The commands to evaluate.
+
+%9Description:%9
+
+ Evaluates the given commands and executes them; you can use internal
+ variables and separate multiple commands by using the ";" character.
+
+%9Examples%9
+
+ /EVAL echo I am connected to ${S} on ${chatnet} as ${N}
+ /EVAL echo My user privileges are +${usermode}; echo Let's party!
+
+%9References:%9
+
+ https://github.com/irssi/irssi/blob/master/docs/special_vars.txt
+
+%9See also:%9 CAT, CD, ECHO, EXEC