replaced busted sed substitution with functioning perl substitutions

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

diff --git a/doc/utilities.texi b/doc/utilities.texi
index db7daa36093e016f73c5ac2309530650e536d15f..ea1cfbb2c8c9c1ea7c213046d1e4b5fd134fb018 100644 (file)
--- a/doc/utilities.texi
+++ b/doc/utilities.texi
@@ -14,12 +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.
 * 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.
 * 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.

+* PERMISSIONS::                 Change permissions on a file.

 * QUIT::                        Terminate the PSPP session.
 * SET::                         Adjust PSPP runtime parameters.
 * SHOW::                        Display runtime parameters.
 * QUIT::                        Terminate the PSPP session.
 * SET::                         Adjust PSPP runtime parameters.
 * SHOW::                        Display runtime parameters.


@@ -87,7 +89,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
 


@@ -101,8 +103,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


@@ -169,7 +180,7 @@ to the operating system.
 This command cannot be used if the SAFER setting is active.
 
 
 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 @@
 @section INCLUDE
 @vindex INCLUDE
 @vindex @@


@@ -187,7 +198,32 @@ 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 QUIT, SET, INCLUDE, Utilities
+@node PERMISSIONS, QUIT, INCLUDE, Utilities
+@comment  node-name,  next,  previous,  up
+@section PERMISSIONS
+@vindex PERMISSIONS
+@cindex mode
+@cindex file mode
+@cindex changing file permissions
+
+@display
+PERMISSIONS
+        FILE='filename'
+        /PERMISSIONS = @{READONLY,WRITEABLE@}.
+@end display
+
+@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.
+
+
+@node QUIT, SET, PERMISSIONS, Utilities

 @section QUIT
 @vindex QUIT
 
 @section QUIT
 @vindex QUIT
 


@@ -213,6 +249,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='.'


@@ -315,7 +352,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.
 


@@ -327,6 +364,15 @@ 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


@@ -472,9 +518,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
 


@@ -501,8 +554,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


@@ -510,11 +562,15 @@ The ERASE command.
 @item
 The HOST command.
 @item
 @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.
 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
 @end table
 
 @node SHOW, SUBTITLE, SET, Utilities