/usr/share/doc/unoconv/unoconv.1.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.9" />
<title>unoconv(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */

/* Default font. */
body {
  font-family: Georgia,serif;
}

/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
  font-family: Arial,Helvetica,sans-serif;
}

body {
  margin: 1em 5% 1em 5%;
}

a {
  color: blue;
  text-decoration: underline;
}
a:visited {
  color: fuchsia;
}

em {
  font-style: italic;
  color: navy;
}

strong {
  font-weight: bold;
  color: #083194;
}

h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
}

h1, h2, h3 {
  border-bottom: 2px solid silver;
}
h2 {
  padding-top: 0.5em;
}
h3 {
  float: left;
}
h3 + * {
  clear: left;
}
h5 {
  font-size: 1.0em;
}

div.sectionbody {
  margin-left: 0;
}

hr {
  border: 1px solid silver;
}

p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
}

ul, ol, li > p {
  margin-top: 0;
}
ul > li     { color: #aaa; }
ul > li > * { color: black; }

.monospaced, code, pre {
  font-family: "Courier New", Courier, monospace;
  font-size: inherit;
  color: navy;
  padding: 0;
  margin: 0;
}
pre {
  white-space: pre-wrap;
}

#author {
  color: #527bbd;
  font-weight: bold;
  font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}

#footer {
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
}
#footer-text {
  float: left;
  padding-bottom: 0.5em;
}
#footer-badges {
  float: right;
  padding-bottom: 0.5em;
}

#preamble {
  margin-top: 1.5em;
  margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.0em;
  margin-bottom: 2.0em;
  margin-right: 10%;
  color: #606060;
}

div.content { /* Block element content. */
  padding: 0;
}

/* Block element titles. */
div.title, caption.title {
  color: #527bbd;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
}
div.title + * {
  margin-top: 0;
}

td div.title:first-child {
  margin-top: 0.0em;
}
div.content div.title:first-child {
  margin-top: 0.0em;
}
div.content + div.title {
  margin-top: 0.0em;
}

div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid #dddddd;
  border-left: 4px solid #f0f0f0;
  padding: 0.5em;
}

div.listingblock > div.content {
  border: 1px solid #dddddd;
  border-left: 5px solid #f0f0f0;
  background: #f8f8f8;
  padding: 0.5em;
}

div.quoteblock, div.verseblock {
  padding-left: 1.0em;
  margin-left: 1.0em;
  margin-right: 10%;
  border-left: 5px solid #f0f0f0;
  color: #888;
}

div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock > pre.content {
  font-family: inherit;
  font-size: inherit;
}
div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
  text-align: left;
}

div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
}
div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 3px solid #dddddd;
}

div.exampleblock > div.content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }

dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
  color: navy;
}
dd > *:first-child {
  margin-top: 0.1em;
}

ul, ol {
    list-style-position: outside;
}
ol.arabic {
  list-style-type: decimal;
}
ol.loweralpha {
  list-style-type: lower-alpha;
}
ol.upperalpha {
  list-style-type: upper-alpha;
}
ol.lowerroman {
  list-style-type: lower-roman;
}
ol.upperroman {
  list-style-type: upper-roman;
}

div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
  margin-top: 0.1em;
  margin-bottom: 0.1em;
}

tfoot {
  font-weight: bold;
}
td > div.verse {
  white-space: pre;
}

div.hdlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
div.hdlist tr {
  padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
  font-weight: bold;
}
td.hdlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
  color: navy;
}
td.hdlist2 {
  vertical-align: top;
}
div.hdlist.compact tr {
  margin: 0;
  padding-bottom: 0;
}

.comment {
  background: yellow;
}

.footnote, .footnoteref {
  font-size: 0.8em;
}

span.footnote, span.footnoteref {
  vertical-align: super;
}

#footnotes {
  margin: 20px 0 20px 0;
  padding: 7px 0 0 0;
}

#footnotes div.footnote {
  margin: 0 0 5px 0;
}

#footnotes hr {
  border: none;
  border-top: 1px solid silver;
  height: 1px;
  text-align: left;
  margin-left: 0;
  width: 20%;
  min-width: 100px;
}

div.colist td {
  padding-right: 0.5em;
  padding-bottom: 0.3em;
  vertical-align: top;
}
div.colist td img {
  margin-top: 0.3em;
}

@media print {
  #footer-badges { display: none; }
}

