Updated man page; now called zsnes.5 and stored in man5 (reflects 1.337)

This commit is contained in:
hpsolo
2002-02-27 01:50:13 +00:00
parent 74670492a8
commit a34f34d63c
3 changed files with 315 additions and 50 deletions

241
zsnes/src/linux/zsnes.5 Normal file
View File

@@ -0,0 +1,241 @@
.TH ZSNES 1 "26 FEB 2002"
.SH VERSION 1.337
.SH ZSNES
Play Super Nintendo games on your Intel x86 or compatible PC!
.SH SYNOPSIS
\fBzsnes\fP [-?] [-0] [-1 #] [-2 #] [-7] [-8] [-9] [-a] [-c] [-cb] [-cd] [-d] [-dd] [-e] [-f #] [-g #] [-h | -l] [-i] [-j] [-k #] [-m] [-n] [-o] [-om] [-p #] [-r #] [-s] [-sa] [-sn] [-t | -u] [-v #] [-w] [-y] [-z] <romname>
.SS
.TP
\fB-0\fP
Disable color 0 modification in 256 (8-bit) color modes
.TP
\fB-1 # / -2 #\fP
Not documented until I know for sure how this works on Linux.
.TP
\fB-7\fP
Disable SPC700 speedhack
.TP
\fB-8\fP
Force 8-bit sound
.TP
\fB-9\fP
Off by 1 line fix
.TP
\fB-a\fP
Turn on auto frame skip
.TP
\fB-c\fP
Scale to fit screen
.TP
\fB-cb\fP
Remove Background Color in 256 (8-bit) color modes
.TP
\fB-cc\fP
No image scale and center image in screen
.TP
\fB-d\fP
Start with debugger
.TP
\fb-dd\fP
Disable sound DSP emulation
.TP
\fB-e\fP
Skip ENTER key press at beginning
.TP
\fB-f #\fP
Enable frame skipping, where \fB#\fP is a numerical value from \fI0-9\fP
.TP
\fB-g #\fP
Enable gamma correction, where \fB#\fP is a numerical value from \fI0-5\fP. Default is \fI0\fP
.TP
\fB-h\fP
Force HiROM. Cannot be used with \fB-l\fP
.TP
\fB-i\fP
Uninterleave ROM image
.TP
\fB-j\fP
Disable Mouse (Automatically turns off right mouse click)
.TP
\fB-k #\fP
Set volume level, where \fB#\fP is a numerical value from \fI1-100\fP
.TP
\fB-l\fP
Force LoROM. Cannot be used with \fB-h\fP
.TP
\fB-m\fP
Disable GUI
.TP
\fB-n\fP
Enable scanlines
.TP
\fB-o\fP
Enable FPU copy
.TP
\fB-om\fP
Enable MMX copy
.TP
\fB-p #\fP
Percentage of instructions to execute, where \fB#\fP is a numerical value from \fI50-150\fP
.TP
\fB-r #\fP
Set audio sampling rate, where \fB#\fP is one of:
\fI0\fP = 8 KHz \fI1\fP = 11.025 KHz \fI2\fP = 22.05 KHz \fI3\fP = 44.1 KHz \fI4\fP = 16 KHz \fI5\fP = 32 KHz
.TP
\fB-s\fP
Enable SPC700/DSP emulation (i.e., sound)
.TP
\fB-sa\fP
Show files with all extensions (*.*) in GUI. Default is to only show files with one of the extensions listed in \fBromname\fP
.TP
\fB-sn\fP
Enable snowy GUI background
.TP
\fB-t\fP
Force NTSC (60 Hz) timing. Cannot be used with \fB-u\fP
.TP
\fB-u\fP
Force PAL (50 Hz) timing. Cannot be used with \fB-t\fP
.TP
\fB-v #\fP
\fINot documented until I know how this works under Linux\fP
.TP
\fB-w\fP
Enable VSync
.TP
\fB-y\fP
Enable EAGLE (640x480x256 <8-bit> only) or Interpolation (640x480x65536 <16-bit> only)
.TP
\fB-z\fP
Enable stereo sound
.TP
\fBromname\fP
Name of ROM to auto-load. \fBromname\fP is of the format \fBfilename.ext\fP, where \fB.ext\fP is one of \fI.SMC, .SFC, .SWC, .FIG, .058, .078, .1, .A, .USA,\fP or \fB.JAP\fP To save space, you can zip the ROM files and zSNES should still be able to load them.
.SH DESCRIPTION
\fBzSNES\fP is an emulator for the Super Nintendo video game console, written mostly in assembler by zsKnight and _Demo_ (who also works on ePSXe), with Pharos and Teuf as assistant coders. Originally a DOS program, it has now been ported to Windows and Linux. All core udpates will be done simultaneously (i.e. for DOS, Windows, and Linux versions).
Visit http://www.zsnes.com for the latest updates.
.SH "FILES AND DIRECTORIES"
.TP
zsnes
The main program
.TP
~/.zsnes
The directory where the save states, screenshots, and movie files are stored. This directory is created by zsnes
.TP
~/.zsnes/zsnesl.cfg
Where configuration settings are stored. This file is created by zsnes.
.TP
~/.zsnes/.zguicfgl.dat
The dat file for the GUI. This file is created by zsnes. \fBIf for some reason you update your version of zsnes and it keeps crashing before you can do anything, you should try deleting this file and have zsnes create a new one.\fP
.SH "GRAPHICS PACKS"
The graphics packs for games such as Star Ocean, Street Fighter Alpha, and others must be stored in the ~/.zsnes directory. For example, if you have Star Ocean, you will need to place the graphics pack in ~/.zsnes/SOCNSDD1 and the files within that directory must all be lowercase. (This will remain this way until the authors decide to make changes in the init.asm file.) As of version 1.337, the directory name of the graphics packs must be capitalized and all files within that directory are in lowercase.
.SH "SEE ALSO"
\fIzsnesgui(1)\fP and \fIzsnesfaq(1)\fP, neither of which happens to be written yet. (Hey, this is a work in progress.)
.SH "SPECIAL CHIP GAMES"
Many games that use special chips do not work, including but not limited to the following:
SuperFX:
- Dirt Trax FX
- Winter Gold
DSP-1 (and variants):
- Pilotwings
- Top Gear 3000
SDD-1:
- Street Fighter Alpha 2 now works with the DeJap graphics pack.
- Star Ocean now works with the DeJap graphics pack.
SPC7110:
- Far East of Eden Zero works with the DeJap graphics pack.
SA-1:
- Super Mario RPG: Legend of the Seven Stars
.SH AUTHOR
This document was written by Mitchell Mebane (majm101@yahoo.com) and updated by Han Duong (han@classicgaming.com). The latest official version of this document (i.e., excluding betas) may always be found at the zSNES CVS page (zsnes.sourceforge.net).
The authors of zSNES are:
.TP
zsKnight
(zsknight@zsnes.com)
.TP
_Demo_
(_demo_@zsnes.com)
.TP
Pharos
(pharos@zsnes.com)
.TP
Teuf
(Don't know if he has a zsnes.com email yet, if/when he does, it will probably be teuf@zsnes.com)
\fBDo not email them any ROM requests, or send any file attachments without their prior consent.\fP
.SH "LINUX CONTRIBUTORS"
The contributors to the Linux version are:
.TP
- Steven "relnev" Fuller
.TP
- Andrew "prometheus" Henderson
.TP
- Dan "theoddone33" Olson
.TP
- Shawn "EvilTypeGuy" Walker
.TP
- Han "hpsolo" Duong
.TP
- Aaron Lehmann
.TP
- Patrick "Diablo-D3" McFarland
.SH "VERSION HISTORY"
.TP
Initial release of ZSNES man page by Mitchell "The Khan Artist" Mebane.
.TP
Updated by Han Duong (from now on the man page version should match the release of ZSNES).
zSNES manpage, version 1.337.

View File

@@ -1,8 +1,8 @@
.TH ZSNES 1 "30 APRIL 01"
.SH VERSION 1.0
.TH ZSNES 1 "26 FEB 2002"
.SH VERSION 1.337
.SH NAME
zSNES \- Play Super Nintendo games on your Intel x86 or compatible PC.
.SH ZSNES
Play Super Nintendo games on your Intel x86 or compatible PC!
.SH SYNOPSIS
\fBzsnes\fP [-?] [-0] [-1 #] [-2 #] [-7] [-8] [-9] [-a] [-c] [-cb] [-cd] [-d] [-dd] [-e] [-f #] [-g #] [-h | -l] [-i] [-j] [-k #] [-m] [-n] [-o] [-om] [-p #] [-r #] [-s] [-sa] [-sn] [-t | -u] [-v #] [-w] [-y] [-z] <romname>
@@ -13,7 +13,7 @@ zSNES \- Play Super Nintendo games on your Intel x86 or compatible PC.
\fB-0\fP
Disable color 0 modification in 256 (8-bit) color modes
.TP
\fB-1 #/-2 #\fP
\fB-1 # / -2 #\fP
Not documented until I know for sure how this works on Linux.
.TP
\fB-7\fP
@@ -44,13 +44,13 @@ Start with debugger
Disable sound DSP emulation
.TP
\fB-e\fP
Skip Enter key press at beginning
Skip ENTER key press at beginning
.TP
\fB-f #\fP
Enable frame skipping, where \fB#\fP is a numerical value from \fI0-9\fP
.TP
\fB-g #\fP
Enable Gamme Correction, where \fB#\fP is a numerical value from \fI0-5\fP. Default is \fI0\fP
Enable gamma correction, where \fB#\fP is a numerical value from \fI0-5\fP. Default is \fI0\fP
.TP
\fB-h\fP
Force HiROM. Cannot be used with \fB-l\fP
@@ -85,7 +85,7 @@ Percentage of instructions to execute, where \fB#\fP is a numerical value from \
\fB-r #\fP
Set audio sampling rate, where \fB#\fP is one of:
\fI0\fP = 8 KHz \fI1\fP = 11.025 KHz \fI2\fP = 22.05 KHz \fI3\fP = 44.1 KHz \fI4\fP = 16 KHz \fI5\fP = 32 KHz
\fI0\fP = 8 KHz \fI1\fP = 11.025 KHz \fI2\fP = 22.05 KHz \fI3\fP = 44.1 KHz \fI4\fP = 16 KHz \fI5\fP = 32 KHz
.TP
\fB-s\fP
Enable SPC700/DSP emulation (i.e., sound)
@@ -94,7 +94,7 @@ Enable SPC700/DSP emulation (i.e., sound)
Show files with all extensions (*.*) in GUI. Default is to only show files with one of the extensions listed in \fBromname\fP
.TP
\fB-sn\fP
Enable Snowy GUI background
Enable snowy GUI background
.TP
\fB-t\fP
Force NTSC (60 Hz) timing. Cannot be used with \fB-u\fP
@@ -103,7 +103,7 @@ Force NTSC (60 Hz) timing. Cannot be used with \fB-u\fP
Force PAL (50 Hz) timing. Cannot be used with \fB-t\fP
.TP
\fB-v #\fP
\fINot documented unitl I know how this works under Linux\fP
\fINot documented until I know how this works under Linux\fP
.TP
\fB-w\fP
Enable VSync
@@ -112,42 +112,40 @@ Enable VSync
Enable EAGLE (640x480x256 <8-bit> only) or Interpolation (640x480x65536 <16-bit> only)
.TP
\fB-z\fP
Enable Stereo Sound
Enable stereo sound
.TP
\fBromname\fP
Name of ROM to auto-load. \fBromname\fP is of the format \fBfilename.ext\fP, where \fB.ext\fP is one of \fI.SMC, .SFC, .SWC, .FIG, .058, .078, .1, .A, .USA,\fP or \fB.JAP\fP
Name of ROM to auto-load. \fBromname\fP is of the format \fBfilename.ext\fP, where \fB.ext\fP is one of \fI.SMC, .SFC, .SWC, .FIG, .058, .078, .1, .A, .USA,\fP or \fB.JAP\fP To save space, you can zip the ROM files and zSNES should still be able to load them.
.SH DESCRIPTION
\fBzSNES\fP is an emulator for the Super Nintendo video game console, written mostly in assembler by zsKnight and _Demo_ (who also works on ePSXe), with Pharos and Teuf as assistant coders.
\fBzSNES\fP is an emulator for the Super Nintendo video game console, written mostly in assembler by zsKnight and _Demo_ (who also works on ePSXe), with Pharos and Teuf as assistant coders. Originally a DOS program, it has now been ported to Windows and Linux. All core udpates will be done simultaneously (i.e. for DOS, Windows, and Linux versions).
.SH FILES
Visit http://www.zsnes.com for the latest updates.
.SH "FILES AND DIRECTORIES"
.TP
zsnesl
The main program.
zsnes
The main program
.TP
zsnesl.cfg
Where configuration settings are stored.
~/.zsnes
The directory where the save states, screenshots, and movie files are stored. This directory is created by zsnes
.TP
other
I will list the rest of the major files as soon as I compile the Linux version.
~/.zsnes/zsnesl.cfg
Where configuration settings are stored. This file is created by zsnes.
.TP
~/.zsnes/.zguicfgl.dat
The dat file for the GUI. This file is created by zsnes. \fBIf for some reason you update your version of zsnes and it keeps crashing before you can do anything, you should try deleting this file and have zsnes create a new one.\fP
.SH "GRAPHICS PACKS"
The graphics packs for games such as Star Ocean, Street Fighter Alpha, and others must be stored in the ~/.zsnes directory. For example, if you have Star Ocean, you will need to place the graphics pack in ~/.zsnes/SOCNSDD1 and the files within that directory must all be lowercase. (This will remain this way until the authors decide to make changes in the init.asm file.) As of version 1.337, the directory name of the graphics packs must be capitalized and all files within that directory are in lowercase.
.SH "SEE ALSO"
\fIzsnesgui(1)\fP and \fIzsnesfaq(1)\fP, neither of which happens to be written yet. (Hey, this is a work in progress.)
.SH BUGS
As of 1.17b, the following are known bugs:
In Tales of Phantasia, the emulator crashes during the scene when Dhaos is released from his seal. This can be circumvented by using certain GFX modes during that scene. (I'm not sure what they are for Linux yet, or if this problem even occurs.)
Final Fantasy Mystic Quest does not work. (I don't know to what extent it doesn't work, I deleted the game because (IMO) it sucked, I have heard this from a bunch of people, including zsKnight.)
An American Tale: Feivel Goes West does not work due to a bug in the HiROM/LoROM detection routines. (Works in current CVS tree.)
****************
.SH "SPECIAL CHIP GAMES"
Many games that use special chips do not work, including but not limited to the following:
@@ -160,38 +158,34 @@ SuperFX:
DSP-1 (and variants):
- Pilotwings (mostly works with current CVS tree, some problems.)
- Pilotwings
- Top Gear 3000
SDD-1:
- Street Fighter Alpha 2
- Street Fighter Alpha 2 now works with the DeJap graphics pack.
- Star Ocean (Dialog text is legible, in Linux CVS source, some graphics are legible.)
Note: these games work, but all the graphics are illegible. (Except as noted for Star Ocean.)
- Star Ocean now works with the DeJap graphics pack.
SPC7110:
- Far East of Eden Zero (Works in current CVS tree.)
- Far East of Eden Zero works with the DeJap graphics pack.
SA-1:
- Super Mario RPG: Legend of the Seven Stars (Mostly works, the status text on the level-up screen is not shown.)
- Super Mario RPG: Legend of the Seven Stars
****************
.SH AUTHOR
This document was written by Mitchell Mebane (majm101@yahoo.com). The latest official version of this document (i.e., excluding betas) may always be found at the zSNES CVS page (zsnes.sourceforge.net).
This document was written by Mitchell Mebane (majm101@yahoo.com) and updated by Han Duong (han@classicgaming.com). The latest official version of this document (i.e., excluding betas) may always be found at the zSNES CVS page (zsnes.sourceforge.net).
The authors of zSNES are:
.SS
.TP
zsKnight
(zsknight@zsnes.com)
@@ -205,13 +199,43 @@ Pharos
Teuf
(Don't know if he has a zsnes.com email yet, if/when he does, it will probably be teuf@zsnes.com)
Do not email them any ROM requests, or send any file attachments without their prior consent.
\fBDo not email them any ROM requests, or send any file attachments without their prior consent.\fP
.SH "LINUX CONTRIBUTORS"
The contributors to the Linux version are:
.SH "VERSION HISTORY"
.SS
.TP
Initial release.
- Steven "relnev" Fuller
zSNES manpage, version 0.5. Total characters: 5142.
.TP
- Andrew "prometheus" Henderson
.TP
- Dan "theoddone33" Olson
.TP
- Shawn "EvilTypeGuy" Walker
.TP
- Han "hpsolo" Duong
.TP
- Aaron Lehmann
.TP
- Patrick "Diablo-D3" McFarland
.SH "VERSION HISTORY"
.TP
Initial release of ZSNES man page by Mitchell "The Khan Artist" Mebane.
.TP
Updated by Han Duong (from now on the man page version should match the release of ZSNES).
zSNES manpage, version 1.337.