File: brandy.1

package info (click to toggle)
brandy 1.23.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,268 kB
  • sloc: ansic: 39,421; makefile: 91; sh: 1
file content (144 lines) | stat: -rw-r--r-- 3,535 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
.TH BRANDY 1 "28 Dec 2021" "brandy 1.22.12" "BBC BASIC VI interpreter"
.\" This man page was compiled by Darren Salt.

.SH NAME
brandy \- a portable BBC BASIC VI interpreter

.SH SYNOPSIS
.B brandy \-help
.br
.B brandy \-version
.br
.B brandy
.RB [ \-size
.RI < size >]
.RB [ \-fullscreen ]
.RB [ \-swsurface ]
.RB [ \-path
.RI < list >]
.RB [ \-load
.RI < file >]
.RB [ \-chain
.RI < file >]
.RB [ \-quit
.RI < file >]
.RB [ \-lib
.RI < file >]
.RB [ \-ignore ]
.RB [ \-\-
.RI < options >]
.RI [< file >]

.SH DESCRIPTION

.B Brandy
is an interpreter for
.BR "BBC BASIC VI" ,
the dialect of BASIC that Acorn Computers supplied with their ranges of
desktop computers that use the ARM processor such as the Archimedes and
Risc PC, and is still in use on these and compatibles.

.B BASIC V
is a much extended version of BBC BASIC. This was the BASIC used on the
6502-based BBC Micro that Acorn made during the 1980s.

.SH OPTIONS

.TP
.B \-help
Print a summary of these options.

.TP
.BR \-size " <" \fIsize\fP >
Set the size of the Basic workspace to
.I size
bytes when starting the interpreter. The minimum size allowed is 16384 bytes
and anything below this value will be set to it. The maximum size is
2147483644 bytes (4 bytes short of 2GiB).
The size may have a suffix of
.B k
to denote that the size is in kilobytes or
.B m
if it is in megabytes. For example,
.B \-size 100k
will set the workspace size to 100 kilobytes (102400 bytes) and
.B \-size 8m
will set it to eight megabytes (8388608 bytes).

.TP
.BR \-lib " <" \fIfilename\fP >
Load Basic library
.I filename
when the interpreter starts. This option can be
repeated as many times as required to load a number of libraries. This is
equivalent to typing
.B INSTALL
.I filename
at the interpreter's command line. The libraries are loaded in the order
given on the command line. Note that the search order is the reverse of this.

.TP
.BR \-load " <" \fIfilename\fP >
Load Basic program
.I filename
when the interpreter starts.

.TP
.BR \-path " <" \fIdirectory\fP >[,< \fIdirectory\fP ]...
This specifies a list of directories that the interpreter will search when
looking for libraries and programs. The directory names are separated by
commas. The pseudo-variable
.B FILEPATH$
is set to this value.

.TP
.BR \-quit " <" \fIfilename\fP >
Load and run the Basic program
.IR filename .
Leave the interpreter when the program has finished running.

.TP
.BR \-chain " <" \fIfilename\fP >
Load and run the Basic program
.IR filename .
Remain in the interpreter when the program has finished running.

.TP
.B \-ignore
Ignore certain `unsupported feature' errors. By default the interpreter
reports an error whenever it comes across a BASIC V feature that it does not
support. This option allows some unsupported features that do not affect the
basic running of the program to be ignored.

.TP
.RI < filename >
This is exactly equivalent to
.BR \-chain .

.TP
.RI \-nostar
Do not check commands issued via
.B OSCLI
to see if they are dealt with by Brandy. Pass all commands to the
underlying operating system.

.P
The case of the names of the options is ignored. It depends on the operating
system under which the interpreter is running as to whether the names of
files are case sensitive or insensitive.


.SH "SEE ALSO"

.TP
.I /usr/share/doc/brandy
Full documentation.

.TP
.I /usr/share/doc/brandy/examples
Example programs.

.SH AUTHORS

David Daniels, with contributions from Darren Salt and Colin Tuckley.
Matrix Brandy modifications by Michael McConnell and contributors.