Fixed reading of system files with non-ascii characters in variable names.
[pspp] / doc / utilities.texi
index ea1cfbb2c8c9c1ea7c213046d1e4b5fd134fb018..3c688292ebc23c6b84d7c774bc3432825acb0bb6 100644 (file)
@@ -22,7 +22,6 @@ encountered in the input.
 * HOST::                        Temporarily return to the operating system.
 * INCLUDE::                     Include a file within the current one.
 * PERMISSIONS::                 Change permissions on a file.
 * HOST::                        Temporarily return to the operating system.
 * INCLUDE::                     Include a file within the current one.
 * PERMISSIONS::                 Change permissions on a file.
-* QUIT::                        Terminate the PSPP session.
 * SET::                         Adjust PSPP runtime parameters.
 * SHOW::                        Display runtime parameters.
 * SUBTITLE::                    Provide a document subtitle.
 * SET::                         Adjust PSPP runtime parameters.
 * SHOW::                        Display runtime parameters.
 * SUBTITLE::                    Provide a document subtitle.
@@ -164,8 +163,6 @@ FINISH.
 @cmd{FINISH} terminates the current PSPP session and returns
 control to the operating system.
 
 @cmd{FINISH} terminates the current PSPP session and returns
 control to the operating system.
 
-This command is not valid in interactive mode.
-
 @node HOST, INCLUDE, FINISH, Utilities
 @comment  node-name,  next,  previous,  up
 @section HOST
 @node HOST, INCLUDE, FINISH, Utilities
 @comment  node-name,  next,  previous,  up
 @section HOST
@@ -198,7 +195,7 @@ command file.
 Include files may be nested to any depth, up to the limit of available
 memory.
 
 Include files may be nested to any depth, up to the limit of available
 memory.
 
-@node PERMISSIONS, QUIT, INCLUDE, Utilities
+@node PERMISSIONS, SET, INCLUDE, Utilities
 @comment  node-name,  next,  previous,  up
 @section PERMISSIONS
 @vindex PERMISSIONS
 @comment  node-name,  next,  previous,  up
 @section PERMISSIONS
 @vindex PERMISSIONS
@@ -223,22 +220,7 @@ unchanged.
 This command cannot be used if the SAFER setting is active.
 
 
 This command cannot be used if the SAFER setting is active.
 
 
-@node QUIT, SET, PERMISSIONS, Utilities
-@section QUIT
-@vindex QUIT
-
-@display
-Two possible syntaxes:
-        QUIT.
-        EXIT.
-@end display
-
-@cmd{QUIT} terminates the current PSPP session and returns control
-to the operating system.  
-
-This command is not valid within a command file.
-
-@node SET, SHOW, QUIT, Utilities
+@node SET, SHOW, PERMISSIONS, Utilities
 @section SET
 @vindex SET
 
 @section SET
 @vindex SET
 
@@ -262,8 +244,6 @@ SET
         /MXERRS=max_errs
         /MXWARNS=max_warnings
         /PROMPT='prompt'
         /MXERRS=max_errs
         /MXWARNS=max_warnings
         /PROMPT='prompt'
-        /VIEWLENGTH=@{MINIMUM,MEDIAN,MAXIMUM,n_lines@}
-        /VIEWWIDTH=n_characters
 
 (program execution)
         /MEXPAND=@{ON,OFF@}
 
 (program execution)
         /MEXPAND=@{ON,OFF@}
@@ -287,22 +267,15 @@ SET
         /PRINTBACK=@{ON,OFF@}
         /RESULTS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
 
         /PRINTBACK=@{ON,OFF@}
         /RESULTS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
 
-(output activation)
-        /LISTING=@{ON,OFF@}
-        /PRINTER=@{ON,OFF@}
-        /SCREEN=@{ON,OFF@}
-
 (output driver options)
         /HEADERS=@{NO,YES,BLANK@}
         /LENGTH=@{NONE,length_in_lines@}
 (output driver options)
         /HEADERS=@{NO,YES,BLANK@}
         /LENGTH=@{NONE,length_in_lines@}
-        /LISTING=filename
+        /LISTING=@{ON,OFF,filename@}
         /MORE=@{ON,OFF@}
         /MORE=@{ON,OFF@}
-        /PAGER=@{OFF,"pager_name"@}
         /WIDTH=@{NARROW,WIDTH,n_characters@}
 
 (logging)
         /JOURNAL=@{ON,OFF@} [filename]
         /WIDTH=@{NARROW,WIDTH,n_characters@}
 
 (logging)
         /JOURNAL=@{ON,OFF@} [filename]
-        /LOG=@{ON,OFF@} [filename]
 
 (system files)
         /COMPRESSION=@{ON,OFF@}
 
 (system files)
         /COMPRESSION=@{ON,OFF@}
@@ -312,29 +285,19 @@ SET
         /SAFER=ON
 
 (obsolete settings accepted for compatibility, but ignored)
         /SAFER=ON
 
 (obsolete settings accepted for compatibility, but ignored)
-        /AUTOMENU=@{ON,OFF@}
-        /BEEP=@{ON,OFF@}
-        /BLOCK='c'
         /BOXSTRING=@{'xxx','xxxxxxxxxxx'@}
         /CASE=@{UPPER,UPLOW@}
         /BOXSTRING=@{'xxx','xxxxxxxxxxx'@}
         /CASE=@{UPPER,UPLOW@}