#toc {
  margin-bottom: 2.5em;
}

#toctitle {
  color: #527bbd;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
}

div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
}
div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
}
div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
}
div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
}

span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }

span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }

span.big { font-size: 2em; }
span.small { font-size: 0.6em; }

span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }

div.unbreakable { page-break-inside: avoid; }


/*
 * xhtml11 specific
 *
 * */

div.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.tableblock > table {
  border: 3px solid #527bbd;
}
thead, p.table.header {
  font-weight: bold;
  color: #527bbd;
}
p.table {
  margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
  border-style: none;
}
div.tableblock > table[frame="hsides"] {
  border-left-style: none;
  border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
  border-top-style: none;
  border-bottom-style: none;
}


/*
 * html5 specific
 *
 * */

table.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
thead, p.tableblock.header {
  font-weight: bold;
  color: #527bbd;
}
p.tableblock {
  margin-top: 0;
}
table.tableblock {
  border-width: 3px;
  border-spacing: 0px;
  border-style: solid;
  border-color: #527bbd;
  border-collapse: collapse;
}
th.tableblock, td.tableblock {
  border-width: 1px;
  padding: 4px;
  border-style: solid;
  border-color: #527bbd;
}

table.tableblock.frame-topbot {
  border-left-style: hidden;
  border-right-style: hidden;
}
table.tableblock.frame-sides {
  border-top-style: hidden;
  border-bottom-style: hidden;
}
table.tableblock.frame-none {
  border-style: hidden;
}

th.tableblock.halign-left, td.tableblock.halign-left {
  text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
  text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
  text-align: right;
}

th.tableblock.valign-top, td.tableblock.valign-top {
  vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
  vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
  vertical-align: bottom;
}


/*
 * manpage specific
 *
 * */

body.manpage h1 {
  padding-top: 0.5em;
  padding-bottom: 0.5em;
  border-top: 2px solid silver;
  border-bottom: 2px solid silver;
}
body.manpage h2 {
  border-style: none;
}
body.manpage div.sectionbody {
  margin-left: 3em;
}

@media print {
  body.manpage div#toc { display: none; }
}


</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = {  // Namespace.

/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////

/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

 /* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, 2006, 2009. License: GPL */

// toclevels = 1..4.
toc: function (toclevels) {

  function getText(el) {
    var text = "";
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
        text += i.data;
      else if (i.firstChild != null)
        text += getText(i);
    }
    return text;
  }

  function TocEntry(el, text, toclevel) {
    this.element = el;
    this.text = text;
    this.toclevel = toclevel;
  }

  function tocEntries(el, toclevels) {
    var result = new Array;
    var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
    // Function that scans the DOM tree for header elements (the DOM2
    // nodeIterator API would be a better technique but not supported by all
    // browsers).
    var iterate = function (el) {
      for (var i = el.firstChild; i != null; i = i.nextSibling) {
        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
          var mo = re.exec(i.tagName);
          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
          }
          iterate(i);
        }
      }
    }
    iterate(el);
    return result;
  }

  var toc = document.getElementById("toc");
  if (!toc) {
    return;
  }

  // Delete existing TOC entries in case we're reloading the TOC.
  var tocEntriesToRemove = [];
  var i;
  for (i = 0; i < toc.childNodes.length; i++) {
    var entry = toc.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div'
     && entry.getAttribute("class")
     && entry.getAttribute("class").match(/^toclevel/))
      tocEntriesToRemove.push(entry);
  }
  for (i = 0; i < tocEntriesToRemove.length; i++) {
    toc.removeChild(tocEntriesToRemove[i]);
  }

  // Rebuild TOC entries.
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "_toc_" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    toc.parentNode.removeChild(toc);
},


/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////

/* Based on footnote generation code from:
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 */

