work on docs
[pspp] / doc / pspp-output.texi
index 4b9aeb203e4e944b80b524d66c55456688ca262c..b580690dc5708f20cac83a9813838e6dce378055 100644 (file)
@@ -1,5 +1,5 @@
 @c PSPP - a program for statistical analysis.
-@c Copyright (C) 2019 Free Software Foundation, Inc.
+@c Copyright (C) 2019, 2020 Free Software Foundation, Inc.
 @c Permission is granted to copy, distribute and/or modify this document
 @c under the terms of the GNU Free Documentation License, Version 1.3
 @c or any later version published by the Free Software Foundation;
@@ -29,6 +29,10 @@ SPSS 15 and earlier versions instead use @file{.spo} files.
 
 @t{pspp-output} [@var{options}] @t{convert} @var{source} @var{destination}
 
+@t{pspp-output} [@var{options}] @t{get-table-look} @var{source} @var{destination}
+
+@t{pspp-output} [@var{options}] @t{convert-table-look} @var{source} @var{destination}
+
 @t{pspp-output -@w{-}help}
 
 @t{pspp-output -@w{-}version}
@@ -42,6 +46,8 @@ developers may find useful for debugging.
 * The pspp-output detect Command::
 * The pspp-output dir Command::
 * The pspp-output convert Command::
+* The pspp-output get-table-look Command::
+* The pspp-output convert-table-look Command::
 * Input Selection Options::
 @end menu
 
@@ -110,8 +116,46 @@ details of the available output options.
 By default, if the source is corrupt or otherwise cannot be processed,
 the destination is not written.  With @option{-F} or @option{--force},
 the destination is written as best it can, even with errors.
+
+@item --table-look=@var{file}
+Reads a table style from @var{file} and applies it to all of the
+output tables.  The file should be a TableLook @file{.stt} or
+@file{.tlo} file.
 @end table
 
+@node The pspp-output get-table-look Command
+@section The @code{get-table-look} Command
+
+@display
+@t{pspp-output} [@var{options}] @t{get-table-look} @var{source} @var{destination}
+@end display
+
+Reads SPV file @var{source}, applies any selection options
+(@pxref{Input Selection Options}), picks the first table from the
+selected object, extracts the TableLook from that table, and writes it
+to @var{destination} (typically with an @file{.stt} extension) in the
+TableLook XML format.
+
+Use @samp{-} for @var{source} to instead write the default look to
+@var{destination}.
+
+The user may use the TableLook file to change the style of tables in
+other files, by passing it to the @option{--table-look} option on the
+@code{convert} command.
+
+@node The pspp-output convert-table-look Command
+@section The @code{convert-table-look} Command
+
+@display
+@t{pspp-output} [@var{options}] @t{convert-table-look} @var{source} @var{destination}
+@end display
+
+Reads @file{.stt} or @file{.tlo} file @var{source}, and writes it back
+to @var{destination} (typically with an @file{.stt} extension) in the
+TableLook XML format.  This is useful for converting a TableLook
+@file{.tlo} file from SPSS 15 or earlier into the newer @file{.stt}
+format.
+
 @node Input Selection Options
 @section Input Selection Options
 
@@ -159,6 +203,12 @@ The @option{--labels} option matches the labels in table output (that
 is, the table titles).  Labels are affected by the output language,
 variable names and labels, split file settings, and other factors.
 
+@item --nth-commands=@var{n}@dots{}
+Include only objects from the @var{n}th command that matches
+@option{--command} (or the @var{n}th command overall if
+@option{--command} is not specified), where @var{n} is 1 for the first
+command, 2 for the second, and so on.
+
 @item --instances=@var{instance}@dots{}
 Include the specified @var{instance} of an object that matches the
 other criteria within a single command.  The @var{instance} may be a