aboutsummaryrefslogtreecommitdiff
path: root/games/yae/yae.1
diff options
context:
space:
mode:
authorB. Watson <yalhcru@gmail.com>2014-01-30 17:02:44 +0700
committerRobby Workman <rworkman@slackbuilds.org>2014-02-01 00:40:30 -0600
commitcc3ee0bbc2a4d65982aed9d1614112bd11b0e383 (patch)
tree889b2d0fe2d772caf5e125937041d6581976410a /games/yae/yae.1
parent784b68cd9fd28c0f0e40c9c519ebffda222f8ad2 (diff)
games/yae: Added (Yet another Apple Emulator).
Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
Diffstat (limited to 'games/yae/yae.1')
-rw-r--r--games/yae/yae.1220
1 files changed, 220 insertions, 0 deletions
diff --git a/games/yae/yae.1 b/games/yae/yae.1
new file mode 100644
index 0000000000000..41aedfacb2325
--- /dev/null
+++ b/games/yae/yae.1
@@ -0,0 +1,220 @@
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
+.\"
+.\" 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" ''
+'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.
+.ie \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.el \{\
+. de IX
+..
+.\}
+.\"
+.\" 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 "YAE 1"
+.TH YAE 1 "2013-08-29" "0.7" "yae"
+.\" 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"
+yae \- Yet another Apple Emulator
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fByae\fR [\-2|\-e|\-+] [disk\-image] ...
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fByae\fR emulates the Apple \s-1II\s0, \s-1II+\s0, and //e 8\-bit computers from Apple,
+Inc. Standard .dsk images are supported. If \fByae\fR is run without any
+disk image arguments, \fI/usr/share/yae/Master.dsk\fR will be booted.
+.PP
+\&\s-1ROM\s0 image files are required; see \fB\s-1FILES\s0\fR for details.
+.PP
+\&\s-1OSS\s0 audio is supported, using the /dev/audio device. For Linux systems
+using \s-1ALSA\s0, \s-1OSS\s0 audio is provided by the snd_pcm_oss and snd_mixer_oss
+kernel modules. If /dev/audio can't be opened, the emulator will run
+with sound disabled.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\-2" 4
+.IX Item "-2"
+Emulate the Apple \s-1II\s0.
+.Sp
+Note that the emulator uses the same \s-1ROM\s0 image for \s-1II\s0 and \s-1II+\s0, so the
+emulated \s-1II\s0 will have Applesoft and autostart (which the original \s-1II\s0
+didn't ship with).
+.IP "\-+" 4
+Emulate the Apple \s-1II+\s0.
+.IP "\-e" 4
+.IX Item "-e"
+Emulate the Apple //e (the default).
+.SH "KEYSTROKES"
+.IX Header "KEYSTROKES"
+.IP "Backspace" 4
+.IX Item "Backspace"
+Alias for the left-arrow key.
+.IP "Control+Delete" 4
+.IX Item "Control+Delete"
+Apple Reset key.
+.IP "Left Alt" 4
+.IX Item "Left Alt"
+The left (open) apple key on the //e keyboard.
+.IP "Right Alt" 4
+.IX Item "Right Alt"
+The right (closed) apple key on the //e keyboard.
+.IP "F1" 4
+.IX Item "F1"
+Change disks in the first drive (slot 6, drive 0). This will either
+read a filename on standard input (if kdialog can't be run), or display
+a kdialog file-selector. Either way, the emulator stops and its window
+becomes unresponsive until a file has been chosen.
+.IP "F2" 4
+.IX Item "F2"
+Exit the emulator immediately. No confirmation dialog, so
+be careful.
+.PP
+All other keystrokes are translated to their equivalent Apple \s-1II\s0
+keystrokes, or ignored if there is no equivalent key on the Apple
+keyboard.
+.SH "FILES"
+.IX Header "FILES"
+.IP "\fB.yaerc\fR, \fB~/.yaerc\fR" 4
+.IX Item ".yaerc, ~/.yaerc"
+Config file. Searched for first in the current directory,
+then in user's home directory. For config file syntax, see
+\&\fI/usr/share/yae/yaerc.sample\fR.
+.IP "\s-1ROM\s0 files" 4
+.IX Item "ROM files"
+For \s-1II\s0 and \s-1II+\s0 emulation, the required \s-1ROM\s0 image is called \fB\s-1APPLE2\s0.ROM\fR.
+For the //e, the image is \fB\s-1APPLE2E\s0.ROM\fR. For all modes, \fB\s-1DISK\s0.ROM\fR is
+required.
+.Sp
+\&\s-1ROM\s0 file locations can be set in the config file. By default, they're
+searched for in the current directory. If the ROMs can't be found in
+the configured location or the current directory, they will searched
+for in \fI/usr/share/yae\fR.
+.Sp
+If the required \s-1ROM\s0 files can't be found, the emulator will refuse
+to start.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBkegs\fR(1), \fBdos33fsutils\fR(1)
+.SH "AUTHORS"
+.IX Header "AUTHORS"
+\&\fByae\fR was originally written by Doug Kwan, and includes enhancements by
+Warren Toomey. The version documented here also has some small bugfixes
+and enhancements by B. Watson.
+.PP
+This man page was written by B. Watson.