sack works
[pspp] / doc / invoking.texi
index 4800fc6997991f341ce52758dfc52f2440a3ff56..4f76012d91681671922d625bcb89b11d813d3368 100644 (file)
@@ -24,6 +24,7 @@ interface.
 * Main Options::
 * PDF PostScript SVG and PNG Output Options::
 * Plain Text Output Options::
+* SPV Output Options::
 * TeX Output Options::
 * HTML Output Options::
 * OpenDocument Output Options::
@@ -52,6 +53,7 @@ corresponding short options.
 -O format=@var{format}
 -O device=@{terminal|listing@}
 --no-output
+--table-look=@var{file}
 -e, --error-file=@var{error-file}
 @end example
 
@@ -125,6 +127,23 @@ 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 @option{--table-look=@var{file}}
+Reads a table style from @var{file} and applies it to all @pspp{}
+table output.  The file should be a TableLook @file{.stt} or
+@file{.tlo} file.  @pspp{} searches for @var{file} in the current
+directory, then in @file{.pspp/looks} in the user's home directory,
+then in a @file{looks} subdirectory inside @pspp{}'s data directory
+(usually @file{/usr/local/share/pspp}).  If @pspp{} cannot find
+@var{file} under the given name, it also tries adding a @file{.stt}
+extension.
+
+When this option is not specified, @pspp{} looks for
+@file{default.stt} using the algorithm above, and otherwise it falls
+back to a default built-in style.
+
+Using @code{SET TLOOK} in @pspp{} syntax overrides the style set on
+the command line (@pxref{SET}).
+
 @item @option{-e @var{error-file}}
 @itemx @option{--error-file=@var{error-file}}
 Configures a file to receive @pspp{} error, warning, and note messages in
@@ -215,13 +234,12 @@ by @command{make check} and similar scripts.
 To produce output in PDF, PostScript, SVG, or PNG format, specify
 @option{-o @var{file}} on the @pspp{} command line, optionally
 followed by any of the options shown in the table below to customize
-the output format.  These output formats are only available if your
-installation of @pspp{} was compiled with the Cairo library.
+the output format.
 
 PDF, PostScript, and SVG use real units: each dimension among the
 options listed below may have a suffix @samp{mm} for millimeters,
 @samp{in} for inches, or @samp{pt} for points.  Lacking a suffix,
-numbers below 50 are assumed to be in inches and those about 50 are
+numbers below 50 are assumed to be in inches and those above 50 are
 assumed to be in millimeters.
 
 PNG files are pixel-based, so dimensions in PNG output must ultimately
@@ -266,16 +284,18 @@ Either @code{portrait} or @code{landscape}.  Default: @code{portrait}.
 @itemx @option{-O top-margin=@var{dimension}}
 @itemx @option{-O bottom-margin=@var{dimension}}
 Sets the margins around the page.  See
-below for the allowed forms of @var{dimension} Default: @code{0.5in}.
+below for the allowed forms of @var{dimension}. Default: @code{0.5in}.
+
+@item @option{-O object-spacing=@var{dimension}}
+Sets the amount of vertical space between objects (such as headings or
+tables).
 
 @item @option{-O prop-font=@var{font-name}}
-@itemx @option{-O fixed-font=@var{font-name}}
-Sets the font used for proportional, or fixed-pitch text.  Most
-systems support CSS-like font names such as ``serif'' and
-``monospace'', but a wide range of system-specific font are likely to
-be supported as well.
+Sets the default font used for ordinary text.  Most systems support
+CSS-like font names such as ``Sans Serif'', but a wide range of
+system-specific fonts are likely to be supported as well.
 
-Default: proportional font @code{serif}, fixed-pitch font @code{monospace}.
+Default: proportional font @code{Sans Serif}.
 
 @item @option{-O font-size=@var{font-size}}
 Sets the size of the default fonts, in thousandths of a point.  Default:
@@ -286,6 +306,15 @@ This option makes PSPP trim empty space around each page of output,
 before adding the margins.  This can make the output easier to include
 in other documents.
 
+@item @option{-O outline=@var{boolean}}
+For PDF output only, this option controls whether PSPP includes an
+outline in the output file.  PDF viewers usually display the outline
+as a side bar that allows for easy navigation of the file.
+The default is true unless @option{-O trim=true} is also specified.
+(The Cairo graphics library that PSPP uses to produce PDF output has a
+bug that can cause a crash when outlines and trimming are used
+together.)
+
 @item @option{-O font-resolution=@var{dpi}}
 Sets the resolution for font rendering, in dots per inch.  For PDF,
 PostScript, and SVG output, the default is 72 dpi, so that a 10-point
@@ -318,9 +347,7 @@ chart is output, the @samp{#} is replaced by the chart number.  The
 default is the file name specified on @option{-o} with the extension
 stripped off and replaced by @file{-#.png}.
 
-Specify @code{none} to disable chart output.  Charts are always
-disabled if your installation of @pspp{} was compiled without the
-Cairo library.
+Specify @code{none} to disable chart output.
 
 @item @option{-O foreground-color=@var{color}}
 @itemx @option{-O background-color=@var{color}}
@@ -339,9 +366,9 @@ the WIDTH setting (@pxref{SET}), for output to a file.
 @item @option{-O box=@{ascii|unicode@}}
 Sets the characters used for lines in tables.
 If set to
-@code{ascii} the characters @samp{-}, @samp{|}, and @samp{+} for single-width
-lines and @samp{=} and @samp{#} for double-width lines are used.
-If set to @code{unicode} then  Unicode box drawing characters will be used.
+@code{ascii}, output uses use the characters @samp{-}, @samp{|}, and @samp{+} for single-width
+lines and @samp{=} and @samp{#} for double-width lines.
+If set to @code{unicode} then, output uses Unicode box drawing characters.
 The default is @code{unicode} if the locale's character encoding is "UTF-8"
 or @code{ascii} otherwise.
 
@@ -351,6 +378,30 @@ overstriking, which may not be supported by all the software to which
 you might pass the output.  Default: @code{none}.
 @end table
 
+@node SPV Output Options
+@section SPV Output Options
+
+SPSS 16 and later write @file{.spv} files to represent the contents of
+its output editor.  To produce output in @file{.spv} format, specify
+@option{-o @var{file}} on the @pspp{} command line, optionally
+followed by any of the options shown in the table below to customize
+the output format.
+
+@table @asis
+@item @option{-O format=spv}
+Specify the output format.  This is only necessary if the file name
+given on @option{-o} does not end in @file{.spv}.
+
+@item @option{-O paper-size=@var{paper-size}}
+@itemx @option{-O left-margin=@var{dimension}}
+@itemx @option{-O right-margin=@var{dimension}}
+@itemx @option{-O top-margin=@var{dimension}}
+@itemx @option{-O bottom-margin=@var{dimension}}
+@itemx @option{-O object-spacing=@var{dimension}}
+These have the same syntax and meaning as for PDF output.  @xref{PDF
+PostScript SVG and PNG Output Options}, for details.
+@end table
+
 @node TeX Output Options
 @section TeX Output Options
 @cindex @TeX{}