Skip to content

Commit 4f11fac

Browse files
committed
README: update variable descriptions and example to reflect new names
1 parent 94193b9 commit 4f11fac

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,18 @@ Lispect
1414
$ `lispect example.lsp USERNAME@DOMAIN PASSWORD`
1515
→ login `USERNAME@DOMAIN` with `ssh` and input `PASSWORD` automatically
1616

17+
> [!NOTE]
18+
> Some variable names have been updated for compatibility with recent versions of gmnlisp, but the old names remain available for now.
19+
1720
```example.lsp
1821
(catch 'fail
1922
(if (< (length ARGV) 2)
2023
(progn
21-
(format (error-output) "Usage: ~A ~A USERNAME@DOMAIN PASSWORD~%" EXECUTABLE-NAME PROGRAM-NAME)
24+
(format (error-output) "Usage: ~A ~A USERNAME@DOMAIN PASSWORD~%" *executable-name* *program-name*)
2225
(throw 'fail nil)))
2326
24-
(let ((account (car ARGV))
25-
(password (cadr ARGV))
27+
(let ((account (car *argv*))
28+
(password (cadr *argv*))
2629
(sshpid nil))
2730
2831
(with-handler
@@ -110,20 +113,21 @@ Parameters enclosed in curly braces {...} are optional and can be omitted.
110113
- Get the value of the environment variable NAME
111114
- `(setenv "NAME" "VALUE")`
112115
- Set the value of the environment variable NAME as VALUE
113-
- `ARGV`
114-
- The list of command line arguments
115-
- `PROGRAM-NAME`
116-
- The path of the script
117-
- `EXECUTABLE-NAME`
118-
- The path of the executable of lispect
119-
- `MATCH`
120-
- The matching string in the block of `(expect*)`
116+
- `*argv*` (formerly `ARGV`, now deprecated)[^1]
117+
The list of command-line arguments.
118+
- `*program-name*` (formerly `PROGRAM-NAME`, now deprecated)[^1]
119+
The path to the script.
120+
- `*executable-name*` (formerly `EXECUTABLE-NAME`, now deprecated)[^1]
121+
The path to the Lispect executable.
122+
- `*match*` (formerly `MATCH`, now deprecated)[^1]
123+
The matched string in an `(expect*)` block.
121124
- `(catch TAG-FORM FORM...)` and `(throw TAG-FORM RESULT-FORM)`
122125
- Non-local exits. See also [ISLISP draft - 14.7. Non-local exits](https://islisp-dev.github.io/ISLispHyperDraft/islisp-v23.html#non_local_exits)
123126
- `(with-handler HANDLER FORM...)`
124127
- When an error occurs in `FORMS...`, call `HANDLER`.
125128
See also [ISLISP Draft - Operations relating to condition handling](https://islisp-dev.github.io/ISLispHyperDraft/islisp-v23.html#s_with_handler)
126129

130+
[^1]: These variable names were changed to accommodate gmnlisp v0.7.10 and later, in which symbol names are case-insensitive. The new format avoids potential name conflicts.
127131

128132
Other functions are defined on [ISLisp]
129133

0 commit comments

Comments
 (0)