footnotes: function () {
  // Delete existing footnote entries in case we're reloading the footnodes.
  var i;
  var noteholder = document.getElementById("footnotes");
  if (!noteholder) {
    return;
  }
  var entriesToRemove = [];
  for (i = 0; i < noteholder.childNodes.length; i++) {
    var entry = noteholder.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
      entriesToRemove.push(entry);
  }
  for (i = 0; i < entriesToRemove.length; i++) {
    noteholder.removeChild(entriesToRemove[i]);
  }

  // Rebuild footnote entries.
  var cont = document.getElementById("content");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
    if (spans[i].className == "footnote") {
      n++;
      var note = spans[i].getAttribute("data-note");
      if (!note) {
        // Use [\s\S] in place of . so multi-line matches work.
        // Because JavaScript has no s (dotall) regex flag.
        note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
        spans[i].innerHTML =
          "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
        spans[i].setAttribute("data-note", note);
      }
      noteholder.innerHTML +=
        "<div class='footnote' id='_footnote_" + n + "'>" +
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
        n + "</a>. " + note + "</div>";
      var id =spans[i].getAttribute("id");
      if (id != null) refs["#"+id] = n;
    }
  }
  if (n == 0)
    noteholder.parentNode.removeChild(noteholder);
  else {
    // Process footnoterefs.
    for (i=0; i<spans.length; i++) {
      if (spans[i].className == "footnoteref") {
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
        href = href.match(/#.*/)[0];  // Because IE return full URL.
        n = refs[href];
        spans[i].innerHTML =
          "[<a href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
      }
    }
  }
},

