all repos — mgba @ bb1ce789d268b484311b121943acf3ce3809c6d7

mGBA Game Boy Advance Emulator

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