doc: Document pspp-dump-sav.
[pspp] / doc / pspp-dump-sav.texi
1 @node Invoking pspp-dump-sav
2 @chapter Invoking @command{pspp-dump-sav}
3 @cindex Invocation
4 @cindex @command{pspp-dump-sav}
5
6 @command{pspp-dump-sav} is a command-line utility accompanying
7 @pspp{}.  It reads one or more SPSS system files and prints their
8 contents.  The output format is useful for debugging system file
9 readers and writers and for discovering how to interpret unknown or
10 poorly understood records.  End users may find the output useful for
11 providing the PSPP developers information about system files that PSPP
12 does not accurately read.
13
14 Synopsis:
15
16 @display
17 @t{pspp-dump-sav} [@t{-d}[@var{maxcases}] | @t{-@w{-}data}[@t{=}@var{maxcases}]] @var{file}@dots{}
18
19 @t{pspp-dump-sav -@w{-}help} | @t{-h}
20
21 @t{pspp-dump-sav -@w{-}version} | @t{-v}
22 @end display
23
24 The following options are accepted:
25
26 @table @asis
27 @item @t{-d}[@var{maxcases}]
28 @item @t{-@w{-}data}[@t{=}@var{maxcases}]
29 By default, @command{pspp-dump-sav} does not print any of the data in a
30 system file, only the file headers.  Specify this option to print the
31 data as well.  If @var{maxcases} is specified, then it limits the
32 number of cases printed.
33
34 @item @t{-h}
35 @itemx @t{-@w{-}help}
36 Prints a usage message on stdout and exits.
37
38 @item @t{-v}
39 @itemx @t{-@w{-}version}
40 Prints version information on stdout and exits.
41 @end table
42
43 Some errors that prevent files from being interpreted successfully
44 cause @command{pspp-dump-sav} to exit without reading any additional
45 files given on the command line.