slackbuilds_ponce/games/steem/steem.6

219 lines
6.8 KiB
Groff
Raw Normal View History

.\" 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 "STEEM 6"
.TH STEEM 6 "2014-11-12" "3.2" "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"
steem \- the Atari STE emulator for Linux/X11
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
steem [options] [disk_image_a [disk_image_b]] [cartridge] [tos_image]
.PP
steem [options] [state_file]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Steem is a Freeware Atari \s-1ST/STE\s0 emulator for Windows and Linux.
.SH "OPTIONS"
.IX Header "OPTIONS"
.SS "Image Files"
.IX Subsection "Image Files"
.IP "\fB[disk_image_a], [disk_image_b]\fR" 4
.IX Item "[disk_image_a], [disk_image_b]"
Optional disk images to be used for the \s-1ST\s0's A: and B: drives. File types supported are
\&\s-1ST/MSA/DIM/STT/ZIP/RAR.\s0 If 2 disks are specified, the first will be \s-1ST\s0 drive A: and the second drive B:.
.IP "\fB[cartridge]\fR" 4
.IX Item "[cartridge]"
Optional name of a cartridge image (.STC) to be loaded.
.IP "\fB[state_file]\fR" 4
.IX Item "[state_file]"
state file: previously saved state file (.STS) to load. If none is specified, Steem will
load \*(L"auto.sts\*(R" provided the relevant option is checked in the Options dialog.
.IP "\fB[tos_image]\fR" 4
.IX Item "[tos_image]"
\&\s-1TOS\s0 image file to use. By default, this is set in steem.ini and does not need setting on the
command line. For most games and applications, the \s-1TOS\s0 image should be the \s-1UK\s0 v1.02 image
(tos102.img).
.SS "Switches"
.IX Subsection "Switches"
Options are case-independent and can be prefixed by \-, \-\-, / or nothing.
.IP "\fB\s-1NOSHM\s0\fR" 4
.IX Item "NOSHM"
disable use of Shared Memory.
.IP "\fB\s-1NOSOUND\s0\fR" 4
.IX Item "NOSOUND"
no sound output.
.IP "\fBSOF=<n\fR>" 4
.IX Item "SOF=<n>"
set sound output frequency to <n> Hz.
.IP "\fBPABUFSIZE=<n\fR>" 4
.IX Item "PABUFSIZE=<n>"
set PortAudio buffer size to <n> samples.
.IP "\fBFONT=<string\fR>" 4
.IX Item "FONT=<string>"
use a different font.
.IP "\fB\s-1HELP\s0\fR" 4
.IX Item "HELP"
print help message and quit.
.IP "\fBINI=<file\fR>" 4
.IX Item "INI=<file>"
use <file> instead of steem.ini to initialise options.
.IP "\fBTRANS=<file\fR>" 4
.IX Item "TRANS=<file>"
use <file> instead of searching for Translate.txt or Translate_*.txt to translate the \s-1GUI\s0
text.
.PP
All of these options (except INI= and TRANS=) can be changed from the \s-1GUI\s0 once steem is running. It
is easiest just to run steem and play with the \s-1GUI.\s0
.SH "FILES"
.IX Header "FILES"
.IP "\fB/usr/bin/steem\fR" 4
.IX Item "/usr/bin/steem"
Shell script wrapper that sets up the environment for the actual steem binary.
.IP "\fB/usr/libexec/steem\fR" 4
.IX Item "/usr/libexec/steem"
Actual steem binary. Don't run directly, as it doesn't behave in a very Linux-friendly way.
.IP "\fB~/.steem/\fR" 4
.IX Item "~/.steem/"
Directory steem executes in. Contains steem.ini and all save-state files, including auto.sts.
.SH "AUTHORS"
.IX Header "AUTHORS"
Steem was written by Anthony and Russell Hayward.
.PP
This man page and the steem wrapper script were written by B. Watson, for the SlackBuilds.org
project (but may be used by anyone)