Commit | Line | Data |
---|---|---|
82c1bdcc | 1 | .TH virtualjaguar 1 2021-05-24 Virtualjaguar Rx |
cf76e892 JPM |
2 | .SH NAME |
3 | virtualjaguar \- An Atari Jaguar emulator | |
4 | ||
5 | .SH SYNOPSIS | |
6 | .B virtualjaguar | |
7 | .RI [options] | |
fe3b257d | 8 | .RI [rom image file] |
cf76e892 JPM |
9 | |
10 | .SH DESCRIPTION | |
82c1bdcc | 11 | Virtual Jaguar Rx is an emulator for the Atari Jaguar videogame system. It includes a debugger. |
cf76e892 JPM |
12 | |
13 | .SH OPTIONS | |
14 | .TP | |
15 | .B [rom image file] | |
82c1bdcc | 16 | Name of file to load |
cf76e892 JPM |
17 | .TP |
18 | .B \-a, \-\-alpine | |
19 | Run in Alpine emulation mode | |
20 | .TP | |
21 | .B \-b, \-\-bios | |
22 | Boot using Jaguar BIOS | |
23 | .TP | |
24 | .B \-\-no\-bios | |
25 | Do not use Jaguar BIOS | |
26 | .TP | |
9b25d85d | 27 | .B \-D, \-\-debugger |
cf76e892 JPM |
28 | Run in Debugger emulation mode |
29 | .TP | |
82c1bdcc | 30 | .B \-\-dram-max |
cf76e892 JPM |
31 | Set the main ram to 8MB |
32 | .TP | |
33 | .B \-g, \-\-gpu | |
34 | Enable GPU emulation | |
35 | .TP | |
36 | .B \-\-no\-gpu | |
37 | Disable GPU emulation | |
38 | .TP | |
39 | .B \-l, \-\-log | |
40 | Create and use log file | |
41 | .TP | |
42 | .B \-\-no\-log | |
43 | Do not use log file | |
44 | .TP | |
fe3b257d | 45 | .B \-h, \-?, \-\-help |
cf76e892 JPM |
46 | Show command line help |
47 | ||
fe3b257d JPM |
48 | .SH SETTINGS |
49 | .TP | |
50 | .B \-\-es\-all | |
82c1bdcc JPM |
51 | Erase all settings |
52 | .TP | |
fe3b257d | 53 | .B \-\-es\-ui |
82c1bdcc JPM |
54 | Erase UI settings only |
55 | .TP | |
fe3b257d | 56 | .B \-\-es\-alpine |
82c1bdcc JPM |
57 | Erase alpine mode settings only |
58 | .TP | |
fe3b257d JPM |
59 | .B \-\-es\-debugger |
60 | Erase debugger mode settings only | |
61 | ||
cf76e892 | 62 | .SH SOUND |
82c1bdcc | 63 | DSP emulation is needed for audio output. |
cf76e892 JPM |
64 | .TP |
65 | .B \-d, \-\-dsp | |
66 | Enable DSP emulation | |
67 | .TP | |
68 | .B \-\-no\-dsp | |
69 | Disable DSP emulation | |
70 | ||
71 | .SH VIDEO | |
72 | .TP | |
73 | .B \-f, \-\-fullscreen | |
74 | Start in full screen mode | |
75 | .TP | |
76 | .B \-p, \-\-pal | |
77 | PAL mode | |
78 | .TP | |
79 | .B \-n, \-\-ntsc | |
80 | NTSC mode | |
81 | .TP | |
82 | .B \-B, \-\-blur | |
83 | Enable GL bilinear filter | |
84 | .TP | |
85 | .B \-\-no\-blur | |
86 | Disable GL bilinear filter | |
87 | .TP | |
88 | .B \-z, \-\-please\-dont\-kill\-my\-computer | |
89 | Do not show emulation of tv static. This can be slow on low end CPUs. | |
90 | ||
fe3b257d JPM |
91 | .SH SHORTCUTS |
92 | .TP | |
93 | The default key bindings are: | |
cf76e892 | 94 | .TP |
82c1bdcc JPM |
95 | .B Ctrl+Q |
96 | Quit virtualjaguar | |
cf76e892 | 97 | .TP |
82c1bdcc JPM |
98 | .B Ctrl+I |
99 | Pick file to load a new program | |
fe3b257d JPM |
100 | .TP |
101 | .B Ctrl+C | |
82c1bdcc | 102 | Configure tab |
fe3b257d JPM |
103 | .TP |
104 | .B Ctrl+S | |
82c1bdcc | 105 | Emulator status |
fe3b257d JPM |
106 | .TP |
107 | .B Ctrl+Shift+F5 | |
82c1bdcc | 108 | Restart program |
fe3b257d JPM |
109 | .TP |
110 | .B F11 | |
82c1bdcc | 111 | Step into code |
fe3b257d JPM |
112 | .TP |
113 | .B F10 | |
82c1bdcc | 114 | Step over code |
cf76e892 JPM |
115 | .TP |
116 | .B Esc | |
82c1bdcc | 117 | Pause emulation |
cf76e892 JPM |
118 | .TP |
119 | .B F7 | |
82c1bdcc | 120 | Advance the emulation by a single frame |
cf76e892 JPM |
121 | .TP |
122 | .B F9 | |
82c1bdcc | 123 | Toggle full screen mode |
fe3b257d JPM |
124 | .TP |
125 | .B F8 | |
126 | Screenshot | |
82c1bdcc JPM |
127 | .TP |
128 | .B Ctrl+B | |
129 | Function breakpoint | |
130 | .TP | |
131 | .B Ctrl+Alt+B | |
132 | Breakpoints list | |
133 | .TP | |
134 | .B Ctrl+Shift+F9 | |
135 | Delete all breakpoints | |
cf76e892 | 136 | |
fe3b257d | 137 | .SH CONTROLS |
cf76e892 | 138 | .TP |
fe3b257d JPM |
139 | The default key bindings for controller 1 are: |
140 | (Key bindings can be changed in the configuration dialog.) | |
cf76e892 JPM |
141 | .TP |
142 | .B S | |
82c1bdcc | 143 | Up |
cf76e892 JPM |
144 | .TP |
145 | .B X | |
82c1bdcc | 146 | Down |
cf76e892 JPM |
147 | .TP |
148 | .B A | |
82c1bdcc | 149 | Left |
cf76e892 JPM |
150 | .TP |
151 | .B D | |
82c1bdcc | 152 | Right |
cf76e892 JPM |
153 | .TP |
154 | .B P | |
82c1bdcc | 155 | Pause |
cf76e892 JPM |
156 | .TP |
157 | .B O | |
82c1bdcc | 158 | Option |
cf76e892 JPM |
159 | .TP |
160 | .B J | |
82c1bdcc | 161 | Button C |
cf76e892 JPM |
162 | .TP |
163 | .B K | |
82c1bdcc | 164 | Button B |
cf76e892 JPM |
165 | .TP |
166 | .B L | |
82c1bdcc | 167 | Button A |
cf76e892 JPM |
168 | .TP |
169 | .B 1 through 0 | |
170 | Buttons 1 through 0 on the keypad | |
171 | .TP | |
172 | .B = | |
173 | Keypad * | |
174 | .TP | |
175 | .B - | |
176 | Keypad # | |
177 | ||
178 | .SH FILES | |
fe3b257d | 179 | .PP |
cf76e892 JPM |
180 | .B virtualjaguar.log |
181 | Virtualjaguar log file. Only written if the log option (\-l or | |
182 | \-\-log) is given. If the file cannot be opened, the log it sent to | |
183 | standard output instead. The log file is overwritten on startup. Note | |
184 | that the file is written to the current directory. | |
fe3b257d JPM |
185 | .PP |
186 | .B ${XDG_DATA_HOME}/virtualjaguar/screenshots/ (typically ~/.local/share/data/virtualjaguar/screenshots/) | |
187 | Screenshots will be save in this directory. | |
188 | .PP | |
cf76e892 JPM |
189 | .B ${XDG_DATA_HOME}/virtualjaguar/eeproms/ (typically ~/.local/share/data/virtualjaguar/eeproms/) |
190 | Some Atari Jaguar cartridges feature a small writable EEPROM, used for | |
191 | saving game state and score lists. If this directory exists, | |
192 | virtualjaguar will emulate the EEPROM by saving the state in file in | |
193 | this directory. | |
fe3b257d | 194 | .PP |
cf76e892 JPM |
195 | .B ${XDG_DATA_HOME}/virtualjaguar/software/ (typically ~/.local/share/data/virtualjaguar/software/) |
196 | The virtualjaguar GUI for loading software scans this directory, and | |
197 | shows the loadable files, along with information about the program, | |
198 | and a label image if one is included in a zip archive of the software. | |
199 | ||
200 | .SH AUTHOR | |
201 | This manual page was written by Teemu Hukkanen <tjhukkan@iki.fi>. | |
fe3b257d | 202 | Additional information written by Jean-Paul Mari <djipi.mari@gmail.com>. |