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