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