path: root/games/colem/colem.6

.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 "COLEM 6"
.TH COLEM 6 "2020-10-26" "5.4" "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"
colem \- Emulator for ColecoVision and Coleco Adam consoles
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
colem [\-option1 [\-option2...]] [filename]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
ColEm is a portable emulator of the old ColecoVision videogame console. It should run most ColecoVision games and supports Coleco's SuperAction controllers with spin wheels.
.PP
You can always get the latest ColEm binaries, source code, and support files from
http://fms.komkon.org/ColEm/
.SH "OPTIONS"
.IX Header "OPTIONS"
[filename]
Name of the file to load as a cartridge [default: \s-1CART.ROM\s0]
.PP
This program will transparently uncompress singular GZIPped files.
.IP "\-verbose <level>" 4
.IX Item "-verbose <level>"
Select debugging messages [bitmask, default: 5]
.RS 4
.IP "0" 4
Silent
.IP "1" 4
.IX Item "1"
Startup messages
.IP "2" 4
.IX Item "2"
\&\s-1VDP\s0
.IP "4" 4
.IX Item "4"
Illegal Z80 ops
.IP "16" 4
.IX Item "16"
Sound
.IP "32" 4
.IX Item "32"
Disks
.IP "64" 4
.IX Item "64"
Tapes
.IP "128" 4
.IX Item "128"
AdamNet
.RE
.RS 4
.RE
.IP "\-pal, \-ntsc" 4
.IX Item "-pal, -ntsc"
Video system to use [default: \-ntsc]
.IP "\-skip <percent>" 4
.IX Item "-skip <percent>"
Percentage of frames to skip [default: 25]
.IP "\-help" 4
.IX Item "-help"
Print this help page
.IP "\-home <dirname>" 4
.IX Item "-home <dirname>"
Set directory with system \s-1ROM\s0 files [default: see \s-1FILES,\s0 below]
.IP "\-adam, \-cv" 4
.IX Item "-adam, -cv"
Run in Adam/ColecoVision mode [default: \-cv]
.IP "\-allspr" 4
.IX Item "-allspr"
Show all sprites [off]
.IP "\-autoa, \-noautoa" 4
.IX Item "-autoa, -noautoa"
Autofire/No autofire for FIRE-R button [default: \-noautoa]
.IP "\-autob, \-noautob" 4
.IX Item "-autob, -noautob"
Autofire/No autofire for FIRE-L button [default: \-noautob]
.IP "\-spin1x, \-spin1y" 4
.IX Item "-spin1x, -spin1y"
Mouse X/Y position as SuperAction spinner 1 [default: off]
.IP "\-spin2x, \-spin2y" 4
.IX Item "-spin2x, -spin2y"
Mouse X/Y position as SuperAction spinner 2 [default: off]
.IP "\-drums, \-nodrums" 4
.IX Item "-drums, -nodrums"
Hit/Don't hit \s-1MIDI\s0 drums on noise [default: \-nodrums]
.IP "\-logsnd <filename>" 4
.IX Item "-logsnd <filename>"
Write soundtrack to a \s-1MIDI\s0 file [default: \s-1LOG.MID\s0]
.IP "\-palette <number>" 4
.IX Item "-palette <number>"
Use given color palette [default: 0]
.RS 4
.IP "0" 4
Scaled \s-1VDP\s0 colors
.IP "1" 4
.IX Item "1"
Original \s-1VDP\s0 colors
.IP "2" 4
.IX Item "2"
Faded \s-1NTSC\s0 colors
.RE
.RS 4
.RE
.IP "\-sound [<quality>]" 4
.IX Item "-sound [<quality>]"
Sound emulation quality [default: 22050]
.IP "\-nosound" 4
.IX Item "-nosound"
Don't emulate sound [default: emulate sound]
.IP "\-trap <address>" 4
.IX Item "-trap <address>"
Trap execution when \s-1PC\s0 reaches address [default: FFFFh]
.IP "\-sync <frequency>" 4
.IX Item "-sync <frequency>"
Sync screen updates to <frequency> [default: 60]
.IP "\-nosync" 4
.IX Item "-nosync"
Do not sync screen updates [default: \-nosync]
.IP "\-linear" 4
.IX Item "-linear"
Scale display with linear interpolation [default: off]
.IP "\-soft" 4
.IX Item "-soft"
Scale display with 2xSaI [default: off]
.IP "\-eagle" 4
.IX Item "-eagle"
Scale display with \s-1EAGLE\s0 [default: off]
.IP "\-epx" 4
.IX Item "-epx"
Scale display with \s-1EPX\s0 [default: off]
.IP "\-scale2x" 4
.IX Item "-scale2x"
Scale display with Scale2X [default: off]
.IP "\-cmy" 4
.IX Item "-cmy"
Simulate \s-1CMY\s0 pixel raster [default: off]
.IP "\-rgb" 4
.IX Item "-rgb"
Simulate \s-1RGB\s0 pixel raster [default: off]
.IP "\-mono" 4
.IX Item "-mono"
Simulate monochrome \s-1CRT\s0 [default: off]
.IP "\-sepia" 4
.IX Item "-sepia"
Simulate sepia \s-1CRT\s0 [default: off]
.IP "\-green" 4
.IX Item "-green"
Simulate green \s-1CRT\s0 [default: off]
.IP "\-amber" 4
.IX Item "-amber"
Simulate amber \s-1CRT\s0 [default: off]
.IP "\-saver, \-nosaver" 4
.IX Item "-saver, -nosaver"
Save/don't save \s-1CPU\s0 when inactive [default: \-saver]
.IP "\-shm, \-noshm" 4
.IX Item "-shm, -noshm"
Use/don't use \s-1MIT SHM\s0 extensions for X [default: \-shm]
.IP "\-scale <factor>" 4
.IX Item "-scale <factor>"
Scale window by <factor> [default: 2]
.IP "\-4x3" 4
.IX Item "-4x3"
Force 4:3 television screen ratio [default: off]
.IP "\-sgm, \-nosgm" 4
.IX Item "-sgm, -nosgm"
Enable Super Game Module extension [default: off]
.IP "\-24c08, \-24c256" 4
.IX Item "-24c08, -24c256"
Enable serial \s-1EEPROM\s0 emulation [default: off]
.IP "\-sram" 4
.IX Item "-sram"
Enable battery-backed \s-1SRAM\s0 emulation [default: off]
.IP "\-tv, \-lcd, \-raster" 4
.IX Item "-tv, -lcd, -raster"
Simulate \s-1TV\s0 scanlines or \s-1LCD\s0 raster [default: off]
.IP "\-printer" 4
.IX Item "-printer"
Redirect Adam printer output to file [default: stdout]
.IP "\-diska, \-diskb, \-diskc, \-diskd" 4
.IX Item "-diska, -diskb, -diskc, -diskd"
Set disk images used for Adam drives A: \- D: [default: none]
.IP "\-tapea, \-tapeb, \-tapec, \-taped" 4
.IX Item "-tapea, -tapeb, -tapec, -taped"
Set tape images used for Adam drives A: \- D: [default: none]
.SH "KEYBOARD BINDINGS"
.IX Header "KEYBOARD BINDINGS"
[\s-1ALT\s0] Hold to switch to the second controller
.IP "[\s-1SPACE\s0]" 4
.IX Item "[SPACE]"
FIRE-R button (also: [\s-1SHIFT\s0],A,S,D,F,G,H,J,K,L)
.IP "[\s-1CONTROL\s0]" 4
.IX Item "[CONTROL]"
FIRE-L button (also: Z,X,C,V,B,N,M)
.IP "[Q]" 4
.IX Item "[Q]"
SuperAction \s-1PURPLE\s0 button (also: E,T,U,O)
.IP "[W]" 4
.IX Item "[W]"
SuperAction \s-1BLUE\s0 button (also: R,Y,I,P)
.IP "[0]\-[9]" 4
.IX Item "[0]-[9]"
Digit buttons
.IP "[\-]" 4
[*] button
.IP "[=]" 4
[#] button
.IP "[\s-1PGUP\s0]" 4
.IX Item "[PGUP]"
Fast-forward emulation (also: [F9])
.IP "[\s-1ESC\s0]" 4
.IX Item "[ESC]"
Quit emulation (also: [F12])
.IP "[F1]" 4
.IX Item "[F1]"
Go into the built-in debugger
.IP "[F2]" 4
.IX Item "[F2]"
Turn soundtrack log on/off
.IP "[F3]" 4
.IX Item "[F3]"
Toggle FIRE-R autofire on/off
.IP "[F4]" 4
.IX Item "[F4]"
Toggle FIRE-L autofire on/off
.IP "[F5]" 4
.IX Item "[F5]"
Invoke configuration menu
.IP "[F6]" 4
.IX Item "[F6]"
Load emulation state
.IP "[F7]" 4
.IX Item "[F7]"
Save emulation state
.IP "[F8]" 4
.IX Item "[F8]"
Turn scanline simulation on/off
.IP "[\s-1ALT\s0]+[F8]" 4
.IX Item "[ALT]+[F8]"
Toggle screen softening on/off
.IP "[F9]" 4
.IX Item "[F9]"
Fast-forward emulation (also: [\s-1PGUP\s0])
.IP "[F11]" 4
.IX Item "[F11]"
Reset hardware
.IP "[F12]" 4
.IX Item "[F12]"
Quit emulation (also: [\s-1ESC\s0])
.IP "[\s-1ALT\s0]+[\s-1PGUP\s0]" 4
.IX Item "[ALT]+[PGUP]"
Increase audio volume
.IP "[\s-1ALT\s0]+[\s-1PGDOWN\s0]" 4
.IX Item "[ALT]+[PGDOWN]"
Decrease audio volume
.SH "FILES"
.IX Header "FILES"
.IP "coleco.rom" 4
.IX Item "coleco.rom"
ColecoVision \s-1BIOS ROM\s0 image (8192 bytes). This is the only \s-1ROM\s0 required for playing ColecoVision games.
.IP "writer.rom" 4
.IX Item "writer.rom"
SmartWriter \s-1ROM \s0(32768 bytes), only required for emulating the Coleco \s-1ADAM\s0 system.
.IP "eos.rom" 4
.IX Item "eos.rom"
Extended \s-1OS ROM \s0(8192 bytes), only required for emulating the Coleco \s-1ADAM\s0 system.
.PP
The above \s-1ROM\s0 images may be named in all-lowercase or all-uppercase, and are searched for in:
.PP
1. The directory specified by \-home, or the current directory if \-home not given.
.PP
2. /usr/share/colem/
.PP
3. ~/.colem/
.PP
The coleco.rom file will occasionally be found on websites with the names \*(L"os7.rom\*(R" or \*(L"ColecoVision \s-1BIOS \s0(1982).col\*(R". Its md5sum is one of:
.PP
.Vb 3
\& 2c66f5911e5b42b8ebe113403548eee7 (original version)
\& 00fd13b66d39c69706aa48eb84a78411 (hacked version, different font)
\& 47f7180592a00b9631c97a12ff0fdd3c (hacked version, no title screen delay)
.Ve
.PP
ColEm works with any of the above \s-1ROM\s0 images.
.SH "AUTHOR"
.IX Header "AUTHOR"
ColEm is by Marat Fayzullin, (C)FMS 1994\-2020
.PP
This man page is by B. Watson, for the SlackBuilds.org project (but may be used by anyone for any
purpose).