work on debugging rules
[pspp] / doc / pspp-dump-sav.texi
1 @c PSPP - a program for statistical analysis.
2 @c Copyright (C) 2017, 2020 Free Software Foundation, Inc.
3 @c Permission is granted to copy, distribute and/or modify this document
4 @c under the terms of the GNU Free Documentation License, Version 1.3
5 @c or any later version published by the Free Software Foundation;
6 @c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
7 @c A copy of the license is included in the section entitled "GNU
8 @c Free Documentation License".
9 @c
10 @node Invoking pspp-dump-sav
11 @chapter Invoking @command{pspp-dump-sav}
12 @cindex Invocation
13 @cindex @command{pspp-dump-sav}
14
15 @command{pspp-dump-sav} is a command-line utility accompanying
16 @pspp{}.  It is not installed by default, so it may be missing
17 from your PSPP installation.
18 It reads one or more SPSS system files and prints their
19 contents.  The output format is useful for debugging system file
20 readers and writers and for discovering how to interpret unknown or
21 poorly understood records.  End users may find the output useful for
22 providing the PSPP developers information about system files that PSPP
23 does not accurately read.
24
25 Synopsis:
26
27 @display
28 @t{pspp-dump-sav} [@t{-d}[@var{maxcases}] | @t{-@w{-}data}[@t{=}@var{maxcases}]] @var{file}@dots{}
29
30 @t{pspp-dump-sav -@w{-}help} | @t{-h}
31
32 @t{pspp-dump-sav -@w{-}version} | @t{-v}
33 @end display
34
35 The following options are accepted:
36
37 @table @asis
38 @item @t{-d}[@var{maxcases}]
39 @item @t{-@w{-}data}[@t{=}@var{maxcases}]
40 By default, @command{pspp-dump-sav} does not print any of the data in a
41 system file, only the file headers.  Specify this option to print the
42 data as well.  If @var{maxcases} is specified, then it limits the
43 number of cases printed.
44
45 @item @t{-h}
46 @itemx @t{-@w{-}help}
47 Prints a usage message on stdout and exits.
48
49 @item @t{-v}
50 @itemx @t{-@w{-}version}
51 Prints version information on stdout and exits.
52 @end table
53
54 Some errors that prevent files from being interpreted successfully
55 cause @command{pspp-dump-sav} to exit without reading any additional
56 files given on the command line.