1. NAME

ssconvert - a command line spreadsheet format converter

2. SYNOPSIS

ssconvert [OPTIONS] infile outfile

ssconvert [OPTIONS] --merge-to outfile infile1 infile2 ...

3. DESCRIPTION

ssconvert is a command line utility to convert spreadsheet files between various spreadsheet file formats. It is a companion utility to Gnumeric, the powerful spreadsheet program created by the GNOME project. ssconvert accepts either file names or URIs as infile outfile. The special URIs fd://0 and fd://1 can be used for standard input and standard output respectively.

4. OPTIONS

This program follows the usual GNU command line syntax, with single letter options starting with a single dash (`-') and longer options starting with two dashes (`--').

4.1. Main options

--recalc

    Recalculate all formulas before writing.

--list-exporters

    List the available exporters (file formats).

-T, --export-type=ID
    Specify which exporter to use; see below for a list. This is only necessary when the right format does not follow from the output file name.

-O, --export-options=optionsstring
    Specify parameters for the chosen exporter. optionsstring is a list of parameter=value pairs, separated by spaces. The parameter names and values allowed are specific to the exporter and are documented below. Multiple parameters can be specified

--list-importers

    List the available importers (file formats).

-T, --import-type=ID Specify which importer to use; see below for a list. This is only necessary when the right format does not follow from the input file name.

-E, --import-encoding=STRING
    Specify an encoding for imported content.

-M, --merge-to=FILENAME
    Merge a collection of workbooks into one. Sheet size will expand to the largest in all the workbooks. Names in the scope of individual workbooks will end up in the scope of the merged workbook. The merge will be aborted if there are name conflicts.

4.2. Help options

-v, --version

    Display ssconvert's version.

-h, --help, --usage

    Display a brief usage message.

4.3. Path options

-L, --lib-dir=STRING

    Set the root library directory.

-D, --data-dir=STRING

    Adjust the root data directory.

5. LIST OF IMPORTANT IDS

  • Gnumeric_XmlIO:sax
        Gnumeric's XML file format
  • Gnumeric_Excel:excel_dsf
        Microsoft Excel (tm) 97/2000/XP & 5.0/95 format
  • Gnumeric_Excel:xlsx
        Microsoft Excel (tm) 2007 ("Office Open XML", .URL "http://en.wikipedia.org/wiki/XLSX" "OOXML" ) format
  • Gnumeric_pdf:pdf_assistant
        Portable Document Format
  • Gnumeric_stf:stf_assistant
        Text export (configurable) (*.txt)
  • Gnumeric_stf:stf_csv
        Comma Separated Values

6. LIST OF LESS IMPORTANT IDS

7. OPTIONS FOR THE PORTABLE DOCUMENT FORMAT (*.pdf) EXPORTER

  • sheet
        Name of the workbook sheet to operate on.
  • paper
        Paper size. Valid values include "A4" for ISO A4 and "na_letter_8.5x11in" for US Letter.

8. OPTIONS FOR THE CONFIGURABLE TEXT (*.txt) EXPORTER

  • sheet
        Name of the workbook sheet to operate on.
  • eol
        End Of Line convention; how lines are terminated. "unix" for linefeed, "mac" for carriage return; "windows" for carriage return plus linefeed.
  • charset
        The character encoding of the output. Defaults to UTF-8.
  • locale
        
  • quote
        The character or string used for quoting fields. Defaults to "\\"" (quotation mark / double quote).
  • separator
        The string used to separate fields. Defaults to space.
  • format
        Acceptable values: "automatic", "raw", or "preserve".
  • transliterate-mode
        How to handle characters that cannot be represented in the chosen output character set. Acceptable values: "transliterate", or "escape".
  • quoting-mode
        When does data need to be quoted? "never", "auto" (puts quotes where needed), or "always". Defaults to "never".
  • quoting-on-whitespace
        Controls whether initial or terminal whitespace forces quoting. Defaults to TRUE.

9. EXAMPLES

To convert the gnumeric file foo.gnumeric to a Microsoft Excel(TM) format file foo.xls:

ssconvert foo.gnumeric foo.xls

The export format can be specified explicitly, to override the default (which is based on the file extension):

ssconvert --export-type=Gnumeric_stf:stf_csv\fR foo.xls foo.txt

To convert an Excel format file statfuns.xls to a text file, specifying the semicolon as the separator character:

ssconvert -O 'separator=; format=raw' samples/excel/statfuns.xls statfuns.txt

10. LICENSE

ssconvert is licensed under the terms of the General Public License (GPL), version 2. For information on this license look at the source code that came with the software or see the .URL "http://www.gnu.org" "GNU project page" .

11. COPYRIGHT

The copyright on the gnumeric software and source code is held by the individual authors as is documented in the source code.

12. AUTHOR

ssconvert's primary author is Jody Goldberg < >; ssconvert builds on the gnumeric codebase. The initial version of this manpage was written by J.H.M. Dassen (Ray) < >.

13. SEE ALSO

gnumeric(1), ssgrep(1), ssindex(1) .URL "http://www.gnome.org/projects/gnumeric/" "The Gnumeric Homepage" . .URL "http://www.gnome.org/" "The GNOME project page" .