Add documentation for SPV file format.

[pspp] / doc / pspp-convert.texi

diff --git a/doc/pspp-convert.texi b/doc/pspp-convert.texi
index 83aa8ae4e98b287c316a0fbf8753df53249af114..3719de224c44dcb5fb1af537a417969e33c491a5 100644 (file)
--- a/doc/pspp-convert.texi
+++ b/doc/pspp-convert.texi
@@ -4,7 +4,8 @@
 @cindex @command{pspp-convert}
 
 @command{pspp-convert} is a command-line utility accompanying
-@pspp{}. It reads an SPSS system or portable file @var{input} and
+@pspp{}. It reads an SPSS or SPSS/PC+ system file or SPSS portable
+file or encrypted SPSS syntax file @var{input} and
 writes a copy of it to another @var{output} in a different format.
 Synopsis:
 
@@ -16,7 +17,7 @@ Synopsis:
 @t{pspp-convert -@w{-}version}
 @end display
 
-The format of @var{Iinput} is automatically detected, when possible.
+The format of @var{input} is automatically detected, when possible.
 The character encoding of old SPSS system files cannot always be
 guessed correctly, and SPSS/PC+ system files do not include any
 indication of their encoding.  Use @code{-e @var{encoding}} to specify
@@ -38,14 +39,26 @@ SPSS system file.
 
 @item por
 SPSS portable file.
+
+@item sps
+SPSS syntax file.  (Only encrypted syntax files may be converted to
+this format.)
 @end table
 
+@command{pspp-convert} can convert most input formats to most output
+formats.  Encrypted system file and syntax files are exceptions: if
+the input file is in an encrypted format, then the output file must be
+the same format (decrypted).  To decrypt such a file, specify the
+encrypted file as @var{input}.  The output will be the equivalent
+plaintext file.  You will be prompted for the password (or use
+@option{-p}, documented below).
+
 Use @code{-O @var{extension}} to override the inferred format or to
 specify the format for unrecognized extensions.
 
 The following options are accepted:
 
-@table @code
+@table @option
 @item -O @var{format}
 @itemx --output-format=@var{format}
 Specifies the desired output format.  @var{format} must be one of the
@@ -64,6 +77,16 @@ Overrides the encoding in which character strings in @var{input} are
 interpreted.  This option is necessary because old SPSS system files,
 and SPSS/PC+ system files, do not self-identify their encoding.
 
+@item -p @var{password}
+@item --password=@var{password}
+Specifies the password to use to decrypt an encrypted SPSS system file
+or syntax file.  If this option is not specified,
+@command{pspp-convert} will prompt interactively for the password as
+necessary.
+
+Be aware that command-line options, including passwords, may be
+visible to other users on multiuser systems.
+
 @item -h
 @itemx --help
 Prints a usage message on stdout and exits.