This is an automated email from the ASF dual-hosted git repository.
paulk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git
The following commit(s) were added to refs/heads/master by this push:
new 9b781ce2e8 GROOVY-8162: Update Groovysh to JLine3 (additional
documentation)
9b781ce2e8 is described below
commit 9b781ce2e8b5ad790376710705d61805c0b5cfa7
Author: Paul King <[email protected]>
AuthorDate: Sat Aug 2 15:45:19 2025 +1000
GROOVY-8162: Update Groovysh to JLine3 (additional documentation)
---
.../src/spec/doc/assets/img/repl_less.png | Bin 0 -> 737258 bytes
.../groovy-groovysh/src/spec/doc/groovysh.adoc | 93 +++++----------------
2 files changed, 19 insertions(+), 74 deletions(-)
diff --git a/subprojects/groovy-groovysh/src/spec/doc/assets/img/repl_less.png
b/subprojects/groovy-groovysh/src/spec/doc/assets/img/repl_less.png
new file mode 100644
index 0000000000..1361e33a88
Binary files /dev/null and
b/subprojects/groovy-groovysh/src/spec/doc/assets/img/repl_less.png differ
diff --git a/subprojects/groovy-groovysh/src/spec/doc/groovysh.adoc
b/subprojects/groovy-groovysh/src/spec/doc/groovysh.adoc
index 2fa26c8792..692b61d3c4 100644
--- a/subprojects/groovy-groovysh/src/spec/doc/groovysh.adoc
+++ b/subprojects/groovy-groovysh/src/spec/doc/groovysh.adoc
@@ -342,54 +342,28 @@ org.apache.commons:commons-email:
This command can be given at any time to add new dependencies.
-[[GroovyShell-display]]
+[[GroovyShell-less]]
===== `/less`
-Display the contents of all existing import, type, method and variable
snippets.
+Display the contents of a file (usually a page at a time).
+Formatting of common file types is supported.
-[[GroovyShell-Example]]
-Example
-
------------------------
-groovy:000> class Foo {
-groovy:001> def bar
-groovy:002> def baz() {
-groovy:003> :display
- 001> class Foo {
- 002> def bar
- 003> def baz() {
------------------------
+image:assets/img/repl_less.png[Usage of the /less command, width=85%]
[[GroovyShell-clear]]
===== `/clear`
-Clears the current buffer, resetting the prompt counter to 000. Can be used to
recover from compilation errors.
-
-[[GroovyShell-show]]
-===== `show`
-
-Show variables, classes or preferences or imports.
-
-[[GroovyShell-showvariables]]
-`show variables`
+Clears the screen.
---------------------------
-groovy:000> :show variables
-Variables:
- _ = true
---------------------------
+[[GroovyShell-reset]]
+===== `/reset`
-[[GroovyShell-showclasses]]
-`show classes`
+Clears the current buffer and shared variables.
-[[GroovyShell-showimports]]
-`show imports`
-
-[[GroovyShell-showpreferences]]
-`show preferences`
+[[GroovyShell-show]]
+===== `/show`
-[[GroovyShell-showall]]
-`show all`
+Show the shared variables (the binding).
[[GroovyShell-prnt]]
===== `/prnt`
@@ -397,7 +371,7 @@ Variables:
The `/prnt` command outputs its argument to the console. Both variable
expansion
and formatting are supported.
-image:assets/img/repl_prnt.png[Echo, width=60%]
+image:assets/img/repl_prnt.png[usage of the /prnt command, width=60%]
See also the `/echo` command, which is similar but takes multiple arguments.
It also supports variable expansion but doesn't support formatting.
@@ -408,28 +382,13 @@ It also supports variable expansion but doesn't support
formatting.
Opens the GUI object browser to inspect a variable or the result of the
last evaluation.
-[[GroovyShell-purge]]
-===== `purge`
-
-Purges objects from the shell.
-
-[[GroovyShell-purgevariables]]
-`purge variables`
+[[GroovyShell-del]]
+===== `/del`
-[[GroovyShell-purgeclasses]]
-`purge classes`
+Deletes objects from the shell.
-[[GroovyShell-purgeimports]]
-`purge imports`
-
-[[GroovyShell-purgepreferences]]
-`purge preferences`
-
-[[GroovyShell-purgeall]]
-`purge all`
-
-[[GroovyShell-edit]]
-===== `edit`
+[[GroovyShell-nano]]
+===== `/nano`
Edit the current buffer in an external editor.
@@ -437,29 +396,15 @@ Currently only works on UNIX systems which have the
`EDITOR` environment
variable set, or have configured the `editor` preference.
[[GroovyShell-load]]
-===== `load`
+===== `/load`
Load one or more files (or urls) into the buffer.
[[GroovyShell-save]]
-===== `save`
+===== `/save`
Saves the buffer’s contents to a file.
-[[GroovyShell-record]]
-===== `record`
-
-Record the current session to a file.
-
-[[GroovyShell-recordstart]]
-`record start`
-
-[[GroovyShell-recordstop]]
-`record stop`
-
-[[GroovyShell-recordstatus]]
-`record status`
-
[[GroovyShell-history]]
===== `history`
