Create a directory for EEPROMs if it doesn't already exist
[clinton/Virtual-Jaguar-Rx.git] / docs / virtualjaguar.1
CommitLineData
cf76e892
JPM
1.TH virtualjaguar 1 2017-09-06 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
11Virtualjaguar is an emulator for the Atari Jaguar videogame system.
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 \-a, \-\-debugger
28Run in Debugger emulation mode
29.TP
30.B \-a, \-\-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 SOUND
49DSP emulation is needed for audio output
50.TP
51.B \-d, \-\-dsp
52Enable DSP emulation
53.TP
54.B \-\-no\-dsp
55Disable DSP emulation
56
57.SH VIDEO
58.TP
59.B \-f, \-\-fullscreen
60Start in full screen mode
61.TP
62.B \-p, \-\-pal
63PAL mode
64.TP
65.B \-n, \-\-ntsc
66NTSC mode
67.TP
68.B \-B, \-\-blur
69Enable GL bilinear filter
70.TP
71.B \-\-no\-blur
72Disable GL bilinear filter
73.TP
74.B \-z, \-\-please\-dont\-kill\-my\-computer
75Do not show emulation of tv static. This can be slow on low end CPUs.
76
77.SH CONTROLS
78.TP
79.B Ctrl-Q
80Quit virtualjaguar
81.TP
82.B Ctrl-I
83Load a new program
84.TP
85.B Esc
86Pause emulation
87.TP
88.B F7
89Advance the emulation by a single frame
90.TP
91.B F9
92Toggle full screen mode
93
94.TP
95The default keybindings for controller 1 are:
96(Keybindings can be changed in the configuration dialog.)
97.TP
98.B S
99Up
100.TP
101.B X
102Down
103.TP
104.B A
105Left
106.TP
107.B D
108Right
109.TP
110.B P
111Pause
112.TP
113.B O
114Option
115.TP
116.B J
117Button C
118.TP
119.B K
120Button B
121.TP
122.B L
123Button A
124.TP
125.B 1 through 0
126Buttons 1 through 0 on the keypad
127.TP
128.B =
129Keypad *
130.TP
131.B -
132Keypad #
133
134.SH FILES
135.TP
136.B virtualjaguar.log
137Virtualjaguar log file. Only written if the log option (\-l or
138\-\-log) is given. If the file cannot be opened, the log it sent to
139standard output instead. The log file is overwritten on startup. Note
140that the file is written to the current directory.
141.TP
142.B ${XDG_DATA_HOME}/virtualjaguar/eeproms/ (typically ~/.local/share/data/virtualjaguar/eeproms/)
143Some Atari Jaguar cartridges feature a small writable EEPROM, used for
144saving game state and score lists. If this directory exists,
145virtualjaguar will emulate the EEPROM by saving the state in file in
146this directory.
147.TP
148.B ${XDG_DATA_HOME}/virtualjaguar/software/ (typically ~/.local/share/data/virtualjaguar/software/)
149The virtualjaguar GUI for loading software scans this directory, and
150shows the loadable files, along with information about the program,
151and a label image if one is included in a zip archive of the software.
152
153.SH AUTHOR
154This manual page was written by Teemu Hukkanen <tjhukkan@iki.fi>.
155Additional informations written by Flynn.