Add caching to naodash_user

[nethack-naodash.git] / naodash

diff --git a/naodash b/naodash
index 47505de57ebab93a8a4d1dc26a69409217e09e94..52b175ea485ec13439440b7dbdedecd833f4c84f 100755 (executable)
--- a/naodash
+++ b/naodash
@@ -24,10 +24,25 @@ naodash - Analyze NetHack xlogfiles and extract statistics (command-line interfa
 
 naodash is a command-line interface to L<NetHack::NAOdash>. It takes a
 NAO username or a path to an xlogfile, analyzes it, and prints the
-results of the analysis. A terminal with color and/or UTF-8 support is
+results of the analysis. A terminal with ANSI escape code support is
 required. Do not parse this command's output. For computer-readable
 output, please use the L<NetHack::NAOdash> library directly.
 
+=head1 ENVIRONMENT
+
+=over
+
+=item NAODASH_CACHE
+
+Path to a directory that should be used to cache xlogfiles downloaded
+from NAO, or the special value 'none' (case-insensitive) to disable
+caching.
+
+By default a directory named 'naodash' in the default temporary
+directory (C<< File::Spec->tmpdir >>) is used.
+
+=back
+
 =head1 SEE ALSO
 
 L<NetHack::NAOdash>, L<http://alt.org/nethack/>, L<App::NAOdash>, L<App::Web::NAOdash>