doc: Document pspp-dump-sav.

Requested by Harry Thijssen.
Bug #43857.

diff --git a/doc/automake.mk b/doc/automake.mk
index a5255e03fe2ddc2ba27bd8f985b2d8eef1bd2b70..8c9f660ee347d5bf564852c2a56cf73abc21a678 100644 (file)
--- a/doc/automake.mk
+++ b/doc/automake.mk
@@ -19,6 +19,7 @@ doc_pspp_TEXINFOS = doc/version.texi \
        doc/language.texi \
        doc/license.texi \
        doc/pspp-convert.texi \
+       doc/pspp-dump-sav.texi \
        doc/ni.texi \
        doc/not-implemented.texi \
        doc/statistics.texi \

diff --git a/doc/pspp-convert.texi b/doc/pspp-convert.texi
index 83aa8ae4e98b287c316a0fbf8753df53249af114..350fc9b0cdfc90c5ec42c072e765ff3b7727c76f 100644 (file)
--- a/doc/pspp-convert.texi
+++ b/doc/pspp-convert.texi
@@ -16,7 +16,7 @@ Synopsis:
 @t{pspp-convert -@w{-}version}
 @end display
 
-The format of @var{Iinput} is automatically detected, when possible.
+The format of @var{input} is automatically detected, when possible.
 The character encoding of old SPSS system files cannot always be
 guessed correctly, and SPSS/PC+ system files do not include any
 indication of their encoding.  Use @code{-e @var{encoding}} to specify

diff --git a/doc/pspp-dump-sav.texi b/doc/pspp-dump-sav.texi
new file mode 100644 (file)
index 0000000..951a79d
--- /dev/null
+++ b/doc/pspp-dump-sav.texi
@@ -0,0 +1,45 @@
+@node Invoking pspp-dump-sav
+@chapter Invoking @command{pspp-dump-sav}
+@cindex Invocation
+@cindex @command{pspp-dump-sav}
+
+@command{pspp-dump-sav} is a command-line utility accompanying
+@pspp{}.  It reads one or more SPSS system files and prints their
+contents.  The output format is useful for debugging system file
+readers and writers and for discovering how to interpret unknown or
+poorly understood records.  End users may find the output useful for
+providing the PSPP developers information about system files that PSPP
+does not accurately read.
+
+Synopsis:
+
+@display
+@t{pspp-dump-sav} [@t{-d}[@var{maxcases}] | @t{-@w{-}data}[@t{=}@var{maxcases}]] @var{file}@dots{}
+
+@t{pspp-dump-sav -@w{-}help} | @t{-h}
+
+@t{pspp-dump-sav -@w{-}version} | @t{-v}
+@end display
+
+The following options are accepted:
+
+@table @asis
+@item @t{-d}[@var{maxcases}]
+@item @t{-@w{-}data}[@t{=}@var{maxcases}]
+By default, @command{pspp-dump-sav} does not print any of the data in a
+system file, only the file headers.  Specify this option to print the
+data as well.  If @var{maxcases} is specified, then it limits the
+number of cases printed.
+
+@item @t{-h}
+@itemx @t{-@w{-}help}
+Prints a usage message on stdout and exits.
+
+@item @t{-v}
+@itemx @t{-@w{-}version}
+Prints version information on stdout and exits.
+@end table
+
+Some errors that prevent files from being interpreted successfully
+cause @command{pspp-dump-sav} to exit without reading any additional
+files given on the command line.

diff --git a/doc/pspp.texi b/doc/pspp.texi
index 74ce9d7386dcb2d3a52b426f8be670cf4a71b45a..d5844a5a3485c5371b6512f62190bbaee6de802e 100644 (file)
--- a/doc/pspp.texi
+++ b/doc/pspp.texi
@@ -113,6 +113,7 @@ in the production of this manual.
 * Utilities::                   Other commands.
 
 * Invoking pspp-convert::       Utility for converting among file formats.
+* Invoking pspp-dump-sav::      Utility for examining raw .sav files.
 * Not Implemented::             What's not here yet
 * Bugs::                        Known problems; submitting bug reports.
 
@@ -141,6 +142,7 @@ in the production of this manual.
 @include utilities.texi
 
 @include pspp-convert.texi
+@include pspp-dump-sav.texi
 @include not-implemented.texi
 @include bugs.texi