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 l Ar loglevel
17.Op Fl p Ar patchfile
18.Op Fl s Ar n
19.Ar file
20.Sh DESCRIPTION
21.Nm
22is a Game Boy Advance emulator.
23The options are as follows:
24.Bl -tag -width Ds
25.It Fl 1
26Scale the window 1\(mu.
27.It Fl 2
28Scale the window 2\(mu.
29.It Fl 3
30Scale the window 3\(mu.
31.It Fl 4
32Scale the window 4\(mu.
33.It Fl 5
34Scale the window 5\(mu.
35.It Fl 6
36Scale the window 6\(mu.
37.It Fl b Ar biosfile , Fl -bios Ar biosfile
38Specify a BIOS file to use during boot.
39If this flag is omitted,
40.Nm
41will use the BIOS specified in the configuration file,
42or a high\(hylevel emulated BIOS if none is specified.
43.It Fl f
44Start the emulator full\(hyscreen.
45.It Fl g
46Start a
47.Xr gdb 1
48session.
49By default the session starts on port 2345.
50.It Fl l Ar loglevel
51Log messages during emulation.
52.Ar loglevel
53is a bitmask defining which types of messages to log:
54.Bl -bullet -compact
55.It
561 \(en fatal errors
57.It
582 \(en errors
59.It
604 \(en warnings
61.It
628 \(en informative messages
63.It
6416 \(en debugging messages
65.It
6632 \(en stub messages for unimplemented features
67.It
68256 \(en in\(hygame errors
69.It
70512 \(en software interrupts
71.It
721024 \(en emulator status messages
73.It
742048 \(en serial I/O messages
75.El
76The default is to log warnings, errors, fatal errors, and status messages.
77.It Fl p Ar patchfile , Fl -patch Ar patchfile
78Specify a patch file in BPS, IPS, or UPS format.
79.It Fl s Ar n , Fl -frameskip Ar n
80Skip every
81.Ar n
82frames.
83.El
84.Sh CONTROLS
85The default controls are as follows:
86.Bl -hang -width "Frame advance" -compact
87.It A
88.Cm x
89.It B
90.Cm z
91.It L
92.Cm a
93.It R
94.Cm s
95.It Start
96.Aq Cm Enter
97.It Select
98.Aq Cm Backspace
99.It Load state
100.Cm F1 Ns \(en Ns Cm F9
101.It Save state
102.Ao Cm Shift Ac Ns \(hy Ns Cm F1 Ns \(en Ns Cm F9
103.It Frame advance
104.Ao Cm Ctrl Ac Ns \(hy Ns Cm n
105.El
106.Sh ENVIRONMENT
107.Bl -tag -width Ds -compact
108.It Ev XDG_CONFIG_HOME
109The location where
110.Nm
111will look for the configuration directory.
112If not set,
113.Pa ~/.config
114is used.
115.El
116.Sh FILES
117.Bl -tag -width Ds -compact
118.It Pa $XDG_CONFIG_HOME/mgba/config.ini
119Default
120.Xr mgba 6
121configuration file.
122.It Pa $XDG_CONFIG_HOME/mgba/qt.ini
123Default
124.Nm mgba-qt
125configuration file.
126.It Pa portable.ini
127If this file exists in the current directory,
128.Nm
129will read
130.Pa config.ini
131and
132.Pa qt.ini
133from the current directory instead of
134.Pa $XDG_CONFIG_HOME/mgba .
135.El
136.Sh AUTHORS
137.An Jeffrey Pfau Aq Mt jeffrey@endrift.com
138.Sh HOMEPAGE
139.Bl -bullet
140.It
141.Lk https://mgba.io/ "mGBA homepage"
142.It
143.Lk https://github.com/mgba-emu/mgba "Development repository"
144.It
145.Lk https://github.com/mgba-emu/mgba/issues "Bug tracker"
146.It
147.Lk https://forums.mgba.io/ "Message board"
148.El