spv-file-format: Improve description of structure member format.
[pspp.git] / doc / pspp-dump-sav.texi
blob1758288fe92a9ae4d9b6535fe7eb6c97e0c07702
1 @c PSPP - a program for statistical analysis.
2 @c Copyright (C) 2017 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}
15 @command{pspp-dump-sav} is a command-line utility accompanying
16 @pspp{}.  It reads one or more SPSS system files and prints their
17 contents.  The output format is useful for debugging system file
18 readers and writers and for discovering how to interpret unknown or
19 poorly understood records.  End users may find the output useful for
20 providing the PSPP developers information about system files that PSPP
21 does not accurately read.
23 Synopsis:
25 @display
26 @t{pspp-dump-sav} [@t{-d}[@var{maxcases}] | @t{-@w{-}data}[@t{=}@var{maxcases}]] @var{file}@dots{}
28 @t{pspp-dump-sav -@w{-}help} | @t{-h}
30 @t{pspp-dump-sav -@w{-}version} | @t{-v}
31 @end display
33 The following options are accepted:
35 @table @asis
36 @item @t{-d}[@var{maxcases}]
37 @item @t{-@w{-}data}[@t{=}@var{maxcases}]
38 By default, @command{pspp-dump-sav} does not print any of the data in a
39 system file, only the file headers.  Specify this option to print the
40 data as well.  If @var{maxcases} is specified, then it limits the
41 number of cases printed.
43 @item @t{-h}
44 @itemx @t{-@w{-}help}
45 Prints a usage message on stdout and exits.
47 @item @t{-v}
48 @itemx @t{-@w{-}version}
49 Prints version information on stdout and exits.
50 @end table
52 Some errors that prevent files from being interpreted successfully
53 cause @command{pspp-dump-sav} to exit without reading any additional
54 files given on the command line.