renamed pspp_linreg_coeff to pspp_coeff

[pspp-builds.git] / doc / utilities.texi

diff --git a/doc/utilities.texi b/doc/utilities.texi
index c63009907e81d6eca16a5e679e6ef9ccdc6725e2..54ae7b3b9e5e2e9be189b171c8e4eaac5a63d88a 100644 (file)
--- a/doc/utilities.texi
+++ b/doc/utilities.texi
@@ -14,6 +14,7 @@ encountered in the input.
 * DISPLAY DOCUMENTS::           Display active file documents.
 * DISPLAY FILE LABEL::          Display the active file label.
 * DROP DOCUMENTS::              Remove documents from the active file.
 * DISPLAY DOCUMENTS::           Display active file documents.
 * DISPLAY FILE LABEL::          Display the active file label.
 * DROP DOCUMENTS::              Remove documents from the active file.

+* ECHO::                        Write a string to the output stream.

 * ERASE::                       Erase a file.
 * EXECUTE::                     Execute pending transformations.
 * FILE LABEL::                  Set the active file's label.
 * ERASE::                       Erase a file.
 * EXECUTE::                     Execute pending transformations.
 * FILE LABEL::                  Set the active file's label.


@@ -21,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.


@@ -88,7 +88,7 @@ DISPLAY FILE LABEL.
 active file,
 if any.  @xref{FILE LABEL}.
 
 active file,
 if any.  @xref{FILE LABEL}.
 

-@node DROP DOCUMENTS, ERASE, DISPLAY FILE LABEL, Utilities
+@node DROP DOCUMENTS, ECHO, DISPLAY FILE LABEL, Utilities

 @section DROP DOCUMENTS
 @vindex DROP DOCUMENTS
 
 @section DROP DOCUMENTS
 @vindex DROP DOCUMENTS
 


@@ -102,8 +102,17 @@ New documents can be added with @cmd{DOCUMENT} (@pxref{DOCUMENT}).
 @cmd{DROP DOCUMENTS} changes only the active file.  It does not modify any
 system files stored on disk.
 
 @cmd{DROP DOCUMENTS} changes only the active file.  It does not modify any
 system files stored on disk.
 

+@node ECHO, ERASE, DROP DOCUMENTS, Utilities
+@section ECHO
+@vindex ECHO

 
 

-@node ERASE, EXECUTE, DROP DOCUMENTS, Utilities
+@display 
+ECHO 'arbitrary text' .
+@end display
+
+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}).
+
+@node ERASE, EXECUTE, ECHO, Utilities

 @comment  node-name,  next,  previous,  up
 @section ERASE
 @vindex ERASE
 @comment  node-name,  next,  previous,  up
 @section ERASE
 @vindex ERASE


@@ -154,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


@@ -177,8 +184,8 @@ This command cannot be used if the SAFER setting is active.
 
 @display
 Two possible syntaxes:
 
 @display
 Two possible syntaxes:

-        INCLUDE 'filename'.
-        @@filename.
+        INCLUDE 'file-name'.
+        @@file-name.

 @end display
 
 @cmd{INCLUDE} causes the PSPP command processor to read an
 @end display
 
 @cmd{INCLUDE} causes the PSPP command processor to read an


@@ -188,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


@@ -198,7 +205,7 @@ memory.
 
 @display
 PERMISSIONS
 
 @display
 PERMISSIONS

-        FILE='filename'
+        FILE='file-name'

         /PERMISSIONS = @{READONLY,WRITEABLE@}.
 @end display
 
         /PERMISSIONS = @{READONLY,WRITEABLE@}.
 @end display
 


@@ -213,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
 


@@ -239,6 +231,7 @@ SET
         /BLANKS=@{SYSMIS,'.',number@}
         /DECIMAL=@{DOT,COMMA@}
         /FORMAT=fmt_spec
         /BLANKS=@{SYSMIS,'.',number@}
         /DECIMAL=@{DOT,COMMA@}
         /FORMAT=fmt_spec

