csv2ods.docbook 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. <?xml version="1.0"?>
  2. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
  3. <refentry id="csv2ods">
  4. <refentryinfo>
  5. <productname>odfpy</productname>
  6. <author><firstname>Agustin</firstname><surname>Henze</surname>
  7. <contrib>Original author of csv-ods.py</contrib>
  8. <email>agustinhenze at gmail.com</email></author>
  9. </refentryinfo>
  10. <refmeta>
  11. <refentrytitle>csv2ods</refentrytitle>
  12. <manvolnum>1</manvolnum>
  13. <refmiscinfo class="manual">User commands</refmiscinfo>
  14. </refmeta>
  15. <refnamediv>
  16. <refname>csv2ods</refname>
  17. <refpurpose>Create OpenDocument spreadsheet from comma separated values</refpurpose>
  18. </refnamediv>
  19. <refsynopsisdiv>
  20. <cmdsynopsis>
  21. <command>csv2ods</command>
  22. <arg choice="plain">-i <replaceable>file.csv</replaceable></arg>
  23. <arg choice="plain">-o <replaceable>file.ods</replaceable></arg>
  24. </cmdsynopsis>
  25. </refsynopsisdiv>
  26. <refsect1>
  27. <title>Description</title>
  28. <para>
  29. This program reads a file in CSV format - table of columns delimited by commas,
  30. tabs or any other character. It then creates a spreadsheet. If a value looks like a number
  31. the cell is formatted as a number as well.
  32. </para>
  33. </refsect1>
  34. <refsect1>
  35. <title>Options</title>
  36. <variablelist>
  37. <varlistentry>
  38. <term>--version</term>
  39. <listitem>
  40. <para>
  41. Show program's version number and exit
  42. </para>
  43. </listitem>
  44. </varlistentry>
  45. <varlistentry>
  46. <term>-h, --help</term>
  47. <listitem>
  48. <para>
  49. Show help message and exit
  50. </para>
  51. </listitem>
  52. </varlistentry>
  53. <varlistentry>
  54. <term>-i <replaceable>INPUT</replaceable>, --input=<replaceable>INPUT</replaceable></term>
  55. <listitem>
  56. <para>
  57. File input in csv.
  58. </para>
  59. </listitem>
  60. </varlistentry>
  61. <varlistentry>
  62. <term>-o <replaceable>OUTPUT</replaceable>, --output=<replaceable>OUTPUT</replaceable></term>
  63. <listitem>
  64. <para>
  65. File output in ods.
  66. </para>
  67. </listitem>
  68. </varlistentry>
  69. <varlistentry>
  70. <term>-d <replaceable>DELIMITER</replaceable>, --delimiter=<replaceable>DELIMITER</replaceable></term>
  71. <listitem>
  72. <para>
  73. Specifies a one-character string to use as the field
  74. separator. It defaults to ",".
  75. </para>
  76. </listitem>
  77. </varlistentry>
  78. <varlistentry>
  79. <term>-c <replaceable>ENCODING</replaceable>, --encoding=<replaceable>ENCODING</replaceable></term>
  80. <listitem>
  81. <para>
  82. Specifies the encoding the file csv. It defaults to utf-8.
  83. </para>
  84. </listitem>
  85. </varlistentry>
  86. <varlistentry>
  87. <term>-t <replaceable>TABLENAME</replaceable>, --table=<replaceable>TABLENAME</replaceable></term>
  88. <listitem>
  89. <para>
  90. The table name in the output file.
  91. </para>
  92. </listitem>
  93. </varlistentry>
  94. <varlistentry>
  95. <term>-s <replaceable>SKIPINITIALSPACE</replaceable>, --skipinitialspace=<replaceable>SKIPINITIALSPACE</replaceable></term>
  96. <listitem>
  97. <para>
  98. Specifies how to interpret whitespace which
  99. immediately follows a delimiter. It defaults to
  100. False, which
  101. means that whitespace immediately following a
  102. delimiter is part
  103. of the following field.
  104. </para>
  105. </listitem>
  106. </varlistentry>
  107. <varlistentry>
  108. <term>-l <replaceable>LINETERMINATOR</replaceable>, --lineterminator=<replaceable>LINETERMINATOR</replaceable></term>
  109. <listitem>
  110. <para>
  111. Specifies the character sequence which should
  112. terminate rows.
  113. </para>
  114. </listitem>
  115. </varlistentry>
  116. <varlistentry>
  117. <term>-q <replaceable>QUOTING</replaceable>, --quoting=<replaceable>QUOTING</replaceable></term>
  118. <listitem>
  119. <para>
  120. It can take on any of the following module constants:
  121. 0 = QUOTE_MINIMAL means only when required, for
  122. example, when a field contains either the quotechar or
  123. the delimiter.
  124. 1 = QUOTE_ALL means that quotes are always placed
  125. around fields.
  126. 2 = QUOTE_NONNUMERIC means that quotes are always
  127. placed around fields which do not parse as integers or
  128. floating point numbers.
  129. 3 = QUOTE_NONE means that quotes are never placed
  130. around fields.
  131. It defaults is QUOTE_MINIMAL.
  132. </para>
  133. </listitem>
  134. </varlistentry>
  135. <varlistentry>
  136. <term>-e <replaceable>ESCAPECHAR</replaceable>, --escapechar=<replaceable>ESCAPECHAR</replaceable></term>
  137. <listitem>
  138. <para>
  139. Specifies a one-character string used to escape the
  140. delimiter when quoting is set to QUOTE_NONE.
  141. </para>
  142. </listitem>
  143. </varlistentry>
  144. <varlistentry>
  145. <term>-r <replaceable>QUOTECHAR</replaceable>, --quotechar=<replaceable>QUOTECHAR</replaceable></term>
  146. <listitem>
  147. <para>
  148. Specifies a one-character string to use as the quoting
  149. character. It defaults to ".
  150. </para>
  151. </listitem>
  152. </varlistentry>
  153. </variablelist>
  154. </refsect1>
  155. <refsect1>
  156. <title>Example</title>
  157. <screen>
  158. csv2ods -i /etc/passwd -o accounts.odt -d:
  159. </screen>
  160. </refsect1>
  161. </refentry>