work on docs
[pspp] / utilities / pspp-convert.1
index 9c96dead1eaa3a6c854be2a09e93970392107f81..db4982b3b8ff2f3437a1198eb24347b7a15d1e4b 100644 (file)
@@ -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
@@ -7,7 +21,7 @@
 .TH pspp\-convert 1 "October 2013" "PSPP" "PSPP Manual"
 .
 .SH NAME
-pspp\-convert \- convert SPSS files to other formats
+pspp\-convert \- convert SPSS data files to other formats
 .
 .SH SYNOPSIS
 \fBpspp\-convert\fR [\fIoptions\fR] \fIinput\fR \fIoutput\fR
@@ -81,10 +95,52 @@ Overrides the encoding in which character strings in \fIinput\fR are
 interpreted.  This option is necessary because old SPSS system files
 do not self-identify their encoding.
 .
+.IP "\fB\-k \fIvar\fR..."
+.IQ "\fB\-\-keep=\fIvar\fR..."
+Drops all variables except those listed as \fIvar\fR, and reorders the
+remaining variables into the specified order.
+.
+.IP "\fB\-d \fIvar\fR..."
+.IQ "\fB\-\-drop=\fIvar\fR..."
+Drops each \fIvar\fR listed from the output.
+.
+.SS "CSV Output Options"
+.PP
+These options affect only output to \fB.csv\fR and \fB.txt\fR files.
+.IP "\fB\-\-labels\fR"
+By default, \fBpspp\-convert\fR writes variables' values to the output.
+With this option, \fBpspp\-convert\fR writes value labels.
+.IP "\fB\-\-no\-var\-names\fR"
+By default, \fRpspp\-convert\fR\fR writes the variable names as the
+first line of output.  With this option, \fBpspp\-convert\fR omits
+this line.
+.IP "\fB\-\-recode\fR"
+By default, \fBpspp\-convert\fR writes user-missing values as their
+regular values.  With this option, \fBpspp\-convert\fR recodes them to
+system-missing values (which are written as a single space).
+
+.IP "\fB\-\-print\-formats\fR"
+By default, \fBpspp\-convert\fR writes numeric variables as plain
+numbers.  This option makes \fBpspp\-convert\fR honor variables'
+print formats.
+
+.IP "\fB\-\-decimal=\fIdecimal\fR"
+This option sets the character used as a decimal point in output.  The
+default is a period (\fB.\fR).
+
+.IP "\fB\-\-delimiter=\fIdelimiter\fR"
+This option sets the character used to separate fields in output.  The
+default is a comma (\fB,\fR), unless the decimal point is a comma, in
+which case a semicolon (\fB;\fR) is used.
+
+.IP "\fB\-\-qualifier=\fIqualifier\fR"
+The option sets the character used to quote fields that contain the
+delimiter.  The default is a double quote (\fB\(dq\fR).
+.
 .SS "Password Options"
 When the input file is encrypted, \fBpspp\-convert\fR needs to obtain
 a password to decrypt it.  To do so, the user may specify the password
-with \f\-p\fR (or \fB\-\-password), or the name of a file containing a
+with \fB\-p\fR (or \fB\-\-password\fR), or the name of a file containing a
 list of possible passwords with \fB\-\-password\-list\fR, or an
 alphabet of possible passwords to try along with a maximum length with
 \fB\-a\fR (or \fB\-\-password\-alphabet\fR) and \fB\-l\fR (or
@@ -131,5 +187,6 @@ Ben Pfaff.
 .
 .SH "SEE ALSO"
 .
+.BR pspp\-output (1),
 .BR pspp (1),
 .BR psppire (1).