summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRob Hoelz <rob@hoelz.ro>2014-04-02 07:38:26 -0500
committerRob Hoelz <rob@hoelz.ro>2014-04-02 07:38:26 -0500
commitcf700a148731499e63ee50497c82350d3dea342e (patch)
tree600ec3960ee509f21c47e2fb57adc9e98de1d15c
parentd1eef79264aa5b0aa1b56ff77d03ab4b8803e9c1 (diff)
downloadlua-term-cf700a148731499e63ee50497c82350d3dea342e.tar.gz
lua-term-cf700a148731499e63ee50497c82350d3dea342e.tar.bz2
lua-term-cf700a148731499e63ee50497c82350d3dea342e.zip
Document jump
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index cfae2e4..2f19b4b 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,7 @@ Usage
26 term.clear() -- clears the screen 26 term.clear() -- clears the screen
27 term.cleareol() -- clears from the cursor to the end of the line 27 term.cleareol() -- clears from the cursor to the end of the line
28 term.cursor.goto(1, 1) 28 term.cursor.goto(1, 1)
29 term.cursor.jump(1, 1) -- jump is just an alias for goto
29 term.cursor.goto(io.stdout, 1, 1) 30 term.cursor.goto(io.stdout, 1, 1)
30 term.cursor.goup(1) 31 term.cursor.goup(1)
31 term.cursor.godown(1) 32 term.cursor.godown(1)
@@ -117,6 +118,10 @@ print(colors.red, 'hello', colors.reset)
117 118
118Place the cursor at (`x`, `y`). 119Place the cursor at (`x`, `y`).
119 120
121### `term.cursor.jump([opt_file], x, y)`
122
123An alias for `term.cursor.goto`.
124
120### `term.cursor.goup([opt_file], nlines)` 125### `term.cursor.goup([opt_file], nlines)`
121 126
122Moves the cursor up `nlines` lines. 127Moves the cursor up `nlines` lines.