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 * ERASE:: Erase a file.
18 * EXECUTE:: Execute pending transformations.
19 * FILE LABEL:: Set the active file's label.
20 * FINISH:: Terminate the PSPP session.
21 * HOST:: Temporarily return to the operating system.
22 * INCLUDE:: Include a file within the current one.
23 * PERMISSIONS:: Change permissions on a file.
24 * QUIT:: Terminate the PSPP session.
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, ERASE, 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.
106 @node ERASE, EXECUTE, DROP DOCUMENTS, Utilities
107 @comment node-name, next, previous, up
112 ERASE FILE file_name.
115 @cmd{ERASE FILE} deletes a file from the local filesystem.
116 file_name must be quoted.
117 This command cannot be used if the SAFER setting is active.
120 @node EXECUTE, FILE LABEL, ERASE, Utilities
128 @cmd{EXECUTE} causes the active file to be read and all pending
129 transformations to be executed.
131 @node FILE LABEL, FINISH, EXECUTE, Utilities
136 FILE LABEL file_label.
139 @cmd{FILE LABEL} provides a title for the active file. This
140 title will be saved into system files and portable files that are
141 created during this PSPP run.
143 file_label need not be quoted. If quotes are
144 included, they become part of the file label.
146 @node FINISH, HOST, FILE LABEL, Utilities
154 @cmd{FINISH} terminates the current PSPP session and returns
155 control to the operating system.
157 This command is not valid in interactive mode.
159 @node HOST, INCLUDE, FINISH, Utilities
160 @comment node-name, next, previous, up
168 @cmd{HOST} suspends the current PSPP session and temporarily returns control
169 to the operating system.
170 This command cannot be used if the SAFER setting is active.
173 @node INCLUDE, PERMISSIONS, HOST, Utilities
179 Two possible syntaxes:
184 @cmd{INCLUDE} causes the PSPP command processor to read an
185 additional command file as if it were included bodily in the current
188 Include files may be nested to any depth, up to the limit of available
191 @node PERMISSIONS, QUIT, INCLUDE, Utilities
192 @comment node-name, next, previous, up
197 @cindex changing file permissions
202 /PERMISSIONS = @{READONLY,WRITEABLE@}.
205 @cmd{PERMISSIONS} changes the permissions of a file.
206 There is one mandatory subcommand which specifies the permissions to
207 which the file should be changed.
208 If you set a file's permission to READONLY, then the file will become
209 unwritable either by you or anyone else on the system.
210 If you set the permission to WRITEABLE, then the file will become
211 writeable by you; the permissions afforded to others will be
215 @node QUIT, SET, PERMISSIONS, Utilities
220 Two possible syntaxes:
225 @cmd{QUIT} terminates the current PSPP session and returns control
226 to the operating system.
228 This command is not valid within a command file.
230 @node SET, SHOW, QUIT, Utilities
238 /BLANKS=@{SYSMIS,'.',number@}
239 /DECIMAL=@{DOT,COMMA@}
247 /CPROMPT='cprompt_string'
248 /DPROMPT='dprompt_string'
249 /ERRORBREAK=@{OFF,ON@}
251 /MXWARNS=max_warnings
253 /VIEWLENGTH=@{MINIMUM,MEDIAN,MAXIMUM,n_lines@}
254 /VIEWWIDTH=n_characters
258 /MITERATE=max_iterations
262 /SEED=@{RANDOM,seed_value@}
263 /UNDEFINED=@{WARN,NOWARN@}
266 /CC@{A,B,C,D,E@}=@{'npre,pre,suf,nsuf','npre.pre.suf.nsuf'@}
267 /DECIMAL=@{DOT,COMMA@}
272 /ERRORS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
274 /MESSAGES=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
275 /PRINTBACK=@{ON,OFF@}
276 /RESULTS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
283 (output driver options)
284 /HEADERS=@{NO,YES,BLANK@}
285 /LENGTH=@{NONE,length_in_lines@}
288 /PAGER=@{OFF,"pager_name"@}
289 /WIDTH=@{NARROW,WIDTH,n_characters@}
292 /JOURNAL=@{ON,OFF@} [filename]
293 /LOG=@{ON,OFF@} [filename]
296 /COMPRESSION=@{ON,OFF@}
297 /SCOMPRESSION=@{ON,OFF@}
302 (obsolete settings accepted for compatibility, but ignored)
306 /BOXSTRING=@{'xxx','xxxxxxxxxxx'@}
307 /CASE=@{UPPER,UPLOW@}
312 /HELPWINDOWS=@{ON,OFF@}
315 /LOWRES=@{AUTO,ON,OFF@}
317 /MENUS=@{STANDARD,EXTENDED@}
319 /PTRANSLATE=@{ON,OFF@}
321 /RUNREVIEW=@{AUTO,MANUAL@}
323 /TB1=@{'xxx','xxxxxxxxxxx'@}
325 /WORKDEV=drive_letter
326 /WORKSPACE=workspace_size
330 @cmd{SET} allows the user to adjust several parameters relating to
331 PSPP's execution. Since there are many subcommands to this command, its
332 subcommands will be examined in groups.
334 On subcommands that take boolean values, ON and YES are synonym, and
335 as are OFF and NO, when used as subcommand values.
337 The data input subcommands affect the way that data is read from data
338 files. The data input subcommands are
342 This is the value assigned to an item data item that is empty or
343 contains only whitespace. An argument of SYSMIS or '.' will cause the
344 system-missing value to be assigned to null items. This is the
345 default. Any real value may be assigned.
348 The default DOT setting causes the decimal point character to be
349 @samp{.}. A setting of COMMA causes the decimal point character to be
353 Allows the default numeric input/output format to be specified. The
354 default is F8.2. @xref{Input/Output Formats}.
357 Program input subcommands affect the way that programs are parsed when
358 they are typed interactively or run from a script. They are
362 This is a single character indicating the end of a command. The default
363 is @samp{.}. Don't change this.
366 Whether a blank line is interpreted as ending the current command. The
370 Interaction subcommands affect the way that PSPP interacts with an
371 online user. The interaction subcommands are
375 The command continuation prompt. The default is @samp{ > }.
378 Prompt used when expecting data input within @cmd{BEGIN DATA} (@pxref{BEGIN
379 DATA}). The default is @samp{data> }.
382 Whether an error causes PSPP to stop processing the current command
383 file after finishing the current command. The default is OFF.
386 The maximum number of errors before PSPP halts processing of the current
387 command file. The default is 50.
390 The maximum number of warnings + errors before PSPP halts processing the
391 current command file. The default is 100.
394 The command prompt. The default is @samp{PSPP> }.
397 The length of the screen in lines. MINIMUM means 25 lines, MEDIAN and
398 MAXIMUM mean 43 lines. Otherwise specify the number of lines. Normally
399 PSPP should auto-detect your screen size so this shouldn't have to be
403 The width of the screen in characters. Normally 80 or 132.
406 Program execution subcommands control the way that PSPP commands
407 execute. The program execution subcommands are
417 The maximum number of iterations for an uncontrolled loop (@pxref{LOOP}).
420 The initial pseudo-random number seed. Set to a real number or to
421 RANDOM, which will obtain an initial seed from the current time of day.
427 Data output subcommands affect the format of output data. These
436 Set up custom currency formats. The argument is a string which must
437 contain exactly three commas or exactly three periods. If commas, then
438 the grouping character for the currency format is @samp{,}, and the
439 decimal point character is @samp{.}; if periods, then the situation is
442 The commas or periods divide the string into four fields, which are, in
443 order, the negative prefix, prefix, suffix, and negative suffix. When a
444 value is formatted using the custom currency format, the prefix precedes
445 the value formatted and the suffix follows it. In addition, if the
446 value is negative, the negative prefix precedes the prefix and the
447 negative suffix follows the suffix.
450 The default DOT setting causes the decimal point character to be
451 @samp{.}. A setting of COMMA causes the decimal point character to be
455 Allows the default numeric input/output format to be specified. The
456 default is F8.2. @xref{Input/Output Formats}.
459 Output routing subcommands affect where the output of transformations
460 and procedures is sent. These subcommands are
465 If turned on, commands are written to the listing file as they are read
466 from command files. The default is OFF.
476 Output activation subcommands affect whether output devices of
477 particular types are enabled. These subcommands are
481 Enable or disable listing devices.
484 Enable or disable printer devices.
487 Enable or disable screen devices.
490 Output driver option subcommands affect output drivers' settings. These
503 Logging subcommands affect logging of commands executed to external
504 files. These subcommands are
512 System file subcommands affect the default format of system files
513 produced by PSPP. These subcommands are
520 Whether system files created by @cmd{SAVE} or @cmd{XSAVE} are
521 compressed by default. The default is ON.
524 Security subcommands affect the operations that commands are allowed to
525 perform. The security subcommands are
529 When set, this setting cannot ever be reset, for obvious security
530 reasons. Setting this option disables the following operations:
538 Pipe filenames (filenames beginning or ending with @samp{|}).
541 Be aware that this setting does not guarantee safety (commands can still
542 overwrite files, for instance) but it is an improvement.
545 @node SHOW, SUBTITLE, SET, Utilities
546 @comment node-name, next, previous, up
556 @cmd{SHOW} can be used to display the current state of PSPP's
557 execution parameters. All of the parameters which can be changed
558 using @code{SET} @xref{SET}, can be examined using @cmd{SHOW}, by
559 using a subcommand with the same name.
560 In addition, @code{SHOW} supports the following subcommands:
564 Show details of the lack of warranty for PSPP.
566 Display the terms of PSPP's copyright licence @ref{License}.
571 @node SUBTITLE, TITLE, SHOW, Utilities
576 SUBTITLE 'subtitle_string'.
578 SUBTITLE subtitle_string.
581 @cmd{SUBTITLE} provides a subtitle to a particular PSPP
582 run. This subtitle appears at the top of each output page below the
583 title, if headers are enabled on the output device.
585 Specify a subtitle as a string in quotes. The alternate syntax that did
586 not require quotes is now obsolete. If it is used then the subtitle is
587 converted to all uppercase.
589 @node TITLE, , SUBTITLE, Utilities
594 TITLE 'title_string'.
599 @cmd{TITLE} provides a title to a particular PSPP run.
600 This title appears at the top of each output page, if headers are enabled
601 on the output device.
603 Specify a title as a string in quotes. The alternate syntax that did
604 not require quotes is now obsolete. If it is used then the title is
605 converted to all uppercase.