1
2
3
4pspp-output(1)                    PSPP Manual                   pspp-output(1)
5
6
7

NAME

9       pspp-output - convert and operate on SPSS viewer (SPV) files
10

SYNOPSIS

12       pspp-output detect file
13       pspp-output [options] dir file
14       pspp-output [options] convert source destination
15       pspp-output [options] get-table-look source destination
16       pspp-output [options] convert-table-look source destination
17       pspp-output --help | -h
18       pspp-output --version | -v
19

DESCRIPTION

21       pspp-output  is  a command-line utility accompanying PSPP.  It supports
22       multiple operations on SPSS viewer  or  .spv  files,  here  called  SPV
23       files.  SPSS 16 and later writes SPV files to represent the contents of
24       its output editor.
25
26       SPSS 15 and earlier versions instead use .spo files.  pspp-output  does
27       not support this format.
28
29       pspp-output  has  a number of subcommands, documented separately below.
30       pspp-output also has several undocumented command forms that developers
31       may find useful for debugging.
32
33   The detect command
34       When  invoked  as  pspp-output detect file, pspp-output reads enough of
35       file to determine whether it is an SPV file.  If so, it exits  success‐
36       fully  without outputting anything.  When file is not an SPV file or if
37       some other error occurs, pspp-output prints an error message and  exits
38       with a failure indication.
39
40   The dir command
41       When  invoked  as  pspp-output dir file, pspp-output prints on stdout a
42       table of contents for SPV file file.  By default, this table lists  ev‐
43       ery  object  in the file, except for hidden objects.  See the Input Se‐
44       lection Options section below for information on the options  available
45       to select a subset of objects.
46
47       The  following  additional option for dir is intended mainly for use by
48       PSPP developers:
49
50       --member-names
51              Also show the names of the Zip members associated with each  ob‐
52              ject.
53
54   The convert command
55       When  invoked  as  pspp-output  convert source destination, pspp-output
56       reads the SPV file source and converts it to  another  format,  writing
57       the output to destination.
58
59       By default, pspp-output infers the intended format for destination from
60       its extension.  The known extensions are generally: csv html  list  odt
61       pdf  ps spv svg txt.  Use --help to see an accurate list, since a given
62       installation might be built without support for some formats.
63
64       See the Input Selection Options section below for  information  on  the
65       options  available to select a subset of objects to include in the out‐
66       put.  The following additional options are accepted:
67
68       -O format=format
69              Overrides the format inferred from the output file's  extension.
70              format must be one of the extensions listed above.
71
72       -O option=value
73              Sets  an  option  for the output file format.  Refer to the PSPP
74              manual for details of the available output options.
75
76       -F
77       --force
78              By default, if the source is corrupt or otherwise cannot be pro‐
79              cessed,  the  destination  is  not  written.   These option make
80              pspp-output write the output as best it can, even with errors.
81
82       --table-look=file
83              Reads a table style from file and applies it to all of the  out‐
84              put tables.  The file should a TableLook .stt or .tlo file.
85
86   The get-table-look command
87       When   invoked   as   pspp-output  get-table-look  source  destination,
88       pspp-output reads SPV file source, applies any  selection  options  (as
89       described  under  Input Selection Options below), picks the first table
90       from the selected object, extracts the TableLook from that  table,  and
91       writes  it  to  destination  (typically  with an .stt extension) in the
92       TableLook XML format.
93
94       Use - for source to instead write the default look to destination.
95
96       The user may use the TableLook file to change the style  of  tables  in
97       other  files,  by  passing it to the --table-look option on the convert
98       command.
99
100   The convert-table-look command
101       When invoked  as  pspp-output  convert-table-look  source  destination,
102       pspp-output  reads .stt or .tlo file source, and writes it back to des‐
103       tination (typically with an .stt extension) in the TableLook  XML  for‐
104       mat.   This is useful for converting a TableLook .tlo file from SPSS 15
105       or earlier into the newer .stt format.
106
107   Input Selection Options
108       The dir and convert commands, by default, operate on all of the objects
109       in  the source SPV file, except for objects that are not visible in the
110       output viewer window.  The user may specify these options to  select  a
111       subset  of the input objects.  When multiple options are used, only ob‐
112       jects that satisfy all of them are selected:
113
114       --select=[^]class...
115              Include only objects of the given class; with leading ^, include
116              only  objects not in the class.  Use commas to separate multiple
117              classes.  The supported classes are:
118
119                     charts headings logs models tables texts  trees  warnings
120                     outlineheaders pagetitle notes unknown other
121
122              Use --select=help to print this list of classes.
123
124       --commands=[^]command...
125       --subtypes=[^]subtype...
126       --labels=[^]label...
127              Include only objects with the specified command, subtype, or la‐
128              bel.  With a leading ^, include only the  objects  that  do  not
129              match.   Multiple  values  may be specified separated by commas.
130              An asterisk at the end of a value acts as a wildcard.
131
132              The --command option matches command identifiers, case  insensi‐
133              tively.  All of the objects produced by a single command use the
134              same, unique command identifier.  Command identifiers are always
135              in English regardless of the language used for output.  They of‐
136              ten differ from the  command  name  in  PSPP  syntax.   Use  the
137              pspp-output  program's  dir command to print command identifiers
138              in particular output.
139
140              The --subtypes option matches particular tables  within  a  com‐
141              mand,  case insensitively.  Subtypes are not necessarily unique:
142              two commands that produce similar output tables may use the same
143              subtype.   Subtypes  are  always  in  English and dir will print
144              them.
145
146              The --labels option matches the labels in table output (that is,
147              the  table titles).  Labels are affected by the output language,
148              variable names and labels, split file settings, and  other  fac‐
149              tors.
150
151       --nth-commands=n...
152              Include  only  objects  from the nth command that matches --com‐
153              mands (or the nth command overall if --commands  is  not  speci‐
154              fied), where n is 1 for the first command, 2 for the second, and
155              so on.
156
157       --instances=instance...
158              Include the specified instance of an  object  that  matches  the
159              other  criteria  within a single command.  The instance may be a
160              number (1 for the first instance, 2 for the second, and  so  on)
161              or last for the last instance.
162
163       --show-hidden
164              Include  hidden  output objects in the output.  By default, they
165              are excluded.
166
167       --or   Separates two sets of selection options.   Objects  selected  by
168              either set of options are included in the output.
169
170       The  following  additional  input selection options are intended mainly
171       for use by PSPP developers:
172
173       --errors
174              Include only objects that cause an error when  read.   With  the
175              convert  command,  this  is  most useful in conjunction with the
176              --force option.
177
178       --members=member...
179              Include only the objects that include a listed Zip file  member.
180              More  than  one name may be included, comma-separated.  The mem‐
181              bers in an SPV file may be listed with the dir command by adding
182              the  --show-members  option or with the zipinfo program included
183              with many operating systems.  Error  messages  that  pspp-output
184              prints when it reads SPV files also often include member names.
185
186       --member-names
187              Displays  the  name of the Zip member or members associated with
188              each object just above the object itself.
189

OPTIONS

191       -h
192       --help Prints a usage message on stdout and exits.
193
194       -v
195       --version
196              Prints version information on stdout and exits.
197

AUTHORS

199       Ben Pfaff.
200

SEE ALSO

202       pspp-convert(1), pspp(1), psppire(1).
203
204
205
206PSPP                             December 2019                  pspp-output(1)
Impressum