From 15a3524ff76907d4b6eb2e440d7f2fe4687222d6 Mon Sep 17 00:00:00 2001 From: David Griffith Date: Sat, 20 May 2023 11:38:48 -0700 Subject: [PATCH] Added mention of the Z-Machine Standard v1.1 to manpages. Includes a brief description of the save/restore prompt option. --- doc/dfrotz.6 | 19 +++++++++++++++++++ doc/frotz.6 | 19 +++++++++++++++++++ doc/sfrotz.6 | 21 +++++++++++++++++++++ doc/xfrotz.6 | 22 ++++++++++++++++++++++ 4 files changed, 81 insertions(+) diff --git a/doc/dfrotz.6 b/doc/dfrotz.6 index 445cbb3..9556b59 100644 --- a/doc/dfrotz.6 +++ b/doc/dfrotz.6 @@ -511,6 +511,25 @@ It can also be set system-wide in the equivalent files in .B sh(1) .B zsh(1) +.SH Z-MACHINE STANDARDS +.B Frotz +complies with the Z-Machine Standard 1.1 of May 2006, revised February +2014. The authoritative version is found here: +.br +http://inform-fiction.org/zmachine/standards/z1point1/index.html +.P +As of 1.1, an additional optional parameter +.B prompt +is allowed on Version 5 extended save/restore. This parameter allows +a game to read or write an auxiliary (aux) file without prompting the +player. See section 15 of the Standard for details. +.B Frotz +restricts such files to having an ".aux" filename extension. When the +.B -R +(restricted read/write) option is active, reads and writes through this +mechanism are restricted to the provided path the same as all other file +accesses. + .SH ENVIRONMENT Unlike it's curses-using or SDL-using siblings, diff --git a/doc/frotz.6 b/doc/frotz.6 index 5f5f851..aa5959f 100644 --- a/doc/frotz.6 +++ b/doc/frotz.6 @@ -672,6 +672,25 @@ It can also be set system-wide in the equivalent files in .B sh(1) .B zsh(1) +.SH Z-MACHINE STANDARDS +.B Frotz +complies with the Z-Machine Standard 1.1 of May 2006, revised February +2014. The authoritative version is found here: +.br +http://inform-fiction.org/zmachine/standards/z1point1/index.html +.P +As of 1.1, an additional optional parameter +.B prompt +is allowed on Version 5 extended save/restore. This parameter allows +a game to read or write an auxiliary (aux) file without prompting the +player. See section 15 of the Standard for details. +.B Frotz +restricts such files to having an ".aux" filename extension. When the +.B -R +(restricted read/write) option is active, reads and writes through this +mechanism are restricted to the provided path the same as all other file +accesses. + .SH ENVIRONMENT If the ZCODE_PATH environmental variable is defined, frotz will search diff --git a/doc/sfrotz.6 b/doc/sfrotz.6 index c2d8047..7696417 100644 --- a/doc/sfrotz.6 +++ b/doc/sfrotz.6 @@ -445,6 +445,26 @@ https://www.gnu.org/software/freefont/ (Truetype fonts). Logographic glyphs (Kanji and Chinese are not currently supported. +.SH Z-MACHINE STANDARDS +.B Frotz +complies with the Z-Machine Standard 1.1 of May 2006, revised February +2014. The authoritative version is found here: +.br +http://inform-fiction.org/zmachine/standards/z1point1/index.html +.P +As of 1.1, an additional optional parameter +.B prompt +is allowed on Version 5 extended save/restore. This parameter allows +a game to read or write an auxiliary (aux) file without prompting the +player. See section 15 of the Standard for details. +.B Frotz +restricts such files to having an ".aux" filename extension. When the +.B -R +(restricted read/write) option is active, reads and writes through this +mechanism are restricted to the provided path the same as all other file +accesses. + + .SH ENVIRONMENT If the ZCODE_PATH environmental variable is defined, .B Sfrotz @@ -873,3 +893,4 @@ David Griffith . .BR jzip (6) .BR xzip (6) .BR inform (1) + diff --git a/doc/xfrotz.6 b/doc/xfrotz.6 index f0f3388..cfe1570 100644 --- a/doc/xfrotz.6 +++ b/doc/xfrotz.6 @@ -170,6 +170,28 @@ resources: by setting \fBcolor\fP\fInum\fP (class name \fBColor\fP\fInum\fP) to the name of a color, you can change the meaning of the z-machine colors. Note that here the \fBz:\fP\fBnum\fP syntax is not accepted. + + +.SH Z-MACHINE STANDARDS +.B Frotz +complies with the Z-Machine Standard 1.1 of May 2006, revised February +2014. The authoritative version is found here: +.br +http://inform-fiction.org/zmachine/standards/z1point1/index.html +.P +As of 1.1, an additional optional parameter +.B prompt +is allowed on Version 5 extended save/restore. This parameter allows +a game to read or write an auxiliary (aux) file without prompting the +player. See section 15 of the Standard for details. +.B Frotz +restricts such files to having an ".aux" filename extension. When the +.B -R +(restricted read/write) option is active, reads and writes through this +mechanism are restricted to the provided path the same as all other file +accesses. + + .SH ENVIRONMENT .I xfrotz supports the INFOCOM_PATH environment variable. This is a -- 2.34.1