deploy: 78eb657897

docs/api/hilbish/hilbish.editor/index.html

@@ -7,5 +7,7 @@ directly interact with the line editor in use.</p><h3 id=functions class=heading
 <a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><h4 id=getline---string class=heading>getLine() -> string
 <a href=#getline---string class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the current input line.</p><h4 id=getvimregisterregister---string class=heading>getVimRegister(register) -> string
 <a href=#getvimregisterregister---string class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the text that is at the register.</p><h4 id=inserttext class=heading>insert(text)
-<a href=#inserttext class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Inserts text into the line.</p><h4 id=setvimregisterregister-text class=heading>setVimRegister(register, text)
+<a href=#inserttext class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Inserts text into the line.</p><h4 id=getchar---string class=heading>getChar() -> string
+<a href=#getchar---string class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Reads a keystroke from the user. This is in a format
+of something like Ctrl-L..</p><h4 id=setvimregisterregister-text class=heading>setVimRegister(register, text)
 <a href=#setvimregisterregister-text class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets the vim register at <code>register</code> to hold the passed text.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>

docs/api/hilbish/index.html

@@ -63,6 +63,7 @@ a desination.</p><h4 id=methods class=heading>Methods
 <a href=#autoflushauto class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Sets/toggles the option of automatically flushing output.
 A call with no argument will toggle the value.</p><h5 id=flush class=heading>flush()
 <a href=#flush class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Flush writes all buffered input to the sink.</p><h5 id=read---string class=heading>read() -> string
-<a href=#read---string class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Reads input from the sink.</p><h5 id=writestr class=heading>write(str)
+<a href=#read---string class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Reads a liine of input from the sink.</p><h5 id=readall---string class=heading>readAll() -> string
+<a href=#readall---string class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Reads all input from the sink.</p><h5 id=writestr class=heading>write(str)
 <a href=#writestr class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Writes data to a sink.</p><h5 id=writelnstr class=heading>writeln(str)
 <a href=#writelnstr class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Writes data to a sink with a newline at the end.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>

docs/api/hilbish/index.xml

@@ -8,6 +8,7 @@ handler(line, pos) The handler function is the callback for tab completion in Hi
 Functions getLine() -> string Returns the current input line.
 getVimRegister(register) -> string Returns the text that is at the register.
 insert(text) Inserts text into the line.
+getChar() -> string Reads a keystroke from the user. This is in a format of something like Ctrl-L..
 setVimRegister(register, text) Sets the vim register at register to hold the passed text.</description></item><item><title>Interface hilbish.history</title><link>https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.history/</guid><description>Introduction The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.
 Functions add(cmd) Adds a command to the history.
 all() -&amp;gt; table Retrieves all history.

index.xml

@@ -24,6 +24,7 @@ handler(line, pos) The handler function is the callback for tab completion in Hi
 Functions getLine() -> string Returns the current input line.
 getVimRegister(register) -> string Returns the text that is at the register.
 insert(text) Inserts text into the line.
+getChar() -> string Reads a keystroke from the user. This is in a format of something like Ctrl-L..
 setVimRegister(register, text) Sets the vim register at register to hold the passed text.</description></item><item><title>Interface hilbish.history</title><link>https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.history/</guid><description>Introduction The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.
 Functions add(cmd) Adds a command to the history.
 all() -&amp;gt; table Retrieves all history.