install: function(toclevels) {
  var timerId;

  function reinstall() {
    asciidoc.footnotes();
    if (toclevels) {
      asciidoc.toc(toclevels);
    }
  }

  function reinstallAndRemoveTimer() {
    clearInterval(timerId);
    reinstall();
  }

  timerId = setInterval(reinstall, 500);
  if (document.addEventListener)
    document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
  else
    window.onload = reinstallAndRemoveTimer;
}

}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="manpage">
<div id="header">
<h1>
unoconv(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>unoconv -
   convert any document from and to any LibreOffice supported format
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p><em>unoconv</em> [options] file [file2 ..]</p></div>
<div class="paragraph"><p><em>unoconv</em> --listener [--server SRV] [--port PRT] [--connection CON]</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>unoconv is a command line utility that can convert any file format that
LibreOffice can import, to any file format that LibreOffice is capable of
exporting.</p></div>
<div class="paragraph"><p>unoconv uses the LibreOffice&#8217;s UNO bindings for non-interactive conversion
of documents and therefore needs an LibreOffice instance to communicate with.
Therefore if it cannot find one, it will start its own instance for temporary
usage. If desired, one can start a &#8220;listener&#8221; instance to use for subsequent
connections or even for remote connections.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
-c, --connection
</dt>
<dd>
<p>
    UNO connection string to be used by the client to connect to an
    LibreOffice instance, or used by the listener to make LibreOffice
    listen.
</p>
<div class="literalblock">
<div class="content">
<pre><code>Default connection string is "socket,host=localhost,port=2002;urp;StarOffice.ComponentContext"</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
-d, --doctype
</dt>
<dd>
<p>
    Specify the LibreOffice document type of the backend format. Possible
    document types are: <em>document</em>, <em>graphics</em>, <em>presentation</em>,
    <em>spreadsheet</em>.
</p>
<div class="literalblock">
<div class="content">
<pre><code>Default document type is 'document'.</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
-e, --export
</dt>
<dd>
<p>
    Set specific export filter options (related to the used LibreOffice filter).
</p>
<div class="literalblock">
<div class="content">
<pre><code>eg. for the PDF output filter one can specify: -e PageRange=1-2</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>See the *EXPORT FILTERS* section.</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
-f, --format
</dt>
<dd>
<p>
    Specify the output format for the document. You can get a list of
    possible output formats per document type by using the <code>--show</code> option.
</p>
<div class="literalblock">
<div class="content">
<pre><code>Default document type is 'pdf'.</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
-F, --field
</dt>
<dd>
<p>
    Replace user-defined text field with value
</p>
<div class="literalblock">
<div class="content">
<pre><code>eg. -F Client_Name="Oracle"</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
-i, --import
</dt>
<dd>
<p>
    Set specific import filters options (related to the used LibreOffice
    import filter based on the input filename).
</p>
<div class="literalblock">
<div class="content">
<pre><code>See the *IMPORT FILTERS* section.</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
-l, --listener
</dt>
<dd>
<p>
    Start unoconv as listener for unoconv clients to connect to.
</p>
</dd>
<dt class="hdlist1">
-n, --no-launch
</dt>
<dd>
<p>
    By default if no listener is running, unoconv will launch its own
    (temporary) listener to make sure the conversion works. This option
    will abort the conversion if no listener is found, rather than starting
    our own listener.
</p>
</dd>
<dt class="hdlist1">
-o, --output
</dt>
<dd>
<p>
    If the argument is a directory, put the converted documents in this
    directory. If multiple input files are provided, use it as a
    basename (and add output extension). Otherwise use it as the
    output filename.
</p>
</dd>
<dt class="hdlist1">
--password
</dt>
<dd>
<p>
    Provide a password to decrypt the document
</p>
</dd>
<dt class="hdlist1">
--pipe
</dt>
<dd>
<p>
    Use a pipe as an alternative connection mechanism to talk to LibreOffice.
</p>
</dd>
<dt class="hdlist1">
-p, --port
</dt>
<dd>
<p>
    Port to listen on (as listener) or to connect to (as client).
</p>
<div class="literalblock">
<div class="content">
<pre><code>Default port is '2002'.</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
--preserve
</dt>
<dd>
<p>
    Keep timestamp and permissions of the original document
</p>
</dd>
<dt class="hdlist1">
-s, --server
</dt>
<dd>
<p>
    Server (address) to listen on (as listener) or to connect to (as client).
</p>
<div class="literalblock">
<div class="content">
<pre><code>Default server is 'localhost'.</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
--show
</dt>
<dd>
<p>
    List the possible output formats to be used with <code>-f</code>.
</p>
</dd>
<dt class="hdlist1">
--stdin
</dt>
<dd>
<p>
    Read input file from stdin (filenames are ignored if provided)
</p>
</dd>
<dt class="hdlist1">
--stdout
</dt>
<dd>
<p>
    Print converted output file to stdout.
</p>
</dd>
<dt class="hdlist1">
-t, --template
</dt>
<dd>
<p>
    Specify the template to use for importing styles from. This can be very
    useful if you have a corporate identity you have to apply to every
    document you distribute.
</p>
</dd>
<dt class="hdlist1">
-T, --timeout
</dt>
<dd>
<p>
    When unoconv starts its own listener, try to connect to it for an amount
    of seconds before giving up. Increasing this may help when you receive
    random errors caused by the listener not being ready to accept conversion
    jobs.
</p>
</dd>
<dt class="hdlist1">
-v, --verbose
</dt>
<dd>
<p>
    Be more and more and more verbose.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_arguments">ARGUMENTS</h2>
<div class="sectionbody">
<div class="paragraph"><p>You can provide one or more <strong>files</strong> as arguments to convert each of them to
the specified <strong>output format</strong>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_import_filters">IMPORT FILTERS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Depending on the used input file, a different LibreOffice import filter is
automatically used by unoconv. This import filter can be influenced by the
<code>-i</code> option that, depending on the filter used, accepts different arguments.</p></div>
<div class="paragraph"><p>It is not always clear what import filter options you can provide, the import
dialog in LibreOffice for the filter you ar using might give a good indication
as to what you can expect as import filter options.</p></div>
<div class="paragraph"><p>The reference is LibreOffice&#8217;s documentation, for spreadsheets it is described at:
<a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Filter_Options">http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Filter_Options</a>
but we will look into some examples.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_default_import_filter_options">DEFAULT IMPORT FILTER OPTIONS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The default import filter for many imports (eg. Lotus, dBase or DIF) accepts
as the only argument the input encoding-type, so if you require utf-8 (76)
you can do:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>-i FilterOptions=76</code></pre>
</div></div>
<div class="paragraph"><p>For a list of possible encoding types, you can use the above link to find the
possible options.</p></div>
<div class="ulist"><ul>
<li>
<p>
FilterOptions
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_text_import_filter_options">TEXT IMPORT FILTER OPTIONS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The Text import filter accepts a FilterOptions setting holding the input
encoding.</p></div>
<div class="ulist"><ul>
<li>
<p>
FilterOptions
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_csv_import_filter_options">CSV IMPORT FILTER OPTIONS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The CSV import filter accepts a FilterOptions setting, the order is:
<em>separator(s),text-delimiter,encoding,first-row,column-format</em></p></div>
<div class="paragraph"><p>For example you might want to use this for a <em>real</em> comma-separated document:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>-i FilterOptions=44,34,76,2,1/5/2/1/3/1/4/1</code></pre>
</div></div>
<div class="paragraph"><p>which will use a comma (44) as the field separator, a double quote (34) as the
text delimiter, UTF-8 (76) for the input encoding, start from the second row
and use the specified formats for each column (1 means standard, 5 means
YY/MM/DD date)</p></div>
<div class="paragraph"><p>If you like to use more than one separator (say a space or a tab) and use the
system&#8217;s encoding (9), but with no text-delimiter, you can do:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>-i FilterOptions=9/32,,9,2</code></pre>
</div></div>
<div class="paragraph"><p>For a list of possible encoding types, you can use the above link to find the
possible options.</p></div>
<div class="ulist"><ul>
<li>
<p>
FilterOptions
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_export_filters">EXPORT FILTERS</h2>
<div class="sectionbody">
<div class="paragraph"><p>In contrast to import filters, export filters can have multiple named options,
although it is not always clear what options are available. It all depends on
the version of LibreOffice. The export dialog you get in LibreOffice might give
you a clue about what is possible, each of those widgets represents an option.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_text_export_filter_options">TEXT EXPORT FILTER OPTIONS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The Text export filter accepts a FilterOptions setting holding the output
encoding.</p></div>
<div class="ulist"><ul>
<li>
<p>
FilterOptions
</p>
</li>
</ul></div>
<div class="paragraph"><p>The order of the arguments is:
<em>encoding,field-seperator,text-delimiter,quote-all-text-cells,save-cell-content-as-shown</em></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_csv_export_filter_options">CSV EXPORT FILTER OPTIONS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The CSV export filter accepts various arguments, the order is:
<em>field-seperator(s),text-delimiter,encoding</em></p></div>
<div class="paragraph"><p>For example you might want to use this for a <em>real</em> comma-separated document:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>-e FilterOptions=44,34,76</code></pre>
</div></div>
<div class="paragraph"><p>which will use a comma (44) as the field separator, a double quote (34) as the
text delimiter, UTF-8 (76) for the export encoding, start from the second row and
use the specified formats for each column (1 means standard, 5 means YY/MM/DD
date)</p></div>
<div class="paragraph"><p>If you like to use more than one separator (say a space or a tab) and use the
system&#8217;s encoding (9), but with no text-delimiter, you can do:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>-e FilterOptions=9/32,,9</code></pre>
</div></div>
<div class="paragraph"><p>For a list of possible encoding types, you can use the above link to find the
possible options.</p></div>
<div class="ulist"><ul>
<li>
<p>
FilterOptions
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_pdf_export_filter_options">PDF EXPORT FILTER OPTIONS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The PDF export filter is likely the most advanced export filter in its kind
with a myriad of options one can use. The export filter options are described
in a separate document, or on LibreOffice&#8217;s wiki at:</p></div>
<div class="paragraph"><p><a href="http://wiki.services.openoffice.org/wiki/API/Tutorials/PDF_export">http://wiki.services.openoffice.org/wiki/API/Tutorials/PDF_export</a></p></div>
<div class="paragraph"><p>For example one can specify: <code>-e PageRange=1-2</code></p></div>
<div class="paragraph"><p>Here is a list of all options, however for more details please look in
<em>filters.txt</em>:</p></div>
<div class="ulist"><ul>
<li>
<p>
AllowDuplicateFieldNames
</p>
</li>
<li>
<p>
CenterWindow
</p>
</li>
<li>
<p>
Changes
</p>
</li>
<li>
<p>
ConvertOOoTargetToPDFTarget
</p>
</li>
<li>
<p>
DisplayPDFDocumentTitle
</p>
</li>
<li>
<p>
DocumentOpenPassword
</p>
</li>
<li>
<p>
EmbedStandardFonts
</p>
</li>
<li>
<p>
EnableCopyingOfContent
</p>
</li>
<li>
<p>
EnableTextAccessForAccessibilityTools
</p>
</li>
<li>
<p>
EncryptFile
</p>
</li>
<li>
<p>
ExportBookmarks
</p>
</li>
<li>
<p>
ExportBookmarksToPDFDestination
</p>
</li>
<li>
<p>
ExportFormFields
</p>
</li>
<li>
<p>
ExportLinksRelativeFsys
</p>
</li>
<li>
<p>
ExportNotes
</p>
</li>
<li>
<p>
ExportNotesPages
</p>
</li>
<li>
<p>
FirstPageOnLeft
</p>
</li>
<li>
<p>
FormsType
</p>
</li>
<li>
<p>
HideViewerMenubar
</p>
</li>
<li>
<p>
HideViewerToolbar
</p>
</li>
<li>
<p>
HideViewerWindowControls
</p>
</li>
<li>
<p>
InitialPage
</p>
</li>
<li>
<p>
InitialView
</p>
</li>
<li>
<p>
IsAddStream
</p>
</li>
<li>
<p>
IsSkipEmptyPages
</p>
</li>
<li>
<p>
Magnification
</p>
</li>
<li>
<p>
MaxImageResolution
</p>
</li>
<li>
<p>
OpenBookmarkLevels
</p>
</li>
<li>
<p>
OpenInFullScreenMode
</p>
</li>
<li>
<p>
PageLayout
</p>
</li>
<li>
<p>
PageRange
</p>
</li>
<li>
<p>
PDFViewSelection
</p>
</li>
<li>
<p>
PermissionPassword
</p>
</li>
<li>
<p>
Printing
</p>
</li>
<li>
<p>
Quality
</p>
</li>
<li>
<p>
ReduceImageResolution
</p>
</li>
<li>
<p>
ResizeWindowToInitialPage
</p>
</li>
<li>
<p>
RestrictPermissionPassword
</p>
</li>
<li>
<p>
Selection
</p>
</li>
<li>
<p>
SelectPdfVersion
</p>
</li>
<li>
<p>
UseLosslessCompression
</p>
</li>
<li>
<p>
UseTaggedPDF
</p>
</li>
<li>
<p>
UseTransitionEffects
</p>
</li>
<li>
<p>
Watermark
</p>
</li>
<li>
<p>
Zoom
</p>
</li>
</ul></div>
<div class="sect2">
<h3 id="_graphics_export_filter_options">GRAPHICS EXPORT FILTER OPTIONS</h3>
<div class="ulist"><ul>
<li>
<p>
Height
</p>
</li>
<li>
<p>
Resolution
</p>
</li>
<li>
<p>
Width
</p>
</li>
</ul></div>
<div class="sect3">
<h4 id="_bmp_export_filter_options">BMP EXPORT FILTER OPTIONS</h4>
<div class="ulist"><ul>
<li>
<p>
Compression
</p>
</li>
<li>
<p>
RLEEncoding
</p>
</li>
</ul></div>
</div>
<div class="sect3">
<h4 id="_jpeg_export_filter_options">JPEG EXPORT FILTER OPTIONS</h4>
<div class="ulist"><ul>
<li>
<p>
ColorDepth
</p>
</li>
<li>
<p>
Quality
</p>
</li>
</ul></div>
</div>
<div class="sect3">
<h4 id="_pbm_pgm_ppm_export_filter_options">PBM/PGM/PPM EXPORT FILTER OPTIONS</h4>
<div class="ulist"><ul>
<li>
<p>
Encoding
</p>
</li>
</ul></div>
</div>
<div class="sect3">
<h4 id="_png_export_filter_options">PNG EXPORT FILTER OPTIONS</h4>
<div class="ulist"><ul>
<li>
<p>
Compression
</p>
</li>
<li>
<p>
InterlacedMode
</p>
</li>
</ul></div>
</div>
<div class="sect3">
<h4 id="_gif_export_filter_options">GIF EXPORT FILTER OPTIONS</h4>
<div class="ulist"><ul>
<li>
<p>
InterlacedMode
</p>
</li>
<li>
<p>
Transparency
</p>
</li>
</ul></div>
</div>
<div class="sect3">
<h4 id="_eps_export_filter_options">EPS EXPORT FILTER OPTIONS</h4>
<div class="ulist"><ul>
<li>
<p>
ColorFormat
</p>
</li>
<li>
<p>
Compression
</p>
</li>
<li>
<p>
Preview
</p>
</li>
<li>
<p>
Version
</p>
</li>
</ul></div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="paragraph"><p>You can use unoconv in standalone mode, this means that in absence of an
LibreOffice listener, it will starts its own:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>unoconv -f pdf some-document.odt</code></pre>
</div></div>
<div class="paragraph"><p>One can use unoconv as a listener (by default localhost:2002) to let other
unoconv instances connect to it:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>unoconv --listener &amp;
unoconv -f pdf some-document.odt
unoconv -f doc other-document.odt
unoconv -f jpg some-image.png
unoconv -f xsl some-spreadsheet.csv
kill -15 %-</code></pre>
</div></div>
<div class="paragraph"><p>This also works on a remote host:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>unoconv --listener --server 1.2.3.4 --port 4567</code></pre>
</div></div>
<div class="paragraph"><p>and then connect another system to convert documents:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>unoconv --server 1.2.3.4 --port 4567</code></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_environment_variables">ENVIRONMENT VARIABLES</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
UNO_PATH
</dt>
<dd>
<p>
    specifies what LibreOffice pyuno installation unoconv needs to use
    eg. <em>/opt/libreoffice3.4/basis-link/program</em>
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_exit_status">EXIT STATUS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Normally, the exit status is 0 if the conversion ran successful. If an error
has occured, the return code is most likely an error returned by LibreOffice
(or its interface, called UNO) however, the error never translates to something
meaningful. In case you like to decipher the LibreOffice errCode, look at:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>http://cgit.freedesktop.org/libreoffice/core/tree/tools/inc/tools/errcode.hxx
http://cgit.freedesktop.org/libreoffice/core/tree/svtools/inc/svtools/sfxecode.hxx
http://cgit.freedesktop.org/libreoffice/core/tree/svtools/inc/svtools/soerr.hxx</code></pre>
</div></div>
<div class="paragraph"><p>Using the above lists, the error code 2074 means:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>Class: 1 (ERRCODE_CLASS_ABORT)
Code: 26 (ERRCODE_IO_INVALIDPARAMETER or SVSTREAM_INVALID_PARAMETER)</code></pre>
</div></div>
<div class="paragraph"><p>And the error code 3088 means:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>Class: 3 (ERRCODE_CLASS_NOTEXISTS)
Code: 16 (ERRCODE_IO_CANTWRITE)</code></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="literalblock">
<div class="content">
<pre><code>convert(1), file(1), odt2txt</code></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_bugs">BUGS</h2>
<div class="sectionbody">
<div class="paragraph"><p>unoconv uses the UNO bindings to connect to LibreOffice, in absence of a usable
socket, it will start its own LibreOffice instance with the correct parameters.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">Please see the TODO file for known bugs and future plans.</td>
</tr></table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_references">REFERENCES</h2>
<div class="sectionbody">
<div class="paragraph"><p>unoconv is very useful together with the following tools:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Asciidoc
</dt>
<dd>
<p>
    <a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a>
</p>
</dd>
<dt class="hdlist1">
asciidoc-odf
</dt>
<dd>
<p>
    <a href="http://github.com/dagwieers/asciidoc-odf">http://github.com/dagwieers/asciidoc-odf</a>
</p>
</dd>
<dt class="hdlist1">
docbook2odf
</dt>
<dd>
<p>
    <a href="http://open.comsultia.com/docbook2odf/">http://open.comsultia.com/docbook2odf/</a>
</p>
</dd>
</dl></div>
<div class="paragraph"><p>A list of possible import and export formats is available from:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
OpenOffice 2.1
</dt>
<dd>
<p>
    <a href="http://wiki.services.openoffice.org/wiki/Framework/Article/Filter/FilterList_OOo_2_1">http://wiki.services.openoffice.org/wiki/Framework/Article/Filter/FilterList_OOo_2_1</a>
</p>
</dd>
<dt class="hdlist1">
OpenOffice 3.0
</dt>
<dd>
<p>
    <a href="http://wiki.services.openoffice.org/wiki/Framework/Article/Filter/FilterList_OOo_3_0">http://wiki.services.openoffice.org/wiki/Framework/Article/Filter/FilterList_OOo_3_0</a>
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_author">AUTHOR</h2>
<div class="sectionbody">
<div class="paragraph"><p>Written by Dag Wieers, &lt;<a href="mailto:dag@wieers.com">dag@wieers.com</a>&gt;</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_resources">RESOURCES</h2>
<div class="sectionbody">
<div class="paragraph"><p>Main web site: <a href="http://dag.wieers.com/home-made/unoconv/">http://dag.wieers.com/home-made/unoconv/</a></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_copying">COPYING</h2>
<div class="sectionbody">
<div class="paragraph"><p>Copyright (C) 2007 Dag Wieers. Free use of this software is granted under the
terms of the GNU General Public License (GPL).</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 0.4<br />
Last updated
 2015-07-08 23:47:52 UTC
</div>
</div>
</body>
</html>
unoconv 0.7-1.1 / usr / share / doc / unoconv / unoconv.1.html
