1 @node Utilities, Not Implemented, Statistics, Top
4 Commands that don't fit any other category are placed here.
6 Most of these commands are not affected by commands like @cmd{IF} and
8 they take effect only once, unconditionally, at the time that they are
9 encountered in the input.
12 * COMMENT:: Document your syntax file.
13 * DOCUMENT:: Document the active file.
14 * DISPLAY DOCUMENTS:: Display active file documents.
15 * DISPLAY FILE LABEL:: Display the active file label.
16 * DROP DOCUMENTS:: Remove documents from the active file.
17 * ECHO:: Write a string to the output stream.
18 * ERASE:: Erase a file.
19 * EXECUTE:: Execute pending transformations.
20 * FILE LABEL:: Set the active file's label.
21 * FINISH:: Terminate the PSPP session.
22 * HOST:: Temporarily return to the operating system.
23 * INCLUDE:: Include a file within the current one.
24 * PERMISSIONS:: Change permissions on a file.
25 * SET:: Adjust PSPP runtime parameters.
26 * SHOW:: Display runtime parameters.
27 * SUBTITLE:: Provide a document subtitle.
28 * TITLE:: Provide a document title.
31 @node COMMENT, DOCUMENT, Utilities, Utilities
37 Two possibles syntaxes:
38 COMMENT comment text @dots{} .
39 *comment text @dots{} .
42 @cmd{COMMENT} is ignored. It is used to provide information to
43 the author and other readers of the PSPP syntax file.
45 @cmd{COMMENT} can extend over any number of lines. Don't forget to
46 terminate it with a dot or a blank line.
48 @node DOCUMENT, DISPLAY DOCUMENTS, COMMENT, Utilities
53 DOCUMENT documentary_text.
56 @cmd{DOCUMENT} adds one or more lines of descriptive commentary to the
57 active file. Documents added in this way are saved to system files.
58 They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
59 DOCUMENTS}. They can be removed from the active file with @cmd{DROP
62 Specify the documentary text following the DOCUMENT keyword. You can
63 extend the documentary text over as many lines as necessary. Lines are
64 truncated at 80 characters width. Don't forget to terminate
65 the command with a dot or a blank line.
67 @node DISPLAY DOCUMENTS, DISPLAY FILE LABEL, DOCUMENT, Utilities
68 @section DISPLAY DOCUMENTS
69 @vindex DISPLAY DOCUMENTS
75 @cmd{DISPLAY DOCUMENTS} displays the documents in the active file. Each
76 document is preceded by a line giving the time and date that it was
77 added. @xref{DOCUMENT}.
79 @node DISPLAY FILE LABEL, DROP DOCUMENTS, DISPLAY DOCUMENTS, Utilities
80 @section DISPLAY FILE LABEL
81 @vindex DISPLAY FILE LABEL
87 @cmd{DISPLAY FILE LABEL} displays the file label contained in the
89 if any. @xref{FILE LABEL}.
91 @node DROP DOCUMENTS, ECHO, DISPLAY FILE LABEL, Utilities
92 @section DROP DOCUMENTS
93 @vindex DROP DOCUMENTS
99 @cmd{DROP DOCUMENTS} removes all documents from the active file.
100 New documents can be added with @cmd{DOCUMENT} (@pxref{DOCUMENT}).
102 @cmd{DROP DOCUMENTS} changes only the active file. It does not modify any
103 system files stored on disk.
105 @node ECHO, ERASE, DROP DOCUMENTS, Utilities
110 ECHO 'arbitrary text' .
113 Use @cmd{ECHO} to write arbitrary text to the output stream. The text should be enclosed in quotation marks following the normal rules for string tokens (@pxref{Tokens}).
115 @node ERASE, EXECUTE, ECHO, Utilities
116 @comment node-name, next, previous, up
121 ERASE FILE file_name.
124 @cmd{ERASE FILE} deletes a file from the local filesystem.
125 file_name must be quoted.
126 This command cannot be used if the SAFER setting is active.
129 @node EXECUTE, FILE LABEL, ERASE, Utilities
137 @cmd{EXECUTE} causes the active file to be read and all pending
138 transformations to be executed.
140 @node FILE LABEL, FINISH, EXECUTE, Utilities
145 FILE LABEL file_label.
148 @cmd{FILE LABEL} provides a title for the active file. This
149 title will be saved into system files and portable files that are
150 created during this PSPP run.
152 file_label need not be quoted. If quotes are
153 included, they become part of the file label.
155 @node FINISH, HOST, FILE LABEL, Utilities
163 @cmd{FINISH} terminates the current PSPP session and returns
164 control to the operating system.
166 @node HOST, INCLUDE, FINISH, Utilities
167 @comment node-name, next, previous, up
175 @cmd{HOST} suspends the current PSPP session and temporarily returns control
176 to the operating system.
177 This command cannot be used if the SAFER setting is active.
180 @node INCLUDE, PERMISSIONS, HOST, Utilities
186 Two possible syntaxes:
191 @cmd{INCLUDE} causes the PSPP command processor to read an
192 additional command file as if it were included bodily in the current
195 Include files may be nested to any depth, up to the limit of available
198 @node PERMISSIONS, SET, INCLUDE, Utilities
199 @comment node-name, next, previous, up
204 @cindex changing file permissions
209 /PERMISSIONS = @{READONLY,WRITEABLE@}.
212 @cmd{PERMISSIONS} changes the permissions of a file.
213 There is one mandatory subcommand which specifies the permissions to
214 which the file should be changed.
215 If you set a file's permission to READONLY, then the file will become
216 unwritable either by you or anyone else on the system.
217 If you set the permission to WRITEABLE, then the file will become
218 writeable by you; the permissions afforded to others will be
220 This command cannot be used if the SAFER setting is active.
223 @node SET, SHOW, PERMISSIONS, Utilities
231 /BLANKS=@{SYSMIS,'.',number@}
232 /DECIMAL=@{DOT,COMMA@}
234 /EPOCH=@{AUTOMATIC,year@}
241 /CPROMPT='cprompt_string'
242 /DPROMPT='dprompt_string'
243 /ERRORBREAK=@{OFF,ON@}
245 /MXWARNS=max_warnings
250 /MITERATE=max_iterations
254 /SEED=@{RANDOM,seed_value@}
255 /UNDEFINED=@{WARN,NOWARN@}
258 /CC@{A,B,C,D,E@}=@{'npre,pre,suf,nsuf','npre.pre.suf.nsuf'@}
259 /DECIMAL=@{DOT,COMMA@}
264 /ERRORS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
266 /MESSAGES=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
267 /PRINTBACK=@{ON,OFF@}
268 /RESULTS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
270 (output driver options)
271 /HEADERS=@{NO,YES,BLANK@}
272 /LENGTH=@{NONE,length_in_lines@}
273 /LISTING=@{ON,OFF,filename@}
275 /WIDTH=@{NARROW,WIDTH,n_characters@}
278 /JOURNAL=@{ON,OFF@} [filename]
281 /COMPRESSION=@{ON,OFF@}
282 /SCOMPRESSION=@{ON,OFF@}
287 (obsolete settings accepted for compatibility, but ignored)
288 /BOXSTRING=@{'xxx','xxxxxxxxxxx'@}
289 /CASE=@{UPPER,UPLOW@}
294 /LOWRES=@{AUTO,ON,OFF@}
296 /MENUS=@{STANDARD,EXTENDED@}
299 /TB1=@{'xxx','xxxxxxxxxxx'@}
301 /WORKSPACE=workspace_size
305 @cmd{SET} allows the user to adjust several parameters relating to
306 PSPP's execution. Since there are many subcommands to this command, its
307 subcommands will be examined in groups.
309 On subcommands that take boolean values, ON and YES are synonym, and
310 as are OFF and NO, when used as subcommand values.
312 The data input subcommands affect the way that data is read from data
313 files. The data input subcommands are
317 This is the value assigned to an item data item that is empty or
318 contains only white space. An argument of SYSMIS or '.' will cause the
319 system-missing value to be assigned to null items. This is the
320 default. Any real value may be assigned.
323 The default DOT setting causes the decimal point character to be
324 @samp{.}. A setting of COMMA causes the decimal point character to be
328 Allows the default numeric input/output format to be specified. The
329 default is F8.2. @xref{Input/Output Formats}.
333 Specifies the range of years used when a 2-digit year is read from a
334 data file or used in a date construction expression (@pxref{Date
335 Construction}). If a 4-digit year is specified, then 2-digit years
336 are interpreted starting from that year, known as the epoch. If
337 AUTOMATIC (the default) is specified, then the epoch begins 69 years
338 before the current date.
341 Program input subcommands affect the way that programs are parsed when
342 they are typed interactively or run from a command file. They are
346 This is a single character indicating the end of a command. The default
347 is @samp{.}. Don't change this.
350 Whether a blank line is interpreted as ending the current command. The
354 Interaction subcommands affect the way that PSPP interacts with an
355 online user. The interaction subcommands are
359 The command continuation prompt. The default is @samp{ > }.
362 Prompt used when expecting data input within @cmd{BEGIN DATA} (@pxref{BEGIN
363 DATA}). The default is @samp{data> }.
366 Whether an error causes PSPP to stop processing the current command
367 file after finishing the current command. The default is OFF.
370 The maximum number of errors before PSPP halts processing of the current
371 command file. The default is 50.
374 The maximum number of warnings + errors before PSPP halts processing the
375 current command file. The default is 100.
378 The command prompt. The default is @samp{PSPP> }.
381 Program execution subcommands control the way that PSPP commands
382 execute. The program execution subcommands are
392 The maximum number of iterations for an uncontrolled loop (@pxref{LOOP}).
395 The initial pseudo-random number seed. Set to a real number or to
396 RANDOM, which will obtain an initial seed from the current time of day.
402 Data output subcommands affect the format of output data. These
411 Set up custom currency formats. The argument is a string which must
412 contain exactly three commas or exactly three periods. If commas, then
413 the grouping character for the currency format is @samp{,}, and the
414 decimal point character is @samp{.}; if periods, then the situation is
417 The commas or periods divide the string into four fields, which are, in
418 order, the negative prefix, prefix, suffix, and negative suffix. When a
419 value is formatted using the custom currency format, the prefix precedes
420 the value formatted and the suffix follows it. In addition, if the
421 value is negative, the negative prefix precedes the prefix and the
422 negative suffix follows the suffix.
425 The default DOT setting causes the decimal point character to be
426 @samp{.}. A setting of COMMA causes the decimal point character to be
430 Allows the default numeric input/output format to be specified. The
431 default is F8.2. @xref{Input/Output Formats}.
434 Output routing subcommands affect where the output of transformations
435 and procedures is sent. These subcommands are
440 If turned on, commands are written to the listing file as they are read
441 from command files. The default is OFF.
451 Output driver option subcommands affect output drivers' settings. These
471 Logging subcommands affect logging of commands executed to external
472 files. These subcommands are
480 System file subcommands affect the default format of system files
481 produced by PSPP. These subcommands are
488 Whether system files created by @cmd{SAVE} or @cmd{XSAVE} are
489 compressed by default. The default is ON.
492 Security subcommands affect the operations that commands are allowed to
493 perform. The security subcommands are
497 Setting this option disables the following operations:
505 The PERMISSIONS command.
507 Pipe filenames (filenames beginning or ending with @samp{|}).
510 Be aware that this setting does not guarantee safety (commands can still
511 overwrite files, for instance) but it is an improvement.
512 When set, this setting cannot be reset during the same session, for
513 obvious security reasons.
516 @node SHOW, SUBTITLE, SET, Utilities
517 @comment node-name, next, previous, up
546 @cmd{SHOW} can be used to display the current state of PSPP's execution
547 parameters. Parameters that can be changed using @cmd{SET}
548 (@pxref{SET}), can be examined using @cmd{SHOW} using the subcommand
549 with the same name. @code{SHOW} supports the following additional
556 Show all custom currency settings (CCA through CCE).
558 Show details of the lack of warranty for PSPP.
560 Display the terms of PSPP's copyright licence (@pxref{License}).
563 Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL.
565 @node SUBTITLE, TITLE, SHOW, Utilities
570 SUBTITLE 'subtitle_string'.
572 SUBTITLE subtitle_string.
575 @cmd{SUBTITLE} provides a subtitle to a particular PSPP
576 run. This subtitle appears at the top of each output page below the
577 title, if headers are enabled on the output device.
579 Specify a subtitle as a string in quotes. The alternate syntax that did
580 not require quotes is now obsolete. If it is used then the subtitle is
581 converted to all uppercase.
583 @node TITLE, , SUBTITLE, Utilities
588 TITLE 'title_string'.
593 @cmd{TITLE} provides a title to a particular PSPP run.
594 This title appears at the top of each output page, if headers are enabled
595 on the output device.
597 Specify a title as a string in quotes. The alternate syntax that did
598 not require quotes is now obsolete. If it is used then the title is
599 converted to all uppercase.