2 \\$2 \(laURL: \\$1 \(ra\\$3
4 .if \n[.g] .mso www.tmac
5 .TH SSCONVERT 1 "2011-11-04" "gnumeric" "GNOME"
7 ssconvert \- a command line spreadsheet format converter
10 \fBssconvert\fR [\fIOPTIONS\fR] \fIinfile\fR \fIoutfile\fR
12 \fBssconvert\fR [\fIOPTIONS\fR] \fB\-\-merge\-to\fR \fIoutfile\fR \fIinfile1\fR \fIinfile2\fR \fB...\fR
15 \fBssconvert\fR is a command line utility to convert spreadsheet files
16 between various spreadsheet file formats. It is a companion utility to
17 \fBGnumeric\fR, the powerful spreadsheet program created by the GNOME
20 \fBssconvert\fR accepts either file names or URIs as \fIinfile\fR
21 \fIoutfile\fR. The special URIs \fIfd://0\fR and \fIfd://1\fR can be
22 used for standard input and standard output respectively.
25 This program follows the usual GNU command line syntax, with single
26 letter options starting with a single dash (`-') and longer options
27 starting with two dashes (`--').
32 Recalculate all cells before writing the result.
34 .B \-\-list\-exporters
35 List the available exporters (file formats that can be written).
37 .B \-T, \-\-export\-type=\fIID\fR
38 Specify which exporter to use; see below for a list. This is only
39 necessary when the right format does not follow from the output file
42 .B \-O, \-\-export\-options=\fIoptionsstring\fR
43 Specify parameters for the chosen exporter.
44 \fIoptionsstring\fR is a list of \fIparameter\fR=\fIvalue\fR pairs, separated
46 The parameter names and values allowed are specific to the exporter and are
47 documented below. Multiple parameters can be specified
49 .B \-\-list\-importers
50 List the available importers (file formats that can be read).
51 .B \-I, \-\-import\-type=\fIID\fR
52 Specify which importer to use; see below for a list. This is only
53 necessary when the right format does not follow from the input file
56 .B \-E, \-\-import\-encoding=\fISTRING\fR
57 Specify an encoding for imported content.
59 .B \-M, \-\-merge\-to=\fIFILENAME\fR
60 Merge a collection of workbooks into one. Sheet size will expand
61 to the largest in all the workbooks. Names in the scope of
62 individual workbooks will end up in the scope of the merged
63 workbook. The merge will be aborted if there are name conflicts.
65 .B \-S, \-\-export\-file\-per\-sheet
66 Export a file for each sheet if the exporter only supports one sheet at a
67 time. The output filename is treated as a template in which sheet number
68 is substituted for %n and/or sheet name is substituted for %s. If there
69 are not substitutions, a default of ".%s" is added.
74 Display ssconvert's version.
76 .B \-h, \-\-help, \-\-usage
77 Display a brief usage message.
80 Show all help options.
82 .B \-\-help\-libspreadsheet
83 Show Gnumeric options.
85 .SH LIST OF IMPORTER/EXPORTER IDS
86 The following IDs can be can be used both for import (reading) and export
90 Gnumeric's XML file format (*.gnumeric)
92 .B Gnumeric_OpenCalc:openoffice
93 .URL "http://en.wikipedia.org/wiki/OpenDocument" "OpenDocument"
95 .URL "http://en.wikipedia.org/wiki/OpenOffice.org_Calc" "OpenOffice Calc"
96 (*.sxc, *.ods) format.
97 As an exporter, this is ODF/OpenOffice without foreign elements (*.ods).
100 .URL "http://en.wikipedia.org/wiki/Data_Interchange_Format" "Data Interchange Format"
103 .B Gnumeric_paradox:paradox
104 .URL "http://en.wikipedia.org/wiki/Paradox_%28database%29" "Paradox database"
105 or primary index file (*.db, *.px)
107 .B Gnumeric_stf:stf_assistant
110 .B Gnumeric_sylk:sylk
111 .URL "http://en.wikipedia.org/wiki/Multiplan" "MultiPlan"
112 .URL "http://en.wikipedia.org/wiki/SYmbolic_LinK_%28SYLK%29" "Symbolic Link (SYLK)"
115 .B Gnumeric_Excel:xlsx
116 Microsoft Excel (tm) 2007 ("Office Open XML",
117 .URL "http://en.wikipedia.org/wiki/XLSX" "OOXML"
120 .SH LIST OF IMPORTANT IMPORTER IDS
122 .B Gnumeric_stf:stf_csvtab
123 Comma or tab separated values (CSV/TSV) (*.csv)
125 .B Gnumeric_html:html
128 .B Gnumeric_Excel:excel
129 Microsoft Excel (tm) (*.xls)
131 .B Gnumeric_Excel:excel_xml
132 Microsoft Excel (tm) 2003 SpreadsheetML
134 .SH LIST OF OTHER IMPORTER IDS
136 .B Gnumeric_QPro:qpro
137 .URL "http://en.wikipedia.org/wiki/Quattro_Pro" "Quattro Pro"
138 (*.wb1, *.wb2, *.wb3)
140 .B Gnumeric_applix:applix
143 .B Gnumeric_lotus:lotus
144 .URL "http://en.wikipedia.org/wiki/Lotus_1-2-3" "Lotus 1-2-3"
145 (*.wk1, *.wks, *.123)
148 .URL "http://en.wikipedia.org/wiki/MPS_%28format%29" "MPS (Mathematical Programming System) format"
149 Linear programming and mixed integer programming file format (*.mps)
151 .B Gnumeric_oleo:oleo
152 .URL "http://en.wikipedia.org/wiki/GNU_Oleo" "GNU Oleo"
155 .B Gnumeric_plan_perfect:pln
156 PlanPerfect Format (PLN)
158 .B Gnumeric_psiconv:psiconv
164 .B Gnumeric_xbase:xbase
165 .URL "http://en.wikipedia.org/wiki/XBase" "xBase"
168 .SH LIST OF IMPORTANT EXPORTER IDS
170 .B Gnumeric_OpenCalc:odf
171 ODF/OpenOffice with foreign elements (*.ods)
173 .B Gnumeric_glpk:glpk
174 GLPK Linear Program Solver
176 .B Gnumeric_html:html40
179 .B Gnumeric_html:html40frag
180 HTML (*.html) fragment
182 .B Gnumeric_html:xhtml
185 .B Gnumeric_html:xhtml_range
186 XHTML range - for export to clipboard
188 .B Gnumeric_pdf:pdf_assistant
189 Portable Document Format (*.PDF)
191 .B Gnumeric_stf:stf_csv
192 Comma separated values (CSV)
194 .B Gnumeric_Excel:excel_dsf
195 Microsoft Excel (tm) 97/2000/XP & 5.0/95
197 .SH LIST OF OTHER EXPORTER IDS
199 .B Gnumeric_Excel:excel_biff7
200 Microsoft Excel (tm) 5.0/95
202 .B Gnumeric_Excel:excel_biff8
203 Microsoft S Excel (tm) 97/2000/XP
205 .B Gnumeric_GnomeGlossary:po
206 Gnome Glossary PO file format
208 .B Gnumeric_html:html32
211 .B Gnumeric_html:latex
214 .B Gnumeric_html:latex_table
215 LaTeX 2e (*.tex) table fragment
217 .B Gnumeric_html:roff
218 .URL "http://en.wikipedia.org/wiki/Troff" "TROFF"
221 .B Gnumeric_lpsolve:lpsolve
222 .URL "http://sourceforge.net/projects/lpsolve/" "LPSolve"
223 Mixed Integer Linear Programming (MILP) solver
225 .SH OPTIONS FOR THE PORTABLE DOCUMENT FORMAT (*.pdf) EXPORTER
229 Name of the workbook sheet to operate on.
230 You can specify several sheets by repeating this option. If this option is not given the active
231 sheet (i. e. the sheet that was active when the file was saved) is used.
232 This is ignored if the \fBobject\fR option is given.
236 Name of the sheet object to print. If this option is given any \fBsheet\fR option is ignored.
237 Only the first \fBobject\fR given is exported.
241 Paper size. Valid values include "\fBA4\fR" for ISO A4 and
242 "\fBna_letter_8.5x11in\fR" for US Letter. If an individual graph is specified through the
243 \fBobject\fR option, then a paper size of "\fBfit\fR" reduces the size of the paper to the
245 .\" FIXME Is there a convenient way to list all valid paper sizes?
246 .\" It looks like at least the values from plugins/excel/ms-excel-read.c's
247 .\" paper_size_table[] are supported.
249 .SH OPTIONS FOR THE CONFIGURABLE TEXT (*.txt) EXPORTER
250 .\" Cf. "g_object_class_install_property" calls in src/stf-export.c
254 Name of the workbook sheet to operate on.
255 You can specify several sheets by repeating this option. If this option is not given the active
256 sheet (i. e. the sheet that was active when the file was saved) is used.
260 End Of Line convention; how lines are terminated.
261 "\fBunix\fR" for linefeed,
262 "\fBmac\fR" for carriage return;
263 "\fBwindows\fR" for carriage return plus linefeed.
267 The character encoding of the output. Defaults to UTF-8.
271 The locale to use for number and date formatting.
272 Defaults to the current locale as reported by \fBlocale\fR(1).
273 Consult \fBlocale \-a\fR output for acceptable values.
277 The character or string used for quoting fields. Defaults to "\fB\\"\fR"
278 (quotation mark / double quote).
282 The string used to separate fields. Defaults to space.
286 How cells should be formatted.
288 "\fBautomatic\fR" (apply automatic formatting; default),
289 "\fBraw\fR" (output data raw, unformatted), or
290 "\fBpreserve\fR" (preserve the formatting from the source document).
292 This deals with the difference between a cell's contents and the way those
293 contents are formatted.
295 Consider a cell in a Gnumeric input document that was
296 input as "4/19/73" in a US locale, with a format set to "d-mmm-yyyy" and
297 thus formatted as "19-Apr-1973".
299 With the default \fBformat\fR setting of "\fBautomatic\fR" it will be output
300 as "1973/04/19". With "\fBpreserve\fR", the formatting will be preserved and
301 it will be output as "19-Apr-1973". With "\fBraw\fR" it will be output as
302 "26773" (Gnumeric's internal representation: days since an epoch).
305 .B transliterate-mode
306 How to handle unrepresentable characters (characters that cannot be
307 represented in the chosen output character set).
309 "\fBtransliterate\fR", or
314 When does data need to be quoted?
316 "\fBauto\fR" (puts quotes where needed), or
317 "\fBalways\fR". Defaults to "\fBnever\fR".
320 .B quoting-on-whitespace
321 Controls whether initial or terminal whitespace forces quoting. Defaults to
336 To convert the Gnumeric file \fIfoo.gnumeric\fR to a Microsoft Excel(TM)
340 \fBssconvert\fR \fIfoo.gnumeric\fR \fIfoo.xls\fR
342 The export format can be specified explicitly, to override the default
343 (which is based on the file extension):
345 \fBssconvert\fR \fB\-\-export\-type=\fRGnumeric_stf:stf_csv\fR \fIfoo.xls\fR
348 To convert an Excel format file \fIstatfuns.xls\fR to a text file,
349 specifying the semicolon as the separator character:
351 \fBssconvert\fR \fB-O 'separator=; format=raw'\fR \fIsamples/excel/statfuns.xls\fR \fIstatfuns.txt\fR
356 \fBssconvert\fR is licensed under the terms of the General Public
357 License (GPL), version 2 or 3. For information on this license look at the
358 source code that came with the software or see the
359 .URL "http://www.gnu.org" "GNU project page" .
363 The copyright on the \fBGnumeric\fR software and source code is held
364 by the individual authors as is documented in the source code.
368 \fBssconvert\fR's primary author is Jody Goldberg <jody@gnome.org>;
369 \fBssconvert\fR builds on the \fBGnumeric\fR codebase.
371 The initial version of this manpage was written by J.H.M. Dassen (Ray)
372 <jdassen@debian.org>.
380 .URL "http://www.gnome.org/projects/gnumeric/" "The Gnumeric Homepage" .
382 .URL "http://www.gnome.org/" "The GNOME project page" .