mirror of
https://git.sr.ht/~crc_/retroforth
synced 2024-11-16 19:48:56 +01:00
some corrections to the manual (remove a reference to the "ok" prompt, clarify that retro does not display it, remove references to some old command line options)
FossilOrigin-Name: c803aaadf0e83931f55155004815c3c92bdaa0e5927de86ad406d70095e91b87
This commit is contained in:
crc
parent
1f7d3091b8
commit
09ca6158a7
5 changed files with 28 additions and 44 deletions
|
|
@ -338,7 +338,7 @@ RETRO can be run for scripting or interactive use.
|
|||
## Interactive
|
||||
|
||||
To start it interactively, run: `retro` without any command line
|
||||
arguments, or with `-i`, `-s`, or `-i,c`.
|
||||
arguments, or with `-i`.
|
||||
|
||||
Starting the interactive system:
|
||||
|
||||
|
|
@ -354,23 +354,14 @@ retro -i
|
|||
|
||||
This should be sufficient for most uses.
|
||||
|
||||
Starting the interactive system (without displaying the
|
||||
startup banner):
|
||||
|
||||
```
|
||||
retro -s
|
||||
```
|
||||
|
||||
## Using In a Pipe
|
||||
|
||||
If using a Unix shell and piping input between processes, you
|
||||
will probably want to use `-s` to suppress the startup messages
|
||||
and `Ok` prompt that normally appear.
|
||||
Retro will work with piped input.
|
||||
|
||||
E.g.,
|
||||
|
||||
```
|
||||
echo "'lol s:put nl" | retro -s
|
||||
echo "'lol s:put nl" | retro
|
||||
```
|
||||
|
||||
## Running A Program In A File
|
||||
|
|
@ -409,11 +400,10 @@ For a summary of the full command line arguments available:
|
|||
|
||||
Interactive Usage:
|
||||
|
||||
retro [-h] [-i] [-c] [-s] [-f filename] [-t]
|
||||
retro [-h] [-i] [-f filename] [-t]
|
||||
|
||||
-h Display this help text
|
||||
-i Interactive mode (line buffered)
|
||||
-s Suppress the startup text
|
||||
-f filename Run the contents of the specified file
|
||||
-t Run tests (in ``` blocks) in any loaded files
|
||||
|
||||
|
|
@ -427,19 +417,23 @@ retro -i
|
|||
|
||||
You should see something similar to this:
|
||||
|
||||
RETRO 12 (2019.6)
|
||||
RETRO 12 (2021.7)
|
||||
8388608 MAX, TIB @ 1025, Heap @ 9374
|
||||
|
||||
At this point you are at the *listener*, which reads and
|
||||
processes your input. You are now set to begin exploring
|
||||
RETRO.
|
||||
|
||||
RETRO is normally silent; unlike other Forth systems, it
|
||||
does not display an "ok" prompt.
|
||||
|
||||
To exit, run `bye`:
|
||||
|
||||
```
|
||||
bye
|
||||
```
|
||||
|
||||
|
||||
# Unu: Simple, Literate Source Files
|
||||
|
||||
RETRO is written in a literate style. Most of the sources
|
||||
|
|
|
|||
|
|
@ -8,15 +8,19 @@ retro -i
|
|||
|
||||
You should see something similar to this:
|
||||
|
||||
RETRO 12 (2019.6)
|
||||
RETRO 12 (2021.7)
|
||||
8388608 MAX, TIB @ 1025, Heap @ 9374
|
||||
|
||||
At this point you are at the *listener*, which reads and
|
||||
processes your input. You are now set to begin exploring
|
||||
RETRO.
|
||||
|
||||
RETRO is normally silent; unlike other Forth systems, it
|
||||
does not display an "ok" prompt.
|
||||
|
||||
To exit, run `bye`:
|
||||
|
||||
```
|
||||
bye
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ RETRO can be run for scripting or interactive use.
|
|||
## Interactive
|
||||
|
||||
To start it interactively, run: `retro` without any command line
|
||||
arguments, or with `-i`, `-s`, or `-i,c`.
|
||||
arguments, or with `-i`.
|
||||
|
||||
Starting the interactive system:
|
||||
|
||||
|
|
@ -21,23 +21,14 @@ retro -i
|
|||
|
||||
This should be sufficient for most uses.
|
||||
|
||||
Starting the interactive system (without displaying the
|
||||
startup banner):
|
||||
|
||||
```
|
||||
retro -s
|
||||
```
|
||||
|
||||
## Using In a Pipe
|
||||
|
||||
If using a Unix shell and piping input between processes, you
|
||||
will probably want to use `-s` to suppress the startup messages
|
||||
and `Ok` prompt that normally appear.
|
||||
Retro will work with piped input.
|
||||
|
||||
E.g.,
|
||||
|
||||
```
|
||||
echo "'lol s:put nl" | retro -s
|
||||
echo "'lol s:put nl" | retro
|
||||
```
|
||||
|
||||
## Running A Program In A File
|
||||
|
|
@ -76,10 +67,9 @@ For a summary of the full command line arguments available:
|
|||
|
||||
Interactive Usage:
|
||||
|
||||
retro [-h] [-i] [-c] [-s] [-f filename] [-t]
|
||||
retro [-h] [-i] [-f filename] [-t]
|
||||
|
||||
-h Display this help text
|
||||
-i Interactive mode (line buffered)
|
||||
-s Suppress the startup text
|
||||
-f filename Run the contents of the specified file
|
||||
-t Run tests (in ``` blocks) in any loaded files
|
||||
|
|
|
|||
|
|
@ -51,15 +51,19 @@ Start RETRO in interactive mode:
|
|||
<span class="tt">```</span></span><br/><br/>
|
||||
You should see something similar to this:
|
||||
<br/><br/>
|
||||
<tt class='indentedcode'>RETRO 12 (2019.6)</tt>
|
||||
<tt class='indentedcode'>RETRO 12 (2021.7)</tt>
|
||||
<tt class='indentedcode'>8388608 MAX, TIB @ 1025, Heap @ 9374</tt>
|
||||
<br/><br/>
|
||||
At this point you are at the <strong>listener</strong>, which reads and
|
||||
processes your input. You are now set to begin exploring
|
||||
RETRO.
|
||||
<br/><br/>
|
||||
RETRO is normally silent; unlike other Forth systems, it
|
||||
does not display an "ok" prompt.
|
||||
<br/><br/>
|
||||
To exit, run <span class="tt">bye</span>:
|
||||
<br/><br/>
|
||||
<span class='codeblock'><span class="tt">```</span><br/><span class="tt">bye </span><br/>
|
||||
<span class="tt">```</span></span></p>
|
||||
<span class="tt">```</span></span><br/><br/>
|
||||
</p>
|
||||
</body></html>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ RETRO can be run for scripting or interactive use.
|
|||
<span class="h2">Interactive</span>
|
||||
<br/><br/>
|
||||
To start it interactively, run: <span class="tt">retro</span> without any command line
|
||||
arguments, or with <span class="tt">-i</span>, <span class="tt">-s</span>, or <span class="tt">-i,c</span>.
|
||||
arguments, or with <span class="tt">-i</span>.
|
||||
<br/><br/>
|
||||
Starting the interactive system:
|
||||
<br/><br/>
|
||||
|
|
@ -62,20 +62,13 @@ Or:
|
|||
<span class="tt">```</span></span><br/><br/>
|
||||
This should be sufficient for most uses.
|
||||
<br/><br/>
|
||||
Starting the interactive system (without displaying the
|
||||
startup banner):
|
||||
<br/><br/>
|
||||
<span class='codeblock'><span class="tt">```</span><br/><span class="tt">retro -s </span><br/>
|
||||
<span class="tt">```</span></span><br/><br/>
|
||||
<span class="h2">Using In a Pipe</span>
|
||||
<br/><br/>
|
||||
If using a Unix shell and piping input between processes, you
|
||||
will probably want to use <span class="tt">-s</span> to suppress the startup messages
|
||||
and <span class="tt">Ok</span> prompt that normally appear.
|
||||
Retro will work with piped input.
|
||||
<br/><br/>
|
||||
E.g.,
|
||||
<br/><br/>
|
||||
<span class='codeblock'><span class="tt">```</span><br/><span class="tt">echo "'lol s:put nl" <span class='defer'>|</span> retro -s </span><br/>
|
||||
<span class='codeblock'><span class="tt">```</span><br/><span class="tt">echo "'lol s:put nl" <span class='defer'>|</span> retro </span><br/>
|
||||
<span class="tt">```</span></span><br/><br/>
|
||||
<span class="h2">Running A Program In A File</span>
|
||||
<br/><br/>
|
||||
|
|
@ -109,11 +102,10 @@ For a summary of the full command line arguments available:
|
|||
<br/><br/>
|
||||
<tt class='indentedcode'>Interactive Usage:</tt>
|
||||
<br/><br/>
|
||||
<tt class='indentedcode'> retro [-h] [-i] [-c] [-s] [-f filename] [-t]</tt>
|
||||
<tt class='indentedcode'> retro [-h] [-i] [-f filename] [-t]</tt>
|
||||
<br/><br/>
|
||||
<tt class='indentedcode'> -h Display this help text</tt>
|
||||
<tt class='indentedcode'> -i Interactive mode (line buffered)</tt>
|
||||
<tt class='indentedcode'> -s Suppress the startup text</tt>
|
||||
<tt class='indentedcode'> -f filename Run the contents of the specified file</tt>
|
||||
<tt class='indentedcode'> -t Run tests (in ``` blocks) in any loaded files</tt>
|
||||
</p>
|
||||
|
|
|
|||
Loading…
Reference in a new issue