mgba/doc/mgba-qt.6

153 lines
3.1 KiB
Groff
Raw Permalink Normal View History

.\" Copyright (c) 2015-2016 Anthony J. Bentley <anthony@anjbe.name>
.\"
.\" This Source Code Form is subject to the terms of the Mozilla Public
.\" License, v. 2.0. If a copy of the MPL was not distributed with this
.\" file, you can obtain one at https://mozilla.org/MPL/2.0/.
.Dd July 29, 2015
.Dt MGBA-QT 6
.Os
.Sh NAME
.Nm mgba-qt
.Nd Game Boy Advance emulator
.Sh SYNOPSIS
.Nm mgba-qt
2016-07-09 21:58:12 +00:00
.Op Fl 123456fg
2015-08-06 07:34:45 +00:00
.Op Fl b Ar biosfile
2018-04-20 18:34:27 +00:00
.Op Fl C Ar option Ns = Ns Ar value
2015-08-06 07:51:08 +00:00
.Op Fl l Ar loglevel
2015-08-06 07:34:45 +00:00
.Op Fl p Ar patchfile
.Op Fl s Ar n
2018-09-26 06:33:34 +00:00
.Op Fl t Ar statefile
.Ar file
.Sh DESCRIPTION
.Nm
is a Game Boy Advance emulator.
2015-08-06 07:34:45 +00:00
The options are as follows:
.Bl -tag -width Ds
.It Fl 1
Scale the window 1\(mu.
.It Fl 2
Scale the window 2\(mu.
.It Fl 3
Scale the window 3\(mu.
.It Fl 4
Scale the window 4\(mu.
.It Fl 5
Scale the window 5\(mu.
.It Fl 6
Scale the window 6\(mu.
2015-08-06 07:34:45 +00:00
.It Fl b Ar biosfile , Fl -bios Ar biosfile
Specify a BIOS file to use during boot.
If this flag is omitted,
.Nm
will use the BIOS specified in the configuration file,
or a high\(hylevel emulated BIOS if none is specified.
2018-04-20 18:34:27 +00:00
.It Fl C Ar option Ns = Ns Ar value , Fl -config Ar option Ns = Ns Ar value
Override the given config
.Ar option
with
.Ar value .
.It Fl f
Start the emulator full\(hyscreen.
2016-07-09 21:58:12 +00:00
.It Fl g
Start a
.Xr gdb 1
session.
By default the session starts on port 2345.
2015-08-06 07:51:08 +00:00
.It Fl l Ar loglevel
Log messages during emulation.
.Ar loglevel
is a bitmask defining which types of messages to log:
.Bl -bullet -compact
.It
1 \(en fatal errors
.It
2 \(en errors
.It
4 \(en warnings
.It
8 \(en informative messages
.It
16 \(en debugging messages
.It
32 \(en stub messages for unimplemented features
.It
2018-09-26 06:33:34 +00:00
64 \(en in\(hygame errors
2015-08-06 07:51:08 +00:00
.El
The default is to log warnings, errors, fatal errors, and status messages.
2015-08-06 07:34:45 +00:00
.It Fl p Ar patchfile , Fl -patch Ar patchfile
2015-08-06 16:31:05 +00:00
Specify a patch file in BPS, IPS, or UPS format.
2015-08-06 07:34:45 +00:00
.It Fl s Ar n , Fl -frameskip Ar n
Skip every
.Ar n
frames.
2018-09-26 06:33:34 +00:00
.It Fl t Ar statefile , Fl -savestate Ar statefile
Load initial game state from
.Ar statefile .
2015-08-06 07:34:45 +00:00
.El
.Sh CONTROLS
The default controls are as follows:
.Bl -hang -width "Frame advance" -compact
.It A
.Cm x
.It B
.Cm z
.It L
.Cm a
.It R
.Cm s
.It Start
.Aq Cm Enter
.It Select
.Aq Cm Backspace
.It Load state
.Cm F1 Ns \(en Ns Cm F9
.It Save state
.Ao Cm Shift Ac Ns \(hy Ns Cm F1 Ns \(en Ns Cm F9
.It Frame advance
.Ao Cm Ctrl Ac Ns \(hy Ns Cm n
.El
.Sh ENVIRONMENT
.Bl -tag -width Ds -compact
.It Ev XDG_CONFIG_HOME
The location where
.Nm
will look for the configuration directory.
If not set,
.Pa ~/.config
is used.
.El
.Sh FILES
.Bl -tag -width Ds -compact
.It Pa $XDG_CONFIG_HOME/mgba/config.ini
Default
.Xr mgba 6
configuration file.
.It Pa $XDG_CONFIG_HOME/mgba/qt.ini
Default
.Nm mgba-qt
configuration file.
.It Pa portable.ini
If this file exists in the current directory,
.Nm
will read
.Pa config.ini
and
.Pa qt.ini
from the current directory instead of
.Pa $XDG_CONFIG_HOME/mgba .
.El
.Sh AUTHORS
.An Jeffrey Pfau Aq Mt jeffrey@endrift.com
.Sh HOMEPAGE
.Bl -bullet
.It
.Lk https://mgba.io/ "mGBA homepage"
.It
.Lk https://github.com/mgba-emu/mgba "Development repository"
.It
.Lk https://github.com/mgba-emu/mgba/issues "Bug tracker"
.It
.Lk https://forums.mgba.io/ "Message board"
.El