doc/mgba-qt.6 (view raw)
1.\" Copyright (c) 2015-2016 Anthony J. Bentley <anthony@anjbe.name>
2.\"
3.\" This Source Code Form is subject to the terms of the Mozilla Public
4.\" License, v. 2.0. If a copy of the MPL was not distributed with this
5.\" file, you can obtain one at https://mozilla.org/MPL/2.0/.
6.Dd July 29, 2015
7.Dt MGBA-QT 6
8.Os
9.Sh NAME
10.Nm mgba-qt
11.Nd Game Boy Advance emulator
12.Sh SYNOPSIS
13.Nm mgba-qt
14.Op Fl 123456fg
15.Op Fl b Ar biosfile
16.Op Fl C Ar option Ns = Ns Ar value
17.Op Fl l Ar loglevel
18.Op Fl p Ar patchfile
19.Op Fl s Ar n
20.Ar file
21.Sh DESCRIPTION
22.Nm
23is a Game Boy Advance emulator.
24The options are as follows:
25.Bl -tag -width Ds
26.It Fl 1
27Scale the window 1\(mu.
28.It Fl 2
29Scale the window 2\(mu.
30.It Fl 3
31Scale the window 3\(mu.
32.It Fl 4
33Scale the window 4\(mu.
34.It Fl 5
35Scale the window 5\(mu.
36.It Fl 6
37Scale the window 6\(mu.
38.It Fl b Ar biosfile , Fl -bios Ar biosfile
39Specify a BIOS file to use during boot.
40If this flag is omitted,
41.Nm
42will use the BIOS specified in the configuration file,
43or a high\(hylevel emulated BIOS if none is specified.
44.It Fl C Ar option Ns = Ns Ar value , Fl -config Ar option Ns = Ns Ar value
45Override the given config
46.Ar option
47with
48.Ar value .
49.It Fl f
50Start the emulator full\(hyscreen.
51.It Fl g
52Start a
53.Xr gdb 1
54session.
55By default the session starts on port 2345.
56.It Fl l Ar loglevel
57Log messages during emulation.
58.Ar loglevel
59is a bitmask defining which types of messages to log:
60.Bl -bullet -compact
61.It
621 \(en fatal errors
63.It
642 \(en errors
65.It
664 \(en warnings
67.It
688 \(en informative messages
69.It
7016 \(en debugging messages
71.It
7232 \(en stub messages for unimplemented features
73.It
74256 \(en in\(hygame errors
75.It
76512 \(en software interrupts
77.It
781024 \(en emulator status messages
79.It
802048 \(en serial I/O messages
81.El
82The default is to log warnings, errors, fatal errors, and status messages.
83.It Fl p Ar patchfile , Fl -patch Ar patchfile
84Specify a patch file in BPS, IPS, or UPS format.
85.It Fl s Ar n , Fl -frameskip Ar n
86Skip every
87.Ar n
88frames.
89.El
90.Sh CONTROLS
91The default controls are as follows:
92.Bl -hang -width "Frame advance" -compact
93.It A
94.Cm x
95.It B
96.Cm z
97.It L
98.Cm a
99.It R
100.Cm s
101.It Start
102.Aq Cm Enter
103.It Select
104.Aq Cm Backspace
105.It Load state
106.Cm F1 Ns \(en Ns Cm F9
107.It Save state
108.Ao Cm Shift Ac Ns \(hy Ns Cm F1 Ns \(en Ns Cm F9
109.It Frame advance
110.Ao Cm Ctrl Ac Ns \(hy Ns Cm n
111.El
112.Sh ENVIRONMENT
113.Bl -tag -width Ds -compact
114.It Ev XDG_CONFIG_HOME
115The location where
116.Nm
117will look for the configuration directory.
118If not set,
119.Pa ~/.config
120is used.
121.El
122.Sh FILES
123.Bl -tag -width Ds -compact
124.It Pa $XDG_CONFIG_HOME/mgba/config.ini
125Default
126.Xr mgba 6
127configuration file.
128.It Pa $XDG_CONFIG_HOME/mgba/qt.ini
129Default
130.Nm mgba-qt
131configuration file.
132.It Pa portable.ini
133If this file exists in the current directory,
134.Nm
135will read
136.Pa config.ini
137and
138.Pa qt.ini
139from the current directory instead of
140.Pa $XDG_CONFIG_HOME/mgba .
141.El
142.Sh AUTHORS
143.An Jeffrey Pfau Aq Mt jeffrey@endrift.com
144.Sh HOMEPAGE
145.Bl -bullet
146.It
147.Lk https://mgba.io/ "mGBA homepage"
148.It
149.Lk https://github.com/mgba-emu/mgba "Development repository"
150.It
151.Lk https://github.com/mgba-emu/mgba/issues "Bug tracker"
152.It
153.Lk https://forums.mgba.io/ "Message board"
154.El