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