X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Futilities.texi;h=d825b9abc4a5e0e6a676ecd2c258bbb5f7d06e77;hb=38c2638eed90f33225870563c4be183097e4155a;hp=ba5a5e8b0912a18c317a1e80195b724f188434fc;hpb=fdcc4b6875ccdbf7bd01bc401e87afbeb71c2bfd;p=pspp-builds.git diff --git a/doc/utilities.texi b/doc/utilities.texi index ba5a5e8b..d825b9ab 100644 --- a/doc/utilities.texi +++ b/doc/utilities.texi @@ -23,6 +23,7 @@ encountered in the input. * FINISH:: Terminate the PSPP session. * HOST:: Temporarily return to the operating system. * INCLUDE:: Include a file within the current one. +* INSERT:: Insert a file within the current one. * PERMISSIONS:: Change permissions on a file. * SET:: Adjust PSPP runtime parameters. * SHOW:: Display runtime parameters. @@ -220,23 +221,70 @@ This command cannot be used if the SAFER setting is active. @node INCLUDE @section INCLUDE @vindex INCLUDE -@vindex @@ @display -Two possible syntaxes: - INCLUDE 'file-name'. - @@file-name. + INCLUDE [FILE=]'file-name'. @end display @cmd{INCLUDE} causes the PSPP command processor to read an additional command file as if it were included bodily in the current command file. - +If errors are encountered in the included file, then command processing will +stop and no more commands will be processed. Include files may be nested to any depth, up to the limit of available memory. + +The @cmd{INSERT} command (@pxref{INSERT}) may be used instead of +@cmd{INCLUDE} if you require more flexible options. +The syntax +@example +INCLUDE FILE=@var{file-name}. +@end example +@noindent +functions identically to +@example +INSERT FILE=@var{file-name} ERROR=STOP CD=NO SYNTAX=BATCH. +@end example + + +@node INSERT +@section INSERT +@vindex INSERT + +@display + INSERT [FILE=]'file-name' + [CD=@{NO,YES@}] + [ERROR=@{CONTINUE,STOP@}] + [SYNTAX=@{BATCH,INTERACTIVE@}]. +@end display + +@cmd{INSERT} is similar to @cmd{INCLUDE} (@pxref{INCLUDE}) +but somewhat more flexible. +It causes the command processor to read a file as if it were embedded in the +current command file. + +If @samp{CD=YES} is specified, then before including the file, the +current directory will be changed to the directory of the included +file. +The default setting is @samp{CD=NO}. +Note that this directory will remain current until it is +changed explicitly (with the @cmd{CD} command, or a subsequent +@cmd{INSERT} command with the @samp{CD=YES} option). +It will not revert to its original setting even after the included +file is finished processing. + +If @samp{ERROR=STOP} is specified, errors encountered in the +inserted file will cause processing to immediately cease. +Otherwise processing will continue at the next command. +The default setting is @samp{ERROR=CONTINUE}. + +If @samp{SYNTAX=INTERACTIVE} is specified then the syntax contained in +the included file must conform to interactive syntax +conventions. @xref{Syntax Variants}. +The default setting is @samp{SYNTAX=BATCH}. + @node PERMISSIONS -@comment node-name, next, previous, up @section PERMISSIONS @vindex PERMISSIONS @cindex mode @@ -286,6 +334,7 @@ SET /MXERRS=max_errs /MXWARNS=max_warnings /PROMPT='prompt' + /WORKSPACE=workspace_size (program execution) /MEXPAND=@{ON,OFF@} @@ -342,7 +391,6 @@ SET /SCRIPTTAB='c' /TB1=@{'xxx','xxxxxxxxxxx'@} /TBFONTS='string' - /WORKSPACE=workspace_size /XSORT=@{YES,NO@} @end display @@ -358,6 +406,7 @@ files. The data input subcommands are @table @asis @item BLANKS +@anchor{SET BLANKS} This is the value assigned to an item data item that is empty or contains only white space. An argument of SYSMIS or '.' will cause the system-missing value to be assigned to null items. This is the @@ -365,10 +414,13 @@ default. Any real value may be assigned. @item DECIMAL @anchor{SET DECIMAL} -The default DOT setting causes the decimal point character to be -@samp{.} and the grouping character to be @samp{,}. A setting of COMMA +This value may be set to DOT or COMMA. +Setting it to DOT causes the decimal point character to be +@samp{.} and the grouping character to be @samp{,}. +Setting it to COMMA causes the decimal point character to be @samp{,} and the grouping character to be @samp{.}. +The default value is determined from the system locale. @item FORMAT Allows the default numeric input/output format to be specified. The @@ -505,6 +557,17 @@ RANDOM, which will obtain an initial seed from the current time of day. @item UNDEFINED Currently not used. + +@item WORKSPACE +The maximum amount of memory that PSPP will use to store data being processed. +If memory in excess of the workspace size is required, then PSPP will start +to use temporary files to store the data. +Setting a higher value will, in general, mean procedures will run faster, +but may cause other applications to run slower. +On platforms without virtual memory management, setting a very large workspace +may cause PSPP to abort. +@cindex workspace +@cindex memory, amount used to store cases @end table Data output subcommands affect the format of output data. These