lexer: Reimplement for better testability and internationalization.
[pspp-builds.git] / doc / invoking.texi
index 830d176463baccdb4f8de9261b162bc30954907b..4c4f74aa5392c6692457fc1ab2be6b0cd3515599 100644 (file)
@@ -41,6 +41,7 @@ corresponding short options.
 -O @var{option}=@var{value}
 -O format=@var{format}
 -O device=@{terminal|listing@}
+--no-output
 -e, --error-file=@var{error-file}
 @end example
 
@@ -48,10 +49,12 @@ corresponding short options.
 @example
 -I, --include=@var{dir}
 -I-, --no-include
+-b, --batch
 -i, --interactive
 -r, --no-statrc
 -a, --algorithm=@{compatible|enhanced@}
 -x, --syntax=@{compatible|enhanced@}
+--syntax-encoding=@var{encoding}
 @end example
 
 @item Informational options
@@ -106,6 +109,11 @@ SET command's output routing subcommands (@pxref{SET}).  By default,
 output written to standard output is considered a terminal device and
 other output is considered a listing device.
 
+@item --no-output
+Disables output entirely, if neither @option{-o} nor @option{-O} is
+also used.  If one of those options is used, @option{--no-output} has
+no effect.
+
 @item -e @var{error-file}
 @itemx --error-file=@var{error-file}
 Configures a file to receive PSPP error, warning, and note messages in
@@ -129,11 +137,13 @@ inserted in the include path by default.  The default include path is
 user's home directory, followed by PSPP's system configuration
 directory (usually @file{/etc/pspp} or @file{/usr/local/etc/pspp}).
 
+@item -b
+@item --batch
 @item -i
 @itemx --interactive
-This option forces syntax files to be interpreted in interactive
-mode, rather than the default batch mode.  @xref{Syntax Variants}, for
-a description of the differences.
+These options forces syntax files to be interpreted in batch mode or
+interactive mode, respectively, rather than the default ``auto'' mode.
+@xref{Syntax Variants}, for a description of the differences.
 
 @item -r
 @itemx --no-statrc
@@ -155,8 +165,14 @@ With @code{enhanced}, the default, PSPP accepts its own extensions
 beyond those compatible with the proprietary program SPSS.  With
 @code{compatible}, PSPP rejects syntax that uses these extensions.
 
-@item -?
-@itemx --help
+@item --syntax-encoding=@var{encoding}
+Specifies @var{encoding} as the encoding for syntax files named on the
+command line.  The @var{encoding} also becomes the default encoding
+for other syntax files read during the PSPP session by the
+@cmd{INCLUDE} and @cmd{INSERT} commands.  @xref{INSERT}, for the
+accepted forms of @var{encoding}.
+
+@item --help
 Prints a message describing PSPP command-line syntax and the available
 device formats, then exits.
 
@@ -208,17 +224,11 @@ assumed.
 @item -O orientation=@var{orientation}
 Either @code{portrait} or @code{landscape}.  Default: @code{portrait}.
 
-@item -O headers=@var{boolean}
-When enabled, headers showing the time and date, title and subtitle,
-and page number are printed at the top of each page.  Default:
-@code{on}.
-
 @item -O left-margin=@var{dimension}
 @itemx -O right-margin=@var{dimension}
 @itemx -O top-margin=@var{dimension}
 @itemx -O bottom-margin=@var{dimension}
-Sets the margins around the page.  The headers, if enabled, are not
-included in the margins; they are in addition to the margins.  See
+Sets the margins around the page.  See
 below for the allowed forms of @var{dimension} Default: @code{0.5in}.
 
 @item -O prop-font=@var{font-name}
@@ -379,8 +389,19 @@ Specify the output format.  This is only necessary if the file name
 given on @option{-o} does not end in @file{.csv}.
 
 @item -O separator=@var{field-separator}
-Sets the character used to separate fields.  The default is a comma
+Sets the character used to separate fields.  Default: a comma
 (@samp{,}).
+
+@item -O quote=@var{qualifier}
+Sets @var{qualifier} as the character used to quote fields that
+contain white space, the separator (or any of the characters in the
+separator, if it contains more than one character), or the quote
+character itself.  If @var{qualifier} is longer than one character,
+only the first character is used; if @var{qualifier} is the empty
+string, then fields are never quoted.
+
+@item -O captions=@var{boolean}
+Whether table captions should be printed.  Default: @code{on}.
 @end table
 
 The CSV format used is an extension to that specified in RFC 4180:
@@ -390,8 +411,9 @@ The CSV format used is an extension to that specified in RFC 4180:
 Each table row is output on a separate line, and each column is output
 as a field.  The contents of a cell that spans multiple rows or
 columns is output only for the top-left row and column; the rest are
-output as empty fields.  When a table has a caption, it is output just
-above the table as a single field prefixed by @samp{Table:}.
+output as empty fields.  When a table has a caption and captions are
+enabled, the caption is output just above the table as a single field
+prefixed by @samp{Table:}.
 
 @item Text
 Text in output is printed as a field on a line by itself.  The TITLE