Checkin of new directory structure.
[pspp-builds.git] / doc / utilities.texi
index db7daa36093e016f73c5ac2309530650e536d15f..3c688292ebc23c6b84d7c774bc3432825acb0bb6 100644 (file)
@@ -14,13 +14,14 @@ 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.
+* ECHO::                        Write a string to the output stream.
 * ERASE::                       Erase a file.
 * EXECUTE::                     Execute pending transformations.
 * FILE LABEL::                  Set the active file's label.
 * FINISH::                      Terminate the PSPP session.
 * HOST::                        Temporarily return to the operating system.
 * INCLUDE::                     Include a file within the current one.
-* QUIT::                        Terminate the PSPP session.
+* PERMISSIONS::                 Change permissions on a file.
 * SET::                         Adjust PSPP runtime parameters.
 * SHOW::                        Display runtime parameters.
 * SUBTITLE::                    Provide a document subtitle.
@@ -87,7 +88,7 @@ DISPLAY 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
 
@@ -101,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.
 
+@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
@@ -153,8 +163,6 @@ FINISH.
 @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
@@ -169,7 +177,7 @@ to the operating system.
 This command cannot be used if the SAFER setting is active.
 
 
-@node INCLUDE, QUIT, HOST, Utilities
+@node INCLUDE, PERMISSIONS, HOST, Utilities
 @section INCLUDE
 @vindex INCLUDE
 @vindex @@
@@ -187,22 +195,32 @@ command file.
 Include files may be nested to any depth, up to the limit of available
 memory.
 
-@node QUIT, SET, INCLUDE, Utilities
-@section QUIT
-@vindex QUIT
+@node PERMISSIONS, SET, INCLUDE, Utilities
+@comment  node-name,  next,  previous,  up
+@section PERMISSIONS
+@vindex PERMISSIONS
+@cindex mode
+@cindex file mode
+@cindex changing file permissions
 
 @display
-Two possible syntaxes:
-        QUIT.
-        EXIT.
+PERMISSIONS
+        FILE='filename'
+        /PERMISSIONS = @{READONLY,WRITEABLE@}.
 @end display
 
-@cmd{QUIT} terminates the current PSPP session and returns control
-to the operating system.  
+@cmd{PERMISSIONS} changes the permissions of a file.  
+There is one mandatory subcommand which specifies the permissions to
+which the file should be changed.  
+If you set a file's  permission  to READONLY, then the file will become
+unwritable either by you or anyone else on the system.
+If you set the permission to WRITEABLE, then the file will become
+writeable by you; the permissions afforded to others will be
+unchanged.
+This command cannot be used if the SAFER setting is active.
 
-This command is not valid within a command file.
 
-@node SET, SHOW, QUIT, Utilities
+@node SET, SHOW, PERMISSIONS, Utilities
 @section SET
 @vindex SET
 
@@ -213,6 +231,7 @@ SET
         /BLANKS=@{SYSMIS,'.',number@}
         /DECIMAL=@{DOT,COMMA@}
         /FORMAT=fmt_spec
+        /EPOCH=@{AUTOMATIC,year@}
 
 (program input)
         /ENDCMD='.'
@@ -225,8 +244,6 @@ SET
         /MXERRS=max_errs
         /MXWARNS=max_warnings
         /PROMPT='prompt'
-        /VIEWLENGTH=@{MINIMUM,MEDIAN,MAXIMUM,n_lines@}
-        /VIEWWIDTH=n_characters
 
 (program execution)
         /MEXPAND=@{ON,OFF@}
@@ -250,22 +267,15 @@ SET
         /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@}
-        /LISTING=filename
+        /LISTING=@{ON,OFF,filename@}
         /MORE=@{ON,OFF@}
-        /PAGER=@{OFF,"pager_name"@}
         /WIDTH=@{NARROW,WIDTH,n_characters@}
 
 (logging)
         /JOURNAL=@{ON,OFF@} [filename]
-        /LOG=@{ON,OFF@} [filename]
 
 (system files)
         /COMPRESSION=@{ON,OFF@}
@@ -275,29 +285,19 @@ SET
         /SAFER=ON
 
 (obsolete settings accepted for compatibility, but ignored)
-        /AUTOMENU=@{ON,OFF@}
-        /BEEP=@{ON,OFF@}
-        /BLOCK='c'
         /BOXSTRING=@{'xxx','xxxxxxxxxxx'@}
         /CASE=@{UPPER,UPLOW@}
-        /COLOR=@dots{}
         /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
-        /PTRANSLATE=@{ON,OFF@}
-        /RCOLORS=@dots{}
-        /RUNREVIEW=@{AUTO,MANUAL@}
         /SCRIPTTAB='c'
         /TB1=@{'xxx','xxxxxxxxxxx'@}
         /TBFONTS='string'
-        /WORKDEV=drive_letter
         /WORKSPACE=workspace_size
         /XSORT=@{YES,NO@}
 @end display
@@ -315,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
-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.
 
@@ -327,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 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
-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
@@ -367,15 +376,6 @@ current command file.  The default is 100.
 
 @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
@@ -448,20 +448,6 @@ from command files.  The default is OFF.
 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
 
@@ -472,9 +458,16 @@ subcommands are
 @itemx MORE
 @itemx PAGER 
 @itemx WIDTH
-Currently not used.
 @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
 
@@ -501,8 +494,7 @@ perform.  The security subcommands are
 
 @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
@@ -510,11 +502,15 @@ The ERASE command.
 @item
 The HOST command.
 @item
+The PERMISSIONS command.
+@item
 Pipe filenames (filenames 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.
+When set, this setting cannot be reset during the same session, for
+obvious security reasons.
 @end table
 
 @node SHOW, SUBTITLE, SET, Utilities
@@ -524,24 +520,47 @@ overwrite files, for instance) but it is an improvement.
 
 @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
 
-@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
+@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
-Display the terms of PSPP's copyright licence @ref{License}.
+Display the terms of PSPP's copyright licence (@pxref{License}).
 @end table
 
-
+Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL.
 
 @node SUBTITLE, TITLE, SHOW, Utilities
 @section SUBTITLE