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

View File

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

View File

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