deploy: 3eb3e564dafcbada761b43aa5ee8cb45e15f447a

versions/document-lua/docs/api/hilbish/index.xml

@@ -2,7 +2,9 @@
 Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -&amp;gt; table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&amp;gt; string? Resolves an alias to its original command. Will thrown an error if the alias doesn&amp;rsquo;t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completion</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/</guid><description>Introduction The completions interface deals with tab completions.
 Functions bins(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&amp;gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.editor</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/</guid><description>Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.
 Functions getLine() -&amp;gt; string Returns the current input line. getVimRegister(register) -&amp;gt; string Returns the text that is at the register. insert(text) Inserts text into the Hilbish command line. getChar() -&amp;gt; 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>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/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 as a table. clear() Deletes all commands from the history. get(index) Retrieves a command from the history based on the index. size() -&amp;gt; number Returns the amount of commands in the history. hilbish.</description></item><item><title>Module hilbish.messages</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.messages/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.messages/</guid><description>Introduction The messages interface defines a way for Hilbish-integrated commands, user config and other tasks to send notifications to alert the user.z The hilbish.message type is a table with the following keys: title (string): A title for the message notification. text (string): The contents of the message. channel (string): States the origin of the message, hilbish.* is reserved for Hilbish tasks. summary (string): A short summary of the text. icon (string): Unicode (preferably standard emoji) icon for the message notification read (boolean): Whether the full message has been read or not.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason.
+Functions add(cmd) Adds a command to the history. all() -&amp;gt; table Retrieves all history as a table. clear() Deletes all commands from the history. get(index) Retrieves a command from the history based on the index. size() -&amp;gt; number Returns the amount of commands in the history. hilbish.</description></item><item><title>Module hilbish.jobs</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.jobs/</guid><description>Introduction Manage interactive jobs in Hilbish via Lua.
+Jobs are the name of background tasks/commands. A job can be started via interactive usage or with the functions defined below for use in external runners.
+Functions add(cmdstr, args, execPath) Creates a new job. This function does not run the job. This function is intended to be all() -&amp;gt; table[@Job] Returns a table of all job objects. disown(id) Disowns a job. This simply deletes it from the list of jobs without stopping it.</description></item><item><title>Module hilbish.messages</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.messages/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.messages/</guid><description>Introduction The messages interface defines a way for Hilbish-integrated commands, user config and other tasks to send notifications to alert the user.z The hilbish.message type is a table with the following keys: title (string): A title for the message notification. text (string): The contents of the message. channel (string): States the origin of the message, hilbish.* is reserved for Hilbish tasks. summary (string): A short summary of the text. icon (string): Unicode (preferably standard emoji) icon for the message notification read (boolean): Whether the full message has been read or not.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason.
 Note that you don&amp;rsquo;t ever need to use the load function that is here as modules can be loaded with a require call like Lua C modules, and the search paths can be changed with the paths property here.</description></item><item><title>Module hilbish.os</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</guid><description> Introduction Provides simple text information properties about the current operating system. This mainly includes the name and version.
 Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OS</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel.
 Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code.

versions/document-lua/index.xml

@@ -60,7 +60,9 @@ Functions abs(path) -> string Returns an absolute version of the path. ba
 Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -&amp;gt; table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&amp;gt; string? Resolves an alias to its original command. Will thrown an error if the alias doesn&amp;rsquo;t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completion</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/</guid><description>Introduction The completions interface deals with tab completions.
 Functions bins(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&amp;gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.editor</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/</guid><description>Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.
 Functions getLine() -&amp;gt; string Returns the current input line. getVimRegister(register) -&amp;gt; string Returns the text that is at the register. insert(text) Inserts text into the Hilbish command line. getChar() -&amp;gt; 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>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/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 as a table. clear() Deletes all commands from the history. get(index) Retrieves a command from the history based on the index. size() -&amp;gt; number Returns the amount of commands in the history. hilbish.</description></item><item><title>Module hilbish.messages</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.messages/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.messages/</guid><description>Introduction The messages interface defines a way for Hilbish-integrated commands, user config and other tasks to send notifications to alert the user.z The hilbish.message type is a table with the following keys: title (string): A title for the message notification. text (string): The contents of the message. channel (string): States the origin of the message, hilbish.* is reserved for Hilbish tasks. summary (string): A short summary of the text. icon (string): Unicode (preferably standard emoji) icon for the message notification read (boolean): Whether the full message has been read or not.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason.
+Functions add(cmd) Adds a command to the history. all() -&amp;gt; table Retrieves all history as a table. clear() Deletes all commands from the history. get(index) Retrieves a command from the history based on the index. size() -&amp;gt; number Returns the amount of commands in the history. hilbish.</description></item><item><title>Module hilbish.jobs</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.jobs/</guid><description>Introduction Manage interactive jobs in Hilbish via Lua.
+Jobs are the name of background tasks/commands. A job can be started via interactive usage or with the functions defined below for use in external runners.
+Functions add(cmdstr, args, execPath) Creates a new job. This function does not run the job. This function is intended to be all() -&amp;gt; table[@Job] Returns a table of all job objects. disown(id) Disowns a job. This simply deletes it from the list of jobs without stopping it.</description></item><item><title>Module hilbish.messages</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.messages/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.messages/</guid><description>Introduction The messages interface defines a way for Hilbish-integrated commands, user config and other tasks to send notifications to alert the user.z The hilbish.message type is a table with the following keys: title (string): A title for the message notification. text (string): The contents of the message. channel (string): States the origin of the message, hilbish.* is reserved for Hilbish tasks. summary (string): A short summary of the text. icon (string): Unicode (preferably standard emoji) icon for the message notification read (boolean): Whether the full message has been read or not.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason.
 Note that you don&amp;rsquo;t ever need to use the load function that is here as modules can be loaded with a require call like Lua C modules, and the search paths can be changed with the paths property here.</description></item><item><title>Module hilbish.os</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</guid><description> Introduction Provides simple text information properties about the current operating system. This mainly includes the name and version.
 Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OS</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel.
 Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code.