aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2024-07-14 01:03:50 -0400
committerB. Watson <urchlay@slackware.uk>2024-07-14 01:04:44 -0400
commitdfc8edb273235c2494bad0d119990b2981978cbb (patch)
tree0db55d3ee004dfff4edd5b4858c91b9d3a7a0d09
parent9a50a4df8790a2bcc749e7b178c7cc725ac50691 (diff)
downloadbw-atari8-tools-dfc8edb273235c2494bad0d119990b2981978cbb.tar.gz
listbas: tweak doc.
-rw-r--r--listbas.159
-rw-r--r--listbas.rst58
2 files changed, 26 insertions, 91 deletions
diff --git a/listbas.1 b/listbas.1
index 9b27d5b..146df50 100644
--- a/listbas.1
+++ b/listbas.1
@@ -124,44 +124,8 @@ be prefixed with \fI$\fP if it\(aqs in hex, or no prefix for decimal.
.sp
Color output only works on terminal emulators (or real terminals)
that support ANSI/VT220 style escape codes. This includes all modern
-terminal emulators, and most not\-so\-modern ones in the UNIX world.
-.sp
-The color scheme is adjustable via the \fB\-c\fP option; see
-\fBCustomization\fP, below. To avoid having to give your custom colors on
-the command line every time, see \fBENVIRONMENT\fP, below.
-.sp
-The default color scheme is:
-.INDENT 0.0
-.TP
-.B \fByellow\fP
-Commands. Also "command operators" such as the \fBGOTO\fP in \fBON/GOTO\fP and
-the \fBSTEP\fP in a \fBFOR\fP command. These are really operators as far as
-BASIC is concerned, but it makes more sense to colorize them as commands.
-.TP
-.B \fBgreen\fP
-Operators (except functions and "command operators"), quotes around
-strings, and commas between \fBDATA\fP elements.
-.TP
-.B \fBpurple\fP
-Functions.
-.TP
-.B \fBred\fP
-Numbers (except line numbers at the start of a line) and string
-constants (but not the quotes around the string).
-.TP
-.B \fBcyan\fP
-Line numbers at the start of a line and \fBDATA\fP items.
-.TP
-.B \fBblue\fP
-Comments (\fBREM\fP text).
-.TP
-.B \fBuncolorized\fP
-Variable names.
-.UNINDENT
-.sp
-Black and white are not used by default because presumably, one or the
-other is the background color of the terminal.
-.SS Customization
+terminal emulators, and most not\-so\-modern ones in the UNIX world. See
+\fBNOTES\fP for a list of tested terminal emulators.
.sp
You can customize the colors by using the \fB\-c\fP \fIcolors\fP option, either
on the command line, or in the \fBLISTBAS_OPTS\fP environment variable.
@@ -204,29 +168,29 @@ The order they\(aqre used in the \fIcolors\fP argument is:
.INDENT 0.0
.TP
.B \fB1\fP
-Commands.
+BASIC keywords. Default: \fI3\fP (yellow).
.TP
.B \fB2\fP
-Operators.
+Operators, including quotes around strings and commas between \fBDATA\fP items. Default: \fI2\fP (green).
.TP
.B \fB3\fP
-Functions.
+Functions. Default: \fI5\fP (purple).
.TP
.B \fB4\fP
-Constants.
+Constants (numeric or string). Default: \fI1\fP (red).
.TP
.B \fB5\fP
Line numbers (at the start of a line only; \fBGOTO\fP and \fBGOSUB\fP line numbers
-are constants).
+are constants). Default: \fI6\fP (cyan).
.TP
.B \fB6\fP
-\fBDATA\fP items (but not the commas between them).
+\fBREM\fP text. Default: \fI4\fP (blue).
.TP
.B \fB7\fP
-\fBREM\fP text.
+\fBDATA\fP items (but not the commas between them). Default: \fI6\fP (cyan).
.TP
.B \fB8\fP
-Variable names.
+Variable names. Default: \fIn\fP (uncolorized).
.UNINDENT
.sp
So, the default color scheme is equivalent to:
@@ -235,6 +199,9 @@ So, the default color scheme is equivalent to:
\fB\-c\fP \fI3251646n\fP
.UNINDENT
.UNINDENT
+.sp
+Black and white are not used by default because presumably, one or the
+other is the background color of the terminal.
.SH NOTES
.sp
\fBlistbas\fP will refuse to operate on a LIST\-protected program with
diff --git a/listbas.rst b/listbas.rst
index 855238a..46a44a4 100644
--- a/listbas.rst
+++ b/listbas.rst
@@ -98,44 +98,9 @@ COLORS
Color output only works on terminal emulators (or real terminals)
that support ANSI/VT220 style escape codes. This includes all modern
-terminal emulators, and most not-so-modern ones in the UNIX world.
+terminal emulators, and most not-so-modern ones in the UNIX world. See
+**NOTES** for a list of tested terminal emulators.
-The color scheme is adjustable via the **-c** option; see
-**Customization**, below. To avoid having to give your custom colors on
-the command line every time, see **ENVIRONMENT**, below.
-
-The default color scheme is:
-
-**yellow**
- Commands. Also "command operators" such as the **GOTO** in **ON/GOTO** and
- the **STEP** in a **FOR** command. These are really operators as far as
- BASIC is concerned, but it makes more sense to colorize them as commands.
-
-**green**
- Operators (except functions and "command operators"), quotes around
- strings, and commas between **DATA** elements.
-
-**purple**
- Functions.
-
-**red**
- Numbers (except line numbers at the start of a line) and string
- constants (but not the quotes around the string).
-
-**cyan**
- Line numbers at the start of a line and **DATA** items.
-
-**blue**
- Comments (**REM** text).
-
-**uncolorized**
- Variable names.
-
-Black and white are not used by default because presumably, one or the
-other is the background color of the terminal.
-
-Customization
--------------
You can customize the colors by using the **-c** *colors* option, either
on the command line, or in the **LISTBAS_OPTS** environment variable.
*colors* is a string of exactly 8 characters, each of which must be the
@@ -174,34 +139,37 @@ The colors are the standard ANSI ones, plus *n*:
The order they're used in the *colors* argument is:
**1**
- Commands.
+ BASIC keywords. Default: *3* (yellow).
**2**
- Operators.
+ Operators, including quotes around strings and commas between **DATA** items. Default: *2* (green).
**3**
- Functions.
+ Functions. Default: *5* (purple).
**4**
- Constants.
+ Constants (numeric or string). Default: *1* (red).
**5**
Line numbers (at the start of a line only; **GOTO** and **GOSUB** line numbers
- are constants).
+ are constants). Default: *6* (cyan).
**6**
- **DATA** items (but not the commas between them).
+ **REM** text. Default: *4* (blue).
**7**
- **REM** text.
+ **DATA** items (but not the commas between them). Default: *6* (cyan).
**8**
- Variable names.
+ Variable names. Default: *n* (uncolorized).
So, the default color scheme is equivalent to:
**-c** *3251646n*
+Black and white are not used by default because presumably, one or the
+other is the background color of the terminal.
+
NOTES
=====