all repos — mgba @ 341ab1ea75d5b8ee58ecf6cb724d697e1ea93626

mGBA Game Boy Advance Emulator

doc/mgba.6 (view raw)

  1.\" Copyright (c) 2015 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 6
  8.Os
  9.Sh NAME
 10.Nm mgba
 11.Nd Game Boy Advance emulator
 12.Sh SYNOPSIS
 13.Nm mgba
 14.Op Fl 123456dfg
 15.Op Fl b Ar biosfile
 16.Op Fl c Ar cheatfile
 17.Op Fl p Ar patchfile
 18.Op Fl s Ar n
 19.Op Fl v Ar moviefile
 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 a high\(hylevel emulated BIOS.
 43.It Fl c Ar cheatfile , Fl -cheats Ar cheatfile
 44Apply cheat codes from
 45.Ar cheatfile .
 46.It Fl d
 47Start emulating via the command\(hyline debugger.
 48.It Fl f
 49Start the emulator full\(hyscreen.
 50.It Fl g
 51Start a
 52.Xr gdb 1
 53session.
 54By default the session starts on port 2345.
 55.It Fl p Ar patchfile , Fl -patch Ar patchfile
 56Specify a patch file in IPS or UPS format.
 57.It Fl s Ar n , Fl -frameskip Ar n
 58Skip every
 59.Ar n
 60frames.
 61.It Fl v Ar moviefile , Fl -movie Ar moviefile
 62Play back a movie of recording input from
 63.Ar moviefile .
 64.El
 65.Sh CONTROLS
 66The default controls are as follows:
 67.Bl -hang -width "Frame advance" -compact
 68.It A
 69.Cm x
 70.It B
 71.Cm z
 72.It L
 73.Cm a
 74.It R
 75.Cm s
 76.It Start
 77.Aq Cm Enter
 78.It Select
 79.Aq Cm Backspace
 80.It Load state
 81.Cm F1 Ns \(en Ns Cm F9
 82.It Save state
 83.Ao Cm Shift Ac Ns \(hy Ns Cm F1 Ns \(en Ns Cm F9
 84.It Frame advance
 85.Ao Cm Ctrl Ac Ns \(hy Ns Cm n
 86.El
 87.Sh DEBUGGER
 88When
 89.Nm
 90is run with the
 91.Fl d
 92option, the command\(hyline debugger is enabled.
 93It supports the following commands:
 94.Pp
 95.Bl -tag -compact -width 1
 96.It Cm b Ns Oo Cm reak Oc Ar address
 97.It Cm b Ns Oo Cm reak Oc Ns Cm /a Ar address
 98.It Cm b Ns Oo Cm reak Oc Ns Cm /t Ar address
 99Set a breakpoint at
100.Ar address .
101.It Cm c Ns Op Cm ontinue
102Continue execution.
103.It Cm d Ns Oo elete Oc Ar address
104Delete a breakpoint at
105.Ar address .
106.It Cm dis Ns Oo Cm asm Oc Ar address Op Ar count
107.It Cm dis Ns Oo Cm asm Oc Ns Cm /a Ar address Op Ar count
108.It Cm dis Ns Oo Cm asm Oc Ns Cm /t Ar address Op Ar count
109.It Cm dis Ns Oo Cm assemble Oc Ar address Op Ar count
110.It Cm dis Ns Oo Cm assemble Oc Ns Cm /a Ar address Op Ar count
111.It Cm dis Ns Oo Cm assemble Oc Ns Cm /t Ar address Op Ar count
112Disassemble
113.Ar count
114instructions starting at address
115.Ar address .
116If
117.Ar count
118is not specified, only disassemble the instruction at
119.Ar address .
120.It Cm h Ns Op Cm elp
121Print help.
122.It Cm i Ns Op Cm nfo
123.It Cm status
124Print the current contents of general\(hypurpose registers.
125.It Cm n Ns Op Cm ext
126Execute the next instruction.
127.It Cm p Ns Oo Cm rint Oc Ar value ...
128.It Cm p Ns Oo Cm rint Oc Ns Cm /t Ar value ...
129.It Cm p Ns Oo Cm rint Oc Ns Cm /x Ar value ...
130Print
131.Ar value .
132.It Cm q Ns Op Cm uit
133Quit the emulator.
134.It Cm reset
135Reset the emulation.
136.It Cm r/1 Ar address
137.It Cm r/2 Ar address
138.It Cm r/4 Ar address
139Read a byte, halfword, or word from
140.Ar address .
141.It Cm w Ns Oo Cm atch Oc Ar address
142Set a watchpoint at
143.Ar address .
144.It Cm w/1 Ar address
145.It Cm w/2 Ar address
146.It Cm w/4 Ar address
147Write a byte, halfword, or word to
148.Ar address .
149.It Cm w/r Ar register
150Write a word to
151.Ar register .
152.It Cm x/1 Ar address
153.It Cm x/2 Ar address
154.It Cm x/4 Ar address
155Examine bytes, halfwords, or words from
156.Ar address .
157.It Cm \&!\ \&
158Break into the attached debugger.
159.El
160.Sh AUTHORS
161.An Jeffrey Pfau Aq Mt jeffrey@endrift.com
162.Sh HOMEPAGE
163.Bl -bullet
164.It
165.Lk https://mgba.io/ "mGBA homepage"
166.It
167.Lk https://github.com/mgba-emu/mgba "Development repository"
168.It
169.Lk https://github.com/mgba-emu/mgba/issues "Bug tracker"
170.It
171.Lk https://forums.mgba.io/ "Message board"
172.El