doc: Add files generated by TeX to gitignore.
[pspp] / utilities / pspp-convert.1
1 .\" -*- nroff -*-
2 .de IQ
3 .  br
4 .  ns
5 .  IP "\\$1"
6 ..
7 .TH pspp\-convert 1 "October 2013" "PSPP" "PSPP Manual"
8 .
9 .SH NAME
10 pspp\-convert \- convert SPSS system and portable files to other formats
11 .
12 .SH SYNOPSIS
13 \fBpspp\-convert\fR [\fIoptions\fR] \fIinput\fR \fIoutput\fR
14 .br
15 \fBpspp\-convert \-\-help\fR | \fB\-h\fR
16 .br
17 \fBpspp\-convert \-\-version\fR | \fB\-v\fR
18 .
19 .SH DESCRIPTION
20 The \fBpspp\-convert\fR program reads SPSS system or portable file
21 \fIinput\fR and writes it to \fIoutput\fR, performing format
22 conversion as necessary.
23 .PP
24 The format of \fIinput\fR is automatically detected, except that the
25 character encoding of old system files cannot always be guessed
26 correctly.  Use \fB\-e \fIencoding\fR to specify the encoding in this
27 case.
28 .PP
29 By default, the intended format for \fIoutput\fR is inferred from its
30 extension:
31 .
32 .IP \fBcsv\fR
33 .IQ \fBtxt\fR
34 Comma-separated value.  Each value is formatted according to its
35 variable's print format.  The first line in the file contains variable
36 names.
37 .
38 .IP \fBsav\fR
39 .IQ \fBsys\fR
40 SPSS system file.
41 .
42 .IP \fBpor\fR
43 SPSS portable file.
44 .
45 .PP
46 Use \fB\-O \fIextension\fR to override the inferred format or to
47 specify the format for unrecognized extensions.
48 .
49 .PP
50 \fBpspp\-convert\fR can convert most input formats to most output
51 formats, with one exception: if the input file is an encrypted system
52 file, then the output file must also be an (unencrypted) system file.
53 .
54 .SH "OPTIONS"
55 .
56 .IP "\fB\-O format\fR"
57 .IQ "\fB\-\-output\-format=\fIformat\fR"
58 Specifies the desired output format.  \fIformat\fR must be one of the
59 extensions listed above, e.g. \fB\-O csv\fR requests comma-separated
60 value output.
61 .
62 .IP "\fB\-c \fImaxcases\fR"
63 .IQ "\fB\-\-cases=\fImaxcases\fR"
64 By default, all cases are copied from \fIinput\fR to \fIoutput\fR.
65 Specifying this option to limit the number of cases written to
66 \fIoutput\fR to \fImaxcases\fR.
67 .
68 .IP "\fB\-e \fIcharset\fR"
69 .IQ "\fB\-\-encoding=\fIcharset\fR"
70 Overrides the encoding in which character strings in \fIinput\fR are
71 interpreted.  This option is necessary because old SPSS system files
72 do not self-identify their encoding.
73 .
74 .IP "\fB\-p \fIpassword\fR"
75 .IQ "\fB\-\-password=\fIpassword\fR"
76 Specifies the password to use to decrypt an encrypted SPSS system file
77 \fIinput\fR.  If this option is not specified, \fBpspp\-convert\fR
78 prompts for the password.
79 .
80 .IP
81 On multiuser systems, this option may not be safe because other users
82 may be able to see the password in process listings.
83 .
84 .IP "\fB\-h\fR"
85 .IQ "\fB\-\-help\fR"
86 Prints a usage message on stdout and exits.
87 .
88 .IP "\fB\-v\fR"
89 .IQ "\fB\-\-version\fR"
90 Prints version information on stdout and exits.
91 .
92 .SH "AUTHORS"
93 Ben Pfaff.
94 .
95 .SH "SEE ALSO"
96 .
97 .BR pspp (1),
98 .BR psppire (1).