]> git.lizzy.rs Git - plan9front.git/blobdiff - sys/man/1/nintendo
dd(1): update manpage to match program
[plan9front.git] / sys / man / 1 / nintendo
index 03bcb0f2d43dfb5d80a104b61596e494d840d1f7..c1b6b29f59f42c34d0eb29071d57dde062769523 100644 (file)
@@ -4,31 +4,47 @@ gb, gba, nes, snes \- emulators
 .SH SYNOPSIS
 .B games/gb
 [
-.B -23a
+.B -acd
+]
+[
+.B -C
+.I ...
+] [
+.B -x
+.I scale
 ]
 .I romfile
 .br
 .B games/gba
 [
-.B -23aT
+.B -a
 ] [
 .B -b
 .I biosfile
 ] [
 .B -s
 .I savetype
+] [
+.B -x
+.I scale
 ]
 .I romfile
 .br
 .B games/nes
 [
-.B -23aos
+.B -aos
+] [
+.B -x
+.I scale
 ]
 .I romfile
 .br
 .B games/snes
 [
-.B -23ahmsT
+.B -ahms
+] [
+.B -x
+.I scale
 ]
 .I romfile
 .SH DESCRIPTION
@@ -37,17 +53,31 @@ gb, gba, nes, snes \- emulators
 .I nes
 and
 .I snes
-are emulators for the Nintendo Game Boy (GB), Nintendo Game Boy Advance (GBA), Nintendo Entertainment System (NES) and Super Nintendo Entertainment System (SNES).
+are emulators for the Nintendo Game Boy and Game Boy Color (GB and GBC), Nintendo Game Boy Advance (GBA), Nintendo Entertainment System (NES), and Super Nintendo Entertainment System (SNES).
 They execute the romfile given as an argument.
-The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, return and shift keys correspond to B, A, Y, X, Start and Select, respectively.
+The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw, \fRreturn and shift keys correspond to B, A, Y, X, L1, L2, Start and Select, respectively.
 Other keys:
 .TP
+F1
+Pause the emulator. If already paused it will step one video frame.
+.TP
 F5
 Save the current state in \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
 .TP
 F6
 Load the current state from \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
 .TP
+F12
+Toggle the emulator's speedometer.  It shows in the upper left,
+off-viewport corner, the ratio between the expected and observed time it
+took to draw 60 frames.
+.TP
+t
+Toggle tracing of the emulator.
+.TP
+`
+It uncaps the 60fps frame rate and lets emulation go as fast as possible.
+.TP
 Esc
 Pause the emulator.
 .TP
@@ -56,23 +86,32 @@ Exit the emulator.
 .PP
 Command line options:
 .TP
-.B -2 -3
-Scale the screen by the given factor.
-.TP
 .B -a
 Enable audio output.
+.TP
+.B -x
+Scale the screen to a given factor regardless of the window's size.
+.PP
+.B gb
+options:
+.TP
+.B -c
+Run GBC roms in GBC mode and DMG (GB) roms in GBC's DMG compatibility mode.
+.TP
+.B -d
+Run GB roms in DMG mode. GBC-only roms will not run in this mode; others will run only in black & white.
+.TP
+.BI -C nnnnnn,nnnnnn,nnnnnn,nnnnnn
+Select a color palette. Has no effect on roms in color mode. The syntax is of the form -C ffffff,aaaaaa,555555,000000 (using HTML style rrggbb notation).
 .PP
 .B gba
 options:
 .TP
 .B -b
-Location of the GBA BIOS file (required to operate the emulator).
+Location of the GBA BIOS file (required to operate the emulator). Default is \fB/sys/games/lib/gbabios.bin\fR.
 .TP
 .B -s
-Save format used by the original game.
-.TP
-.B -T
-Display percentage of how fast the system is running relative to a real GBA.
+Save format used by the original game. Valid formats are: eeprom4, eeprom64, sram256, flash512, flash1024. The number corresponds to the size, in kilobits, of the save file. By default, the emulator attempts to automatically detect the save format, but does not always succeed.
 .PP
 .B nes
 options:
@@ -95,12 +134,11 @@ sets HiROM.
 .TP
 .B -m
 Enable mouse emulation using system mouse. Mouse button 1 (left button) engages the SNES left mouse button. Mouse button 3 (right button) engages the SNES right mouse button. Holding down mouse button 2 (middle button) disengages the SNES mouse entirely so that the Plan 9 cursor offset can be adjusted to align with the SNES cursor.
-.TP
-.B -T
-Display percentage of how fast the system is running relative to a real SNES.
 .SH SOURCE
 .B /sys/src/games/gb
 .br
+.B /sys/src/games/gba
+.br
 .B /sys/src/games/nes
 .br
 .B /sys/src/games/snes
@@ -114,6 +152,8 @@ option is used.
 The SNES horizontal hires mode is supported only with
 .B -2
 scaling.
+.br
+All emulators assume a North American (i.e. NTSC) system. PAL games (and in some cases Japanese games) are not supported.
 .SH HISTORY
 .I Gb
 first appeared in 9front (April, 2012).