From 849c014fb3c51edaa2d39c6281dcecbea48ce6bd Mon Sep 17 00:00:00 2001 From: David Griffith Date: Tue, 27 Jun 2017 02:39:11 -0700 Subject: [PATCH] Modified the manpages in anticipation of the -W option The -W option restricts Frotz to writing only in the specified directory. This is to prevent players from writing somewhere they should not. This is intended to be useful for front-ends or restricted environments -- for instance a chatbot or telnetting to a certain TCP/IP port to play a game. --- doc/dfrotz.6 | 12 ++++++++++++ doc/frotz.6 | 15 +++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/doc/dfrotz.6 b/doc/dfrotz.6 index 668cdd6..48d6410 100644 --- a/doc/dfrotz.6 +++ b/doc/dfrotz.6 @@ -133,6 +133,18 @@ Expand the abbreviations "g", "x", and "z" to "again", "examine", and common abbreviations which were introduced in later games. Use it with caution: A few games might use "g", "x" or "z" for different purposes. +.TP +.B \-W +Write only to the directory specified by the provided pathname. +Ordinarily Frotz will write its saves, transcripts, and move recordings +to whatever path or directory the user provides when the SAVE, SCRIPT, +or RECORDING commands are given. This can be undesirable if Frotz is +run in a restricted environment -- for example by a chatbot. This +option will cause Frotz to write ONLY to the provided path and nowhere +else. Then the controlling process can then watch that directory for +changes and need not worry about someone scribbling something +who-knows-where. + .TP .B \-Z N Error checking mode. diff --git a/doc/frotz.6 b/doc/frotz.6 index 7e78fcb..e804fc8 100644 --- a/doc/frotz.6 +++ b/doc/frotz.6 @@ -175,6 +175,21 @@ Expand the abbreviations "g", "x", and "z" to "again", "examine", and common abbreviations which were introduced in later games. Use it with caution: A few games might use "g", "x" or "z" for different purposes. +.TP +.B \-W +Write only to the directory specified by the provided pathname. +Ordinarily Frotz will write its saves, transcripts, and move recordings +to whatever path or directory the user provides when the +.B SAVE, +.B SCRIPT, +or +.B RECORDING +commands are given. This can be undesirable if Frotz is run in a +restricted environment -- for example by a chatbot. This option will +cause Frotz to write only to the provided path and nowhere else. Then +the controlling process can then watch that directory for changes and +need not worry about someone scribbling something who-knows-where. + .TP .B \-Z N Error checking mode. -- 2.34.1