summaryrefslogtreecommitdiff
path: root/games/sms_sdl/sms_sdl.6
diff options
context:
space:
mode:
Diffstat (limited to 'games/sms_sdl/sms_sdl.6')
-rw-r--r--games/sms_sdl/sms_sdl.6292
1 files changed, 292 insertions, 0 deletions
diff --git a/games/sms_sdl/sms_sdl.6 b/games/sms_sdl/sms_sdl.6
new file mode 100644
index 0000000000..83fbf179b2
--- /dev/null
+++ b/games/sms_sdl/sms_sdl.6
@@ -0,0 +1,292 @@
+.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{
+. if \nF \{
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "SMS_SDL 6"
+.TH SMS_SDL 6 "2014-09-07" "0.9.4a-r7.1" "SlackBuilds.org"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+sms_sdl \- Sega Master System and Game Gear emulator.
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBsms_sdl\fR [\fI\-\-options\fR] \fI<filename.<SMS|GG\fR>>
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\s-1SMS\s0 Plus/SDL is an emulator for the Sega Master System and Sega Game
+Gear video game consoles.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+\&\fINote:\fR The filename may appear anywhere on the command line.
+.IP "\fB\-\-fm\fR" 4
+.IX Item "--fm"
+Enable \s-1YM2413\s0 sound.
+.IP "\fB\-\-japan\fR" 4
+.IX Item "--japan"
+Set the machine type as \s-1DOMESTIC\s0 instead of \s-1OVERSEAS.\s0
+.IP "\fB\-\-usesram\fR" 4
+.IX Item "--usesram"
+Load/save \s-1SRAM\s0 contents before starting/exiting.
+.IP "\fB\-\-fskip\fR <n>" 4
+.IX Item "--fskip <n>"
+Specify the number of frames to skip.
+.IP "\fB\-\-fullspeed\fR" 4
+.IX Item "--fullspeed"
+Do not limit to 60 frames per second.
+.IP "\fB\-\-fullscreen\fR" 4
+.IX Item "--fullscreen"
+Start in fullscreen mode.
+.IP "\fB\-\-joystick\fR" 4
+.IX Item "--joystick"
+Use joystick.
+.IP "\fB\-\-nosound\fR" 4
+.IX Item "--nosound"
+Disable sound.
+.IP "\fB\-\-filter\fR <mode>" 4
+.IX Item "--filter <mode>"
+Render using a filter. Available modes:
+.RS 4
+.IP "2xsai" 4
+.IX Item "2xsai"
+.PD 0
+.IP "super2xsai" 4
+.IX Item "super2xsai"
+.IP "supereagle" 4
+.IX Item "supereagle"
+.IP "advmame2x" 4
+.IX Item "advmame2x"
+.IP "tv2x" 4
+.IX Item "tv2x"
+.IP "2x" 4
+.IX Item "2x"
+.IP "bilinear" 4
+.IX Item "bilinear"
+.IP "dotmatrix" 4
+.IX Item "dotmatrix"
+.RE
+.RS 4
+.RE
+.PD
+.SH "KEYBOARD"
+.IX Header "KEYBOARD"
+.IP "\fBF1\fR" 4
+.IX Item "F1"
+Screenshot in \s-1BMP\s0 format
+.IP "\fBF2\fR" 4
+.IX Item "F2"
+Save state
+.IP "\fBF3\fR" 4
+.IX Item "F3"
+Load state
+.IP "\fBF4/F5\fR" 4
+.IX Item "F4/F5"
+Dec/inc frame skip value
+.IP "\fBF6/F7\fR" 4
+.IX Item "F6/F7"
+Dec/inc state slot
+.IP "\fB1..8\fR" 4
+.IX Item "1..8"
+Switch rendering filter
+.IP "\fBC\fR" 4
+.IX Item "C"
+Button 1
+.IP "\fBV\fR" 4
+.IX Item "V"
+Button 2
+.IP "\fB\s-1ENTER\s0\fR" 4
+.IX Item "ENTER"
+Start (\s-1GG\s0) / pause (\s-1SMS\s0)
+.IP "\fB\s-1ARROWS\s0\fR" 4
+.IX Item "ARROWS"
+Directional pad
+.IP "\fB\s-1TAB\s0\fR" 4
+.IX Item "TAB"
+Console hard reset
+.PP
+The key bindings may not be remapped.
+.SH "FILES"
+.IX Header "FILES"
+\&\s-1ROM\s0 image files may be in raw dump format, or may have a header
+(details are system-specific). Also, \s-1ROM\s0 images may be zipped (not
+gzipped), in which case the first file in the zip file's directory must
+be the \s-1ROM\s0 image (any other files are ignored).
+.PP
+\&\fBsms_sdl\fR looks at the filename to determine the type of \s-1ROM\s0 image
+in use. Any file whose name ends in \fI.gg\fR (case-insensitive match) is
+considered to be a Game Gear \s-1ROM.\s0 Any other file is treated as a Sega
+Master System \s-1ROM.\s0 In the case of a zipped image, this refers to the
+file inside the zip file; the zip file itself doesn't have any special
+naming requirements.
+.PP
+Screenshot filenames (F1 key) are generated by replacing the filename
+extension with \fI\-NNN.bmp\fR, where \s-1NNN\s0 is a 3\-digit number (000 for the
+first screenshot, 001 for the second, etc). The numbering starts at 000
+every time the emulator is started, and existing files will be overwritten
+without confirmation.
+.PP
+State save filenames (F2 key) are generated by replacing the filename
+extension with \fI.stN\fR, where N is the number of the save slot (one or
+more digits). Again, existing files are overwritten without confirmation.
+.PP
+Screenshots and savestates are stored in \fI~/.sms_sdl\fR.
+.SH "CONFIG FILE"
+.IX Header "CONFIG FILE"
+\&\fBsms_sdl\fR is launched by a shell script wrapper which reads the file
+\&\fI~/.sms_sdl/config\fR if it exists. Any of the options above may be placed
+in this file (one option per line, with or without the leading \fB\-\-\fR
+characters). These options will be passed as command-line arguments to
+the real \fBsms_sdl\fR binary every time it runs.
+.PP
+See \fB/usr/doc/sms_sdl\-VERSION/sample_config\fR for further information.
+.SH "PATCHES"
+.IX Header "PATCHES"
+This build of \fBsms_sdl\fR has been patched to add the following features and fixes:
+.IP "\-" 4
+The \fB\-\-fm\fR and \fB\-\-japan\fR options now work (patch by Ellington Santos).
+.IP "\-" 4
+\&\fBsms_sdl\fR can be built and will run on x86_64 systems (patch by B. Watson).
+.IP "\-" 4
+The emulator no longer segfaults when the \s-1ROM\s0 filename doesn't contain a dot (patch by B. Watson).
+.IP "\-" 4
+\&\s-1ROM\s0 filename can appear anywhere on the command line, before or after options (patch by B. Watson).
+.IP "\-" 4
+Wrapper script, supports config file and snapshots/savestates in ~/.sms_sdl (script by B. Watson).
+.SH "AUTHORS"
+.IX Header "AUTHORS"
+The original \s-1SMS\s0 is (C) Charles Mac Donald in 1998, 1999, 2000.
+.PP
+\&\s-1SDL\s0 Version by Gregory Montoir (cyx@frenchkiss.net).
+.PP
+This man page by B. Watson, for the SlackBuilds.org project.