work on docs

[pspp] / utilities / pspp-output.1

diff --git a/utilities/pspp-output.1 b/utilities/pspp-output.1
index ac92efcb1cc19449a428a4449627457212696a8d..5fd913789c0051306d12a9f62945a08a6be9fee0 100644 (file)
--- a/utilities/pspp-output.1
+++ b/utilities/pspp-output.1
@@ -1,4 +1,18 @@
 .\" -*- nroff -*-
+.\" Copyright (C) 2020  Free Software Foundation
+
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
 .de IQ
 .  br
 .  ns
@@ -16,6 +30,10 @@ pspp\-output \- convert and operate on SPSS viewer (SPV) files
 .br
 \fBpspp\-output \fR[\fIoptions\fR] \fBconvert\fR \fIsource destination\fR
 .br
+\fBpspp\-output \fR[\fIoptions\fR] \fBget\-table\-look\fR \fIsource destination\fR
+.br
+\fBpspp\-output \fR[\fIoptions\fR] \fBconvert\-table\-look\fR \fIsource destination\fR
+.br
 \fBpspp\-output \-\-help\fR | \fB\-h\fR
 .br
 \fBpspp\-output \-\-version\fR | \fB\-v\fR
@@ -80,6 +98,32 @@ for details of the available output options.
 By default, if the source is corrupt or otherwise cannot be processed,
 the destination is not written.  These option make \fBpspp\-output\fR
 write the output as best it can, even with errors.
+.IP \fB\-\-table\-look=\fIfile\fR
+Reads a table style from \fIfile\fR and applies it to all of the
+output tables.  The file should a TableLook \fB.stt\fR or \fB.tlo\fR
+file.
+.SS The \fBget\-table\-look\fR command
+When invoked as \fBpspp\-output get\-table\-look \fIsource
+destination\fR, \fBpspp\-output\fR reads SPV file \fIsource\fR,
+applies any selection options (as described under \fBInput Selection
+Options\fR below), picks the first table from the selected object,
+extracts the TableLook from that table, and writes it to
+\fIdestination\fR (typically with an \fB.stt\fR extension) in the
+TableLook XML format.
+.PP
+Use \fB\-\fR for \fIsource\fR to instead write the default look to
+\fIdestination\fR.
+.PP
+The user may use the TableLook file to change the style of tables in
+other files, by passing it to the \fB\-\-table\-look\fR option on the
+\fBconvert\fR command.
+.SS The \fBconvert\-table\-look\fR command
+When invoked as \fBpspp\-output convert\-table\-look \fIsource
+destination\fR, \fBpspp\-output\fR reads \fB.stt\fR or \fR.tlo\fR file
+\fIsource\fR, and writes it back to \fIdestination\fR (typically with
+an \fB.stt\fR extension) in the TableLook XML format.  This is useful
+for converting a TableLook \fB.tlo\fR file from SPSS 15 or earlier
+into the newer \fB.stt\fR format.
 .SS "Input Selection Options"
 The \fBdir\fR and \fBconvert\fR commands, by default, operate on all
 of the objects in the source SPV file, except for objects that are not
@@ -121,6 +165,11 @@ Subtypes are always in English and \fBdir\fR will print them.
 The \fB\-\-labels\fR 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.
+.IP "\-\-nth-commands=\fIn\fR..."
+Include only objects from the \fIn\fRth command that matches
+\fB\-\-commands\fR (or the \fIn\fRth command overall if
+\fB\-\-commands\fR is not specified), where \fIn\fR is 1 for the first
+command, 2 for the second, and so on.
 .IP "\fB\-\-instances=\fIinstance\fR..."
 Include the specified \fIinstance\fR of an object that matches the
 other criteria within a single command.  The \fIinstance\fR may be a