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