i18n: New function utf8_to_title().

[pspp] / doc / pspp-convert.texi

diff --git a/doc/pspp-convert.texi b/doc/pspp-convert.texi
index aad7e74d9e0d7636302a2a2941c81735d8f98373..c84d556d8e96b1f0501e81037cbe14bac08f595b 100644 (file)
--- a/doc/pspp-convert.texi
+++ b/doc/pspp-convert.texi
@@ -55,24 +55,33 @@ 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
+formats.  Encrypted SPSS file formats are exceptions: if the input
+file is in an encrypted format, then the output file will 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.  Options for the output format are ignored in this case.
+
+The password for encrypted files can be specified a few different
+ways.  If the password is known, use the @option{-p} option
+(documented below) or allow @command{pspp-convert} to prompt for it.
+If the password is unknown, use the @option{-a} and @option{-l}
+options to specify how to search for it, or @option{--password-list}
+to specify a file of passwords to try.
+
+Use @code{-O format=@var{format}} to override the inferred format or to
 specify the format for unrecognized extensions.
 
-The following options are accepted:
+@command{pspp-convert} accepts the following options:
 
 @table @option
-@item -O @var{format}
-@itemx --output-format=@var{format}
-Specifies the desired output format.  @var{format} must be one of the
-extensions listed above, e.g. @code{-O csv} requests comma-separated
-value output.
+@item @option{-O format=@var{format}}
+Overrides the format inferred from the output file's extension.  Use
+@option{--help} to list the available formats.  @xref{Invoking PSPP},
+for details of the available output formats.
+
+@item @option{-O @var{option}=@var{value}}
+Sets an option for the output file format.  @xref{Invoking PSPP}, for
+details of the available output options.
 
 @item -c @var{maxcases}
 @itemx --cases=@var{maxcases}
@@ -96,6 +105,28 @@ necessary.
 Be aware that command-line options, including passwords, may be
 visible to other users on multiuser systems.
 
+When used with @option{-a} (or @option{--password-alphabet}) and
+@option{-l} (or @option{--password-length}), this option specifies the
+starting point for the search.  This can be used to restart a search
+that was interrupted.
+
+@item -a @var{alphabet}
+@item --password-alphabet=@var{alphabet}
+Specifies the alphabet of symbols over which to search for an
+encrypted file's password.  @var{alphabet} may include individual
+characters and ranges delimited by @samp{-}.  For example, @option{-a
+a-z} searches lowercase letters, @option{-a A-Z0-9} searches uppercase
+letters and digits, and @option{-a ' -~'} searches all printable ASCII
+characters.
+
+@item -l @var{max-length}
+@item --password-length=@var{max-length}
+Specifies the maximum length of the passwords to try.
+
+@item --password-list=@var{file}
+Specifies a file to read containing a list of passwords to try, one
+per line.  If @var{file} is @file{-}, reads from stdin.
+
 @item -h
 @itemx --help
 Prints a usage message on stdout and exits.