summaryrefslogtreecommitdiff
path: root/doc/instruction.txt
blob: 530dab9d2eb1e875528fc6312f7f39569340dcc5 (plain)
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
                      czx81 - A CURSES based ZX81 emulator
                         Copyright (C) 2020 Ian Cowburn
              ZX81 ROM Copyright (C) 1981 Nine Tiles Networks LTD

LICENSE
-------

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.


KEYBOARD
--------

    All normal characters should produce the equivalent character if it exists
    on the ZX81.  The emulator assumes you can generate the characters A-Z which
    will be mapped to the equivalent ZX81 key when a lower case character is
    entered.  An upper case character will generate the shifted version of the
    character as it appeared on the ZX81 keyboard.

    The cursor keys should act as cursor keys.

    The ESCAPE key will display the runtime menu.

    The following keys have the following effects:

    F1          - Emulate the EDIT key (shift 1)
    F2          - Emulate the AND key (shift 2)
    F3          - Emulate the THEN key (shift 3)
    F4          - Emulate the TO key (shift 4)
    F5          - Emulate the GRAPHICS key (shift 9)
    F6          - Emulate the FUNCTION key (shift new line)
    F7          - Emulate the BREAK key (shift space)
    BACKSPACE   - Emulate the RUBOUT key (shift 0)
    DELETE      - Emulate the RUBOUT key (shift 0)

    When emulating the keyboard the key is held down for a default of one frame.
    This can be altered in the runtime menu.


LOADING AND SAVING
------------------

    czx81 will try and load the filename you give it in a LOAD command.  It
    looks in a configured directory (the current directory if none is
    configured).  The file must be a ZX81 snapshot .P file.  The directory
    that it loads from can be configured.  See the CONFIGURATION FILE section.

    If you SAVE a file it will save it in the current directory, or the 
    configured one if one is configured.  Note that the ability to save must
    be enabled.  See the CONFIGURATION FILE section.


RUNTIME MENU
------------

    When you press ESCAPE the runtime menu is displayed and offers the following
    options:

    F1          - Toggle tracing on and off.  When on tracing will display the
                  disassembly at the PC and the state of the Z80 registers.

    F2          - Alter the number of frames the key is held down following a
                  keypress.  The default of 1 works OK for BASIC.

    F3          - Reset the ZX81.

    F4          - Quit the emulator.


CONFIGURATION FILE
------------------

    On startup czx81 will read configuration from the file $HOME/.czx81rc

    The following directive can be used:

    snappath <directory>        - Specifies the location of .P files for loading
                                  and saving, if enabled.

    allowsave                   - Allow the saving of files.


 vim: expandtab spell