Patch #6210: implement ability to resize output device parameters to
[pspp-builds.git] / doc / utilities.texi
1 @node Utilities
2 @chapter Utilities
3
4 Commands that don't fit any other category are placed here.
5
6 Most of these commands are not affected by commands like @cmd{IF} and
7 @cmd{LOOP}:
8 they take effect only once, unconditionally, at the time that they are
9 encountered in the input.
10
11 @menu
12 * ADD DOCUMENT::                Add documentary text to the active file.
13 * CD::                          Change the current directory.
14 * COMMENT::                     Document your syntax file.
15 * DOCUMENT::                    Document the active file.
16 * DISPLAY DOCUMENTS::           Display active file documents.
17 * DISPLAY FILE LABEL::          Display the active file label.
18 * DROP DOCUMENTS::              Remove documents from the active file.
19 * ECHO::                        Write a string to the output stream.
20 * ERASE::                       Erase a file.
21 * EXECUTE::                     Execute pending transformations.
22 * FILE LABEL::                  Set the active file's label.
23 * FINISH::                      Terminate the PSPP session.
24 * HOST::                        Temporarily return to the operating system.
25 * INCLUDE::                     Include a file within the current one.
26 * INSERT::                      Insert a file within the current one.
27 * PERMISSIONS::                 Change permissions on a file.
28 * SET::                         Adjust PSPP runtime parameters.
29 * SHOW::                        Display runtime parameters.
30 * SUBTITLE::                    Provide a document subtitle.
31 * TITLE::                       Provide a document title.
32 @end menu
33
34 @node ADD DOCUMENT
35 @comment  node-name,  next,  previous,  up
36 @section ADD DOCUMENT
37 @vindex  ADD DOCUMENT
38
39 @display
40 ADD DOCUMENT 
41     'line one' 'line two' @dots{} 'last line' .
42 @end display
43
44
45 @cmd{ADD DOCUMENT} adds one or more lines of descriptive commentary to 
46 the active file.  Documents added in this way are saved to system files.
47 They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
48 DOCUMENTS}.  They can be removed from the active file with @cmd{DROP
49 DOCUMENTS}.
50
51 Each line of documentary text must be enclosed in quotation marks, and 
52 may not be more than 80 bytes long. @xref{DOCUMENT}.
53
54 @node CD
55 @section CD
56 @vindex CD
57 @cindex directory
58 @cindex changing directory
59
60 @display
61 CD 'new directory' .
62 @end display 
63
64 @cmd{CD} changes the current directory.  The new directory will become that specified by the command.
65
66 @node COMMENT
67 @section COMMENT
68 @vindex COMMENT
69 @vindex *
70
71 @display 
72 Two possibles syntaxes:
73         COMMENT comment text @dots{} .
74         *comment text @dots{} .
75 @end display
76
77 @cmd{COMMENT} is ignored.  It is used to provide information to
78 the author and other readers of the PSPP syntax file.  
79
80 @cmd{COMMENT} can extend over any number of lines.  Don't forget to
81 terminate it with a dot or a blank line.
82
83
84
85 @node DOCUMENT
86 @section DOCUMENT
87 @vindex DOCUMENT
88
89 @display
90 DOCUMENT @var{documentary_text}.
91 @end display
92
93 @cmd{DOCUMENT} adds one or more lines of descriptive commentary to the
94 active file.  Documents added in this way are saved to system files.
95 They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
96 DOCUMENTS}.  They can be removed from the active file with @cmd{DROP
97 DOCUMENTS}.
98
99 Specify the @var{documentary text} following the DOCUMENT keyword.  
100 It is interpreted literally --- any quotes or other punctuation marks 
101 will be included in the file.
102 You can extend the documentary text over as many lines as necessary.  
103 Lines are truncated at 80 bytes.  Don't forget to terminate
104 the command with a dot or a blank line. @xref{ADD DOCUMENT}.
105
106 @node DISPLAY DOCUMENTS
107 @section DISPLAY DOCUMENTS
108 @vindex DISPLAY DOCUMENTS
109
110 @display
111 DISPLAY DOCUMENTS.
112 @end display
113
114 @cmd{DISPLAY DOCUMENTS} displays the documents in the active file.  Each
115 document is preceded by a line giving the time and date that it was
116 added.  @xref{DOCUMENT}.
117
118 @node DISPLAY FILE LABEL
119 @section DISPLAY FILE LABEL
120 @vindex DISPLAY FILE LABEL
121
122 @display
123 DISPLAY FILE LABEL.
124 @end display
125
126 @cmd{DISPLAY FILE LABEL} displays the file label contained in the
127 active file,
128 if any.  @xref{FILE LABEL}.
129
130 This command is a PSPP extension.
131
132 @node DROP DOCUMENTS
133 @section DROP DOCUMENTS
134 @vindex DROP DOCUMENTS
135
136 @display
137 DROP DOCUMENTS.
138 @end display
139
140 @cmd{DROP DOCUMENTS} removes all documents from the active file.
141 New documents can be added with @cmd{DOCUMENT} (@pxref{DOCUMENT}).
142
143 @cmd{DROP DOCUMENTS} changes only the active file.  It does not modify any
144 system files stored on disk.
145
146 @node ECHO
147 @section ECHO
148 @vindex ECHO
149
150 @display 
151 ECHO 'arbitrary text' .
152 @end display
153
154 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}).
155
156 @node ERASE
157 @comment  node-name,  next,  previous,  up
158 @section ERASE
159 @vindex ERASE
160
161 @display
162 ERASE FILE file_name.
163 @end display
164
165 @cmd{ERASE FILE} deletes a file from the local filesystem.
166 file_name must be quoted.
167 This command cannot be used if the SAFER setting is active.
168
169
170 @node EXECUTE
171 @section EXECUTE
172 @vindex EXECUTE
173
174 @display
175 EXECUTE.
176 @end display
177
178 @cmd{EXECUTE} causes the active file to be read and all pending
179 transformations to be executed.
180
181 @node FILE LABEL
182 @section FILE LABEL
183 @vindex FILE LABEL
184
185 @display
186 FILE LABEL file_label.
187 @end display
188
189 @cmd{FILE LABEL} provides a title for the active file.  This
190 title will be saved into system files and portable files that are
191 created during this PSPP run.
192
193 file_label need not be quoted.  If quotes are
194 included, they become part of the file label.
195
196 @node FINISH
197 @section FINISH
198 @vindex FINISH
199
200 @display
201 FINISH.
202 @end display
203
204 @cmd{FINISH} terminates the current PSPP session and returns
205 control to the operating system.
206
207 @node HOST
208 @comment  node-name,  next,  previous,  up
209 @section HOST
210 @vindex HOST
211
212 @display
213 HOST.
214 @end display
215
216 @cmd{HOST} suspends the current PSPP session and temporarily returns control 
217 to the operating system.
218 This command cannot be used if the SAFER setting is active.
219
220
221 @node INCLUDE
222 @section INCLUDE
223 @vindex INCLUDE
224
225 @display
226         INCLUDE [FILE=]'file-name'.
227 @end display
228
229 @cmd{INCLUDE} causes the PSPP command processor to read an
230 additional command file as if it were included bodily in the current
231 command file.
232 If errors are encountered in the included file, then command processing will 
233 stop and no more commands will be processed.
234 Include files may be nested to any depth, up to the limit of available
235 memory.
236
237
238 The @cmd{INSERT} command (@pxref{INSERT}) may be used instead of
239 @cmd{INCLUDE} if you require more flexible options.
240 The syntax 
241 @example
242 INCLUDE FILE=@var{file-name}.
243 @end example
244 @noindent 
245 functions identically to 
246 @example
247 INSERT FILE=@var{file-name} ERROR=STOP CD=NO SYNTAX=BATCH.
248 @end example
249
250
251 @node INSERT
252 @section INSERT
253 @vindex INSERT
254
255 @display
256      INSERT [FILE=]'file-name'
257         [CD=@{NO,YES@}]
258         [ERROR=@{CONTINUE,STOP@}]
259         [SYNTAX=@{BATCH,INTERACTIVE@}].
260 @end display
261
262 @cmd{INSERT} is similar to @cmd{INCLUDE} (@pxref{INCLUDE}) 
263 but somewhat more flexible.
264 It causes the command processor to read a file as if it were embedded in the 
265 current command file.
266
267 If @samp{CD=YES} is specified, then before including the file, the
268 current directory  will be changed to the directory of the included
269 file.  
270 The default setting is @samp{CD=NO}.
271 Note that this directory will remain current until it is
272 changed explicitly (with the @cmd{CD} command, or a subsequent
273 @cmd{INSERT} command with the @samp{CD=YES} option).
274 It will not revert to its original setting even after the included
275 file is finished processing.
276
277 If @samp{ERROR=STOP} is specified, errors encountered in the
278 inserted file will cause processing to immediately cease.
279 Otherwise processing will continue at the next command.
280 The default setting is @samp{ERROR=CONTINUE}.
281
282 If @samp{SYNTAX=INTERACTIVE} is specified then the syntax contained in
283 the included file must conform to interactive syntax
284 conventions. @xref{Syntax Variants}.
285 The default setting is @samp{SYNTAX=BATCH}.
286
287 @node PERMISSIONS
288 @section PERMISSIONS
289 @vindex PERMISSIONS
290 @cindex mode
291 @cindex file mode
292 @cindex changing file permissions
293
294 @display
295 PERMISSIONS
296         FILE='file-name'
297         /PERMISSIONS = @{READONLY,WRITEABLE@}.
298 @end display
299
300 @cmd{PERMISSIONS} changes the permissions of a file.  
301 There is one mandatory subcommand which specifies the permissions to
302 which the file should be changed.  
303 If you set a file's  permission  to READONLY, then the file will become
304 unwritable either by you or anyone else on the system.
305 If you set the permission to WRITEABLE, then the file will become
306 writeable by you; the permissions afforded to others will be
307 unchanged.
308 This command cannot be used if the SAFER setting is active.
309
310
311 @node SET
312 @section SET
313 @vindex SET
314
315 @display
316 SET
317
318 (data input)
319         /BLANKS=@{SYSMIS,'.',number@}
320         /DECIMAL=@{DOT,COMMA@}
321         /FORMAT=fmt_spec
322         /EPOCH=@{AUTOMATIC,year@}
323         /RIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
324         /RRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
325
326 (program input)
327         /ENDCMD='.'
328         /NULLINE=@{ON,OFF@}
329
330 (interaction)
331         /CPROMPT='cprompt_string'
332         /DPROMPT='dprompt_string'
333         /ERRORBREAK=@{OFF,ON@}
334         /MXERRS=max_errs
335         /MXWARNS=max_warnings
336         /PROMPT='prompt'
337
338 (program execution)
339         /MEXPAND=@{ON,OFF@}
340         /MITERATE=max_iterations
341         /MNEST=max_nest
342         /MPRINT=@{ON,OFF@}
343         /MXLOOPS=max_loops
344         /SEED=@{RANDOM,seed_value@}
345         /UNDEFINED=@{WARN,NOWARN@}
346
347 (data output)
348         /CC@{A,B,C,D,E@}=@{'npre,pre,suf,nsuf','npre.pre.suf.nsuf'@}
349         /DECIMAL=@{DOT,COMMA@}
350         /FORMAT=fmt_spec
351         /WIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
352         /WRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
353
354 (output routing)
355         /ECHO=@{ON,OFF@}
356         /ERRORS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
357         /INCLUDE=@{ON,OFF@}
358         /MESSAGES=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
359         /PRINTBACK=@{ON,OFF@}
360         /RESULTS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
361
362 (output driver options)
363         /HEADERS=@{NO,YES,BLANK@}
364         /LENGTH=@{NONE,length_in_lines@}
365         /LISTING=@{ON,OFF,'file-name'@}
366         /MORE=@{ON,OFF@}
367         /WIDTH=@{NARROW,WIDTH,n_characters@}
368
369 (logging)
370         /JOURNAL=@{ON,OFF@} ['file-name']
371
372 (system files)
373         /COMPRESSION=@{ON,OFF@}
374         /SCOMPRESSION=@{ON,OFF@}
375
376 (security)
377         /SAFER=ON
378
379 (obsolete settings accepted for compatibility, but ignored)
380         /BOXSTRING=@{'xxx','xxxxxxxxxxx'@}
381         /CASE=@{UPPER,UPLOW@}
382         /CPI=cpi_value
383         /DISK=@{ON,OFF@}
384         /HIGHRES=@{ON,OFF@}
385         /HISTOGRAM='c'
386         /LOWRES=@{AUTO,ON,OFF@}
387         /LPI=lpi_value
388         /MENUS=@{STANDARD,EXTENDED@}
389         /MXMEMORY=max_memory
390         /SCRIPTTAB='c'
391         /TB1=@{'xxx','xxxxxxxxxxx'@}
392         /TBFONTS='string'
393         /WORKSPACE=workspace_size
394         /XSORT=@{YES,NO@}
395 @end display
396
397 @cmd{SET} allows the user to adjust several parameters relating to
398 PSPP's execution.  Since there are many subcommands to this command, its
399 subcommands will be examined in groups.
400
401 On subcommands that take boolean values, ON and YES are synonym, and
402 as are OFF and NO, when used as subcommand values.
403
404 The data input subcommands affect the way that data is read from data
405 files.  The data input subcommands are
406
407 @table @asis
408 @item BLANKS
409 This is the value assigned to an item data item that is empty or
410 contains only white space.  An argument of SYSMIS or '.' will cause the
411 system-missing value to be assigned to null items.  This is the
412 default.  Any real value may be assigned.
413
414 @item DECIMAL
415 @anchor{SET DECIMAL}
416 The default DOT setting causes the decimal point character to be
417 @samp{.} and the grouping character to be @samp{,}.  A setting of COMMA
418 causes the decimal point character to be @samp{,} and the grouping
419 character to be @samp{.}.
420
421 @item FORMAT
422 Allows the default numeric input/output format to be specified.  The
423 default is F8.2.  @xref{Input and Output Formats}.
424
425 @item EPOCH
426 @anchor{SET EPOCH}
427 Specifies the range of years used when a 2-digit year is read from a
428 data file or used in a date construction expression (@pxref{Date
429 Construction}).  If a 4-digit year is specified for the epoch, then
430 2-digit years are interpreted starting from that year, known as the
431 epoch.  If AUTOMATIC (the default) is specified, then the epoch begins
432 69 years before the current date.
433
434 @item RIB
435 @anchor{SET RIB} 
436
437 PSPP extension to set the byte ordering (endianness) used for reading
438 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
439 Formats}).  In MSBFIRST ordering, the most-significant byte appears at
440 the left end of a IB or PIB field.  In LSBFIRST ordering, the
441 least-significant byte appears at the left end.  VAX ordering is like
442 MSBFIRST, except that each pair of bytes is in reverse order.  NATIVE,
443 the default, is equivalent to MSBFIRST or LSBFIRST depending on the
444 native format of the machine running PSPP.
445
446 @item RRB
447 @anchor{SET RRB}
448
449 PSPP extension to set the floating-point format used for reading data in
450 RB format (@pxref{Binary and Hexadecimal Numeric Formats}).  The
451 possibilities are:
452
453 @table @asis
454 @item NATIVE
455 The native format of the machine running PSPP.  Equivalent to either IDL
456 or IDB.
457
458 @item ISL
459 32-bit IEEE 754 single-precision floating point, in little-endian byte
460 order.
461
462 @item ISB
463 32-bit IEEE 754 single-precision floating point, in big-endian byte
464 order.
465
466 @item IDL
467 64-bit IEEE 754 double-precision floating point, in little-endian byte
468 order.
469
470 @item IDB
471 64-bit IEEE 754 double-precision floating point, in big-endian byte
472 order.
473
474 @item VF
475 32-bit VAX F format, in VAX-endian byte order.
476
477 @item VD
478 64-bit VAX D format, in VAX-endian byte order.
479
480 @item VG
481 64-bit VAX G format, in VAX-endian byte order.
482
483 @item ZS
484 32-bit IBM Z architecture short format hexadecimal floating point, in
485 big-endian byte order.  
486
487 @item ZL
488 64-bit IBM Z architecture long format hexadecimal floating point, in
489 big-endian byte order.
490
491 Z architecture also supports IEEE 754 floating point.  The ZS and ZL
492 formats are only for use with very old input files.
493 @end table
494 The default is NATIVE.
495 @end table
496
497 Program input subcommands affect the way that programs are parsed when
498 they are typed interactively or run from a command file.  They are
499
500 @table @asis
501 @item ENDCMD
502 This is a single character indicating the end of a command.  The default
503 is @samp{.}.  Don't change this.
504
505 @item NULLINE
506 Whether a blank line is interpreted as ending the current command.  The
507 default is ON.
508 @end table
509
510 Interaction subcommands affect the way that PSPP interacts with an
511 online user.  The interaction subcommands are
512
513 @table @asis
514 @item CPROMPT
515 The command continuation prompt.  The default is @samp{    > }.
516
517 @item DPROMPT
518 Prompt used when expecting data input within @cmd{BEGIN DATA} (@pxref{BEGIN
519 DATA}).  The default is @samp{data> }.
520
521 @item ERRORBREAK
522 Whether an error causes PSPP to stop processing the current command
523 file after finishing the current command.  The default is OFF.
524
525 @item MXERRS
526 The maximum number of errors before PSPP halts processing of the current
527 command file.  The default is 50.
528
529 @item MXWARNS
530 The maximum number of warnings + errors before PSPP halts processing the
531 current command file.  The default is 100.
532
533 @item PROMPT
534 The command prompt.  The default is @samp{PSPP> }.
535 @end table
536
537 Program execution subcommands control the way that PSPP commands
538 execute.  The program execution subcommands are
539
540 @table @asis
541 @item MEXPAND
542 @itemx MITERATE
543 @itemx MNEST
544 @itemx MPRINT
545 Currently not used.
546
547 @item MXLOOPS
548 The maximum number of iterations for an uncontrolled loop (@pxref{LOOP}).
549
550 @item SEED
551 The initial pseudo-random number seed.  Set to a real number or to
552 RANDOM, which will obtain an initial seed from the current time of day.
553
554 @item UNDEFINED
555 Currently not used.
556 @end table
557
558 Data output subcommands affect the format of output data.  These
559 subcommands are
560
561 @table @asis
562 @item CCA
563 @itemx CCB
564 @itemx CCC
565 @itemx CCD
566 @itemx CCE
567 @anchor{CCx Settings}
568
569 Set up custom currency formats.  @xref{Custom Currency Formats}, for
570 details.
571
572 @item DECIMAL
573 The default DOT setting causes the decimal point character to be
574 @samp{.}.  A setting of COMMA causes the decimal point character to be
575 @samp{,}.
576
577 @item FORMAT
578 Allows the default numeric input/output format to be specified.  The
579 default is F8.2.  @xref{Input and Output Formats}.
580
581 @item WIB
582 @anchor{SET WIB} 
583
584 PSPP extension to set the byte ordering (endianness) used for writing
585 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
586 Formats}).  In MSBFIRST ordering, the most-significant byte appears at
587 the left end of a IB or PIB field.  In LSBFIRST ordering, the
588 least-significant byte appears at the left end.  VAX ordering is like
589 MSBFIRST, except that each pair of bytes is in reverse order.  NATIVE,
590 the default, is equivalent to MSBFIRST or LSBFIRST depending on the
591 native format of the machine running PSPP.
592
593 @item WRB
594 @anchor{SET WRB}
595
596 PSPP extension to set the floating-point format used for writing data in
597 RB format (@pxref{Binary and Hexadecimal Numeric Formats}).  The choices
598 are the same as SET RIB.  The default is NATIVE.
599 @end table
600
601 Output routing subcommands affect where the output of transformations
602 and procedures is sent.  These subcommands are
603
604 @table @asis
605 @item ECHO
606
607 If turned on, commands are written to the listing file as they are read
608 from command files.  The default is OFF.
609
610 @itemx ERRORS
611 @itemx INCLUDE
612 @itemx MESSAGES
613 @item PRINTBACK
614 @item RESULTS
615 Currently not used.
616 @end table
617
618 Output driver option subcommands affect output drivers' settings.  These
619 subcommands are
620
621 @table @asis
622 @item HEADERS
623 @itemx LENGTH
624 @itemx LISTING
625 @itemx MORE
626 @itemx PAGER 
627 @itemx WIDTH
628 @end table
629
630 @cindex headers
631 @cindex length
632 @cindex listing
633 @cindex more
634 @cindex pager 
635 @cindex width
636
637
638 Logging subcommands affect logging of commands executed to external
639 files.  These subcommands are
640
641 @table @asis
642 @item JOURNAL
643 @itemx LOG
644 These subcommands, which are synonyms, control the journal.  The
645 default is ON, which causes commands entered interactively to be
646 written to the journal file.  Commands included from syntax files that
647 are included interactively and error messages printed by PSPP are also
648 written to the journal file, prefixed by @samp{>}.  OFF disables use
649 of the journal.
650
651 The journal is named @file{pspp.jnl} by default.  A different name may
652 be specified.
653 @end table
654
655 System file subcommands affect the default format of system files
656 produced by PSPP.  These subcommands are
657
658 @table @asis
659 @item COMPRESSION
660 Not currently used.
661
662 @item SCOMPRESSION
663 Whether system files created by @cmd{SAVE} or @cmd{XSAVE} are
664 compressed by default.  The default is ON.
665 @end table
666
667 Security subcommands affect the operations that commands are allowed to
668 perform.  The security subcommands are
669
670 @table @asis
671 @item SAFER
672 Setting this option disables the following operations:
673
674 @itemize @bullet
675 @item
676 The ERASE command.
677 @item
678 The HOST command.
679 @item
680 The PERMISSIONS command.
681 @item
682 Pipes (file names beginning or ending with @samp{|}).
683 @end itemize
684
685 Be aware that this setting does not guarantee safety (commands can still
686 overwrite files, for instance) but it is an improvement.
687 When set, this setting cannot be reset during the same session, for
688 obvious security reasons.
689 @end table
690
691 @node SHOW
692 @comment  node-name,  next,  previous,  up
693 @section SHOW
694 @vindex SHOW
695
696 @display
697 SHOW
698         [ALL]
699         [BLANKS]
700         [CC]
701         [CCA]
702         [CCB]
703         [CCC]
704         [CCD]
705         [CCE]
706         [COPYING]
707         [DECIMALS]
708         [ENDCMD]
709         [FORMAT]
710         [LENGTH]
711         [MXERRS]
712         [MXLOOPS]
713         [MXWARNS]
714         [SCOMPRESSION]
715         [UNDEFINED]
716         [WARRANTY]
717         [WEIGHT]
718         [WIDTH]
719 @end display
720
721 @cmd{SHOW} can be used to display the current state of PSPP's execution
722 parameters.  Parameters that can be changed using @cmd{SET}
723 (@pxref{SET}), can be examined using @cmd{SHOW} using the subcommand
724 with the same name.  @code{SHOW} supports the following additional
725 subcommands:
726
727 @table @code
728 @item ALL
729 Show all settings.
730 @item CC
731 Show all custom currency settings (CCA through CCE).
732 @item WARRANTY
733 Show details of the lack of warranty for PSPP.
734 @item COPYING
735 Display the terms of PSPP's copyright licence (@pxref{License}).
736 @end table
737
738 Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL.
739
740 @node SUBTITLE
741 @section SUBTITLE
742 @vindex SUBTITLE
743
744 @display
745 SUBTITLE 'subtitle_string'.
746   or
747 SUBTITLE subtitle_string.
748 @end display
749
750 @cmd{SUBTITLE} provides a subtitle to a particular PSPP
751 run.  This subtitle appears at the top of each output page below the
752 title, if headers are enabled on the output device.
753
754 Specify a subtitle as a string in quotes.  The alternate syntax that did
755 not require quotes is now obsolete.  If it is used then the subtitle is
756 converted to all uppercase.
757
758 @node TITLE
759 @section TITLE
760 @vindex TITLE
761
762 @display
763 TITLE 'title_string'.
764   or
765 TITLE title_string.
766 @end display
767
768 @cmd{TITLE} provides a title to a particular PSPP run.
769 This title appears at the top of each output page, if headers are enabled
770 on the output device.
771
772 Specify a title as a string in quotes.  The alternate syntax that did
773 not require quotes is now obsolete.  If it is used then the title is
774 converted to all uppercase.
775 @setfilename ignored