From aff691c8af5b0d08eadb8db6c71153a7bacae325 Mon Sep 17 00:00:00 2001 From: David Griffith Date: Tue, 31 Jul 2018 13:18:05 -0700 Subject: [PATCH] Update manpages for frotz and dfrotz with -I (interpreter number) stuff. More stuff in the manpages needs to be done, particularly addressing old URLs. --- doc/dfrotz.6 | 33 +++++++++++++++------------------ doc/frotz.6 | 20 +++++++++++--------- 2 files changed, 26 insertions(+), 27 deletions(-) diff --git a/doc/dfrotz.6 b/doc/dfrotz.6 index c84886c..db5e729 100644 --- a/doc/dfrotz.6 +++ b/doc/dfrotz.6 @@ -3,10 +3,12 @@ .SH NAME dfrotz \- interpreter for Infocom and other Z-Machine games (dumb interface) + .SH SYNOPSIS .B dfrotz .RI [ options "] " file + .SH DESCRIPTION .B Frotz is a Z-Machine interpreter. The Z-machine is a virtual machine designed @@ -22,8 +24,8 @@ outlines of V6 graphics with the picture number in the bottom-right corner. .P -This manpage is for Frotz with the dumb interface. Dumb Frotz -does not support sound-effects, graphics, or colors. +This manpage is for Frotz with the dumb interface. Dumb Frotz does not +support sound-effects, graphics, or colors. .SH OPTIONS @@ -39,7 +41,7 @@ value, the test and the result will be reported. .TP .B \-h N -Screen height. Every N lines, a MORE prompt will be printed. Use of +Screen height. Every N lines, a MORE prompt will be printed. Use of the .B \-m option renders this option moot. @@ -67,7 +69,7 @@ When the game starts, load this saved game file. .TP .B \-m -Turn off MORE prompts. This can be desirable when using a printing +Turn off MORE prompts. This can be desirable when using a printing terminal. .TP @@ -115,8 +117,9 @@ and need not worry about someone scribbling or snooping who-knows-where. .TP .B \-s N -Set the random number seed value. The given seed value is used as the initial -seed value on every restart. This is helpful for testing games like +Set the random number seed value. The given seed value is used as the +initial seed value on every restart. This is helpful for testing games +like .B Curses which make random decisions before the first input (such that the hot key Alt\-S does not really help). @@ -272,7 +275,6 @@ the current speed factor). Advance clock just enough to timeout the current input .SS Reverse-Video Display Method Settings - .TP .B \ern none @@ -287,7 +289,6 @@ doublestrike underline .SS Output Compression Settings - .TP .B \ecn none: show whole screen before every input. @@ -303,7 +304,6 @@ shown. Hide top N lines (orthogonal to above modes). .SS Misc Settings - .TP .B \esfX Set speed factor to X. (0 = never timeout automatically). @@ -360,7 +360,6 @@ Standard Frotz hotkeys. use \eH (help) to see the list of hotkeys. .SS Line Type Identification Characters - .SS Input lines (untimed) .TP .B > @@ -403,22 +402,22 @@ does not search any path for game files. .PP A .BR git(1) -repository of all versions of Unix Frotz back to 2.32 is available +repository of all versions of Unix Frotz back to 2.32 is available for public perusal here: .br -https://github.com/DavidGriffith/frotz/. +https://github.com/DavidGriffith/frotz/. .PP -The bleeding edge of Frotz development may be followed there. A wiki +The bleeding edge of Frotz development may be followed there. A wiki summarising Frotz is also there at this URL: .br https://github.com/DavidGriffith/frotz/wiki/ .PP -Source tarballs are available at the IF Archive or any of its many +Source tarballs are available at the IF Archive or any of its many mirrors: .br http://www.ifarchive.org/ .PP -Most distributions of Linux and BSD include Frotz in their package +Most distributions of Linux and BSD include Frotz in their package repositories. @@ -453,7 +452,7 @@ http://inform-fiction.org/I7Downloads/Examples/dm/IntroductionToIF.pdf .SH BUGS -This program has no bugs. no bugs. no bugs. no *WHAP* thank you. If +This program has no bugs. no bugs. no bugs. no *WHAP* thank you. If you find one, please report it to the Github site referenced above in .B FURTHER INFORMATION. @@ -475,5 +474,3 @@ The Unix port is currently maintained by David Griffith . .BR jzip (6) .BR xzip (6) .BR inform (1) - - diff --git a/doc/frotz.6 b/doc/frotz.6 index e2832f9..520148e 100644 --- a/doc/frotz.6 +++ b/doc/frotz.6 @@ -3,10 +3,12 @@ .SH NAME frotz \- interpreter for Infocom and other Z-Machine games + .SH SYNOPSIS .B frotz .RI [ options "] " file + .SH DESCRIPTION .B Frotz is a Z-Machine interpreter. The Z-machine is a virtual machine designed @@ -211,6 +213,7 @@ Error checking mode. .br Default is 1 (report first instance of an error). + .SH INTERPRETER NUMBER The interpreter number is a setting in the Z-machine header which is used to tell the game on what sort of machine the interpreter is @@ -276,11 +279,12 @@ Infocom used the following interpreter numbers: .BR 11 .BR \ \ Tandy\ Color + .SH CONFIGURATION FILES On startup, .B frotz will first check the system's frotz.conf then $HOME/.frotzrc for -configuration information. The configuration file uses a simple syntax +configuration information. The configuration file uses a simple syntax of .br @@ -405,7 +409,6 @@ environmental variable except that you can't put environmental variables in the path or use other shortcuts. For example, "$HOME/games/zcode" is illegal because the shell can't interpret that $HOME variable. - .P The following options are really only useful for weird terminals, weird curses libraries or if you want to force a certain look (like play in @@ -459,7 +462,6 @@ the current screen width. This switch allows you to change this setting. You may set this to "0" to deactivate automatic line-splitting in transcript files. - .P The following options are mainly useful for debugging or cheating. @@ -492,6 +494,7 @@ Watch object movement. This option enables debugging messages from the interpreter which describe the movement of objects in the object tree. Default is "off". + .SH ENVIRONMENT If the ZCODE_PATH environmental variable is defined, frotz will search that path for game files. If that doesn't exist, INFOCOM_PATH will be @@ -502,12 +505,12 @@ searched. .PP A .BR git(1) -repository of all versions of Unix Frotz back to 2.32 is available +repository of all versions of Unix Frotz back to 2.32 is available for public perusal here: .br -https://github.com/DavidGriffith/frotz/. +https://github.com/DavidGriffith/frotz/. .PP -The bleeding edge of Frotz development may be followed there. A wiki +The bleeding edge of Frotz development may be followed there. A wiki summarising Frotz is also there at this URL: .br https://github.com/DavidGriffith/frotz/wiki/ @@ -518,9 +521,10 @@ Here is its URL: .br http://www.ifarchive.org/ .PP -Most distributions of Linux and BSD include Frotz in their package +Most distributions of Linux and BSD include Frotz in their package repositories. + .SH CAVEATS .PP The Z Machine itself has trouble with the concept of resizing a terminal. @@ -581,5 +585,3 @@ The Unix port is currently maintained by David Griffith . .BR jzip (6) .BR xzip (6) .BR inform (1) - - -- 2.34.1