* ERASE:: Erase a file.
* EXECUTE:: Execute pending transformations.
* FILE LABEL:: Set the active dataset's label.
-* FINISH:: Terminate the PSPP session.
+* FINISH:: Terminate the @pspp{} session.
* HOST:: Temporarily return to the operating system.
* INCLUDE:: Include a file within the current one.
* INSERT:: Insert a file within the current one.
* PERMISSIONS:: Change permissions on a file.
* PRESERVE and RESTORE:: Saving settings and restoring them later.
-* SET:: Adjust PSPP runtime parameters.
+* SET:: Adjust @pspp{} runtime parameters.
* SHOW:: Display runtime parameters.
* SUBTITLE:: Provide a document subtitle.
* TITLE:: Provide a document title.
@end display
@cmd{COMMENT} is ignored. It is used to provide information to
-the author and other readers of the PSPP syntax file.
+the author and other readers of the @pspp{} syntax file.
@cmd{COMMENT} can extend over any number of lines. Don't forget to
terminate it with a dot or a blank line.
active dataset,
if any. @xref{FILE LABEL}.
-This command is a PSPP extension.
+This command is a @pspp{} extension.
@node DROP DOCUMENTS
@section DROP DOCUMENTS
@cmd{FILE LABEL} provides a title for the active dataset. This
title will be saved into system files and portable files that are
-created during this PSPP run.
+created during this @pspp{} run.
file_label need not be quoted. If quotes are
included, they become part of the file label.
FINISH.
@end display
-@cmd{FINISH} terminates the current PSPP session and returns
+@cmd{FINISH} terminates the current @pspp{} session and returns
control to the operating system.
@node HOST
HOST COMMAND=['command'...].
@end display
-@cmd{HOST} suspends the current PSPP session and temporarily returns control
+@cmd{HOST} suspends the current @pspp{} session and temporarily returns control
to the operating system.
This command cannot be used if the SAFER setting is active.
-If the COMMAND subcommand is specified, as a sequence of shell
-commands as quoted strings within square brackets, then PSPP executes
+If the @subcmd{COMMAND} subcommand is specified, as a sequence of shell
+commands as quoted strings within square brackets, then @pspp{} executes
them together in a single subshell.
-If no subcommands are specified, then PSPP invokes an interactive
+If no subcommands are specified, then @pspp{} invokes an interactive
subshell.
@node INCLUDE
INCLUDE [FILE=]'file-name' [ENCODING='encoding'].
@end display
-@cmd{INCLUDE} causes the PSPP command processor to read an
+@cmd{INCLUDE} causes the @pspp{} command processor to read an
additional command file as if it were included bodily in the current
command file.
If errors are encountered in the included file, then command processing will
alternative to @cmd{INCLUDE}. An INCLUDE command acts the same as
INSERT with ERROR=STOP CD=NO SYNTAX=BATCH specified.
-The optional ENCODING subcommand has the same meaning as on INSERT.
+The optional @subcmd{ENCODING} subcommand has the same meaning as on INSERT.
@node INSERT
@section INSERT
@code{EUC-JP} (Japan), and @code{windows-1252} (Windows). Not all
systems support all character sets.
-@item @code{Auto}
@item @code{Auto,@var{encoding}}
-Automatically detects whether a syntax file is encoded in
-@var{encoding} or in a Unicode encoding such as UTF-8, UTF-16, or
-UTF-32. The @var{encoding} may be an IANA character set name or
-@code{Locale} (the default). Only ASCII compatible encodings can
-automatically be distinguished from UTF-8 (the most common locale
-encodings are all ASCII-compatible).
+Automatically detects whether a syntax file is encoded in an Unicode
+encoding such as UTF-8, UTF-16, or UTF-32. If it is not, then @pspp{}
+generally assumes that the file is encoded in @var{encoding} (an IANA
+character set name). However, if @var{encoding} is UTF-8, and the
+syntax file is not valid UTF-8, @pspp{} instead assumes that the file
+is encoded in @code{windows-1252}.
+
+For best results, @var{encoding} should be an ASCII-compatible
+encoding (the most common locale encodings are all ASCII-compatible),
+because encodings that are not ASCII compatible cannot be
+automatically distinguished from UTF-8.
+
+@item @code{Auto}
+@item @code{Auto,Locale}
+Automatic detection, as above, with the default encoding taken from
+the system locale or the setting on SET LOCALE.
@end table
When ENCODING is not specified, the default is taken from the
@end display
@cmd{SET} allows the user to adjust several parameters relating to
-PSPP's execution. Since there are many subcommands to this command, its
+@pspp{}'s execution. Since there are many subcommands to this command, its
subcommands will be examined in groups.
-On subcommands that take boolean values, ON and YES are synonym, and
+For subcommands that take boolean values, ON and YES are synonymous,
as are OFF and NO, when used as subcommand values.
The data input subcommands affect the way that data is read from data
@item RIB
@anchor{SET RIB}
-PSPP extension to set the byte ordering (endianness) used for reading
+@pspp{} extension to set the byte ordering (endianness) used for reading
data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
Formats}). In MSBFIRST ordering, the most-significant byte appears at
the left end of a IB or PIB field. In LSBFIRST ordering, the
least-significant byte appears at the left end. VAX ordering is like
MSBFIRST, except that each pair of bytes is in reverse order. NATIVE,
the default, is equivalent to MSBFIRST or LSBFIRST depending on the
-native format of the machine running PSPP.
+native format of the machine running @pspp{}.
@item RRB
@anchor{SET RRB}
-PSPP extension to set the floating-point format used for reading data in
+@pspp{} extension to set the floating-point format used for reading data in
RB format (@pxref{Binary and Hexadecimal Numeric Formats}). The
possibilities are:
@table @asis
@item NATIVE
-The native format of the machine running PSPP. Equivalent to either IDL
+The native format of the machine running @pspp{}. Equivalent to either IDL
or IDB.
@item ISL
The default is NATIVE.
@end table
-Interaction subcommands affect the way that PSPP interacts with an
+Interaction subcommands affect the way that @pspp{} interacts with an
online user. The interaction subcommands are
@table @asis
@item MXERRS
-The maximum number of errors before PSPP halts processing of the current
+The maximum number of errors before @pspp{} halts processing of the current
command file. The default is 50.
@item MXWARNS
-The maximum number of warnings + errors before PSPP halts processing the
+The maximum number of warnings + errors before @pspp{} halts processing the
current command file.
The special value of zero means that all warning situations should be ignored.
No warnings will be issued, except a single initial warning advising the user
The default value is 100.
@end table
-Syntax execution subcommands control the way that PSPP commands
+Syntax execution subcommands control the way that @pspp{} commands
execute. The syntax execution subcommands are
@table @asis
Currently not used.
@item WORKSPACE
-The maximum amount of memory that PSPP will use to store data being processed.
-If memory in excess of the workspace size is required, then PSPP will start
+The maximum amount of memory that @pspp{} will use to store data being processed.
+If memory in excess of the workspace size is required, then @pspp{} will start
to use temporary files to store the data.
Setting a higher value will, in general, mean procedures will run faster,
but may cause other applications to run slower.
On platforms without virtual memory management, setting a very large workspace
-may cause PSPP to abort.
+may cause @pspp{} to abort.
@cindex workspace
@cindex memory, amount used to store cases
@end table
@item WIB
@anchor{SET WIB}
-PSPP extension to set the byte ordering (endianness) used for writing
+@pspp{} extension to set the byte ordering (endianness) used for writing
data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
Formats}). In MSBFIRST ordering, the most-significant byte appears at
the left end of a IB or PIB field. In LSBFIRST ordering, the
least-significant byte appears at the left end. VAX ordering is like
MSBFIRST, except that each pair of bytes is in reverse order. NATIVE,
the default, is equivalent to MSBFIRST or LSBFIRST depending on the
-native format of the machine running PSPP.
+native format of the machine running @pspp{}.
@item WRB
@anchor{SET WRB}
-PSPP extension to set the floating-point format used for writing data in
+@pspp{} extension to set the floating-point format used for writing data in
RB format (@pxref{Binary and Hexadecimal Numeric Formats}). The choices
are the same as SET RIB. The default is NATIVE.
@end table
-In the PSPP text-based interface, the output routing subcommands
+In the @pspp{} text-based interface, the output routing subcommands
affect where output is sent. The following values are allowed for
each of these subcommands:
@item ERRORS
Applies to error and warning messages. The default is BOTH.
-@itemx MESSAGES
+@item MESSAGES
Applies to notes. The default is BOTH.
-@itemx PRINTBACK
+@item PRINTBACK
Determines whether the syntax used for input is printed back as part
of the output. The default is NONE.
-@itemx RESULTS
+@item RESULTS
Applies to everything not in one of the above categories, such as the
results of statistical procedures. The default is BOTH.
@end table
-These subcommands have no effect on output in the PSPP GUI
+These subcommands have no effect on output in the @pspp{} GUI
environment.
Output driver option subcommands affect output drivers' settings. These
These subcommands, which are synonyms, control the journal. The
default is ON, which causes commands entered interactively to be
written to the journal file. Commands included from syntax files that
-are included interactively and error messages printed by PSPP are also
+are included interactively and error messages printed by @pspp{} are also
written to the journal file, prefixed by @samp{>}. OFF disables use
of the journal.
@end table
System file subcommands affect the default format of system files
-produced by PSPP. These subcommands are
+produced by @pspp{}. These subcommands are
@table @asis
@item COMPRESSION
If given as a locale name, only the character encoding of the
locale is relevant.
-System files written by PSPP will use this encoding.
-System files read by PSPP, for which the encoding is unknown, will be
+System files written by @pspp{} will use this encoding.
+System files read by @pspp{}, for which the encoding is unknown, will be
interpreted using this encoding.
The full list of valid encodings and locale names/alias are operating system
[CCE]
[COPYING]
[DECIMALS]
+ [DIRECTORY]
+ [ENVIRONMENT]
[FORMAT]
[LENGTH]
[MXERRS]
[MXLOOPS]
[MXWARNS]
[SCOMPRESSION]
+ [TEMPDIR]
[UNDEFINED]
+ [VERSION]
[WARRANTY]
[WEIGHT]
[WIDTH]
@end display
-@cmd{SHOW} can be used to display the current state of PSPP's execution
+@cmd{SHOW} can be used to display the current state of @pspp{}'s execution
parameters. Parameters that can be changed using @cmd{SET}
(@pxref{SET}), can be examined using @cmd{SHOW} using the subcommand
with the same name. @code{SHOW} supports the following additional
Show all settings.
@item CC
Show all custom currency settings (CCA through CCE).
+@item DIRECTORY
+Shows the current working directory.
+@item ENVIRONMENT
+Shows the operating system details.
+@item TEMPDIR
+Shows the path of the directory where temporary files will be stored.
+@item VERSION
+Shows the version of this installation of @pspp{}.
@item WARRANTY
-Show details of the lack of warranty for PSPP.
-@item COPYING
-Display the terms of PSPP's copyright licence (@pxref{License}).
+Show details of the lack of warranty for @pspp{}.
+@item COPYING / LICENSE
+Display the terms of @pspp{}'s copyright licence (@pxref{License}).
@end table
Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL.
SUBTITLE subtitle_string.
@end display
-@cmd{SUBTITLE} provides a subtitle to a particular PSPP
+@cmd{SUBTITLE} provides a subtitle to a particular @pspp{}
run. This subtitle appears at the top of each output page below the
title, if headers are enabled on the output device.
TITLE title_string.
@end display
-@cmd{TITLE} provides a title to a particular PSPP run.
+@cmd{TITLE} provides a title to a particular @pspp{} run.
This title appears at the top of each output page, if headers are enabled
on the output device.
projects / pspp / blobdiff