| 1 |
.de URL |
| 2 |
\\$2 \(laURL: \\$1 \(ra\\$3 |
| 3 |
.. |
| 4 |
.if \n[.g] .mso www.tmac |
| 5 |
.TH SSCONVERT 1 "2020-04-19" "gnumeric" "GNOME" |
| 6 |
.SH NAME |
| 7 |
ssconvert \- a command line spreadsheet format converter |
| 8 |
|
| 9 |
.SH SYNOPSIS |
| 10 |
\fBssconvert\fR [\fIOPTIONS\fR] \fIinfile\fR \fIoutfile\fR |
| 11 |
.P |
| 12 |
\fBssconvert\fR [\fIOPTIONS\fR] \fB\-\-merge\-to\fR \fIoutfile\fR \fIinfile1\fR \fIinfile2\fR \fB...\fR |
| 13 |
|
| 14 |
.SH DESCRIPTION |
| 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 |
| 18 |
project. |
| 19 |
|
| 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. |
| 23 |
|
| 24 |
.SH OPTIONS |
| 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 (`--'). |
| 28 |
|
| 29 |
.SS "Main options" |
| 30 |
.TP |
| 31 |
.B \-\-recalc |
| 32 |
Recalculate all cells before writing the result. |
| 33 |
.TP |
| 34 |
.B \-\-set \fICELL=CONTENTS\fR |
| 35 |
Set the value of \fICELL\fR to \fICONTENTS\fR. To |
| 36 |
put an expression in a cell, add an extra =, for example \-\-set "A11==A10+1". |
| 37 |
This option may be repeated as many times as needed. The workbook will be |
| 38 |
recalculated after all cells have been set, provided that the workbook is |
| 39 |
set for automatic recalculation. If not, recalculation can be forced |
| 40 |
with \-\-recalc. |
| 41 |
.TP |
| 42 |
.B \-v, \-\-verbose |
| 43 |
Be slightly more verbose about what is going on. |
| 44 |
.TP |
| 45 |
.B \-\-list\-exporters |
| 46 |
List the available exporters (file formats that can be written). |
| 47 |
.TP |
| 48 |
.B \-T, \-\-export\-type=\fIID\fR |
| 49 |
Specify which exporter to use; see below for a list. This is only |
| 50 |
necessary when the right format does not follow from the output file |
| 51 |
name. The list of available export formats can be generated using the |
| 52 |
\-\-list\-exporters option. However, when image export is requested |
| 53 |
using the \-\-export\-graphs option, the list of image formats should be |
| 54 |
consulted instead. That list can be generated using the |
| 55 |
\-\-list\-image\-formats option. |
| 56 |
.TP |
| 57 |
.B \-O, \-\-export\-options=\fIoptionsstring\fR |
| 58 |
Specify parameters for the chosen exporter. |
| 59 |
\fIoptionsstring\fR is a list of \fIparameter\fR=\fIvalue\fR pairs, separated |
| 60 |
by spaces. |
| 61 |
The parameter names and values allowed are specific to the exporter and are |
| 62 |
documented below. Multiple parameters can be specified |
| 63 |
.TP |
| 64 |
.B \-\-export\-graphs |
| 65 |
Export the graphs (or charts) inside the input spreadsheet to |
| 66 |
numbered image files (SVG by default). The list of available image |
| 67 |
formats can be printed with \-\-list\-image-formats |
| 68 |
.TP |
| 69 |
.B \-\-list\-importers |
| 70 |
List the available importers (file formats that can be read). |
| 71 |
.B \-I, \-\-import\-type=\fIID\fR |
| 72 |
Specify which importer to use; see below for a list. This is only |
| 73 |
necessary when the right format does not follow from the input file |
| 74 |
name. |
| 75 |
.TP |
| 76 |
.B \-\-list\-image\-formats |
| 77 |
List the available image formats for graph export |
| 78 |
.TP |
| 79 |
.B \-E, \-\-import\-encoding=\fISTRING\fR |
| 80 |
Specify an encoding for imported content. |
| 81 |
.TP |
| 82 |
.B \-M, \-\-merge\-to=\fIFILENAME\fR |
| 83 |
Merge a collection of workbooks into one. Sheet size will expand |
| 84 |
to the largest in all the workbooks. Names in the scope of |
| 85 |
individual workbooks will end up in the scope of the merged |
| 86 |
workbook. The merge will be aborted if there are name conflicts. |
| 87 |
.TP |
| 88 |
.B \-S, \-\-export\-file\-per\-sheet |
| 89 |
Export a file for each sheet if the exporter only supports one sheet at a |
| 90 |
time. The output filename is treated as a template in which sheet number |
| 91 |
is substituted for %n, sheet name is substituted for %s, and sheet object |
| 92 |
name is substituted for %o in case of graph export. If there are no |
| 93 |
substitutions, a default of ".%n" is added. |
| 94 |
|
| 95 |
.SS "Help options" |
| 96 |
.TP |
| 97 |
.B \-\-version |
| 98 |
Display ssconvert's version. |
| 99 |
.TP |
| 100 |
.B \-h, \-\-help, \-\-usage |
| 101 |
Display a brief usage message. |
| 102 |
.TP |
| 103 |
.B \-\-help\-all |
| 104 |
Show all help options. |
| 105 |
.TP |
| 106 |
.B \-\-help\-libspreadsheet |
| 107 |
Show Gnumeric options. |
| 108 |
|
| 109 |
.SH LIST OF IMPORTER/EXPORTER IDS |
| 110 |
The following IDs can be can be used both for import (reading) and export |
| 111 |
(writing). |
| 112 |
.TP |
| 113 |
.B Gnumeric_XmlIO:sax |
| 114 |
Gnumeric's XML file format (*.gnumeric) |
| 115 |
.TP |
| 116 |
.B Gnumeric_OpenCalc:openoffice |
| 117 |
.URL "http://en.wikipedia.org/wiki/OpenDocument" "OpenDocument" |
| 118 |
or |
| 119 |
.URL "http://en.wikipedia.org/wiki/OpenOffice.org_Calc" "OpenOffice Calc" |
| 120 |
(*.sxc, *.ods) format. |
| 121 |
As an exporter, this is ODF/OpenOffice without foreign elements (*.ods). |
| 122 |
.TP |
| 123 |
.B Gnumeric_dif:dif |
| 124 |
.URL "http://en.wikipedia.org/wiki/Data_Interchange_Format" "Data Interchange Format" |
| 125 |
(*.dif) |
| 126 |
.TP |
| 127 |
.B Gnumeric_paradox:paradox |
| 128 |
.URL "http://en.wikipedia.org/wiki/Paradox_%28database%29" "Paradox database" |
| 129 |
or primary index file (*.db, *.px) |
| 130 |
.TP |
| 131 |
.B Gnumeric_stf:stf_assistant |
| 132 |
Text (configurable) |
| 133 |
.TP |
| 134 |
.B Gnumeric_sylk:sylk |
| 135 |
.URL "http://en.wikipedia.org/wiki/Multiplan" "MultiPlan" |
| 136 |
.URL "http://en.wikipedia.org/wiki/SYmbolic_LinK_%28SYLK%29" "Symbolic Link (SYLK)" |
| 137 |
(*.slk) |
| 138 |
.TP |
| 139 |
.B Gnumeric_Excel:xlsx |
| 140 |
Microsoft Excel (tm) 2007 ("Office Open XML", |
| 141 |
.URL "http://en.wikipedia.org/wiki/XLSX" "OOXML" |
| 142 |
) format |
| 143 |
|
| 144 |
.SH LIST OF IMPORTANT IMPORTER IDS |
| 145 |
.TP |
| 146 |
.B Gnumeric_stf:stf_csvtab |
| 147 |
Comma or tab separated values (CSV/TSV) (*.csv) |
| 148 |
.TP |
| 149 |
.B Gnumeric_html:html |
| 150 |
HTML (*.html, *.htm) |
| 151 |
.TP |
| 152 |
.B Gnumeric_Excel:excel |
| 153 |
Microsoft Excel (tm) (*.xls) |
| 154 |
.TP |
| 155 |
.B Gnumeric_Excel:excel_xml |
| 156 |
Microsoft Excel (tm) 2003 SpreadsheetML |
| 157 |
|
| 158 |
.SH LIST OF OTHER IMPORTER IDS |
| 159 |
.TP |
| 160 |
.B Gnumeric_QPro:qpro |
| 161 |
.URL "http://en.wikipedia.org/wiki/Quattro_Pro" "Quattro Pro" |
| 162 |
(*.wb1, *.wb2, *.wb3) |
| 163 |
.TP |
| 164 |
.B Gnumeric_applix:applix |
| 165 |
Applix (*.as) |
| 166 |
.TP |
| 167 |
.B Gnumeric_lotus:lotus |
| 168 |
.URL "http://en.wikipedia.org/wiki/Lotus_1-2-3" "Lotus 1-2-3" |
| 169 |
(*.wk1, *.wks, *.123) |
| 170 |
.TP |
| 171 |
.B Gnumeric_mps:mps |
| 172 |
.URL "http://en.wikipedia.org/wiki/MPS_%28format%29" "MPS (Mathematical Programming System) format" |
| 173 |
Linear programming and mixed integer programming file format (*.mps) |
| 174 |
.TP |
| 175 |
.B Gnumeric_oleo:oleo |
| 176 |
.URL "http://en.wikipedia.org/wiki/GNU_Oleo" "GNU Oleo" |
| 177 |
(*.oleo) |
| 178 |
.TP |
| 179 |
.B Gnumeric_plan_perfect:pln |
| 180 |
PlanPerfect Format (PLN) |
| 181 |
.TP |
| 182 |
.B Gnumeric_psiconv:psiconv |
| 183 |
Psion (*.psisheet) |
| 184 |
.TP |
| 185 |
.B Gnumeric_sc:sc |
| 186 |
SC/xspread |
| 187 |
.TP |
| 188 |
.B Gnumeric_xbase:xbase |
| 189 |
.URL "http://en.wikipedia.org/wiki/XBase" "xBase" |
| 190 |
(*.dbf) file format |
| 191 |
|
| 192 |
.SH LIST OF IMPORTANT EXPORTER IDS |
| 193 |
.TP |
| 194 |
.B Gnumeric_OpenCalc:odf |
| 195 |
ODF/OpenOffice with foreign elements (*.ods) |
| 196 |
.TP |
| 197 |
.B Gnumeric_glpk:glpk |
| 198 |
GLPK Linear Program Solver |
| 199 |
.TP |
| 200 |
.B Gnumeric_html:html40 |
| 201 |
HTML 4.0 (*.html) |
| 202 |
.TP |
| 203 |
.B Gnumeric_html:html40frag |
| 204 |
HTML (*.html) fragment |
| 205 |
.TP |
| 206 |
.B Gnumeric_html:xhtml |
| 207 |
XHTML (*.html) |
| 208 |
.TP |
| 209 |
.B Gnumeric_html:xhtml_range |
| 210 |
XHTML range - for export to clipboard |
| 211 |
.TP |
| 212 |
.B Gnumeric_pdf:pdf_assistant |
| 213 |
Portable Document Format (*.PDF) |
| 214 |
.TP |
| 215 |
.B Gnumeric_stf:stf_csv |
| 216 |
Comma separated values (CSV) |
| 217 |
.TP |
| 218 |
.B Gnumeric_Excel:excel_dsf |
| 219 |
Microsoft Excel (tm) 97/2000/XP & 5.0/95 |
| 220 |
|
| 221 |
.SH LIST OF OTHER EXPORTER IDS |
| 222 |
.TP |
| 223 |
.B Gnumeric_Excel:excel_biff7 |
| 224 |
Microsoft Excel (tm) 5.0/95 |
| 225 |
.TP |
| 226 |
.B Gnumeric_Excel:excel_biff8 |
| 227 |
Microsoft S Excel (tm) 97/2000/XP |
| 228 |
.TP |
| 229 |
.B Gnumeric_GnomeGlossary:po |
| 230 |
Gnome Glossary PO file format |
| 231 |
.TP |
| 232 |
.B Gnumeric_html:html32 |
| 233 |
HTML 3.2 (*.html) |
| 234 |
.TP |
| 235 |
.B Gnumeric_html:latex |
| 236 |
LaTeX 2e (*.tex) |
| 237 |
.TP |
| 238 |
.B Gnumeric_html:latex_table |
| 239 |
LaTeX 2e (*.tex) table fragment |
| 240 |
.TP |
| 241 |
.B Gnumeric_html:roff |
| 242 |
.URL "http://en.wikipedia.org/wiki/Troff" "TROFF" |
| 243 |
(*.me) format. |
| 244 |
.TP |
| 245 |
.B Gnumeric_lpsolve:lpsolve |
| 246 |
.URL "http://sourceforge.net/projects/lpsolve/" "LPSolve" |
| 247 |
Mixed Integer Linear Programming (MILP) solver |
| 248 |
|
| 249 |
.SH OPTIONS FOR THE PORTABLE DOCUMENT FORMAT (*.pdf) EXPORTER |
| 250 |
|
| 251 |
.TP |
| 252 |
.B sheet |
| 253 |
Name of the workbook sheet to operate on. |
| 254 |
You can specify several sheets by repeating this option. |
| 255 |
This is ignored if the \fBobject\fR option is given. |
| 256 |
|
| 257 |
.TP |
| 258 |
.B active-sheet |
| 259 |
Select the active sheet to operate on. The value for this option is |
| 260 |
irrelevant, but the equal sign is mandatory. |
| 261 |
|
| 262 |
.TP |
| 263 |
.B object |
| 264 |
Name of the sheet object to print. If this option is given any \fBsheet\fR option is ignored. |
| 265 |
Only the first \fBobject\fR given is exported. |
| 266 |
|
| 267 |
.TP |
| 268 |
.B paper |
| 269 |
Paper size. Valid values include "\fBA4\fR" for ISO A4 and |
| 270 |
"\fBna_letter_8.5x11in\fR" for US Letter. If an individual graph is specified through the |
| 271 |
\fBobject\fR option, then a paper size of "\fBfit\fR" reduces the size of the paper to the |
| 272 |
size of the graph. |
| 273 |
.\" FIXME Is there a convenient way to list all valid paper sizes? |
| 274 |
.\" It looks like at least the values from plugins/excel/ms-excel-read.c's |
| 275 |
.\" paper_size_table[] are supported. |
| 276 |
|
| 277 |
.SH OPTIONS FOR THE CONFIGURABLE TEXT (*.txt) EXPORTER |
| 278 |
.\" Cf. "g_object_class_install_property" calls in src/stf-export.c |
| 279 |
|
| 280 |
.TP |
| 281 |
.B sheet |
| 282 |
Name of the workbook sheet to operate on. |
| 283 |
You can specify several sheets by repeating this option. |
| 284 |
|
| 285 |
.TP |
| 286 |
.B active-sheet |
| 287 |
Select the active sheet to operate on. The value for this option is |
| 288 |
irrelevant, but the equal sign is mandatory. |
| 289 |
|
| 290 |
.TP |
| 291 |
.B eol |
| 292 |
End Of Line convention; how lines are terminated. |
| 293 |
"\fBunix\fR" for linefeed, |
| 294 |
"\fBmac\fR" for carriage return; |
| 295 |
"\fBwindows\fR" for carriage return plus linefeed. |
| 296 |
|
| 297 |
.TP |
| 298 |
.B charset |
| 299 |
The character encoding of the output. Defaults to UTF-8. |
| 300 |
|
| 301 |
.TP |
| 302 |
.B locale |
| 303 |
The locale to use for number and date formatting. |
| 304 |
Defaults to the current locale as reported by \fBlocale\fR(1). |
| 305 |
Consult \fBlocale \-a\fR output for acceptable values. |
| 306 |
|
| 307 |
.TP |
| 308 |
.B quote |
| 309 |
The character or string used for quoting fields. Defaults to "\fB\\"\fR" |
| 310 |
(quotation mark / double quote). |
| 311 |
|
| 312 |
.TP |
| 313 |
.B separator |
| 314 |
The string used to separate fields. Defaults to space. |
| 315 |
|
| 316 |
.TP |
| 317 |
.B format |
| 318 |
How cells should be formatted. |
| 319 |
Acceptable values: |
| 320 |
"\fBautomatic\fR" (apply automatic formatting; default), |
| 321 |
"\fBraw\fR" (output data raw, unformatted), or |
| 322 |
"\fBpreserve\fR" (preserve the formatting from the source document). |
| 323 |
|
| 324 |
This deals with the difference between a cell's contents and the way those |
| 325 |
contents are formatted. |
| 326 |
|
| 327 |
Consider a cell in a Gnumeric input document that was |
| 328 |
input as "4/19/73" in a US locale, with a format set to "d-mmm-yyyy" and |
| 329 |
thus formatted as "19-Apr-1973". |
| 330 |
|
| 331 |
With the default \fBformat\fR setting of "\fBautomatic\fR" it will be output |
| 332 |
as "1973/04/19". With "\fBpreserve\fR", the formatting will be preserved and |
| 333 |
it will be output as "19-Apr-1973". With "\fBraw\fR" it will be output as |
| 334 |
"26773" (Gnumeric's internal representation: days since an epoch). |
| 335 |
|
| 336 |
.TP |
| 337 |
.B transliterate-mode |
| 338 |
How to handle unrepresentable characters (characters that cannot be |
| 339 |
represented in the chosen output character set). |
| 340 |
Acceptable values: |
| 341 |
"\fBtransliterate\fR", or |
| 342 |
"\fBescape\fR". |
| 343 |
|
| 344 |
.TP |
| 345 |
.B quoting-mode |
| 346 |
When does data need to be quoted? |
| 347 |
"\fBnever\fR", |
| 348 |
"\fBauto\fR" (puts quotes where needed), or |
| 349 |
"\fBalways\fR". Defaults to "\fBauto\fR". |
| 350 |
|
| 351 |
.TP |
| 352 |
.B quoting-on-whitespace |
| 353 |
Controls whether initial or terminal whitespace forces quoting. Defaults to |
| 354 |
\fBTRUE\fR. |
| 355 |
|
| 356 |
|
| 357 |
.\".SH EXIT STATUS |
| 358 |
.\".SH RETURN VALUE |
| 359 |
.\".SH ERRORS |
| 360 |
.\".SH ENVIRONMENT |
| 361 |
.\".SH FILES |
| 362 |
.\".SH VERSIONS |
| 363 |
.\".SH CONFORMING TO |
| 364 |
.\".SH NOTES |
| 365 |
.\".SH BUGS |
| 366 |
.\".SH USAGE |
| 367 |
.SH EXAMPLE |
| 368 |
To convert the Gnumeric file \fIfoo.gnumeric\fR to a Microsoft Excel(TM) |
| 369 |
format file |
| 370 |
\fIfoo.xls\fR: |
| 371 |
.PP |
| 372 |
\fBssconvert\fR \fIfoo.gnumeric\fR \fIfoo.xls\fR |
| 373 |
.PP |
| 374 |
The export format can be specified explicitly, to override the default |
| 375 |
(which is based on the file extension): |
| 376 |
.PP |
| 377 |
\fBssconvert\fR \fB\-\-export\-type=\fRGnumeric_stf:stf_csv\fR \fIfoo.xls\fR |
| 378 |
\fIfoo.txt\fR |
| 379 |
.PP |
| 380 |
To convert an Excel format file \fIstatfuns.xls\fR to a text file, |
| 381 |
specifying the semicolon as the separator character: |
| 382 |
.PP |
| 383 |
\fBssconvert\fR \fB-O 'separator=; format=raw'\fR \fIsamples/excel/statfuns.xls\fR \fIstatfuns.txt\fR |
| 384 |
.PP |
| 385 |
To export the charts from the input file \fIinput.gnumeric\fR to numbered |
| 386 |
SVG files: |
| 387 |
.PP |
| 388 |
\fBssconvert\fR \fB\-\-export\-graphs\fR \fIinput.gnumeric\fR \fI'output.%n.svg'\fR |
| 389 |
.PP |
| 390 |
To export the charts from the input file \fIinput.gnumeric\fR to numbered |
| 391 |
PNG files: |
| 392 |
.PP |
| 393 |
\fBssconvert\fR \fB\-\-export\-type=png\fR \fB\-\-export\-graphs\fR \fIinput.gnumeric\fR \fI'output.%n.png'\fR |
| 394 |
.PP |
| 395 |
|
| 396 |
.SH LICENSE |
| 397 |
|
| 398 |
\fBssconvert\fR is licensed under the terms of the General Public |
| 399 |
License (GPL), version 2 or 3. For information on this license look at the |
| 400 |
source code that came with the software or see the |
| 401 |
.URL "http://www.gnu.org" "GNU project page" . |
| 402 |
|
| 403 |
.SH COPYRIGHT |
| 404 |
|
| 405 |
The copyright on the \fBGnumeric\fR software and source code is held |
| 406 |
by the individual authors as is documented in the source code. |
| 407 |
|
| 408 |
.SH AUTHOR |
| 409 |
|
| 410 |
\fBssconvert\fR's primary author is Jody Goldberg <[email protected]>; |
| 411 |
\fBssconvert\fR builds on the \fBGnumeric\fR codebase. |
| 412 |
|
| 413 |
The initial version of this manpage was written by J.H.M. Dassen (Ray) |
| 414 |
<[email protected]>. |
| 415 |
|
| 416 |
.SH SEE ALSO |
| 417 |
.BR gnumeric(1), |
| 418 |
.BR ssdiff(1), |
| 419 |
.BR ssgrep(1), |
| 420 |
.BR ssindex(1) |
| 421 |
|
| 422 |
.URL "http://www.gnome.org/projects/gnumeric/" "The Gnumeric Homepage" . |
| 423 |
|
| 424 |
.URL "http://www.gnome.org/" "The GNOME project page" . |