+        /EPOCH=@{AUTOMATIC,year@}

 
 (program input)
         /ENDCMD='.'
 
 (program input)
         /ENDCMD='.'


@@ -251,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@}


@@ -276,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,'file-name'@}

         /MORE=@{ON,OFF@}
         /MORE=@{ON,OFF@}

-        /PAGER=@{OFF,"pager_name"@}

         /WIDTH=@{NARROW,WIDTH,n_characters@}
 
 (logging)
         /WIDTH=@{NARROW,WIDTH,n_characters@}
 
 (logging)

-        /JOURNAL=@{ON,OFF@} [filename]
-        /LOG=@{ON,OFF@} [filename]
+        /JOURNAL=@{ON,OFF@} ['file-name']

 
 (system files)
         /COMPRESSION=@{ON,OFF@}
 
 (system files)
         /COMPRESSION=@{ON,OFF@}


@@ -301,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


@@ -341,7 +315,7 @@ files.  The data input subcommands are
 @table @asis
 @item BLANKS
 This is the value assigned to an item data item that is empty or
 @table @asis
 @item BLANKS
 This is the value assigned to an item data item that is empty or

-contains only whitespace.  An argument of SYSMIS or '.' will cause the
+contains only white space.  An argument of SYSMIS or '.' will cause the

 system-missing value to be assigned to null items.  This is the
 default.  Any real value may be assigned.
 
 system-missing value to be assigned to null items.  This is the
 default.  Any real value may be assigned.
 


@@ -353,10 +327,19 @@ The default DOT setting causes the decimal point character to be
 @item FORMAT
 Allows the default numeric input/output format to be specified.  The
 default is F8.2.  @xref{Input/Output Formats}.
 @item FORMAT
 Allows the default numeric input/output format to be specified.  The
 default is F8.2.  @xref{Input/Output Formats}.

+
+@item EPOCH
+@anchor{SET EPOCH}
+Specifies the range of years used when a 2-digit year is read from a
+data file or used in a date construction expression (@pxref{Date
+Construction}).  If a 4-digit year is specified, then 2-digit years
+are interpreted starting from that year, known as the epoch.  If
+AUTOMATIC (the default) is specified, then the epoch begins 69 years
+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


@@ -393,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


@@ -474,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
 


@@ -498,9 +458,16 @@ subcommands are
 @itemx MORE
 @itemx PAGER 
 @itemx WIDTH
 @itemx MORE
 @itemx PAGER 
 @itemx WIDTH

-Currently not used.

 @end table
 
 @end table
 

+@cindex headers
+@cindex length
+@cindex listing
+@cindex more
+@cindex pager 
+@cindex width
+
+

 Logging subcommands affect logging of commands executed to external
 files.  These subcommands are
 
 Logging subcommands affect logging of commands executed to external
 files.  These subcommands are
 


@@ -527,8 +494,7 @@ perform.  The security subcommands are
 
 @table @asis
 @item SAFER
 
 @table @asis
 @item SAFER

-When set, this setting cannot ever be reset, for obvious security
-reasons.  Setting this option disables the following operations:
+Setting this option disables the following operations:

 
 @itemize @bullet
 @item
 
 @itemize @bullet
 @item


@@ -538,11 +504,13 @@ The HOST command.
 @item
 The PERMISSIONS command.
 @item
 @item
 The PERMISSIONS command.
 @item

-Pipe filenames (filenames beginning or ending with @samp{|}).
+Pipes (file names beginning or ending with @samp{|}).

 @end itemize
 
 Be aware that this setting does not guarantee safety (commands can still
 overwrite files, for instance) but it is an improvement.
 @end itemize
 
 Be aware that this setting does not guarantee safety (commands can still
 overwrite files, for instance) but it is an improvement.

+When set, this setting cannot be reset during the same session, for
+obvious security reasons.

 @end table
 
 @node SHOW, SUBTITLE, SET, Utilities
 @end table
 
 @node SHOW, SUBTITLE, SET, Utilities


@@ -552,24 +520,47 @@ overwrite files, for instance) but it is an improvement.
 
 @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