Modified the manpages in anticipation of the -W option
authorDavid Griffith <dave@661.org>
Tue, 27 Jun 2017 09:39:11 +0000 (02:39 -0700)
committerDavid Griffith <dave@661.org>
Tue, 27 Jun 2017 09:39:11 +0000 (02:39 -0700)
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
doc/frotz.6

index 668cdd69d7c69f0791b31b8d5fe5fad4a3e0046e..48d64106c6122ebb00814c0ca94ceca7f526d512 100644 (file)
@@ -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 <path>
+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.
index 7e78fcb8a5cdb3438b19282011e9ec50a0b15fed..e804fc8992f26dfbaea101b59b66c16c3a6dd291 100644 (file)
@@ -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 <path>
+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.