pspp-convert: Add --labels and --recode options.

[pspp] / doc / utilities.texi

diff --git a/doc/utilities.texi b/doc/utilities.texi
index f229f0ee7fb8df70538582d5094bb31272ffa142..bca15ea53dac8fe0702ff2fb4041241f825257d7 100644 (file)
--- a/doc/utilities.texi
+++ b/doc/utilities.texi
@@ -48,18 +48,18 @@ encountered in the input.
 @vindex  ADD DOCUMENT
 
 @display
 @vindex  ADD DOCUMENT
 
 @display

-ADD DOCUMENT 
+ADD DOCUMENT

     'line one' 'line two' @dots{} 'last line' .
 @end display
 
 
     'line one' 'line two' @dots{} 'last line' .
 @end display
 
 

-@cmd{ADD DOCUMENT} adds one or more lines of descriptive commentary to 
+@cmd{ADD DOCUMENT} adds one or more lines of descriptive commentary to

 the active dataset.  Documents added in this way are saved to system files.
 They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
 DOCUMENTS}.  They can be removed from the active dataset with @cmd{DROP
 DOCUMENTS}.
 
 the active dataset.  Documents added in this way are saved to system files.
 They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
 DOCUMENTS}.  They can be removed from the active dataset with @cmd{DROP
 DOCUMENTS}.
 

-Each line of documentary text must be enclosed in quotation marks, and 
+Each line of documentary text must be enclosed in quotation marks, and

 may not be more than 80 bytes long. @xref{DOCUMENT}.
 
 @node CACHE
 may not be more than 80 bytes long. @xref{DOCUMENT}.
 
 @node CACHE


@@ -80,7 +80,7 @@ This command is accepted, for compatibility, but it has no effect.
 
 @display
 CD 'new directory' .
 
 @display
 CD 'new directory' .

-@end display 
+@end display

 
 @cmd{CD} changes the current directory.  The new directory will become that specified by the command.
 
 
 @cmd{CD} changes the current directory.  The new directory will become that specified by the command.
 


@@ -89,14 +89,14 @@ CD 'new directory' .
 @vindex COMMENT
 @vindex *
 
 @vindex COMMENT
 @vindex *
 

-@display 
+@display

 Two possibles syntaxes:
         COMMENT comment text @dots{} .
         *comment text @dots{} .
 @end display
 
 @cmd{COMMENT} is ignored.  It is used to provide information to
 Two possibles syntaxes:
         COMMENT comment text @dots{} .
         *comment text @dots{} .
 @end display
 
 @cmd{COMMENT} is ignored.  It is used to provide information to

-the author and other readers of the @pspp{} syntax file.  
+the author and other readers of the @pspp{} syntax file.

 
 @cmd{COMMENT} can extend over any number of lines.  Don't forget to
 terminate it with a dot or a blank line.
 
 @cmd{COMMENT} can extend over any number of lines.  Don't forget to
 terminate it with a dot or a blank line.


@@ -117,12 +117,13 @@ They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
 DOCUMENTS}.  They can be removed from the active dataset with @cmd{DROP
 DOCUMENTS}.
 
 DOCUMENTS}.  They can be removed from the active dataset with @cmd{DROP
 DOCUMENTS}.
 

-Specify the @var{documentary text} following the @subcmd{DOCUMENT} keyword.  
-It is interpreted literally --- any quotes or other punctuation marks 
+Specify the @var{documentary text} following the @subcmd{DOCUMENT} keyword.
+It is interpreted literally---any quotes or other punctuation marks

 will be included in the file.
 will be included in the file.

-You can extend the documentary text over as many lines as necessary.  
+You can extend the documentary text over as many lines as necessary,
+including blank lines to separate paragraphs.

 Lines are truncated at 80 bytes.  Don't forget to terminate
 Lines are truncated at 80 bytes.  Don't forget to terminate

-the command with a dot or a blank line. @xref{ADD DOCUMENT}.
+the command with a dot at the end of a line. @xref{ADD DOCUMENT}.

 
 @node DISPLAY DOCUMENTS
 @section DISPLAY DOCUMENTS
 
 @node DISPLAY DOCUMENTS
 @section DISPLAY DOCUMENTS


@@ -168,7 +169,7 @@ system files stored on disk.
 @section ECHO
 @vindex ECHO
 
 @section ECHO
 @vindex ECHO
 

-@display 
+@display

 ECHO 'arbitrary text' .
 @end display
 
 ECHO 'arbitrary text' .
 @end display
 


@@ -182,7 +183,7 @@ Use @cmd{ECHO} to write arbitrary text to the output stream. The text should be
 ERASE FILE @var{file_name}.
 @end display
 
 ERASE FILE @var{file_name}.
 @end display
 

-@cmd{ERASE FILE} deletes a file from the local filesystem.
+@cmd{ERASE FILE} deletes a file from the local file system.

 @var{file_name} must be quoted.
 This command cannot be used if the SAFER (@pxref{SET}) setting is active.
 
 @var{file_name} must be quoted.
 This command cannot be used if the SAFER (@pxref{SET}) setting is active.
 


