odflint.docbook 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. <?xml version="1.0" ?>
  2. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
  4. <refentry id="odflint">
  5. <refentryinfo>
  6. <productname>odfpy</productname>
  7. <author><firstname>Søren</firstname><surname>Roug</surname>
  8. <contrib>Original author</contrib>
  9. </author>
  10. </refentryinfo>
  11. <refmeta>
  12. <refentrytitle>odflint</refentrytitle>
  13. <manvolnum>1</manvolnum>
  14. <refmiscinfo class="manual">User commands</refmiscinfo>
  15. </refmeta>
  16. <refnamediv>
  17. <refname>odflint</refname>
  18. <refpurpose>Check ODF file for problems</refpurpose>
  19. </refnamediv>
  20. <refsynopsisdiv>
  21. <cmdsynopsis>
  22. <command>odflint</command>
  23. <arg choice="plain"><replaceable>path</replaceable></arg>
  24. </cmdsynopsis>
  25. </refsynopsisdiv>
  26. <refsect1><title>Description</title>
  27. <para><command>odflint</command> is a program that will check
  28. an ODF file and give warning if it finds something suspect.
  29. It is not able to make a full validation due to the complexity
  30. of the schema.
  31. </para>
  32. <para>
  33. <quote>Path</quote> is assumed to be an
  34. OpenDocument file of text, spreadsheet or presentation type.
  35. </para>
  36. </refsect1>
  37. <refsect1><title>Example</title>
  38. <screen>
  39. odflint odf-file
  40. </screen>
  41. </refsect1>
  42. <refsect1><title>Bugs</title>
  43. <para>
  44. Validates all versions of ODF as if they are version 1.1. You'll therefore get some false
  45. positives if you check files that aren't generated by odfpy scripts.
  46. </para>
  47. </refsect1>
  48. </refentry>