1UNOCONV(1) UNOCONV(1)
2
6 unoconv - convert any document from and to any LibreOffice supported
7 format
8
10 unoconv [options] file [file2 ..]
11 unoconv --listener [--server SRV] [--port PRT] [--connection CON]
13
15 unoconv is a command line utility that can convert any file format that
16 LibreOffice can import, to any file format that LibreOffice is capable
17 of exporting.
18 unoconv uses the LibreOffice’s UNO bindings for non-interactive
20 conversion of documents and therefore needs an LibreOffice instance to
21 communicate with. Therefore if it cannot find one, it will start its
22 own instance for temporary usage. If desired, one can start a
23 “listener” instance to use for subsequent connections or even for
24 remote connections.
25
27 -c, --connection
28 UNO connection string to be used by the client to connect to an
29 LibreOffice instance, or used by the listener to make LibreOffice
30 listen.
31 Default connection string is "socket,host=localhost,port=2002;urp;StarOffice.ComponentContext"
33 -d, --doctype
35 Specify the LibreOffice document type of the backend format.
36 Possible document types are: document, graphics, presentation,
37 spreadsheet.
38 Default document type is 'document'.
40 -e, --export
42 Set specific export filter options (related to the used LibreOffice
43 filter).
44 eg. for the PDF output filter one can specify: -e PageRange=1-2
46 See the *EXPORT FILTERS* section.
48 -f, --format
50 Specify the output format for the document. You can get a list of
51 possible output formats per document type by using the --show
52 option.
53 Default document type is 'pdf'.
55 -F, --field
57 Add or replace user-defined text field with value
58 eg. -F Client_Name="Oracle"
60 -i, --import
62 Set specific import filters options (related to the used
63 LibreOffice import filter based on the input filename).
64 See the *IMPORT FILTERS* section.
66 -I, --input-filter-name
68 Specify the input filter name, used when the file ending doesn’t
69 match the file type.
70 eg -I odt
72 -l, --listener
74 Start unoconv as listener for unoconv clients to connect to.
75 -M, --meta
77 Add or replace document metadata with value
78 eg. -M Author="Dag Wieers"
80 -n, --no-launch
82 By default if no listener is running, unoconv will launch its own
83 (temporary) listener to make sure the conversion works. This option
84 will abort the conversion if no listener is found, rather than
85 starting our own listener.
86 -o, --output
88 If the argument is a directory, put the converted documents in this
89 directory. If multiple input files are provided, use it as a
90 basename (and add output extension). Otherwise use it as the output
91 filename.
92 --password
94 Provide a password to decrypt the document
95 --pipe
97 Use a pipe as an alternative connection mechanism to talk to
98 LibreOffice.
99 -p, --port
101 Port to listen on (as listener) or to connect to (as client).
102 Default port is '2002'.
104 --preserve
106 Keep timestamp and permissions of the original document
107 -s, --server
109 Server (address) to listen on (as listener) or to connect to (as
110 client).
111 Default server is 'localhost'.
113 --show
115 List the possible output formats to be used with -f.
116 --stdin
118 Read input file from stdin (filenames are ignored if provided)
119 --stdout
121 Print converted output file to stdout.
122 -t, --template
124 Specify the template to use for importing styles from. This can be
125 very useful if you have a corporate identity you have to apply to
126 every document you distribute.
127 -T, --timeout
129 When unoconv starts its own listener, try to connect to it for an
130 amount of seconds before giving up. Increasing this may help when
131 you receive random errors caused by the listener not being ready to
132 accept conversion jobs.
133 -v, --verbose
135 Be more and more and more verbose.
136
138 You can provide one or more files as arguments to convert each of them
139 to the specified output format.
140
142 Depending on the used input file, a different LibreOffice import filter
143 is automatically used by unoconv. This import filter can be influenced
144 by the -i option that, depending on the filter used, accepts different
145 arguments.
146 It is not always clear what import filter options you can provide, the
148 import dialog in LibreOffice for the filter you ar using might give a
149 good indication as to what you can expect as import filter options.
150 The reference is LibreOffice’s documentation, for spreadsheets it is
152 described at:
153 http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Filter_Options
154 but we will look into some examples.
155
157 The default import filter for many imports (eg. Lotus, dBase or DIF)
158 accepts as the only argument the input encoding-type, so if you require
159 utf-8 (76) you can do:
160 -i FilterOptions=76
162 For a list of possible encoding types, you can use the above link to
164 find the possible options.
165 · FilterOptions
167
169 The Text import filter accepts a FilterOptions setting holding the
170 input encoding.
171 · FilterOptions
173
175 The CSV import filter accepts a FilterOptions setting, the order is:
176 separator(s),text-delimiter,encoding,first-row,column-format
177 For example you might want to use this for a real comma-separated
179 document:
180 -i FilterOptions=44,34,76,2,1/5/2/1/3/1/4/1
182 which will use a comma (44) as the field separator, a double quote (34)
184 as the text delimiter, UTF-8 (76) for the input encoding, start from
185 the second row and use the specified formats for each column (1 means
186 standard, 5 means YY/MM/DD date)
187 If you like to use more than one separator (say a space or a tab) and
189 use the system’s encoding (9), but with no text-delimiter, you can do:
190 -i FilterOptions=9/32,,9,2
192 For a list of possible encoding types, you can use the above link to
194 find the possible options.
195 · FilterOptions
197
199 In contrast to import filters, export filters can have multiple named
200 options, although it is not always clear what options are available. It
201 all depends on the version of LibreOffice. The export dialog you get in
202 LibreOffice might give you a clue about what is possible, each of those
203 widgets represents an option.
204
206 The Text export filter accepts a FilterOptions setting holding the
207 output encoding.
208 · FilterOptions
210 The order of the arguments is:
212 encoding,field-seperator,text-delimiter,quote-all-text-cells,save-cell-content-as-shown
213
215 The CSV export filter accepts various arguments, the order is:
216 field-seperator(s),text-delimiter,encoding
217 For example you might want to use this for a real comma-separated
219 document:
220 -e FilterOptions=44,34,76
222 which will use a comma (44) as the field separator, a double quote (34)
224 as the text delimiter, UTF-8 (76) for the export encoding, start from
225 the second row and use the specified formats for each column (1 means
226 standard, 5 means YY/MM/DD date)
227 If you like to use more than one separator (say a space or a tab) and
229 use the system’s encoding (9), but with no text-delimiter, you can do:
230 -e FilterOptions=9/32,,9
232 For a list of possible encoding types, you can use the above link to
234 find the possible options.
235 · FilterOptions
237
239 The PDF export filter is likely the most advanced export filter in its
240 kind with a myriad of options one can use. The export filter options
241 are described in a separate document, or on LibreOffice’s wiki at:
242 http://wiki.services.openoffice.org/wiki/API/Tutorials/PDF_export
244 For example one can specify: -e PageRange=1-2
246 Here is a list of all options, however for more details please look in
248 filters.txt:
249 · AllowDuplicateFieldNames
251 · CenterWindow
253 · Changes
255 · ConvertOOoTargetToPDFTarget
257 · DisplayPDFDocumentTitle
259 · DocumentOpenPassword
261 · EmbedStandardFonts
263 · EnableCopyingOfContent
265 · EnableTextAccessForAccessibilityTools
267 · EncryptFile
269 · ExportBookmarks
271 · ExportBookmarksToPDFDestination
273 · ExportFormFields
275 · ExportLinksRelativeFsys
277 · ExportNotes
279 · ExportNotesPages
281 · FirstPageOnLeft
283 · FormsType
285 · HideViewerMenubar
287 · HideViewerToolbar
289 · HideViewerWindowControls
291 · InitialPage
293 · InitialView
295 · IsAddStream
297 · IsSkipEmptyPages
299 · Magnification
301 · MaxImageResolution
303 · OpenBookmarkLevels
305 · OpenInFullScreenMode
307 · PageLayout
309 · PageRange
311 · PDFViewSelection
313 · PermissionPassword
315 · Printing
317 · Quality
319 · ReduceImageResolution
321 · ResizeWindowToInitialPage
323 · RestrictPermissionPassword
325 · Selection
327 · SelectPdfVersion
329 · UseLosslessCompression
331 · UseTaggedPDF
333 · UseTransitionEffects
335 · Watermark
337 · Zoom
339 GRAPHICS EXPORT FILTER OPTIONS
341 · Height
342 · Resolution
344 · Width
346 BMP EXPORT FILTER OPTIONS
348 · Compression
349 · RLEEncoding
351 JPEG EXPORT FILTER OPTIONS
353 · ColorDepth
354 · Quality
356 PBM/PGM/PPM EXPORT FILTER OPTIONS
358 · Encoding
359 PNG EXPORT FILTER OPTIONS
361 · Compression
362 · InterlacedMode
364 GIF EXPORT FILTER OPTIONS
366 · InterlacedMode
367 · Transparency
369 EPS EXPORT FILTER OPTIONS
371 · ColorFormat
372 · Compression
374 · Preview
376 · Version
378
380 You can use unoconv in standalone mode, this means that in absence of
381 an LibreOffice listener, it will starts its own:
382 unoconv -f pdf some-document.odt
384 One can use unoconv as a listener (by default localhost:2002) to let
386 other unoconv instances connect to it:
387 unoconv --listener &
389 unoconv -f pdf some-document.odt
390 unoconv -f doc other-document.odt
391 unoconv -f jpg some-image.png
392 unoconv -f xsl some-spreadsheet.csv
393 kill -15 %-
394 This also works on a remote host:
396 unoconv --listener --server 1.2.3.4 --port 4567
398 and then connect another system to convert documents:
400 unoconv --server 1.2.3.4 --port 4567
402
404 UNO_PATH
405 specifies what LibreOffice pyuno installation unoconv needs to use
406 eg. /opt/libreoffice3.4/basis-link/program
407
409 Normally, the exit status is 0 if the conversion ran successful. If an
410 error has occured, the return code is most likely an error returned by
411 LibreOffice (or its interface, called UNO) however, the error never
412 translates to something meaningful. In case you like to decipher the
413 LibreOffice errCode, look at:
414 http://cgit.freedesktop.org/libreoffice/core/tree/tools/inc/tools/errcode.hxx
416 http://cgit.freedesktop.org/libreoffice/core/tree/svtools/inc/svtools/sfxecode.hxx
417 http://cgit.freedesktop.org/libreoffice/core/tree/svtools/inc/svtools/soerr.hxx
418 Using the above lists, the error code 2074 means:
420 Class: 1 (ERRCODE_CLASS_ABORT)
422 Code: 26 (ERRCODE_IO_INVALIDPARAMETER or SVSTREAM_INVALID_PARAMETER)
423 And the error code 3088 means:
425 Class: 3 (ERRCODE_CLASS_NOTEXISTS)
427 Code: 16 (ERRCODE_IO_CANTWRITE)
428
430 convert(1), file(1), odt2txt
431
433 unoconv uses the UNO bindings to connect to LibreOffice, in absence of
434 a usable socket, it will start its own LibreOffice instance with the
435 correct parameters.
436 Note
438 Please see the TODO file for known bugs and future plans.
439
441 unoconv is very useful together with the following tools:
442 Asciidoc
444 http://www.methods.co.nz/asciidoc/
445 asciidoc-odf
447 http://github.com/dagwieers/asciidoc-odf
448 docbook2odf
450 http://open.comsultia.com/docbook2odf/
451 A list of possible import and export formats is available from:
453 OpenOffice 2.1
455 http://wiki.services.openoffice.org/wiki/Framework/Article/Filter/FilterList_OOo_2_1
456 OpenOffice 3.0
458 http://wiki.services.openoffice.org/wiki/Framework/Article/Filter/FilterList_OOo_3_0
459
461 Written by Dag Wieers, <dag@wieers.com[1]>
462
464 Main web site: http://dag.wieers.com/home-made/unoconv/
465
467 Copyright (C) 2007 Dag Wieers. Free use of this software is granted
468 under the terms of the GNU General Public License (GPL).
469
471 Dag Wieers <dag@wieers.com>
472 Author.
473
475 1. dag@wieers.com
476 mailto:dag@wieers.com
477 0.4 20 october 2010 UNOCONV(1)