-        /COLOR=@dots{}
         /CPI=cpi_value
         /DISK=@{ON,OFF@}
         /CPI=cpi_value
         /DISK=@{ON,OFF@}
-        /EJECT=@{ON,OFF@}
-        /HELPWINDOWS=@{ON,OFF@}
         /HIGHRES=@{ON,OFF@}
         /HISTOGRAM='c'
         /LOWRES=@{AUTO,ON,OFF@}
         /LPI=lpi_value
         /MENUS=@{STANDARD,EXTENDED@}
         /MXMEMORY=max_memory
         /HIGHRES=@{ON,OFF@}
         /HISTOGRAM='c'
         /LOWRES=@{AUTO,ON,OFF@}
         /LPI=lpi_value
         /MENUS=@{STANDARD,EXTENDED@}
         /MXMEMORY=max_memory
-        /PTRANSLATE=@{ON,OFF@}
-        /RCOLORS=@dots{}
-        /RUNREVIEW=@{AUTO,MANUAL@}
         /SCRIPTTAB='c'
         /TB1=@{'xxx','xxxxxxxxxxx'@}
         /TBFONTS='string'
         /SCRIPTTAB='c'
         /TB1=@{'xxx','xxxxxxxxxxx'@}
         /TBFONTS='string'
-        /WORKDEV=drive_letter
         /WORKSPACE=workspace_size
         /XSORT=@{YES,NO@}
 @end display
         /WORKSPACE=workspace_size
         /XSORT=@{YES,NO@}
 @end display
@@ -376,7 +339,7 @@ before the current date.
 @end table
 
 Program input subcommands affect the way that programs are parsed when
 @end table
 
 Program input subcommands affect the way that programs are parsed when
-they are typed interactively or run from a script.  They are
+they are typed interactively or run from a command file.  They are
 
 @table @asis
 @item ENDCMD
 
 @table @asis
 @item ENDCMD
@@ -413,15 +376,6 @@ current command file.  The default is 100.
 
 @item PROMPT
 The command prompt.  The default is @samp{PSPP> }.
 
 @item PROMPT
 The command prompt.  The default is @samp{PSPP> }.
-
-@item VIEWLENGTH
-The length of the screen in lines.  MINIMUM means 25 lines, MEDIAN and
-MAXIMUM mean 43 lines.  Otherwise specify the number of lines.  Normally
-PSPP should auto-detect your screen size so this shouldn't have to be
-used.
-
-@item VIEWWIDTH
-The width of the screen in characters.  Normally 80 or 132.
 @end table
 
 Program execution subcommands control the way that PSPP commands
 @end table
 
 Program execution subcommands control the way that PSPP commands
@@ -494,20 +448,6 @@ from command files.  The default is OFF.
 Currently not used.
 @end table
 
 Currently not used.
 @end table
 
-Output activation subcommands affect whether output devices of
-particular types are enabled.  These subcommands are
-
-@table @asis
-@item LISTING
-Enable or disable listing devices.
-
-@item PRINTER
-Enable or disable printer devices.
-
-@item SCREEN
-Enable or disable screen devices.
-@end table
-
 Output driver option subcommands affect output drivers' settings.  These
 subcommands are
 
 Output driver option subcommands affect output drivers' settings.  These
 subcommands are
 
@@ -580,24 +520,47 @@ obvious security reasons.
 
 @display
 SHOW
 
 @display
 SHOW
-        /@var{subcommand}
-        
+        [ALL]
+        [BLANKS]
+        [CC]
+        [CCA]
+        [CCB]
+        [CCC]
+        [CCD]
+        [CCE]
+        [COPYING]
+        [DECIMALS]
+        [ENDCMD]
+        [FORMAT]
+        [LENGTH]
+        [MXERRS]
+        [MXLOOPS]
+        [MXWARNS]
+        [SCOMPRESSION]
+        [UNDEFINED]
+        [WARRANTY]
+        [WEIGHT]
+        [WIDTH]
 @end display
 
 @end display
 
-@cmd{SHOW} can be used to display the current state of PSPP's
-execution parameters.  All of the parameters which can be changed 
-using  @code{SET} @xref{SET}, can be examined using @cmd{SHOW}, by
-using a subcommand with the same name.
-In addition, @code{SHOW} supports the following subcommands:
+@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
+subcommands:
 
 @table @code
 
 @table @code
+@item ALL
+Show all settings.
+@item CC
+Show all custom currency settings (CCA through CCE).
 @item WARRANTY
 Show details of the lack of warranty for PSPP.
 @item COPYING
 @item WARRANTY
 Show details of the lack of warranty for PSPP.
 @item COPYING
-Display the terms of PSPP's copyright licence @ref{License}.
+Display the terms of PSPP's copyright licence (@pxref{License}).
 @end table
 
 @end table
 
-
+Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL.
 
 @node SUBTITLE, TITLE, SHOW, Utilities
 @section SUBTITLE
 
 @node SUBTITLE, TITLE, SHOW, Utilities
 @section SUBTITLE