@@ -233,7 +234,7 @@ HOST.
 HOST COMMAND=['@var{command}'...].
 @end display
 
 HOST COMMAND=['@var{command}'...].
 @end display
 

-@cmd{HOST} suspends the current @pspp{} session and temporarily returns control 
+@cmd{HOST} suspends the current @pspp{} session and temporarily returns control

 to the operating system.
 This command cannot be used if the SAFER (@pxref{SET}) setting is active.
 
 to the operating system.
 This command cannot be used if the SAFER (@pxref{SET}) setting is active.
 


@@ -255,7 +256,7 @@ subshell.
 @cmd{INCLUDE} causes the @pspp{} command processor to read an
 additional command file as if it were included bodily in the current
 command file.
 @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 
+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.
 stop and no more commands will be processed.
 Include files may be nested to any depth, up to the limit of available
 memory.


@@ -278,14 +279,14 @@ The optional @subcmd{ENCODING} subcommand has the same meaning as with @cmd{INSE
         [ENCODING=@{LOCALE, '@var{charset_name}'@}].
 @end display
 
         [ENCODING=@{LOCALE, '@var{charset_name}'@}].
 @end display
 

-@cmd{INSERT} is similar to @cmd{INCLUDE} (@pxref{INCLUDE}) 
+@cmd{INSERT} is similar to @cmd{INCLUDE} (@pxref{INCLUDE})

 but somewhat more flexible.
 but somewhat more flexible.

-It causes the command processor to read a file as if it were embedded in the 
+It causes the command processor to read a file as if it were embedded in the

 current command file.
 
 If @subcmd{CD=YES} is specified, then before including the file, the
 current directory  will be changed to the directory of the included
 current command file.
 
 If @subcmd{CD=YES} is specified, then before including the file, the
 current directory  will be changed to the directory of the included

-file.  
+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
 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


@@ -309,7 +310,7 @@ the following forms:
 
 @table @asis
 @item @subcmd{LOCALE}
 
 @table @asis
 @item @subcmd{LOCALE}

-The encoding used by the system locale, or as overridden by the 
+The encoding used by the system locale, or as overridden by the

 @cmd{SET} command (@pxref{SET}).  On GNU/Linux and other Unix-like systems,
 environment variables, e.g.@: @env{LANG} or @env{LC_ALL}, determine the
 system locale.
 @cmd{SET} command (@pxref{SET}).  On GNU/Linux and other Unix-like systems,
 environment variables, e.g.@: @env{LANG} or @env{LC_ALL}, determine the
 system locale.


@@ -362,7 +363,7 @@ They must appear in the syntax to be interpreted.}
 @cmd{OUTPUT} changes the appearance of the tables in which results are printed.
 In particular, it can be used to set the format and precision to which results are displayed.
 
 @cmd{OUTPUT} changes the appearance of the tables in which results are printed.
 In particular, it can be used to set the format and precision to which results are displayed.
 

-After running this command, the default table appearance parameters will have been modified and  each 
+After running this command, the default table appearance parameters will have been modified and  each

 new output table generated will use the new parameters.
 
 Following @code{/TABLECELLS SELECT =} a list of cell classes must appear, enclosed in square
 new output table generated will use the new parameters.
 
 Following @code{/TABLECELLS SELECT =} a list of cell classes must appear, enclosed in square


@@ -407,9 +408,9 @@ PERMISSIONS
         /PERMISSIONS = @{READONLY,WRITEABLE@}.
 @end display
 
         /PERMISSIONS = @{READONLY,WRITEABLE@}.
 @end display
 

-@cmd{PERMISSIONS} changes the permissions of a file.  
+@cmd{PERMISSIONS} changes the permissions of a file.

 There is one mandatory subcommand which specifies the permissions to
 There is one mandatory subcommand which specifies the permissions to

-which the file should be changed.  
+which the file should be changed.

 If you set a file's  permission  to @subcmd{READONLY}, then the file will become
 unwritable either by you or anyone else on the system.
 If you set the permission to @subcmd{WRITEABLE}, then the file will become
 If you set a file's  permission  to @subcmd{READONLY}, then the file will become
 unwritable either by you or anyone else on the system.
 If you set the permission to @subcmd{WRITEABLE}, then the file will become


@@ -517,7 +518,7 @@ SET
 @pspp{}'s execution.  Since there are many subcommands to this command, its
 subcommands will be examined in groups.
 
 @pspp{}'s execution.  Since there are many subcommands to this command, its
 subcommands will be examined in groups.
 

-For subcommands that take boolean values, @subcmd{ON} and @subcmd{YES} are synonymous, 
+For subcommands that take boolean values, @subcmd{ON} and @subcmd{YES} are synonymous,

 as are @subcmd{OFF} and @subcmd{NO}, when used as subcommand values.
 
 The data input subcommands affect the way that data is read from data
 as are @subcmd{OFF} and @subcmd{NO}, when used as subcommand values.
 
 The data input subcommands affect the way that data is read from data


