ShuriZma
/
fceux
mirror of https://github.com/TASEmulators/fceux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

replace corrupted manpages with original versions (#318)

This commit is contained in:
jnahmias 2021-02-01 05:44:39 -05:00 committed by GitHub
parent 6286ba7505
commit dfd84dc349
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 353 additions and 310 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
documentation/fceux-net-server.6
View File

@ -1,58 +1,74 @@
.\" Hey, EMACS: -*- nroff -*-
.\" (C) Copyright 2012 Joe Nahmias <jello@debian.org> .\" (C) Copyright 2012 Joe Nahmias <jello@debian.org>
.Dd November 19, 2014 .\"
.Dt FCEUX-NET-SERVER 6 .\" First parameter, NAME, should be all caps
.Os .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.Sh NAME .\" other parameters are allowed: see man(7), man(1)
.Nm fceux-net-server .TH FCEUX-NET-SERVER 6 "October 12, 2012"
.Nd FCEUX game server .\" Please adjust this date whenever revising the manpage.
.Sh SYNOPSIS .\"
.Nm fceux-net-server .\" Some roff macros, for reference:
.Op Cm options .\" .nh disable hyphenation
.Sh DESCRIPTION .\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
fceux-net-server \- FCE Ultra game server
.SH SYNOPSIS
.B fceux-net-server
.RI [ options ]
.SH DESCRIPTION
This manual page documents briefly the This manual page documents briefly the
.Nm .B fceux-net-server
command. command.
.Pp .PP
.Nm \fBfceux-net-server\fP is the game server for multiplayer use of the FCE Ultra
is the game server for multiplayer use of the family of NES emulators. This server will first look in
.Xr fceux 6 \fI/etc/fceux-server.conf\fP for options. If that file does not exist, it will
family of NES emulators. use the defaults given here. Any argument given directly will override any
This server will first look in default values.
.Pa /etc/fceux-server.conf .SH OPTIONS
for options. These programs follow the usual GNU command line syntax, with long
If that file does not exist, it will use the defaults given here. options starting with two dashes (`-').
Any argument given directly will override any default values. A summary of options is included below.
.Sh OPTIONS .TP
The options are as follows: .B \-h, \-\-help
.Bl -tag -width Ds
.It Fl h , Fl -help
Displays a help message. Displays a help message.
.It Fl v , Fl -version .TP
.B \-v, \-\-version
Displays the version number and quits. Displays the version number and quits.
.It Fl p Ar port , Fl -port Ar port .TP
Starts server on given port; the default is 4046. .B \-p, \-\-port
.It Fl w Ar password , Fl -password Ar password Starts server on given port (default = \fI4046\fP).
.TP
.B \-w, \-\-password
Specifies a password for entry. Specifies a password for entry.
.It Fl m Ar num , Fl -maxclients Ar num .TP
Specifies the maximum number of clients allowed to access the server; .B \-m, \-\-maxclients
the default is 100. Specifies the maximum number of clients allowed to access the
.It Fl t Ar timeout , Fl -timeout Ar timeout server (default = \fI100\fP).
Specifies the number of seconds before the server times out; the default is 5. .TP
.It Fl f Ar divisor , Fl -framedivisor Ar divisor .B \-t, \-\-timeout
Specifies the number of seconds before the server times out (default = \fI5\fP).
.TP
.B \-f, \-\-framedivisor
Specifies frame divisor, which controls the number of updates sent to client; Specifies frame divisor, which controls the number of updates sent to client;
calculated as: 60 \(di framedivisor = updates per second. calculated as: 60 / framedivisor = updates per second (default = \fI1\fP).
The default is 1. .TP
.It Fl c Ar file , Fl -configfile Ar file .B \-c, \-\-configfile
Loads the given configuration file. Loads the given configuration file (default = \fI/etc/fceux\-server.conf\fP).
The default is .SH SEE ALSO
.Pa /etc/fceux-server.conf . .BR fceux (6),
.El The
.Sh SEE ALSO .B FCEUX
.Xr fceux 6 project homepage
.Pp .RI < http://fceux.com/ >.
.Lk http://fceux.com/ "The FCEUX homepage" . .SH AUTHOR
.Sh AUTHORS This manual page was written by Joe Nahmias <jello@debian.org>
.An -nosplit
This manual page was written by
.An Joe Nahmias Aq Mt jello@debian.org
for the Debian GNU/Linux system (but may be used by others). for the Debian GNU/Linux system (but may be used by others).

545
documentation/fceux.6
View File

@ -1,326 +1,353 @@
.Dd November 19, 2014 .\" t Hey, EMACS: -*- nroff -*-
.Dt FCEUX 6 .\" First parameter, NAME, should be all caps
.Os .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.Sh NAME .\" other parameters are allowed: see man(7), man(1)
.Nm fceux .TH FCEUX 6 "June 24, 2012"
.Nd emulator for the Nintendo Entertainment System and Famicom .\" Please adjust this date whenever revising the manpage.
.Sh SYNOPSIS .\"
.Nm fceux .\" Some roff macros, for reference:
.Op Ar options .\" .nh disable hyphenation
.Ar file .\" .hy enable hyphenation
.Sh DESCRIPTION .\" .ad l left justify
.Nm .\" .ad b justify to both left and right margins
is an emulator for the original (8\(hybit) Nintendo Entertainment System (NES). .\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
fceux \- An emulator for the original (8-bit) Nintendo / Famicom game console.
.SH SYNOPSIS
.B fceux
.RI [ options ]
"filename"
.SH DESCRIPTION
.B FCEUX
is an emulator for the original (8-bit) Nintendo Entertainment System (NES).
It has a robust color palette rendering engine that is fully customizable, It has a robust color palette rendering engine that is fully customizable,
along with excellent sound and joystick support, and even supports movie along with excellent sound and joystick support, and even supports movie
recording and playback. recording and playback.
.Sh OPTIONS .SH OPTIONS
.Ss Misc. Options .SS Misc. Options
.Bl -tag -width Ds .TP
.It Fl -no-config Cm 0 | 1 .B \--no-config {0|1}
Use default config file and do not save to it, when enabled. Use default config file and do not save to it, when enabled.
.It Fl g Cm 0 | 1 , Fl -gamegenie Cm 0 | 1 .TP
.B \-g {0|1}, \--gamegenie {0|1}
Enable or disable emulated Game Genie. Enable or disable emulated Game Genie.
.It Fl -nogui Cm 0 | 1 .TP
Enable or disable the GTK graphical interface. .B \--nogui {0|1}
.It Fl -loadlua Ar file Enable or disable the GTK GUI.
Loads Lua script from filename .TP
.Ar file . .B \--loadlua FILE
.El Loads lua script from filename FILE.
.Ss Emulation Options .SS Emulation Options
.Bl -tag -width Ds .TP
.It Fl -pal Cm 0 | 1 .B \--pal {0|1}
Enable or disable PAL mode. Enable or disable PAL mode.
.El .SS Input Options
.Ss Input Options .TP
.Bl -tag -width Ds .B \-i DEV, \--inputcfg DEV
.It Fl i Ar dev , Fl -inputcfg Ar dev Configures input device DEV on startup.
Configures input device Devices: gamepad powerpad hypershot quizking
.Ar dev .TP
on startup. .B \--input{1|2} DEV
Devices include:
.Cm gamepad powerpad hypershot quizking
.It Fl -input1 Ar dev
.It Fl -input2 Ar dev
Set which input device to emulate for input 1 or 2. Set which input device to emulate for input 1 or 2.
Devices include: Devices: gamepad zapper powerpad.0 powerpad.1 arkanoid
.Cm gamepad zapper powerpad.0 powerpad.1 arkanoid .TP
.It Fl -input3 Ar dev .B \--input{3|4} DEV
.It Fl -input4 Ar dev Set the famicom expansion device to emulate for input 3 or 4.
Set the Famicom expansion device to emulate for input 3 or 4. Devices: quizking hypershot mahjong toprider ftrainer familykeyboard
Devices include: oekakids arkanoid shadow bworld 4player
.Cm quizking hypershot mahjong toprider ftrainer familykeyboard oekakids .TP
.Cm arkanoid shadow bworld 4player .B \--inputdisplay {0|1}
.It Fl -inputdisplay Cm 0 | 1
Enable or disable input display. Enable or disable input display.
.It Fl -fourscore Cm 0 | 1 .TP
Enable or disable Fourscore emulation. .B \--fourscore {0|1}
.El Enable or disable fourscore emulation.
.Ss Graphics Options .SS Graphics Options
.Bl -tag -width Ds .TP
.It Fl -newppu Cm 0 | 1 .B \--newppu {0|1}
Enable or disable the new PPU core. Enable or disable the new PPU core. (WARNING: May break savestates)
.Pq Sy Warning : No May break savestates .TP
.It Fl -frameskip Ar frames .B \--frameskip NUM
Set number of frames to skip per emulated frame. Set NUM of frames to skip per emulated frame.
.It Fl -clipsides Cm 0 | 1 .TP
Enable or disable clipping of the leftmost and rightmost 8 columns of the video .B \--clipsides {0|1}
output. Enable or disable clipping of the leftmost and rightmost 8 columns of
.It Fl -slstart Ar scanline the video output.
.TP
.B \--slstart SCANLINE
Set the first scanline to be rendered. Set the first scanline to be rendered.
.It Fl -slend Ar scanline .TP
.B \--slend SCANLINE
Set the last scanline to be rendered. Set the last scanline to be rendered.
.It Fl -nospritelim Cm 0 | 1 .TP
.B \--nospritelim {0|1}
When set to 0, this disables the normal 8 sprites per scanline limitation. When set to 0, this disables the normal 8 sprites per scanline limitation.
When set to 1, this enables the normal 8 sprites per scanline limitation. When set to 1, this enables the normal 8 sprites per scanline limitation.
.Sy Note : No Yes, this option is Sq backwards . NOTE: Yes, this option is 'backwards'.
.It Fl x Ar xres , Fl -xres Ar xres .TP
.B \-x XRES, \--xres XRES
Set horizontal resolution for full screen mode. Set horizontal resolution for full screen mode.
.It Fl y Ar yres , Fl -yres Ar yres .TP
.B \-y YRES, \--yres YRES
Set vertical resolution for full screen mode. Set vertical resolution for full screen mode.
.It Fl -doublebuf Cm 0 | 1 .TP
.B \--doublebuf {0|1}
Enable or disable double buffering. Enable or disable double buffering.
.It Fl -autoscale Cm 0 | 1 .TP
.B \--autoscale {0|1}
Enable or disable autoscaling in fullscreen. Enable or disable autoscaling in fullscreen.
.It Fl -keepratio Cm 0 | 1 .TP
.B \--keepratio {0|1}
Keep native NES aspect ratio when autoscaling. Keep native NES aspect ratio when autoscaling.
.It Fl -xscale Ar val .TP
.It Fl -yscale Ar val .B \--{x|y}scale VAL
Multiply width/height by Multiply width/height by VAL.
.Ar val . (Real numbers > 0 with OpenGL, otherwise integers > 0).
.Ar val .TP
can be a real number greater than 0 with OpenGL output; .B \--{x|y}stretch {0|1}
otherwise, it must be an integer greater than 0.
.It Fl -xstretch Cm 0 | 1
.It Fl -ystretch Cm 0 | 1
Stretch to fill surface on x/y axis (OpenGL only). Stretch to fill surface on x/y axis (OpenGL only).
.It Fl b Cm 8 | 16 | 24 | 32 , Fl -bpp Cm 8 | 16 | 24 | 32 .TP
.B \-b {8|16|24|32}, \--bpp {8|16|24|32}
Set bits per pixel. Set bits per pixel.
.It Fl -opengl Cm 0 | 1 .TP
.B \--opengl {0|1}
Enable or disable OpenGL support. Enable or disable OpenGL support.
.It Fl -openglip Cm 0 | 1 .TP
.B \--openglip {0|1}
Enable or disable OpenGL linear interpolation. Enable or disable OpenGL linear interpolation.
.It Fl f Cm 0 | 1 , Fl -fullscreen Cm 0 | 1 .TP
Enable or disable full\(hyscreen mode. .B \-f {0|1}, \--fullscreen {0|1}
.It Fl -noframe Cm 0 | 1 Enable or disable full-screen mode.
.TP
.B \--noframe {0|1}
Hide title bar and window decorations. Hide title bar and window decorations.
.It Fl -special Ar filter .TP
.B \--special {1-4}
Use special video scaling filters. Use special video scaling filters.
.Ar filter (1 = hq2x 2 = Scale2x 3 = NTSC 2x 4 = hq3x 5 = Scale3x)
is a number from 1\(en5: .TP
.Bl -tag -compact -width a .B \-p FILE, \--palette FILE
.It 1 Use the custom palette in FILE.
hq2x .TP
.It 2 .B \--ntsccolor {0|1}
Scale2x
.It 3
NTSC
.It 4
hq3x
.It 5
Scale3x
.El
.It Fl p Ar file , Fl -palette Ar file
Use the custom palette in
.Ar file .
.It Fl -ntsccolor Cm 0 | 1
Enable or disable NTSC NES colors. Enable or disable NTSC NES colors.
.It Fl -tint Ar val .TP
.B \--tint VAL
Set the NTSC tint. Set the NTSC tint.
.It Fl -hue Ar val .TP
.B \--hue VAL
Set the NTSC hue. Set the NTSC hue.
.El .SS Sound Options
.Ss Sound Options .TP
.Bl -tag -width Ds .B \-s {0|1}, \--sound {0|1}
.It Fl s Cm 0 | 1 , Fl -sound Cm 0 | 1
Enable or disable sound. Enable or disable sound.
.It Fl -soundrate Ar rate .TP
Set the sound playback sample rate (0 = off?). .B \--soundrate RATE
.It Fl -soundq Cm 0 | 1 | 2 Set the sound playback sample rate (0 == off?).
Set sound quality. .TP
.Bl -tag -width a -compact .B \--soundq {0|1|2}
.It 0 Set sound quality. (0 = Low 1 = High 2 = Very High)
Low .TP
.It 1 .B \--soundbufsize MS
High Set sound buffer size to MS milliseconds.
.It 2 .TP
Very high .B \--volume {0-256}
.El Sets the sound volume to the given value, where 256 is max volume.
.It Fl -soundbufsize Ar n .TP
Set sound buffer size to .B \--trianglevol {0-256}
.Ar n Sets the sound volume of the triangle wave to the given value, where 256 is max volume.
milliseconds. .TP
.It Fl -volume Ar val .B \--square1vol {0-256}
Set sound volume to the given value, Sets the sound volume of square wave 1 to the given value, where 256 is max volume.
which can range from 0 to a maximum of 256. .TP
.It Fl -trianglevol Ar val .B \--square2vol {0-256}
Set sound volume of the triangle wave to the given value, Sets the sound volume of square wave 2 to the given value, where 256 is max volume.
which can range from 0 to a maximum of 256. .TP
.It Fl -square1vol Ar val .B \--noisevol {0-256}
Set sound volume of square wave 1 to the given value, Sets the sound volume of the noise generator to the given value, where 256 is max volume.
which can range from 0 to a maximum of 256. .TP
.It Fl -square2vol Ar val .B \--lowpass {0|1}
Set sound volume of square wave 2 to the given value, Enables or disables lowpass filtering of the sound.
which can range from 0 to a maximum of 256. .TP
.It Fl -noisevol Ar val .B \--soundrecord FILE
Set sound volume of the noise generator to the given value, Record sound to file FILE.
which can range from 0 to a maximum of 256. .SS Movie Options
.It Fl -lowpass Cm 0 | 1 .TP
Enable or disable lowpass filtering of the sound. .B \--playmov FILE
.It Fl -soundrecord Ar file Play back a recorded FCM/FM2 movie from filename FILE.
Record sound to .TP
.Ar file . .B \--pauseframe FRAME
.El Pause movie playback at frame FRAME.
.Ss Movie Options .TP
.Bl -tag -width Ds .B \--moviemsg {0|1}
.It Fl -playmov Ar file
Play back a recorded FCM/FM2 movie from
.Ar file .
.It Fl -pauseframe Ar frame
Pause movie playback at frame
.Ar frame .
.It Fl -moviemsg Cm 0 | 1
Enable or disable movie messages. Enable or disable movie messages.
.It Fl -fcmconvert Ar file .TP
Convert fcm movie file .B \--fcmconvert FILE
.Ar file Convert fcm movie file FILE to fm2.
to fm2. .TP
.It Fl -ripsubs Ar file .B \--ripsubs FILE
Convert movie\(cqs subtitles to SubRip (srt) subtitles. Convert movie's subtitles to srt.
.It Fl -subtitles Cm 0 | 1 .TP
.B \--subtitles {0|1}
Enable or disable subtitle display. Enable or disable subtitle display.
.El .SS Networking Options
.Ss Networking Options .TP
.Bl -tag -width Ds .B \-n SRV, \--net SRV
.It Fl n Ar server , Fl -net Ar server Connect to server SRV for TCP/IP network play.
Connect to .TP
.Ar server .B \--port PORT
for TCP/IP network play. Use TCP/IP port PORT for network play.
.It Fl -port Ar port .TP
Use TCP/IP port .B \-u NICK, \--user NICK
.Ar port
for network play.
.It Fl u Ar nick , Fl -user Ar nick
Set the nickname to use in network play. Set the nickname to use in network play.
.It Fl w Ar pass , Fl -pass Ar pass .TP
.B \-w PASS, \--pass PASS
Set password to use for connecting to the server. Set password to use for connecting to the server.
.It Fl k Ar netkey , Fl -netkey Ar netkey .TP
Use the string .B \-k NETKEY, \--netkey NETKEY
.Ar netkey Use string NETKEY to create a unique session for the game loaded.
to create a unique session for the game loaded. .TP
.It Fl -players Ar num .B \--players NUM
Set the number of local players. Set the number of local players.
.It Fl -rp2mic Cm 0 | 1 .TP
.B \--rp2mic {0|1}
If enabled, replace Port 2 Start with microphone (Famicom). If enabled, replace Port 2 Start with microphone (Famicom).
.It Fl -videolog Ar c .TP
Calls mencoder to grab the video and audio streams to encode them. .B \--videolog c
Check the documentation for more on this. Calls mencoder to grab the video and audio streams to encode them. Check the documentation for more on this.?
.It Fl -mute Cm 0 | 1 .TP
Mutes .B \--mute {0|1}
.Nm Mutes FCEUX while still passing the audio stream to mencoder.
while still passing the audio stream to mencoder. .TP
.El .SH KEYBOARD COMMANDS
.Sh KEYBOARD COMMANDS .B FCEUX
.Nm
has a number of commands available within the emulator. has a number of commands available within the emulator.
It also includes default keyboard bindings when emulating game pads It also includes default keyboard bindings when emulating game pads or power pads.
or power pads. .SS Gamepad Keyboard Bindings
.Ss Gamepad Keyboard Bindings
.TS .TS
center box; center box;
cb | cb, cb | c. cb | cb, c | ci.
NES Gamepad Keyboard NES Gamepad Keyboard
= =
\(ua Keypad Up Up Keypad Up
\(da Keypad Down Down Keypad Down
\(<- Keypad Left Left Keypad Left
\(-> Keypad Right Right Keypad Right
A F A F
B D B D
Select S Select S
Start Enter Start Enter
.TE .TE
.Ss Other Commands .SS Other Commands
.Bl -tag -width "Aq Alt+Enter" .PP
.It Aq Cm Alt Ns + Ns Cm Enter .TP 15
Toggle full\(hyscreen mode. .BI <Alt+Enter>
.It Aq Cm F1 Toggle full-screen mode.
Cheat menu (command\(hyline only). .TP 15
.It Aq Cm F2 .BI <F1>
Cheat menu (command-line only).
.TP 15
.BI <F2>
Toggle savestate binding to movies. Toggle savestate binding to movies.
.It Aq Cm F3 .TP 15
Load Lua script. .BI <F3>
.It Aq Cm F4 Load LUA script.
.TP 15
.BI <F4>
Toggles background rendering. Toggles background rendering.
.It Aq Cm F5 .TP 15
.BI <F5>
Save game state into current slot (set using number keys). Save game state into current slot (set using number keys).
.It Aq Cm F7 .TP 15
.BI <F7>
Restore game state from current slot (set using number keys). Restore game state from current slot (set using number keys).
.It Aq Cm F10 .TP 15
.BI <F10>
Toggle movie subtitles. Toggle movie subtitles.
.It Aq Cm F11 .TP 15
.BI <F11>
Reset NES. Reset NES.
.It Aq Cm F12 .TP 15
.BI <F12>
Save screen snapshot. Save screen snapshot.
.It Aq Cm Shift Ns + Ns Cm F5 .TP 15
Begin recording video. .BI Shift + <F5>
.It Aq Cm Shift Ns + Ns Cm F7 Beging recording video.
.TP 15
.BI Shift + <F7>
Load recorded video. Load recorded video.
.It Cm 0 Ns \(en Ns Cm 9 .TP 15
Select the numbered save state slot. .BI 0-9
.It Ao Cm Page Up Ac / Aq Cm Page Down Select save state slot.
.TP 15
.BI Page Up/Page Down
Select next/previous state. Select next/previous state.
.It Cm - .TP 15
.BI \-
Decrease emulation speed. Decrease emulation speed.
.It Cm = .TP 15
.BI =
Increase emulation speed. Increase emulation speed.
.It Aq Cm Tab .TP 15
.BI Tab
Hold for turbo emulation speed. Hold for turbo emulation speed.
.It Aq Cm Pause .TP 15
.BI Pause
Pause emulation. Pause emulation.
.It Cm \e .TP 15
.BI \e
Advance a single frame. Advance a single frame.
.It Cm \&. .TP 15
.BI .
Toggle movie frame counter. Toggle movie frame counter.
.It Cm \&, .TP 15
.BI ,
Toggle input display. Toggle input display.
.It Cm q .TP 15
Toggle movie read\(hyonly. .BI q
.It Cm \(aq Toggle movie read-only.
.TP 15
.BI '
Advance a single frame. Advance a single frame.
.It Cm / .TP 15
.BI /
Lag counter display. Lag counter display.
.It Aq Cm Delete .TP 15
.BI Delete
Frame advance lag skip display. Frame advance lag skip display.
.It Aq Cm Esc .TP 15
.BR <ESC>
Quit Quit
.Nm . .B FCEUX.
.El .SS VS Unisystem Commands
.Ss VS Unisystem Commands .PP
.Bl -tag -width "Aq F8" .TP 15
.It Aq Cm F8 .BI <F8>
Insert coin. Insert coin.
.It Aq Cm F6 .TP 15
Show/hide dip switches. .BI <F6>
.It Cm 1 Ns \(en Ns Cm 8 Show/Hide dip switches.
.TP 15
.BI 1-8
Toggle dip switches (when dip switches are shown). Toggle dip switches (when dip switches are shown).
.El .SS Famicom Disk System Commands
.Ss Famicom Disk System Commands .PP
.Bl -tag -width "Aq F6" .TP 15
.It Aq Cm F6 .BI <F6>
Select disk and disk side. Select disk and disk side.
.It Aq Cm F8 .TP 15
.BI <F8>
Eject or insert disk. Eject or insert disk.
.El .TP
.Sh SEE ALSO .I http://fceux.com/
.Xr fceux-net-server 6 The
.Pp .B FCEUX
.Lk http://fceux.com/ "The FCEUX homepage" . project homepage.
.Sh AUTHORS .SH AUTHOR
.An -nosplit This manual page was written by Joe Nahmias <joe _at_ nahmias.net>,
This manual page was written by Lukas Sabota <ltsmooth42 _at_ gmail.com> and Alexander Toresson
.An Joe Nahmias Aq Mt joe@nahmias.net , <alexander.toresson _at_ gmail.com> for the Debian GNU/Linux system
.An Lukas Sabota Aq Mt ltsmooth42@gmail.com (but may be used by others).
and
.An Alexander Toresson Aq Mt alexander.toresson@gmail.com
for the Debian GNU/Linux system (but may be used by others).