odfmeta.docbook 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  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="odfmeta">
  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>odfmeta</refentrytitle>
  13. <manvolnum>1</manvolnum>
  14. <refmiscinfo class="manual">User commands</refmiscinfo>
  15. </refmeta>
  16. <refnamediv>
  17. <refname>odfmeta</refname>
  18. <refpurpose>List or change the metadata of an ODF file</refpurpose>
  19. </refnamediv>
  20. <refsynopsisdiv>
  21. <cmdsynopsis>
  22. <command>odfmeta</command>
  23. <arg>-l</arg>
  24. <arg>-v</arg>
  25. <arg>-V</arg>
  26. <arg>-c</arg>
  27. <arg>-d</arg>
  28. <arg rep="repeat">-x <replaceable>metafield</replaceable></arg>
  29. <arg rep="repeat">-X <replaceable>metafield</replaceable></arg>
  30. <arg rep="repeat">-a <replaceable>metafield</replaceable></arg>
  31. <arg rep="repeat">-A <replaceable>metafield</replaceable></arg>
  32. <arg rep="repeat">-I <replaceable>metafield</replaceable></arg>
  33. <arg choice="opt">-o <replaceable>path</replaceable></arg>
  34. <arg choice="plain"><replaceable>path</replaceable></arg>
  35. </cmdsynopsis>
  36. </refsynopsisdiv>
  37. <refsect1><title>Description</title>
  38. <para><command>odfmeta</command> is a program that will list or change
  39. the metadata in an OpenDocument file. This is useful for version
  40. control systems. You can change title, keywords, description etc.
  41. </para>
  42. <para>
  43. <quote>Path</quote> is assumed to be an
  44. OpenDocument file of text, spreadsheet or presentation type.
  45. </para>
  46. </refsect1>
  47. <refsect1><title>Options</title>
  48. <variablelist>
  49. <varlistentry>
  50. <term>-l</term>
  51. <listitem>
  52. <para>
  53. List (extract) all known metadata fields.
  54. </para>
  55. </listitem>
  56. </varlistentry>
  57. <varlistentry>
  58. <term>-v or -V</term>
  59. <listitem>
  60. <para>
  61. Print the version number of the ODF document <emphasis>format</emphasis>.
  62. If you use -V it will print "version:" before the number for compatibility with -X.
  63. The version number can't be modified.
  64. </para>
  65. </listitem>
  66. </varlistentry>
  67. <varlistentry>
  68. <term>-c</term>
  69. <listitem>
  70. <para>
  71. Make field values continous by normalizing white space.
  72. Might be convenient when postprocessing with standard (line oriented) text utilities.
  73. </para>
  74. </listitem>
  75. </varlistentry>
  76. <varlistentry>
  77. <term>-d</term>
  78. <listitem>
  79. <para>
  80. Update the modification date to the current date and time.
  81. </para>
  82. </listitem>
  83. </varlistentry>
  84. <varlistentry>
  85. <term>-x <replaceable>metafield</replaceable></term>
  86. <listitem>
  87. <para>
  88. Extract the contents of this metafield from the file.
  89. Known field names are
  90. creation-date,
  91. creator,
  92. date,
  93. description,
  94. editing-cycles,
  95. editing-duration,
  96. generator,
  97. initial-creator,
  98. keyword,
  99. language,
  100. print-date,
  101. printed-by,
  102. subject,
  103. title,
  104. user-defined.
  105. All other names are assumed to be user defined.
  106. </para>
  107. </listitem>
  108. </varlistentry>
  109. <varlistentry>
  110. <term>-X <replaceable>metafield</replaceable></term>
  111. <listitem>
  112. <para>
  113. Same as -x, but also preserves/includes the field name.
  114. </para>
  115. </listitem>
  116. </varlistentry>
  117. <varlistentry>
  118. <term>-a <replaceable>metafield</replaceable></term>
  119. <listitem>
  120. <para>
  121. Append a custom metafield to the metadata; but only if a similar field does not exist yet.
  122. </para>
  123. </listitem>
  124. </varlistentry>
  125. <varlistentry>
  126. <term>-A <replaceable>metafield</replaceable></term>
  127. <listitem>
  128. <para>
  129. Append a custom metafield to the metadata in any case.
  130. </para>
  131. </listitem>
  132. </varlistentry>
  133. <varlistentry>
  134. <term>-I <replaceable>metafield</replaceable></term>
  135. <listitem>
  136. <para>
  137. Append a custom metafield to the metadata and remove any existing similar field.
  138. </para>
  139. </listitem>
  140. </varlistentry>
  141. <varlistentry>
  142. <term>-o <replaceable>path</replaceable></term>
  143. <listitem>
  144. <para>
  145. Filename to write modified ODT file to.
  146. If no <option>-o</option> option is provided, the ODT file will be written to stdout.
  147. </para>
  148. </listitem>
  149. </varlistentry>
  150. </variablelist>
  151. </refsect1>
  152. <refsect1><title>Examples</title>
  153. <screen>
  154. odfmeta -l odf-file.odt
  155. odfmeta -I "title:The Little Engine That Could" -A subject:I-think-I-can -o newfile.odt source.odt
  156. </screen>
  157. </refsect1>
  158. <refsect1><title>See Also</title>
  159. <para>
  160. <command>formail</command>(1),
  161. <command>id3tag</command>(1)
  162. </para>
  163. </refsect1>
  164. <refsect1><title>Bugs</title>
  165. <para>
  166. All known versions of OpenOffice.org keep only four &lt;meta:user-defined&gt; elements.
  167. If you add more than those, you'll loose them next time you save with OpenOffice.org.
  168. KOffice keeps only one &lt;meta:keyword&gt; element.
  169. </para>
  170. </refsect1>
  171. </refentry>