@@ -558,7 +559,7 @@ epoch.  If @subcmd{AUTOMATIC} (the default) is specified, then the epoch begins
 69 years before the current date.
 
 @item RIB
 69 years before the current date.
 
 @item RIB

-@anchor{SET RIB} 
+@anchor{SET RIB}

 
 @pspp{} extension to set the byte ordering (endianness) used for reading
 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
 
 @pspp{} extension to set the byte ordering (endianness) used for reading
 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric


@@ -608,7 +609,7 @@ order.
 
 @item ZS
 32-bit IBM Z architecture short format hexadecimal floating point, in
 
 @item ZS
 32-bit IBM Z architecture short format hexadecimal floating point, in

-big-endian byte order.  
+big-endian byte order.

 
 @item ZL
 64-bit IBM Z architecture long format hexadecimal floating point, in
 
 @item ZL
 64-bit IBM Z architecture long format hexadecimal floating point, in


@@ -630,7 +631,7 @@ command file.  The default is 50.
 
 @item MXWARNS
 The maximum number of warnings + errors before @pspp{} halts processing the
 
 @item MXWARNS
 The maximum number of warnings + errors before @pspp{} halts processing the

-current command file.  
+current command file.

 The special value of zero means that all warning situations should be ignored.
 No warnings will be issued, except a single initial warning advising the user
 that warnings will not be given.
 The special value of zero means that all warning situations should be ignored.
 No warnings will be issued, except a single initial warning advising the user
 that warnings will not be given.


@@ -679,7 +680,7 @@ Mathematics}).  The default @var{fuzzbits} is 6.
 The maximum amount of memory (in kilobytes) 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.
 The maximum amount of memory (in kilobytes) 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, 
+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.
 but may cause other applications to run slower.
 On platforms without virtual memory management, setting a very large workspace
 may cause @pspp{} to abort.


@@ -711,7 +712,7 @@ Allows the default numeric input/output format to be specified.  The
 default is F8.2.  @xref{Input and Output Formats}.
 
 @item WIB
 default is F8.2.  @xref{Input and Output Formats}.
 
 @item WIB

-@anchor{SET WIB} 
+@anchor{SET WIB}

 
 @pspp{} extension to set the byte ordering (endianness) used for writing
 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
 
 @pspp{} extension to set the byte ordering (endianness) used for writing
 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric


@@ -783,7 +784,7 @@ subcommands are
 @itemx TNUMBERS
 The @subcmd{TNUMBERS} option sets the way in which values are displayed in output tables.
 The valid settings are @subcmd{VALUES}, @subcmd{LABELS} and @subcmd{BOTH}.
 @itemx TNUMBERS
 The @subcmd{TNUMBERS} option sets the way in which values are displayed in output tables.
 The valid settings are @subcmd{VALUES}, @subcmd{LABELS} and @subcmd{BOTH}.

-If @subcmd{TNUMBERS} is set to @subcmd{VALUES}, then all values are displayed with their literal value 
+If @subcmd{TNUMBERS} is set to @subcmd{VALUES}, then all values are displayed with their literal value

 (which for a numeric value is a number and for a string value an alphanumeric string).
 If @subcmd{TNUMBERS} is set to @subcmd{LABELS}, then values are displayed using their assigned labels if any.
 (@xref{VALUE LABELS}.)
 (which for a numeric value is a number and for a string value an alphanumeric string).
 If @subcmd{TNUMBERS} is set to @subcmd{LABELS}, then values are displayed using their assigned labels if any.
 (@xref{VALUE LABELS}.)


@@ -803,7 +804,7 @@ If @subcmd{TVARS} is set to @subcmd{BOTH}, then variables will be displayed with
 
 @cindex headers
 @cindex length
 
 @cindex headers
 @cindex length

-@cindex pager 
+@cindex pager

 @cindex width
 @cindex tnumbers
 
 @cindex width
 @cindex tnumbers
 


@@ -867,7 +868,7 @@ This item is used to set the default character encoding.
 The encoding may be specified either as an encoding name or alias
 (see @url{http://www.iana.org/assignments/character-sets}), or
 as a locale name.
 The encoding may be specified either as an encoding name or alias
 (see @url{http://www.iana.org/assignments/character-sets}), or
 as a locale name.

-If given as a locale name, only the character encoding of the 
+If given as a locale name, only the character encoding of the

 locale is relevant.
 
 System files written by @pspp{} will use this encoding.
 locale is relevant.
 
 System files written by @pspp{} will use this encoding.


@@ -886,7 +887,7 @@ SET LOCALE='ru_RU.cp1251'.
 SET LOCALE='japanese'.
 @end example
 
 SET LOCALE='japanese'.
 @end example
 

-Contrary to intuition, this command does not affect any aspect 
+Contrary to intuition, this command does not affect any aspect

 of the system's locale.
 @end table
 
 of the system's locale.
 @end table