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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
|
<!--
PC-BASIC documentation
Copyright (c) 2014-2022 Rob Hagemans
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
http://creativecommons.org/licenses/by-sa/4.0/legalcode
-->
<section>
<h3 id="synopsis">Synopsis</h3>
<code class="flow">
<b>pcbasic</b>
[<var><a href="#p-program">program</a></var>|<var><a href="#p-package">package</a></var>
[<var><a href="#p-output">output</a></var>]]
<span id="placeholder-options">[<var><a href="#options">OPTION</a></var>] ...</span>
</code>
</section>
<hr />
<section>
<h3 id="parameters">Positional arguments</h3>
<p>
Positional arguments must come before any options, must not start with a dash <code><b>-</b></code>.
Any positional arguments that follow options will be ignored.
</p>
<dl>
<dt id="p-program"><code><var>program</var></code></dt>
<dd>
If a <code>.BAS</code> program is specified as the first positional argument,
it will be run.
The
<code><b><a href="#--run">--run</a></b></code>,
<code><b><a href="#--load">--load</a></b></code> and
<code><b><a href="#--convert">--convert</a></b></code> options
override this behaviour.
</dd>
<dt id="p-package"><code><var>package</var></code></dt>
<dd>
If a zipfile <a href="#packages">package</a> or directory is specified as the first positional argument,
any contained <a href="#settings">configuration file <code>PCBASIC.INI</code></a>
will be loaded; usually, it will run a program file in the package.
All other command-line options will override the package configuration file,
note in particular the potential of the
<code><b><a href="#--run">--run</a></b></code>,
<code><b><a href="#--load">--load</a></b></code> and
<code><b><a href="#--convert">--convert</a></b></code> options
to alter the behaviour of the package.
</dd>
<dt id="p-output"><code><var>output</var></code></dt>
<dd>
If a second positional argument is specified, it sets the output file for file format conversion.
This argument is ignored unless the <code><a href="#--convert">--convert</a></code> option is given.
</dd>
</dl>
</section>
<hr />
<section>
<h3 id="options">Options</h3>
<dl>
<dt id="--allow-code-poke">
<code><b>--allow-code-poke</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Allow programs to <code><a href="#POKE">POKE</a></code> into code memory.
</dd>
<dt id="--aspect">
<code><b>--aspect=</b><var>x</var>,<var>y</var></code>
</dt>
<dd>
Set the display aspect ratio to <code><var>x</var></code>:<code><var>y</var></code>.
Only has an effect if combined with <code><b><a href="#--interface">--interface</a>=graphical</b></code>.
</dd>
<dt id="-b">
<code><b>-b</b></code>
</dt>
<dd>
Use the command-line interface. This is identical to
<code><b><a href="#--interface">--interface</a>=cli</b></code>.
</dd>
<dt id="--border">
<code><b>--border=</b><var>width</var></code>
</dt>
<dd>
Set the width of the screen border as a
percentage from 0—100. The percentage refers to the total
width of the borders on both sides as a fraction of the usable
screen width.
Only has an effect if combined with <code><b><a href="#--interface">--interface</a>=graphical</b></code>.
</dd>
<dt id="-c">
<code id="-c"><b>-c=</b><var>statement</var>[<b>:</b><var>statement</var> ...]</code>
</dt>
<dd>
Execute commands as a shell. This is a convenience shorthand and identical to
<code>
<b><a href="#--interface">--interface</a>=none</b>
<b><a href="#--quit">--quit</a>=True</b>
<b><a href="#--exec">--exec</a>=</b><var>statement</var>[<b>:</b><var>statement</var> ...]
</code>.
</dd>
<dt id="--caption">
<code><b>--caption=</b><var>title</var></code>
</dt>
<dd>
Set the title bar caption of the PC-BASIC window.
Default <code><var>title</var></code> is <em>PC-BASIC</em>.
</dd>
<dt id="--cas1">
<code><b>--cas1=</b><var>type</var><b>:</b><var>value</var></code>
</dt>
<dd>
Attach a resource to the <code>CAS1:</code> cassette device.
<code><var>type</var><b>:</b><var>value</var></code> can be
<dl>
<dt><code><b>WAV:</b><var>wav_file</var></code></dt>
<dd>
Connect to the RIFF Wave file <code><var>wav_file</var></code>
with data modulated in IBM PC cassette format.
</dd>
<dt><code><b>CAS:</b><var>cas_file</var></code></dt>
<dd>
Connect to the PCE/PC-BASIC CAS tape image
<code><var>cas_file</var></code>.
</dd>
</dl>
</dd>
<dt id="--codepage">
<code><b>--codepage=</b><var>codepage_id</var>[<b>:nobox</b>]</code>
</dt>
<dd>
Load the specified codepage. The codepage determines which
characters are associated to a given character byte or, in the case
of double-byte codepages, two character bytes. The available codepages are
stored in the <code>codepage/</code> directory; by default, these are:
<ul class="compact">
<li><code><b>437</b></code></li>
<li><code><b>720</b></code></li>
<li><code><b>737</b></code></li>
<li><code><b>775</b></code></li>
<li><code><b>806</b></code></li>
<li><code><b>850</b></code></li>
<li><code><b>851</b></code></li>
<li><code><b>852</b></code></li>
<li><code><b>853</b></code></li>
<li><code><b>855</b></code></li>
<li><code><b>856</b></code></li>
<li><code><b>857</b></code></li>
<li><code><b>858</b></code></li>
<li><code><b>860</b></code></li>
<li><code><b>861</b></code></li>
<li><code><b>862</b></code></li>
<li><code><b>863</b></code></li>
<li><code><b>864</b></code></li>
<li><code><b>865</b></code></li>
<li><code><b>866</b></code></li>
<li><code><b>868</b></code></li>
<li><code><b>869</b></code></li>
<li><code><b>874</b></code></li>
<li><code><b>932</b></code></li>
<li><code><b>934</b></code></li>
<li><code><b>936</b></code></li>
<li><code><b>938</b></code></li>
<li><code><b>949</b></code></li>
<li><code><b>950</b></code></li>
<li><code><b>1258</b></code></li>
<li><code><b>alternativnyj</b></code></li>
<li><code><b>armscii8a</b></code></li>
<li><code><b>big5-2003</b></code></li>
<li><code><b>big5-hkscs</b></code></li>
<li><code><b>georgian-academy</b></code></li>
<li><code><b>georgian-ps</b></code></li>
<li><code><b>iransystem</b></code></li>
<li><code><b>iscii-as</b></code></li>
<li><code><b>iscii-be</b></code></li>
<li><code><b>iscii-de</b></code></li>
<li><code><b>iscii-gu</b></code></li>
<li><code><b>iscii-ka</b></code></li>
<li><code><b>iscii-ma</b></code></li>
<li><code><b>iscii-or</b></code></li>
<li><code><b>iscii-pa</b></code></li>
<li><code><b>iscii-ta</b></code></li>
<li><code><b>iscii-te</b></code></li>
<li><code><b>kamenicky</b></code></li>
<li><code><b>koi8-r</b></code></li>
<li><code><b>koi8-ru</b></code></li>
<li><code><b>koi8-u</b></code></li>
<li><code><b>mazovia</b></code></li>
<li><code><b>mik</b></code></li>
<li><code><b>osnovnoj</b></code></li>
<li><code><b>pascii</b></code></li>
<li><code><b>ruscii</b></code></li>
<li><code><b>russup3</b></code></li>
<li><code><b>russup4ac</b></code></li>
<li><code><b>russup4na</b></code></li>
<li><code><b>viscii</b></code></li>
</ul>.
See the <a href="#codepages">list of codepages</a> in the User's Guide for details.
<br />
The specifier <code><b>nobox</b></code> disables box-drawing recognition
for double-byte character set code pages. By
default, sequences of box-drawing characters are recognised by an
algorithm that isn't as smart as it thinks it is, and displayed as
box drawing rather than as DBCS characters. If <code><b>nobox</b></code>
is set, they will be displayed as DBCS.
</dd>
<dt id="--config">
<code><b>--config=</b><var>config_file</var></code>
</dt>
<dd>
Read a configuration file. The system default configuration is always
read first, but any <a href="#--preset">preset</a> group of options
in a configuration file replaces the whole equivalent default preset group.
</dd>
<dt id="--com1">
<code><b>--com1=</b><var>type</var><b>:</b><var>value</var></code>
</dt>
<dd>
Attach a resource to the <code>COM1:</code> serial device.
<code><var>type</var><b>:</b><var>value</var></code> can be one of the following.
<dl>
<dt>
<code><b>PORT:</b><var>device_name</var></code>
</dt>
<dd>
Connect to a serial device. <code><var>device_name</var></code>
can be a device name such as <code>COM1</code> or
<code>/dev/ttyS0</code> or a number,
where the first serial port is number 0.
</dd>
<dt>
<code><b>SOCKET:</b><var>host</var><b>:</b><var>socket</var></code>
</dt>
<dd>
Connect to a TCP socket on a remote or
local host.
</dd>
<dt>
<code><b>RFC2217:</b><var>host</var><b>:</b><var>socket</var></code>
</dt>
<dd>
Connect using the RFC2217 protocol to a TCP socket on a remote or
local host.
</dd>
<dt>
<code><b>STDIO:</b>[<b>CRLF</b>]</code>
</dt>
<dd>
Connect to standard I/O of the calling shell.
If <code><b>CRLF</b></code> is specified, PC-BASIC replaces <code>CR</code>
characters with <code>LF</code> on its output and <code>LF</code>
with <code>CR</code> on its input. This is more intuitive on Unix shells.
When using a Unix console, you should use <code>stty -icanon</code>
to enable PC-BASIC to read input correctly.
</dd>
</dl>
If this option is not specified, the <code>COM1:</code> device is
unavailable.
</dd>
<dt id="--com2">
<code><b>--com2=</b><var>type</var><b>:</b><var>value</var></code>
</dt>
<dd>
Attach a resource to the <code>COM2:</code> serial device. See
<code><a href="#--com1">--com1</a></code>.
</dd>
<dt id="--convert">
<code><b>--convert=</b>{<b>A</b>|<b>B</b>|<b>P</b>}</code></dt>
<dd>
Convert program to one of the following formats:
<dl class="compact">
<dt><code><b>A</b></code></dt>
<dd>Plain text</dd>
<dt><code><b>B</b></code></dt>
<dd>Tokenised</dd>
<dt><code><b>P</b></code></dt>
<dd>Protected</dd>
</dl>
If <code><var><a href="#p-output">output</a></var></code> is not specified, write to
standard output. If program is not specified, use the argument of
<code><b><a href="#--run">--run</a></b></code> or
<code><b><a href="#--load">--load</a></b></code>. If none of those are
given, read from standard input. Overrides
<code><b><a href="#--resume">--resume</a></b></code>,
<code><b>--run</b></code> and <code><b>--load</b></code>.
</dd>
<dt id="--mouse-clipboard">
<code><b>--mouse-clipboard</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Enable clipboard operations with the mouse. If <code><b>True</b></code> (default),
select text with the left mouse button to copy and paste with the middle mouse button.
</dd>
<dt id="--ctrl-c-break">
<code><b>--ctrl-c-break</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
If <code><b>False</b></code>, follow GW-BASIC behaviour
where <kbd>Ctrl</kbd>+<kbd>C</kbd> breaks <code><a href="#AUTO">AUTO</a></code>
and <code><a href="#INPUT">INPUT</a></code> but not program execution or
<code><a href="#LIST">LIST</a></code>.<br/>
If <code><b>True</b></code>, treat
<kbd>Ctrl</kbd>+<kbd>C</kbd> exactly like
<kbd>Ctrl</kbd>+<kbd>Break</kbd> and
<kbd>Ctrl</kbd>+<kbd>Scroll Lock</kbd> when <code><b><a href="#--interface">--interface</a>=graphical</b></code>.<br/>
With <code><b><a href="#--interface">--interface</a>=</b>{<b>text</b>|<b>cli</b>}</code>,
<kbd>Ctrl</kbd>+<kbd>C</kbd> is always treated like
<kbd>Ctrl</kbd>+<kbd>Break</kbd>.<br/>
Default is <code><b>True</b></code>.
</dd>
<dt id="--current-device">
<code><b>--current-device=</b>{<b>CAS1</b>|<b>@</b>|<b>A</b>|<b>B</b> ... |<b>Z</b>}</code></dt>
<dd>
Set the current device to the indicated PC-BASIC drive letter or
<code><b>CAS1</b></code> for the cassette device. The device chosen
should be mounted to an actual location using
<code><a href="#--mount">--mount</a></code> (or <code><a href="#--cas1">--cas1</a></code>
if the cassette device is chosen).
</dd>
<dt id="--debug">
<code><b>--debug</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
<em>Developer option - use only if you know what you're doing. </em><br />
Enable debugging extension.
</dd>
<dt id="--dimensions">
<code><b>--dimensions=</b><var>x</var>,<var>y</var></code>
</dt>
<dd>
Set window dimensions to <code><var>x</var></code> by
<code><var>y</var></code> pixels. This overrides
<code><a href="#--scaling">--scaling</a>=native</code>
and <code><a href="#--aspect">--aspect</a></code>.
Only has an effect if combined with <code><b><a href="#--interface">--interface</a>=graphical</b></code>.
</dd>
<dt id="--double">
<code id="-d"><b>-d</b></code>
<code><b>--double</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Enable double-precision transcendental math functions. This is
equivalent to the <code><b><a href="#--options">/d</a></b></code> option in GW-BASIC.
</dd>
<dt id="--exec">
<code id="-e"><b>-e=</b><var>statement</var>[<b>:</b><var>statement</var> ...]</code>
<code><b>--exec=</b><var>statement</var>[<b>:</b><var>statement</var> ...]</code>
</dt>
<dd>
Execute BASIC statements. The <code><var>statement</var></code>s are executed
after loading any program but before entering into direct mode or
running it. Multiple statements can be entered by separating them with colons <code><b>:</b></code>.
These will be executed as if they were entered as separate statements, not as a single compound statement:
even if statements such as <code>GOTO</code> or <code>LIST</code> are included, the following statements will still be executed.
The character <code><b>:</b></code> will be interpreted as part of a string if quoted with
single quotes <code><b>"</b></code>. If your calling shell interprets such quotes, you should properly escape them.
</dd>
<dt id="--extension">
<code><b>--extension=</b><var>module_name</var>[<b>,</b><var>module_name</var> ... ]</code>
</dt>
<dd>
<em>Developer option - use only if you know what you're doing. </em><br />
Load extension module(s).
</dd>
<dt id="--font">
<code><b>--font=</b><var>font_name</var>[<b>,</b><var>font_name</var> ... ]</code></dt>
<dd>
Use the specified fonts for the interface. The last fonts specified take precedence, previous ones are
fallback. The available fonts
are stored in <code>font/</code>. By default, the following fonts are
available:
<ul class="compact">
<li><code><b>default</b></code></li>
<li><code><b>cga</b></code></li>
<li><code><b>mda</b></code></li>
<li><code><b>vga</b></code></li>
<li><code><b>olivetti</b></code></li>
<li><code><b>tandy1</b></code></li>
<li><code><b>tandy2</b></code></li>
</ul>.
The font names <code>freedos</code>, <code>univga</code>, and <code>unifont</code>
are treated as synonyms of <code>default</code> unless a font with one of these names
is available. This behaviour is deprecated and these synonyms will be removed in a future version.
See the <a href="#fonts">list of fonts</a> in the User's Guide for details.
</dd>
<dt id="--fullscreen">
<code><b>--fullscreen</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Fullscreen mode.
Only has an effect if combined with <code><b><a href="#--interface">--interface</a>=graphical</b></code>.
</dd>
<dt id="--help">
<code id="-h"><b>-h</b></code>
<code><b>--help</b></code>
</dt>
<dd>
Show a usage message and exit.
</dd>
<dt id="--hide-listing">
<code><b>--hide-listing=</b><var>line_number</var></code>
</dt>
<dd>
Disable listing and saving to plain text of lines beyond <code><var>line_number</var></code>, as in
GW-BASIC beyond <code>65530</code>. Use with care as this allows execution of hidden
lines of code. Default is to list all lines.
</dd>
<dt id="--hide-protected">
<code><b>--hide-protected</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Disable listing and saving to plain text of protected files, as in
GW-BASIC. Use with care as this allows execution of hidden
lines of code.
</dd>
<dt id="--input">
<code id="-i"><b>-i=</b>{<var>input_file</var>|{<b>STDIO</b>|<b>STDIN</b>}[<b>:RAW</b>]}</code>
<code><b>--input=</b>{<var>input_file</var>|{<b>STDIO</b>|<b>STDIN</b>}[<b>:RAW</b>]}</code>
</dt>
<dd>
Retrieve keyboard input from <code><var>input_file</var></code>,
except if <code>KYBD:</code> is read explicitly. Input from
<code>KYBD:</code> files is always read from the keyboard,
following GW-BASIC behaviour.
<br />
If <code><var>input_file</var></code> is <code><b>STDIO:</b></code>
or <code><b>STDIN:</b></code>, keyboard input will be read from standard input.
If <code><b>RAW</b></code> is specified, input will be treated as codepage bytes.
If not, it will be treated as the locale's encoding (probably UTF-8).
</dd>
<dt id="--interface">
<code><b>--interface=</b>[<b>none</b>|<b>cli</b>|<b>text</b>|<b>graphical</b>]</code>
</dt>
<dd>
Choose the type of interface. Not all interfaces will be available on all systems.
The following interface types may be
available:
<dl class="compact">
<dt><code><b>none</b></code></dt>
<dd>Filter for use with pipes. Also <code><b><a href="#-n">-n</a></b></code>.</dd>
<dt><code><b>cli</b></code></dt>
<dd>Command-line interface. Also <code><b><a href="#-b">-b</a></b></code>.</dd>
<dt><code><b>text</b></code></dt>
<dd>ANSI text interface. Also <code><b><a href="#-t">-t</a></b></code>.</dd>
<dt><code><b>graphical</b></code></dt>
<dd>SDL2 graphical interface.</dd>
</dl>
The following values for this option are deprecated:
<dl class="compact">
<dt><code><b>ansi</b></code></dt>
<dd>ANSI text interface. Synonym for <code><b>text</b></code>.</dd>
<dt><code><b>sdl2</b></code></dt>
<dd>SDL2 graphical interface. Synonym for <code><b>graphical</b></code>.</dd>
<dt><code><b>pygame</b></code></dt>
<dd>PyGame graphical interface. Please use <code><b>graphical</b></code> instead.</dd>
<dt><code><b>curses</b></code></dt>
<dd>NCurses text interface. Please use <code><b>text</b></code> instead.</dd>
</dl>
The default is <code><b>graphical</b></code>.
</dd>
<dt id="--keys">
<code id="-k"><b>-k=</b><var>keystring</var></code>
<code><b>--keys=</b><var>keystring</var></code>
</dt>
<dd>
Insert the <code><var>keystring</var></code> into the keyboard buffer.
<code><var>keystring</var></code> may contain escape codes such as <code>\r</code> for return,
<code>\n</code> for line feed and <code>\x<var>XX</var></code> to enter <code>CHR$(&H<var>XX</var>)</code>.
<code><var>keystring</var></code> may contain <a href="#eascii">e-ASCII codes</a> to
indicate keypresses that do not have a regular character encoding. For example,
<code>\0\x0F</code> indicates Shift+Tab.
</dd>
<dt id="--load">
<code id="-l"><b>-l=</b><var>program</var></code>
<code><b>--load=</b><var>program</var></code>
</dt>
<dd>
Start in direct mode with the BASIC <code><var>program</var></code> loaded.
</dd>
<dt id="--logfile">
<code><b>--logfile=</b><var>log_file</var></code>
</dt>
<dd>
Write error and warning messages to
<code><var>log_file</var></code> instead of <code>stderr</code>.
</dd>
<dt id="--lpt1">
<code><b>--lpt1=</b><var>type</var><b>:</b><var>value</var></code>
</dt>
<dd>
Determine where the output goes when writing to the <code>LPT1:</code> parallel device.
<code><var>type</var><b>:</b><var>value</var></code> can be
<dl>
<dt><code><b>PRINTER:</b>[<var>printer_name</var>][<b>:</b><var>trigger</var>]</code></dt>
<dd>
Output is written to a printer. If
<code><var>printer_name</var></code> is not specified, the default
printer is used. Windows and CUPS printers are supported.<br />
The printer will be activated when a file on <code>LPT1:</code is closed,
when a BASIC program terminates or when PC-BASIC is closed.
If specified, <code><var>trigger</var></code> sets an additional trigger
to activate the printer:
<dl class="compact">
<dt><code><b>line</b></code>
<dd>After every line break.</dd>
<dt><code><b>page</b></code>
<dd>After every page break.</dd>
<dt><code><b>close</b></code>
<dd>No additional trigger</dd>
</dl>
The default is <code><b>close</b></code>.
</dd>
<dt><code><b>FILE:</b><var>file_name</var></code></dt>
<dd>
Output is written to a file or character device such as
<code><b>/dev/stdout</b></code> on Unix or <code><b>LPT1</b></code> on Windows.
</dd>
<dt><code><b>STDIO:</b></code></dt>
<dd>
Output is written to the standard output of the calling shell.
</dd>
<dt><code><b>PARPORT:</b><var>port_number</var></code></dt>
<dd>
Output is written to a Centronics parallel port, where <code><var>port_number</var></code>
is <code><b>0</b></code> for the first parallel port, etc.
This option only works with physical parallel ports. To write to a Windows printer or other
device mapped with <code>NET USE LPT1:</code>, use <code><b>FILE:LPT1</b></code> instead.
</dd>
</dl>
The default is <code><b>PRINTER:</b></code>, so that output goes to the default printer
specified by the operating system.
</dd>
<dt id="--lpt2">
<code><b>--lpt2=</b><var>type</var>:<var>value</var></code>
</dt>
<dd>
Attach a resource to the <code>LPT2:</code> parallel device.
See <code><b><a href="#--lpt1">--lpt1</a></b></code>.
Note that, unlike <code>LPT1:</code>, printers connected to <code>LPT2:</code>
do <em>not</em> get activated when a program terminates.
If this option is not specified, <code>LPT2:</code> is unavailable.
</dd>
<dt id="--lpt3">
<code><b>--lpt3=</b><var>type</var>:<var>value</var></code>
</dt>
<dd>
Attach a resource to the <code>LPT3:</code> parallel device.
See <code><b><a href="#--lpt1">--lpt1</a></b></code>.
Note that, unlike <code>LPT1:</code>, printers connected to <code>LPT3:</code>
do <em>not</em> get activated when a program terminates.
If this option is not specified, <code>LPT3:</code> is unavailable.
</dd>
<dt id="--max-files">
<code id="-f"><b>-f=</b><var>number_of_files</var></code>
<code><b>--max-files=</b><var>number_of_files</var></code>
</dt>
<dd>
Set maximum number of open files to
<code><var>number_of_files</var></code>. This is
equivalent to the <code><b><a href="#--options">/f</a></b></code> option in GW-BASIC.
Default is <code><b>3</b></code>.
</dd>
<dt id="--max-memory">
<code><b>--max-memory=</b><var>max_memory</var>[<b>,</b><var>basic_memory_blocks</var>]</code>
</dt>
<dd>
Set the maximum size of the data memory segment to
<code><var>max_memory</var></code> and the maximum size of the data
memory available to BASIC to
<code><var>basic_memory_blocks</var>*16</code>. In PC-BASIC, the
minimum of these values is simply the data memory size; the two
values are allowed for compatibility with the
<code><b><a href="#--options">/m</a></b></code> option in GW-BASIC.
</dd>
<dt id="--max-reclen">
<code id="-s"><b>-s=</b><var>record_length</var></code>
<code><b>--max-reclen=</b><var>record_length</var></code>
</dt>
<dd>
Set maximum record length for <code>RANDOM</code> files to
<code><var>record_length</var></code>. Default is <code><b>128</b></code>, maximum is
<code><b>32767</b></code>. This is equivalent to the
<code><b><a href="#--options">/s</a></b></code> option in GW-BASIC.
</dd>
<dt id="--monitor">
<code><b>--monitor=</b>{<b>rgb</b>|<b>composite</b>|<b>green</b>|<b>amber</b>|<b>grey</b>|<b>mono</b>}</code>
</dt>
<dd>
Sets the monitor type to emulate. Available types are:
<dl class="compact">
<dt><code><b>rgb</b></code></dt>
<dd>RGB colour monitor (default).</dd>
<dt><code><b>composite</b></code></dt>
<dd>
Composite colour monitor.
</dd>
<dt><code><b>green</b></code></dt>
<dd>
Green-tinted monochrome monitor.
</dd>
<dt><code><b>amber</b></code></dt>
<dd>
Amber-tinted monochrome monitor.
</dd>
<dt><code><b>grey</b></code></dt>
<dd>
Greyscale monochrome monitor.
</dd>
<dt><code><b>mono</b></code></dt>
<dd>
Green-tinted monochrome monitor (same as <code><b>green</b></code>).
</dd>
</dl>
On
<code><a href="#SCREEN-statement">SCREEN</a> 2</code> with
<code><b><a href="#--video">--video</a>=</b>{<b>pcjr</b>|<b>tandy</b>|<b>cga</b>}</code>,
<code><b>--monitor=composite</b></code> enables (crude) colour artifacts.
</dd>
<dt id="--mount">
<code><b>--mount=</b>[<var>drive</var><b>:</b><var>path</var>[<b>,</b><var>drive</var><b>:</b><var>path</var> ... ]]</code>
</dt>
<dd>
Assign the path
<code><var>path</var></code> to drive letter <code><var>drive</var>:</code>.
The path can be absolute or relative.
<br />
If this option is not specified: on Windows, all Windows drive letters
will be assigned to PC-BASIC drive
letters; on other systems, the current working directory is assigned to <code>Z:</code>.
If this option is specified but empty, do not mount any drives (except the internal device <code>@:</code>).
</dd>
<dt id="-n">
<code><b>-n</b></code>
</dt>
<dd>
Run PC-BASIC as a command-line filter. Same as
<code><b><a href="#--interface">--interface</a>=none</b></code>.
</dd>
<dt id="--output">
<code id="-o"><b>-o=</b><var>output_file</var>[<b>:append</b>]</code>
<code><b>--output=</b><var>output_file</var>[<b>:append</b>]</code>
</dt>
<dd>
Send screen output to <code><var>output_file</var></code>, except
if <code>SCRN:</code> is written to explicitly. Output to
<code>SCRN:</code> files will always be shown on the screen, as in
GW-BASIC.
<br />
If the specifier <code><b>append</b></code> is given,
the output file is appended to rather than overwritten.
<br />
If <code><var>output_file</var></code> is <code><b>STDIO:</b></code>
or <code><b>STDOUT:</b></code>, screen output will be sent to standard output.
</dd>
<dt id="--peek">
<code><b>--peek=</b>[<var>seg</var><b>:</b><var>addr</var><b>:</b><var>val</var>[<b>,</b><var>seg</var><b>:</b><var>addr</var><b>:</b><var>val</var> ... ]]</code>
</dt>
<dd>
Define <code><a href="#PEEK">PEEK</a></code> preset values. If defined,
<code>DEF SEG <var>seg</var>:? PEEK(<var>addr</var>)</code> will return
<samp><var>val</var></samp>.
</dd>
<dt id="--preset">
<code><b>--preset=</b><var>option_block</var></code>
</dt>
<dd>
Load machine preset options. A preset option corresponds to a
section defined in a config file by a name between square brackets,
like <code class="block">[this]</code> <code><b>--preset=this</b></code> will load all
settings defined in that section. Available presets depend on your
configuration file. See the <a href="#presets">list of default presets</a> in the User's Guide.
</dd>
<dt id="--prevent-close">
<code><b>--prevent-close</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Suppress window close event. This allows BASIC to capture
key combinations that normally close the window.
Graphical interface only. By default, the operating system's key combination to close a window
(usually <kbd>Alt</kbd>+<kbd>F4</kbd>) terminates PC-BASIC. Set
<code><b>--prevent-close</b></code> to allow BASIC to capture
this key combination instead. This is useful if
your program uses this key combination.
</dd>
<dt id="--quit">
<code id="-q"><b>-q</b></code>
<code><b>--quit</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Quit interpreter when execution stops. If combined with
<code><a href="#--run">--run</a></code>, PC-BASIC quits when the program
ends. If set in direct mode, PC-BASIC quits after the first
command is executed.
</dd>
<dt id="--reserved-memory">
<code><b>--reserved-memory=</b><var>number_of_bytes</var></code>
</dt>
<dd>
Reserve <code><var>number_of_bytes</var></code> of memory at the
bottom of the data segment. For compatibility with GW-BASIC.
Default is <code>3429</code> bytes. Lowering this value makes more string and
variable space available for use by programs.
</dd>
<dt id="--resume">
<code><b>--resume</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Resume from saved state. Overrides <code><a href="#--run">--run</a></code> and
<code><a href="#--load">--load</a></code>.
</dd>
<dt id="--run">
<code id="-r"><b>-r=</b><var>program</var></code>
<code><b>--run=</b><var>program</var></code>
</dt>
<dd>
Run the specified <code><var>program</var></code>. Overrides
<code><a href="#--load">--load</a></code>.
</dd>
<dt id="--scaling">
<code><b>--scaling=</b>{<b>smooth</b>|<b>crisp</b>|<b>native</b>}</code>
</dt>
<dd>
Choose scaling method.
<dl>
<dt><code><b>smooth</b></code></dt>
<dd>
The display is smoothly scaled to the largest size that allows for
the correct aspect ratio.
</dd>
<dt><code><b>crisp</b></code></dt>
<dd>
The display is scaled to the same size as with <code><b>smooth</b></code>,
but without smoothing.
</dd>
<dt><code><b>native</b></code></dt>
<dd>
Scaling and aspect ratio are optimised for the display's native
pixel size, without smoothing. <code><b>--scaling=native</b></code>
overrides <code><a href="#--aspect">--aspect.</a></code>
</dd>
</dl>
Default is <code><b>smooth</b></code>.
Only has an effect if combined with <code><b><a href="#--interface">--interface</a>=graphical</b></code>.
</dd>
<dt id="--serial-buffer-size">
<code><b>--serial-buffer-size=</b><var>size</var></code>
</dt>
<dd>
Set serial input buffer <code><var>size</var></code>. Default is
<code>256</code>. If set to <code>0</code>, serial communications are disabled.
</dd>
<dt id="--shell">
<code><b>--shell=</b>[<var>shell-executable</var>]</code>
</dt>
<dd>
Enable the <code><a href="#SHELL">SHELL</a></code>
statement to run the operating system command interpreter <code><var>shell-executable</var></code>.
The executable <code><var>shell-executable</var></code> should support MS-DOS's
<code>COMMAND.COM</code> calling conventions, in particular its <code>/C</code> switch.
Example command interpreters are <code>CMD.EXE</code> on Windows and <code>"wine cmd.exe"</code> on Unix.
If <code><var>shell-executable</var></code> is empty (as it is by default),
the <code><a href="#SHELL">SHELL</a></code> statement is disabled.
</dd>
<dt id="--soft-linefeed">
<code><b>--soft-linefeed</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Do not treat <code>LF</code> in text and program files as a line break. This enables
the highest level of compatibility with GW-BASIC files. If this option is set,
any Linux or Mac text files need to be converted to DOS text before using them with PC-BASIC.
</dd>
<dt id="--sound">
<code><b>--sound</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
<dl class="compact">
<dt><code><b>False</b></code></dt>
<dd>Suppress sound output.</dd>
<dt><code><b>True</b></code></dt>
<dd>Output sound, if a sound driver is available (default).</dd>
</dl>
If sound is on, PC-BASIC will
try to use the SDL2 library first; if it is not available, it will try PortAudio. If neither is available,
sound will be disabled.
The following values for this option are deprecated:
<dl class="compact">
<dt><code><b>none</b></code></dt>
<dd>Suppress sound output. Use <code><b>False</b></code> instead.</dd>
<dt><code><b>interface</b></code></dt>
<dd>Use the native sound engine of the interface. Use <code><b>True</b></code> instead.</dd>
<dt><code><b>sdl2</b></code></dt>
<dd>Use the SDL2 sound generator.</dd>
<dt><code><b>portaudio</b></code></dt>
<dd>Use the PortAudio sound generator.</dd>
<dt><code><b>beep</b></code></dt>
<dd>Use the built-in speaker.</dd>
</dl>
</dd>
<dt id="--state">
<code><b>--state=</b><var>state_file</var></code>
</dt>
<dd>
Set the save-state file to <code><var>state_file</var></code>.
Default is <code>pcbasic.session</code> in the Application Data
directory.
</dd>
<dt id="--syntax">
<code><b>--syntax=</b>{<b>advanced</b>|<b>pcjr</b>|<b>tandy</b>}</code>
</dt>
<dd>
Choose BASIC dialect. Available dialects are:
<dl class="compact">
<dt><code><b>advanced</b></code></dt>
<dd>IBM BASICA</dd>
<dt><code><b>gwbasic</b></code></dt>
<dd>Microsoft GW-BASIC</dd>
<dt><code><b>pcjr</b></code></dt>
<dd>IBM PCjr Cartridge BASIC</dd>
<dt><code><b>tandy</b></code></dt>
<dd>Tandy 1000 GW-BASIC.</dd>
</dl>
Default is <code><b>advanced</b></code>.
</dd>
<dt id="-t">
<code><b>-t</b></code>
</dt>
<dd>
Use text-based interface. Same as
<code><b><a href="#--interface">--interface</a>=text</b></code>.
</dd>
<dt id="--term">
<code><b>--term=</b><var>terminal_program</var></code>
</dt>
<dd>
Set the terminal program run by the PCjr <code><a href="#TERM">TERM</a></code>
command to <code><var>terminal_program</var></code>. This only has an
effect with <code><b><a href="#--syntax">--syntax</a>=</b>{<b>pcjr</b>|<b>tandy</b>}</code>.
</dd>
<dt id="--text-width">
<code><b>--text-width=</b>{<b>40</b>|<b>80</b>}</code>
</dt>
<dd>
Set the number of columns in text mode at startup.
Default is <code><b>80</b></code>.
</dd>
<dt id="--text-encoding">
<code><b>--text-encoding=</b>[<var>encoding</var>]</code>
</dt>
<dd>
Set the text encoding.
<br />
Text files (i.e. plain-text programs and files opened for <code>INPUT</code>
and <code>OUTPUT</code>) stored on a disk device will be assumed to be encoded in
<code><var>encoding</var></code>. Examples of valid encodings are
<code>utf-8</code>, <code>utf-16</code>, <code>latin-1</code>.
<br />
Please ensure that all characters in the
current codepage are included in the encoding you choose; if
this is not the case then such characters will be replaced by
<samp>�</samp> or <samp>?</samp>.
<br />
If <code><var>encoding</var></code> is not set, text files will be treated as
raw bytes in the current PC-BASIC codepage.
</dd>
<dt id="--utf8">
<code><b>--utf8</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
Set the text encoding to UTF-8.
<br />
This option is <em>deprecated</em> and ignored if <code>--text-encoding</code> is set.
Use <code><b><a href="#--text-encoding">--text-encoding</a>=utf-8</b></code> instead.
</dd>
<dt id="--version">
<code id="-v"><b>-v</b></code>
<code><b>--version</b></code>
</dt>
<dd>
Print PC-BASIC version string and exit.
</dd>
<dt id="--video">
<code><b>--video=</b><var>adapter</var></code>
</dt>
<dd>
Set the video adapter to emulate. Available adapters:
<dl class="compact">
<dt><code><b>vga</b></code></dt>
<dd>Video Graphics Array</dd>
<dt><code><b>ega</b></code></dt>
<dd>Enhanced Graphics Adapter</dd>
<dt><code><b>cga</b></code></dt>
<dd>Color/Graphics Adapter</dd>
<dt><code><b>mda</b></code></dt>
<dd>Monochrome Display Adapter</dd>
<dt><code><b>hercules</b></code></dt>
<dd>Hercules Graphics Adapter</dd>
<dt><code><b>pcjr</b></code></dt>
<dd>IBM PCjr graphics</dd>
<dt><code><b>tandy</b></code></dt>
<dd>Tandy 1000 graphics</dd>
<dt><code><b>olivetti</b></code></dt>
<dd>Olivetti M24 graphics</dd>
</dl>
Default is <code><b>vga</b></code>.
<br />
</dd>
<dt id="--video-memory">
<code><b>--video-memory=</b><var>size</var></code>
</dt>
<dd>
Set the amount of emulated video memory available. This affects
the number of video pages that can be used. On PCjr and Tandy, this
can be changed at runtime through the
<code><a href="#CLEAR">CLEAR</a></code> statement;
at least 32768 needs to be available to enter
<code><a href="#SCREEN-statement">SCREEN</a> 5</code> and <code>SCREEN 6</code>.
Default is <code><b>16384</b></code> or PCjr and Tandy and <code><b>262144</b></code> on other
<a href="#--preset">machine presets</a>.
</dd>
<dt id="--wait">
<code id="-w"><b>-w</b></code>
<code><b>--wait</b>[<b>=True</b>|<b>=False</b>]</code>
</dt>
<dd>
If <code><b>True</b></code>, PC-BASIC waits for a keystroke before
closing the window on exit. Only works for
<code><b><a href="#--interface">--interface</a>=graphical</b></code> or
<code><b>--interface=text</b></code>. Default is <code><b>False</b></code>.
</dd>
<dt id="--options">
<code><b>--options=</b><var>gwbasic_options</var></code>
</dt>
<dd>
Set GW-BASIC-style command-line switches. This is a convenience option to facilitate
migration from GW-BASIC. <code><var>gwbasic_options</var></code> is a string that may contain
the following options:
<dl>
<dt>
<code><b>/d</b></code>
</dt>
<dd>
Enable double-precision floating-point math functions.
See also <code><b><a href="#--double">--double</a></b></code>.
</dd>
<dt>
<code><b>/f:</b><var>n</var></code>
</dt>
<dd>
Set the maximum number of open files.
See also <code><b><a href="#--max-files">--max-files</a></b></code>.
</dd>
<dt>
<code><b>/s:</b><var>n</var></code>
</dt>
<dd>
Set the maximum record length for <code>RANDOM</code> files.
See also <code><b><a href="#--max-reclen">--max-reclen</a></b></code>.
</dd>
<dt>
<code><b>/c:</b><var>n</var></code>
</dt>
<dd>
Set the size of the receive buffer for <code>COM</code> devices.
See also <code><b><a href="#--serial-buffer-size">--serial-buffer-size</a></b></code>.
</dd>
<dt>
<code><b>/i</code>
</dt>
<dd>
Statically allocate file control blocks and data buffer. Note that this is already
the default approach in GW-BASIC and PC-BASIC so that this option has no effect.
</dd>
<dt>
<code><b>/m:</b><var>n</var>,<var>m</var></code>
</dt>
<dd>
Set the highest memory location to <code><var>n</var></code> and maximum
BASIC memory size to <code><var>m</var>*16</code> bytes.
See also <code><b><a href="#--max-memory">--max-memory</a></b></code>.
</dd>
<dt>
<code><b>></b><var>filename</var></code>
</dt>
<dd>
Write screen output to <code><var>filename</var></code>.
See also <code><b><a href="#--output">--output</a></b></code>.
</dd>
<dt>
<code><b>>></b><var>filename</var></code>
</dt>
<dd>
Append screen output to <code><var>filename</var></code>.
See also <code><b><a href="#--output">--output</a></b></code>.
</dd>
<dt>
<code><b><</b><var>filename</var></code>
</dt>
<dd>
Read keyboard input from <code><var>filename</var></code>.
See also <code><b><a href="#--input">--input</a></b></code>.
</dd>
</dl>
GW-BASIC-style switches are not case sensitive.
Note that the symbols used in these switches may have different meaning in the shell
from which PC-BASIC is called; you should quote and escape the options as necessary.
</dd>
</dl>
</section>
<hr />
|
