User manual: filename -> file name
[pspp] / doc / invoking.texi
index b1a299720f246a519d98676e048811f3d884916f..fbc7009e5cdd96c15de6f7b4f9b38eb150e9b460 100644 (file)
@@ -24,6 +24,7 @@ interface.
 * Main Options::
 * PDF PostScript and SVG Output Options::
 * Plain Text Output Options::
+* TeX Output Options::
 * HTML Output Options::
 * OpenDocument Output Options::
 * Comma-Separated Value Output Options::
@@ -97,7 +98,7 @@ Use @samp{-} as @var{output-file} to write output to standard output.
 
 If no @option{-o} option is used, then @pspp{} writes text and CSV
 output to standard output and other kinds of output to whose name is
-based on the format, e.g.@: @file{pspp.pdf} for PDF output.
+based on the format, @i{e.g.}@: @file{pspp.pdf} for PDF output.
 
 @item @option{-O @var{option}=@var{value}}
 Sets an option for the output file configured by a preceding
@@ -107,7 +108,7 @@ A few options that apply generically are listed below.
 @item @option{-O format=@var{format}}
 @pspp{} uses the extension of the file name given on @option{-o} to
 select an output format.  Use this option to override this choice by
-specifying an alternate format, e.g.@: @option{-o pspp.out -O format=html} to
+specifying an alternate format, @i{e.g.}@: @option{-o pspp.out -O format=html} to
 write HTML to a file named @file{pspp.out}.  Use @option{--help} to
 list the available formats.
 
@@ -225,8 +226,8 @@ given on @option{-o} does not end in @file{.pdf}, @file{.ps}, or
 @file{.svg}.
 
 @item @option{-O paper-size=@var{paper-size}}
-Paper size, as a name (e.g.@: @code{a4}, @code{letter}) or
-measurements (e.g.@: @code{210x297}, @code{8.5x11in}).
+Paper size, as a name (@i{e.g.}@: @code{a4}, @code{letter}) or
+measurements (@i{e.g.}@: @code{210x297}, @code{8.5x11in}).
 
 The default paper size is taken from the @env{PAPERSIZE} environment
 variable or the file indicated by the @env{PAPERCONF} environment
@@ -342,6 +343,21 @@ overstriking, which may not be supported by all the software to which
 you might pass the output.  Default: @code{none}.
 @end table
 
+@node TeX Output Options
+@section TeX Output Options
+@cindex @TeX{}
+@cindex tex
+
+If you want to publish statistical results in professional or academic
+journals, you will probably want to provide results in @TeX{} format.
+To do this, specify @option{-o @var{file}} on the @pspp{} command line where
+@var{file} is a file name ending in @file{.tex}, or you can specify
+@option{-O format=tex}.
+
+The resulting file can be directly processed using @TeX{} or you can manually
+edit the file to add commentary text.
+Alternatively, you can cut and paste desired sections to another @TeX{} file.
+
 @node HTML Output Options
 @section HTML Output Options
 @cindex HTML
@@ -362,6 +378,11 @@ for details.
 Decorate the tables with borders.  If set to false, the tables produced
 will have no borders.  The default value is true.
 
+@item @option{-O bare=@var{boolean}}
+The HTML output driver ordinarily outputs a complete HTML document.
+If set to true, the driver instead outputs only what would normally be
+the contents of the @code{body} element.  The default value is false.
+
 @item @option{-O css=@var{boolean}}
 Use cascading style sheets.  Cascading style sheets give an improved appearance
 and can be used to produce pages which fit a certain web site's style.
@@ -435,7 +456,7 @@ output just below the table as a single field prefixed by
 
 @item Footnotes
 Within a table, footnote markers are output as bracketed letters
-following the cell's contents, e.g.@tie{}@samp{[a]}, @samp{[b]},
+following the cell's contents, @i{e.g.}@tie{}@samp{[a]}, @samp{[b]},
 @enddots{}  The footnotes themselves are output following the body of
 the table, as a separate two-column table introduced with a line that
 says @samp{Footnotes:}.  Each row in the table represent one footnote: