summaryrefslogtreecommitdiffstats
path: root/games/glulxe/glulxe-glktermw.6
blob: 07bb7703971126fb77d8190be4a92c30d959f309 (plain)
.\" Automatically generated by Pandoc 3.1.6
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "GLULXE-GLKTERMW" "1" "March 2024" "0.6.1" "SlackBuilds.org"
.hy
.SH NAME
.PP
glulxe-glktermw - execute Glulx interactive fiction
.SH SYNOPSIS
.PP
\f[B]glulxe-glktermw\f[R] \f[I]filename\f[R] [ \f[I]options\f[R] ]
.SH OVERVIEW
.PP
\f[B]glulxe-glktermw\f[R] executes Glulx-format interactive fiction
games, which typically end with .ulx, .gblorb, .glb, .blorb, or .blb.
\f[B]glulxe-glktermw\f[R] can work with only a terminal.
.PP
The only required parameter is the filename of the game to play.
The remaining parameters are all optional, and come from the glktermw
library.
.PP
If you have \f[B]glulxe-remglk\f[R] and/or \f[B]glulxe-cheapglk\f[R]
executables, these support extra options.
Currently these don\[cq]t have man pages, but you can run them with
\f[B]-help\f[R] to see the options.
.PP
Further information can be found in /usr/doc/glulxe-0.6.1/README.md.
Note that the \f[B]-singleturn\f[R] example requires
\f[B]glulxe-remglk\f[R].
.SH OPTIONS
.PP
Game options (note: double dash, \f[B]--\f[R]).
\f[I]NUM\f[R] options can be any number.
.TP
\f[B]--undo\f[R] \f[I]NUM\f[R]
Number of undo states to store.
.TP
\f[B]--rngseed\f[R] \f[I]NUM\f[R]
Fix initial RNG if nonzero.
.TP
\f[B]--profile\f[R] \f[I]filename\f[R]
Generate profiling information to a file.
.TP
\f[B]--profcalls\f[R]
Include what-called-what details in profiling.
(Slow!)
.PP
Library options (note: single dash, \f[B]-\f[R]).
\f[I]BOOL\f[R] options can be \f[I]yes\f[R] or \f[I]no\f[R], or no value
to toggle.
.TP
\f[B]-width\f[R] \f[I]NUM\f[R], \f[B]-height\f[R] \f[I]NUM\f[R]
Sets the screen width or height.
Normally automatically determined.
.TP
\f[B]-ml\f[R] \f[I]BOOL\f[R]
Enables or disables the message line (default \[lq]yes\[rq]).
This is the bottom line of the screen.
.TP
\f[B]-revgrid\f[R] \f[I]BOOL\f[R]
Reverse text in grid (status) windows (default \[lq]no\[rq]).
.TP
\f[B]-historylen\f[R] \f[I]NUM\f[R]
Sets the number of commands to keep in the history for each window
(default 20).
.PP
\f[B]-border\f[R] \f[I]BOOL\f[R] :: Whether or not to force
one-character borders between windows.
The default turns on borders unless the game switches them off.
Setting to \[lq]yes\[rq] forces them on at all times, or \[lq]no\[rq]
forces them off at all times, ignoring the game\[cq]s request.
.TP
\f[B]-defprompt\f[R] \f[I]BOOL\f[R]
Provide defaults for file prompts (default \[lq]yes\[rq]).
.TP
\f[B]-precise\f[R] \f[I]BOOL\f[R]
Whether to use more precise timing for timed input (default
\[lq]no\[rq]).
.TP
\f[B]-version\f[R]
Display Glk library version.
.TP
\f[B]-help\f[R]
Display command-line help.
.SH ABOUT
.PP
glulxe was written by Andrew Plotkin <erkyrath@eblong.com> and can be
found at <https://www.eblong.com/zarf/glulx/>.
glktermw was written by Andrew Plotkin <erkyrath@eblong.com> and
Alexander Beels <arb28@columbia.edu> and can be found at
<https://www.eblong.com/zarf/glk/index.html>.
.PP
This manpage was written for Debian by John Goerzen
<jgoerzen@complete.org> based on information in the above locations.
It was updated for glulxe-0.6.1 by B.
Watson <urchlay@slackware.uk>.
.SH AUTHORS
Andrew Plotkin, John Goerzen.