~ubuntu-branches/ubuntu/breezy/tiemu/breezy

« back to all changes in this revision

Viewing changes to help/help_en_us

  • Committer: Bazaar Package Importer
  • Author(s): Julien BLACHE
  • Date: 2005-06-02 16:50:15 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 sarge)
  • Revision ID: james.westby@ubuntu.com-20050602165015-59ab24414tl2wzol
Tags: 1.99+svn1460-1
* New snapshot.
* debian/control:
  + Updated build-depends.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
                                ****************
2
 
                                *   GtkTiEmu   *
3
 
                                ****************
4
 
 
5
 
 
6
 
 
7
 
 
8
 
For the installation procedure, see INSTALL.linux
9
 
For a more specific README, see README.linux or README.win32
10
 
 
11
 
 
12
 
+-------------+
13
 
| DESCRIPTION |
14
 
+-------------+
15
 
 
16
 
GtkTiEmu is a program allowing a PC to emulate a TI calculator (at least the
17
 
TI89/92/92+ types for the moment).
18
 
It uses GTK+ (the Gimp ToolKit, http://www.gimp.org/gtk) for the GUI and the SDL (SimpleDirectmedia Layer) for the display. 
19
 
It works on Linux and Windows platforms actually.
20
 
 
21
 
All link cables are supported by the link port: parallel, serial, 
22
 
Black TI Graph Link, Gray TI Graph Link and the (fast)AVRlink.
23
 
 
24
 
GtkTiEmu is based on XTiger, the original TI emulator for Linux (see the AUTHORS file for more details) which uses the 68k emulation core from UAE (The Ultimate Amiga Emulator).
25
 
It also uses the libticables library.
26
 
 
27
 
 
28
 
+----------+
29
 
| FEATURES |
30
 
+----------+
31
 
 
32
 
Some features:
33
 
 
34
 
o Works on 8, 16, 24/32 planes display (256, 65565, 16M/True colors)
35
 
o Easy to use thanks to a GUI developped with GTK+
36
 
o The ability to save the emulator state
37
 
o Full linkport emulation (all link cables, even virtual)
38
 
o Works with Fargo
39
 
o Works with 1Mb & 2Mb ROMS, 128 or 256k memory (but FLASH Apps/OS does not work)
40
 
o Nice debugger (memory, breakpoints, traps, vectors, ...)
41
 
o Constrast emulated (Try [Alt] + [+] & [-])
42
 
o Useable through a Netscape/IE plugin (under development)
43
 
o Pretty fast
44
 
o Sreenshot of LCD or calculator in several images format (JPG/PCX/XPM/BMP)
45
 
o TI keyboard useable directly from PC keyboard or with the mouse on the skin (VTi's skins)
46
 
 
47
 
 
48
 
+---------------------+
49
 
| SYSTEM REQUIREMENTS |
50
 
+---------------------+
51
 
 
52
 
You will need a PC Intel computer. A 100MHz processor is a minimum.
53
 
GtkTiEmu uses roughly 10MB of RAM.
54
 
Nethertheless, it is fast (it starts in 10 seconds on a PC166/64MB). 
55
 
 
56
 
 
57
 
+------------------+
58
 
| ROMDUMPS & FARGO |
59
 
+------------------+
60
 
 
61
 
To run this emulator you will need a ROM dump. As this file is
62
 
copyrighted by Texas Instrument it will never be distributed with
63
 
the emulator. To get a ROM dump, you can use TiLP or any other
64
 
ROM dumping program. TiLP may be interessant because it can be virtually linked
65
 
with the emulator.
66
 
A TI92 requires FargoII for getting a ROM dump.
67
 
 
68
 
If you want to run Fargo on the emulator, you will need to get
69
 
a backup, put the fargo core inside (converted with
70
 
"putfargo") and send it to the emulator.
71
 
 
72
 
 
73
 
+-----------------+
74
 
| HOW TO USE IT ? |
75
 
+-----------------+
76
 
 
77
 
When you launch it, GtkTiEmu take some a while for initializing it. Once you 
78
 
have launched, you should see a window with the look of your calculator. 
79
 
You can either click with the left button on a TI key, either press the 
80
 
correspondant key of your PC keyboard.
81
 
 
82
 
Else, the right button of your mouse let you access a popup menu which contains
83
 
all you need (I hope !) for configuring/using the emulator.
84
 
 
85
 
 
86
 
+------------------+
87
 
| KEYBOARD MAPPING |
88
 
+------------------+
89
 
 
90
 
The keyboard mapping is the same as VTi (since we use VTi's skins), the well 
91
 
known TI emulator for Windows.
92
 
 
93
 
TI92       PC
94
 
---------  ------------
95
 
[Hand]     [Caps Lock]
96
 
[SHIFT]    [Shift]
97
 
[ON]       [Sroll Lock]
98
 
[DIAMOND]  [Ctrl]
99
 
[2ND]      [Alt]
100
 
[STO>]     [Tab]
101
 
[SIN]      [Insert]
102
 
[COS]      [Home]
103
 
[TAN]      [Page Up]
104
 
[LN]       [End]
105
 
[CLEAR]    [Suppr]
106
 
[MODE]     [Page Down]
107
 
[APPS]     [Print Scrn]
108
 
[(-)]      [<]
109
 
[Theta]    [;]
110
 
[+]        [+]
111
 
[-]        [-]
112
 
[X]        [*]
113
 
[Div]      [/]
114
 
[^]        [�]
115
 
[(]        [[]
116
 
[)]        []]
117
 
 
118
 
Letters, Numbers, Cursormovement, F1-F8 + some others are the
119
 
same keys on both keyboards
120
 
 
121
 
Special Keys
122
 
 
123
 
[F9]       Enter Debugger
124
 
[F10]      Do a screen capture
125
 
 
126
 
 
127
 
+-------------------+
128
 
| RIGHT BUTTON MENU |
129
 
+-------------------+
130
 
 
131
 
Rem: the SDL version have a small and tricky bug: you have to double-click the menuitem for activating it.
132
 
The right button menu give you access to the functionnalities of the emulator. If you let your mouse on the item during some while, a tooltip will appear.
133
 
This menu is organized as follow:
134
 
 
135
 
- Send file to GtkTiEmu: load a file and transfer it into the emulator. Not implemented yet. Instead, you will have to use the virtual link for the moment.
136
 
- Command shell (Linux only): display a prompt in the console for directly entering some commands.
137
 
- Config: load/save the current configuration in the config file (~/.gtktiemu ou gtktiemu.ini). The current state is not saved but loaded if it has been previously saved.
138
 
- Link options: configure the link port
139
 
- Enter debugger: see the DEBUGGER section further in the text
140
 
- Set program entry breakpoint: not implemented yet
141
 
- Reset calc: reset the calculator (RAM, FLASH: all !).
142
 
- Calculator state: save/load the current state or load the latest saved stated
143
 
- Emulator options: 
144
 
        Speed: for tuning GtkTiEmu. Only the 'Sync' item is implemented.
145
 
        Colors: allows you to choose the number of grayscales as well as the colors
146
 
        themselves
147
 
        Keys: not implemented yet
148
 
- Skin for current calc: you can choose to display the emulator with a skin or only
149
 
the LCD display. You can also press 'Alt+Enter' for toggling the full-screen mode
150
 
- Screenshot: do a screenshot of the LCD display. The screenshot file is automatically incremented.
151
 
- RAM: dump the RAM content into a file. The file is a text file and contains
152
 
an hexadecimal & character dump.
153
 
- ROM:
154
 
        Dump ROM: dump the ROM content into a file. The file is a text file and
155
 
        contains an hexadecimal & character dump. Beware, this may take some time
156
 
        and space disk for writing the file (roughly 10 MB).
157
 
        ROM file: select a ROM image to load
158
 
        Update file: select a TI FLASH upgrade file to load
159
 
        Set ROM: list all available ROMs (installed in the ROMs directory) as well
160
 
        as a lot of miscellaneous informations.
161
 
        Convert into ROM: allows you to convert a TI's FLASH upgrade into a ROM 
162
 
        image. Useful for emulating a calculator without a ROM image.
163
 
        Remark: the converted ROM image will not have a boot block and so you will 
164
 
        not be able to use some FLASH features.
165
 
- About: display the logo and the license as well as misc informations.
166
 
- Infos: some informations about the calc and the developper
167
 
- Exit and save state: save the current state and quit
168
 
- Exit without saving state: exit immediately without saving the curren state.
169
 
 
170
 
 
171
 
+--------------------+
172
 
| LINKPORT EMULATION |
173
 
+--------------------+
174
 
 
175
 
GtkTiEmu emulates the linkport in two ways. First through a link cable 
176
 
(hardware or virtual).
177
 
GtkTiEmu can communicate with the hardware (parallel, serial, ... link cable) or virtually (TiLP, VTi, another GtkTiEmu application).
178
 
 
179
 
Remark about virtual links: you have the choice between the GtkTiEmu and 
180
 
the VTi virtual link.
181
 
For Windows users: the Vti virtual link allows you to make GtkTiEmu 
182
 
communicate with VTi. It provides also a different linking method of the 
183
 
GtkTiEmu virtual link.
184
 
For Linux users: the 2 possible virtual link are useable.
185
 
Simply choose the best or the fastest.
186
 
 
187
 
For the GtkTiEmu virtual link, the emulator must be set on the channel #0 and the linking program on the channel #1.
188
 
 
189
 
Else, GtkTiEmu can not load files directly from disk. It will be implemented later.
190
 
Sorry (I know that virtual linking is a bit slow) !
191
 
// to do...
192
 
//It can also load files directly from disc and emulate the TI92
193
 
//protocol to load them into the emulator. This is accomplished
194
 
//from the commandstate (see below) with the "load" command
195
 
//(and also the "files" command which is perhaps less obvious).
196
 
 
197
 
 
198
 
+----------+
199
 
| DEBUGGER |
200
 
+----------+
201
 
 
202
 
It does not work in the Win32 version due to a memory bug.
203
 
 
204
 
For quickly launch the debugger, press F9. Else, you can use the right button menu.
205
 
The debugger allows you to monitor the code and registers, place several kind of breakpoints (addresses, traps, exceptions, data, ...) and also single step your instructions.
206
 
 
207
 
Remark: there is a popup menu available on the 'Code' and 'Memory' frames. Simply press your right button mouse for displaying it !
208
 
 
209
 
Currently, the 'Log' menu is not implemented.
210
 
 
211
 
 
212
 
+-------------+
213
 
| SCREENSHOTS |
214
 
+-------------+
215
 
 
216
 
Simply press F10 for doing a screenshot with the current options. The different options can be easily modified in the 'Screenshot options' dialog box.
217
 
You have the choice between several file formats: PCX, XPM, JPG and BMP (SDL/Win32 and SDL/Linux only).
218
 
 
219
 
The screenshot filename is automatically incremented whenever you do a screenshot.
220
 
 
221
 
 
222
 
+--------------+
223
 
| COMMAND LINE |
224
 
+--------------+
225
 
 
226
 
All the informations about the command line and the configuration file format 
227
 
(~/.gtktiemu or gtktiemu.ini) are available in:
228
 
-  the manpage for the Linux users ('man gtktiemu'),
229
 
-  the Manpage.txt file for the Windows users.
230
 
 
231
 
 
232
 
+--------+
233
 
| THANKS |
234
 
+--------+
235
 
 
236
 
Jonas Minnberg for making (X)Tiger from which we have developped GtkTiEmu.
237
 
Rusty Wagner for the calculator skins.
238
 
 
239
 
 
240
 
+------+
241
 
| BUGS |
242
 
+------+
243
 
 
244
 
- FLASH archive works but not FLASH Apps/OS
245
 
- X11 version seems to not start in 8 bit mode
246
 
- X11 & SDL version have not been tested in 32 bit mode (I wasn't be able to
247
 
  to do it)
248
 
 
249
 
If you find a bug, please give your:
250
 
- calc type
251
 
- ROM version & HW type
252
 
- the size and color depth of your screen (Linux users can use the xdpyinfo
253
 
  command)
254
 
- any infos you think interessant.
255
 
Please report any bugs at <rlievin@mail.com>.
256
 
 
257
 
 
258
 
+------+
259
 
| TODO |
260
 
+------+
261
 
 
262
 
See the TODO file for more informations.
263
 
Nethertheless, if you like programming in GTK+, you could develop a skin editor for Linux. Mail me, you will have all my help !
264
 
 
265
 
 
266
 
+-----------+
267
 
| COPYRIGHT |
268
 
+-----------+
269
 
 
270
 
gtktiemu and the libti68k library are Copyright (C) 2000-2001 by Romain Lievin 
271
 
<rlievin@mail.com> and Thomas Corvazier <corvazier@yahoo.com>
272
 
libticables is Copyright (c) 1999-2001 by Romain Lievin <rlievin@mail.com>
273
 
 
274
 
The libti68k library is based on the XTiger emulator (see AUTHORS for more 
275
 
details) which is based on UAE (Universal Amiga Emulator).
276
 
 
277
 
 
278
 
Copying is allowed under the terms of GNU General Public License (LGPL).  
279
 
See the file COPYING for more details.