[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/lua-mode a57e25e 293/468: Update documentation
From: |
Philip Kaludercic |
Subject: |
[nongnu] elpa/lua-mode a57e25e 293/468: Update documentation |
Date: |
Thu, 5 Aug 2021 04:58:56 -0400 (EDT) |
branch: elpa/lua-mode
commit a57e25ec8fc2c7a764644129f64c79f63c09adb4
Author: immerrr <immerrr+lua@gmail.com>
Commit: immerrr <immerrr+lua@gmail.com>
Update documentation
---
README.md | 28 +++++++++++++++++++++++-----
lua-mode.el | 40 +++++++++++++++++++++++++++++++++++-----
2 files changed, 58 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index a682f7b..12abf8a 100644
--- a/README.md
+++ b/README.md
@@ -49,8 +49,26 @@ hash-bang line (`#!/usr/bin/lua`). Putting this snippet to
`.emacs` should be en
The following variables are available for customization (see more via `M-x
customize-group lua`):
-- `lua-indent-level` (default `3`): indentation offset in spaces
-- `lua-default-application` (default `"lua"`): command to start up the
interpreter
-- `lua-default-command-switches` (default `"-i"`): arguments to pass to the
interpreter on startup (make sure `-i` is there if you expect working with REPL)
-- `lua-search-url-prefix` (default
`"http://www.lua.org/manual/5.1/manual.html#pdf-"`): base URL for documentation
lookup
-- `lua-indent-string-contents` (default `nil`): set to `t` if you like to have
contents of multiline strings to be indented like comments
+- Var `lua-indent-level` (default `3`): indentation offset in spaces
+- Var `lua-indent-string-contents` (default `nil`): set to `t` if you like to
have contents of multiline strings to be indented like comments
+- Var `lua-mode-hook`: list of functions to execute when lua-mode is
initialized
+- Var `lua-documentation-url` (default
`"http://www.lua.org/manual/5.1/manual.html#pdf-"`): base URL for documentation
lookup
+- Var `lua-documentation-function` (default `browse-url`): function used to
show documentation (`eww` is a viable alternative for Emacs 25)
+
+## LUA SUBPROCESS CREATION
+
+- Var `lua-default-application` (default `"lua"`): command to start up the
subprocess (REPL)
+- Var `lua-default-command-switches` (default `"-i"`): arguments to pass to
the subprocess on startup (make sure `-i` is there if you expect working with
Lua shell interactively)
+- Cmd `lua-start-process`: start new REPL process, usually happens
automatically
+- Cmd `lua-kill-process`: kill current REPL process
+
+## LUA SUBPROCESS INTERACTION
+
+- Cmd `lua-show-process-buffer`: switch to REPL buffer
+- Cmd `lua-hide-process-buffer`: hide window showing REPL buffer
+- Var `lua-always-show`: show REPL buffer after sending something
+- Cmd `lua-send-buffer`: send whole buffer
+- Cmd `lua-send-current-line`: send current line
+- Cmd `lua-send-defun`: send current top-level function
+- Cmd `lua-send-region`: send active region
+- Cmd `lua-restart-with-whole-file`: restart REPL and send whole buffer
diff --git a/lua-mode.el b/lua-mode.el
index 122a51e..8216d1f 100644
--- a/lua-mode.el
+++ b/lua-mode.el
@@ -44,11 +44,41 @@
;; indentation, syntactical font-locking, running interactive shell,
;; interacting with `hs-minor-mode' and online documentation lookup.
-;; Interesting variables:
-;; - `lua-indent-level': indentation offset
-;; - `lua-default-application': command to use as the interpreter
-;; - `lua-default-command-switches': arguments to the interpreter
-;; - `lua-search-url-prefix': url to use for documentation lookup
+;; The following variables are available for customization (see more via
+;; `M-x customize-group lua`):
+
+;; - Var `lua-indent-level':
+;; indentation offset in spaces
+;; - Var `lua-indent-string-contents':
+;; set to `t` if you like to have contents of multiline strings to be
+;; indented like comments
+;; - Var `lua-mode-hook':
+;; list of functions to execute when lua-mode is initialized
+;; - Var `lua-documentation-url':
+;; base URL for documentation lookup
+;; - Var `lua-documentation-function': function used to
+;; show documentation (`eww` is a viable alternative for Emacs 25)
+
+;; These are variables/commands that operate on Lua subprocess:
+
+;; - Var `lua-default-application':
+;; command to start up the subprocess (REPL)
+;; - Var `lua-default-command-switches':
+;; arguments to pass to the subprocess on startup (make sure `-i` is there
+;; if you expect working with Lua shell interactively)
+;; - Cmd `lua-start-process': start new REPL process, usually happens
automatically
+;; - Cmd `lua-kill-process': kill current REPL process
+
+;; These are variables/commands for interaction with Lua subprocess:
+
+;; - Cmd `lua-show-process-buffer': switch to REPL buffer
+;; - Cmd `lua-hide-process-buffer': hide window showing REPL buffer
+;; - Var `lua-always-show': show REPL buffer after sending something
+;; - Cmd `lua-send-buffer': send whole buffer
+;; - Cmd `lua-send-current-line': send current line
+;; - Cmd `lua-send-defun': send current top-level function
+;; - Cmd `lua-send-region': send active region
+;; - Cmd `lua-restart-with-whole-file': restart REPL and send whole buffer
;; See "M-x apropos-command ^lua-" for a list of commands.
;; See "M-x customize-group lua" for a list of customizable variables.
- [nongnu] elpa/lua-mode 694421c 274/468: Add lua-remove-syntax-table-property to syntactic keywords, (continued)
- [nongnu] elpa/lua-mode 694421c 274/468: Add lua-remove-syntax-table-property to syntactic keywords, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode b73794f 276/468: Merge pull request #79 from j-fu/master, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 13f6ffa 277/468: Provide lua--setq-local fallback macro for pre-24.3, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode ce0a813 282/468: Mention xristos in AUTHORS, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 6d66aee 284/468: Redo handling of "stdin:N" in tracebacks, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode d7855bc 285/468: remove function lua-comment-p, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 5995697 286/468: Merge pull request #81 from v2e4lisp/remove-lua-comment-p, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 8a37fce 288/468: Merge pull request #82 from holomorph/browse-url, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode c3b103d 290/468: lua-beginning-of-proc: improve defun header regex, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 522edaf 289/468: with-lua-buffer: mark as debuggable, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode a57e25e 293/468: Update documentation,
Philip Kaludercic <=
- [nongnu] elpa/lua-mode ceb74ae 296/468: Add file test/.nosearch, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode a7780dc 304/468: silence 25.1 byte-compiler, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 37f3c42 306/468: Silence compilation warning about referencing a variable from compile.el, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 148858c 309/468: Migrate tests to buttercup, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 0ce2b96 314/468: Allow to set lua-indent-level as file local variable, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 8b9d895 311/468: Fix comments being spilled into the code (issue #25), Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode cadc1ea 312/468: to-be-fontified-as: improve error messages, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 444ac2f 320/468: Merge 'stable' back into 'master', Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode cae5db6 322/468: Fix derived-mode-p test, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 6511687 323/468: Merge pull request #116 from immerrr/fix-derived-mode-p, Philip Kaludercic, 2021/08/05