1 @node Invocation, Language, License, Top
6 @cindex command line, options
7 @cindex options, command-line
9 pspp [ -B @var{dir} | --config-dir=@var{dir} ] [ -o @var{device} | --device=@var{device} ]
10 [ -d @var{var}[=@var{value}] | --define=@var{var}[=@var{value}] ] [-u @var{var} | --undef=@var{var} ]
11 [ -f @var{file} | --out-file=@var{file} ] [ -p | --pipe ] [ -I- | --no-include ]
12 [ -I @var{dir} | --include=@var{dir} ] [ -i | --interactive ]
13 [ -n | --edit | --dry-run | --just-print | --recon ]
14 [ -r | --no-statrc ] [ -h | --help ] [ -l | --list ]
15 [ -c @var{command} | --command @var{command} ] [ -s | --safer ]
16 [ --testing-mode ] [ -V | --version ] [ -v | --verbose ]
17 [ @var{key}=@var{value} ] @var{file}@enddots{}
21 * Non-option Arguments:: Specifying syntax files and output devices.
22 * Configuration Options:: Change the configuration for the current run.
23 * Input and output options:: Controlling input and output files.
24 * Language control options:: Language variants.
25 * Informational options:: Helpful information about PSPP.
28 @node Non-option Arguments, Configuration Options, Invocation, Invocation
29 @section Non-option Arguments
31 Syntax files and output device substitutions can be specified on
37 A file by itself on the command line will be executed as a syntax file.
38 If multiple files may be specified, they are executed in order, as if
39 their contents had been given in a single file.
40 PSPP terminates after the syntax files run, unless the @code{-i} or
41 @code{--interactive} option is given (@pxref{Language control options}).
43 @item @var{key}=@var{value}
45 Defines an output device macro @var{key} to expand to @var{value},
46 overriding any macro having the same @var{key} defined in the device
47 configuration file. @xref{Macro definitions}.
51 There is one other way to specify a syntax file, if your operating
52 system supports it. If you have a syntax file @file{foobar.stat}, put
56 #! /usr/local/bin/pspp
59 at the top, and mark the file as executable with @code{chmod +x
60 foobar.stat}. (If PSPP is not installed in @file{/usr/local/bin},
61 then insert its actual installation directory into the syntax file
62 instead.) Now you should be able to invoke the syntax file just by
63 typing its name. You can include any options on the command line as
64 usual. PSPP entirely ignores any lines beginning with @samp{#!}.
66 @node Configuration Options, Input and output options, Non-option Arguments, Invocation
67 @section Configuration Options
69 Configuration options are used to change PSPP's configuration for the
70 current run. The configuration options are:
73 @item -a @{compatible|enhanced@}
74 @itemx --algorithm=@{compatible|enhanced@}
76 If you chose @code{compatible}, then PSPP will use the same algorithms
77 as used by some proprietary statistical analysis packages.
78 This is not recommended, as these algorithms are inferior and in some cases
80 The default setting is @code{enhanced}.
81 Certain commands have subcommands which allow you to override this setting on
85 @itemx --config-dir=@var{dir}
87 Sets the configuration directory to @var{dir}. @xref{File locations}.
90 @itemx --device=@var{device}
92 Selects the output device with name @var{device}. If this option is
93 given more than once, then all devices mentioned are selected. This
94 option disables all devices besides those mentioned on the command line.
97 @node Input and output options, Language control options, Configuration Options, Invocation
98 @section Input and output options
100 Input and output options affect how PSPP reads input and writes
101 output. These are the input and output options:
105 @itemx --out-file=@var{file}
107 This overrides the output file name for devices designated as listing
108 devices. If a file named @var{file} already exists, it is overwritten.
113 Allows PSPP to be used as a filter by causing the syntax file to be
114 read from stdin and output to be written to stdout. Conflicts with the
115 @code{-f @var{file}} and @code{--file=@var{file}} options.
120 Clears all directories from the include path. This includes all
121 directories put in the include path by default. @xref{Miscellaneous
125 @itemx --include=@var{dir}
127 Appends directory @var{dir} to the path that is searched for include
128 files in PSPP syntax files.
130 @item -c @var{command}
131 @itemx --command=@var{command}
133 Execute literal command @var{command}. The command is executed before
134 startup syntax files, if any.
138 Invoke heuristics to assist with testing PSPP. For use by @code{make
139 check} and similar scripts.
142 @node Language control options, Informational options, Input and output options, Invocation
143 @section Language control options
145 Language control options control how PSPP syntax files are parsed and
146 interpreted. The available language control options are:
152 When a syntax file is specified on the command line, PSPP normally
153 terminates after processing it. Giving this option will cause PSPP to
154 bring up a command prompt after processing the syntax file.
156 In addition, this forces syntax files to be interpreted in interactive
157 mode, rather than the default batch mode. @xref{Tokenizing lines}, for
158 information on the differences between batch mode and interactive mode
159 command interpretation.
167 Only the syntax of any syntax file specified or of commands entered at
168 the command line is checked. Transformations are not performed and
169 procedures are not executed. Not yet implemented.
174 Prevents the execution of the PSPP startup syntax file. Not yet
175 implemented, as startup syntax files aren't, either.
180 Disables certain unsafe operations. This includes the ERASE and
181 HOST commands, as well as use of pipes as input and output files.
184 @node Informational options, , Language control options, Invocation
185 @section Informational options
187 Informational options cause information about PSPP to be written to
188 the terminal. Here are the available options:
194 Prints a message describing PSPP command-line syntax and the available
195 device driver classes, then terminates.
200 Lists the available device driver classes, then terminates.
202 @item -x @{compatible|enhanced@}
203 @itemx --syntax=@{compatible|enhanced@}
205 If you chose @code{compatible}, then PSPP will only accept command syntax that
206 is compatible with the proprietary program SPSS.
207 If you choose @code{enhanced} then additional syntax will be available.
208 The default is @code{enhanced}.
214 Prints a brief message listing PSPP's version, warranties you don't
215 have, copying conditions and copyright, and e-mail address for bug
216 reports, then terminates.
221 Increments PSPP's verbosity level. Higher verbosity levels cause
222 PSPP to display greater amounts of information about what it is
223 doing. Often useful for debugging PSPP's configuration.
225 This option can be given multiple times to set the verbosity level to
226 that value. The default verbosity level is 0, in which no informational
227 messages will be displayed.
229 Higher verbosity levels cause messages to be displayed when the
230 corresponding events take place.
235 Driver and subsystem initializations.
239 Completion of driver initializations. Beginning of driver closings.
243 Completion of driver closings.
247 Files searched for; success of searches.
251 Individual directories included in file searches.
254 Each verbosity level also includes messages from lower verbosity levels.