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