odfmeta.1 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
  1. .\" Title: odfmeta
  2. .\" Author: S\(/oren Roug
  3. .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
  4. .\" Date: 03/15/2009
  5. .\" Manual: User commands
  6. .\" Source: odfpy
  7. .\" Language: English
  8. .\"
  9. .TH "ODFMETA" "1" "03/15/2009" "odfpy" "User commands"
  10. .\" -----------------------------------------------------------------
  11. .\" * (re)Define some macros
  12. .\" -----------------------------------------------------------------
  13. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14. .\" toupper - uppercase a string (locale-aware)
  15. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16. .de toupper
  17. .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18. \\$*
  19. .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20. ..
  21. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22. .\" SH-xref - format a cross-reference to an SH section
  23. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24. .de SH-xref
  25. .ie n \{\
  26. .\}
  27. .toupper \\$*
  28. .el \{\
  29. \\$*
  30. .\}
  31. ..
  32. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33. .\" SH - level-one heading that works better for non-TTY output
  34. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35. .de1 SH
  36. .\" put an extra blank line of space above the head in non-TTY output
  37. .if t \{\
  38. .sp 1
  39. .\}
  40. .sp \\n[PD]u
  41. .nr an-level 1
  42. .set-an-margin
  43. .nr an-prevailing-indent \\n[IN]
  44. .fi
  45. .in \\n[an-margin]u
  46. .ti 0
  47. .HTML-TAG ".NH \\n[an-level]"
  48. .it 1 an-trap
  49. .nr an-no-space-flag 1
  50. .nr an-break-flag 1
  51. \." make the size of the head bigger
  52. .ps +3
  53. .ft B
  54. .ne (2v + 1u)
  55. .ie n \{\
  56. .\" if n (TTY output), use uppercase
  57. .toupper \\$*
  58. .\}
  59. .el \{\
  60. .nr an-break-flag 0
  61. .\" if not n (not TTY), use normal case (not uppercase)
  62. \\$1
  63. .in \\n[an-margin]u
  64. .ti 0
  65. .\" if not n (not TTY), put a border/line under subheading
  66. .sp -.6
  67. \l'\n(.lu'
  68. .\}
  69. ..
  70. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71. .\" SS - level-two heading that works better for non-TTY output
  72. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73. .de1 SS
  74. .sp \\n[PD]u
  75. .nr an-level 1
  76. .set-an-margin
  77. .nr an-prevailing-indent \\n[IN]
  78. .fi
  79. .in \\n[IN]u
  80. .ti \\n[SN]u
  81. .it 1 an-trap
  82. .nr an-no-space-flag 1
  83. .nr an-break-flag 1
  84. .ps \\n[PS-SS]u
  85. \." make the size of the head bigger
  86. .ps +2
  87. .ft B
  88. .ne (2v + 1u)
  89. .if \\n[.$] \&\\$*
  90. ..
  91. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92. .\" BB/BE - put background/screen (filled box) around block of text
  93. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94. .de BB
  95. .if t \{\
  96. .sp -.5
  97. .br
  98. .in +2n
  99. .ll -2n
  100. .gcolor red
  101. .di BX
  102. .\}
  103. ..
  104. .de EB
  105. .if t \{\
  106. .if "\\$2"adjust-for-leading-newline" \{\
  107. .sp -1
  108. .\}
  109. .br
  110. .di
  111. .in
  112. .ll
  113. .gcolor
  114. .nr BW \\n(.lu-\\n(.i
  115. .nr BH \\n(dn+.5v
  116. .ne \\n(BHu+.5v
  117. .ie "\\$2"adjust-for-leading-newline" \{\
  118. \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
  119. .\}
  120. .el \{\
  121. \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
  122. .\}
  123. .in 0
  124. .sp -.5v
  125. .nf
  126. .BX
  127. .in
  128. .sp .5v
  129. .fi
  130. .\}
  131. ..
  132. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  133. .\" BM/EM - put colored marker in margin next to block of text
  134. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  135. .de BM
  136. .if t \{\
  137. .br
  138. .ll -2n
  139. .gcolor red
  140. .di BX
  141. .\}
  142. ..
  143. .de EM
  144. .if t \{\
  145. .br
  146. .di
  147. .ll
  148. .gcolor
  149. .nr BH \\n(dn
  150. .ne \\n(BHu
  151. \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
  152. .in 0
  153. .nf
  154. .BX
  155. .in
  156. .fi
  157. .\}
  158. ..
  159. .\" -----------------------------------------------------------------
  160. .\" * set default formatting
  161. .\" -----------------------------------------------------------------
  162. .\" disable hyphenation
  163. .nh
  164. .\" disable justification (adjust text to left margin only)
  165. .ad l
  166. .\" -----------------------------------------------------------------
  167. .\" * MAIN CONTENT STARTS HERE *
  168. .\" -----------------------------------------------------------------
  169. .SH "Name"
  170. odfmeta \- List or change the metadata of an ODF file
  171. .SH "Synopsis"
  172. .fam C
  173. .HP \w'\fBodfmeta\fR\ 'u
  174. \fBodfmeta\fR [\-l] [\-v] [\-V] [\-c] [\-d] [\-x\ \fImetafield\fR...] [\-X\ \fImetafield\fR...] [\-a\ \fImetafield\fR...] [\-A\ \fImetafield\fR...] [\-I\ \fImetafield\fR...] [\-o\ \fIpath\fR] \fIpath\fR
  175. .fam
  176. .SH "Description"
  177. .PP
  178. \fBodfmeta\fR
  179. is a program that will list or change the metadata in an OpenDocument file\&. This is useful for version control systems\&. You can change title, keywords, description etc\&.
  180. .PP
  181. \(lqPath\(rq
  182. is assumed to be an OpenDocument file of text, spreadsheet or presentation type\&.
  183. .SH "Options"
  184. .PP
  185. \-l
  186. .RS 4
  187. List (extract) all known metadata fields\&.
  188. .RE
  189. .PP
  190. \-v or \-V
  191. .RS 4
  192. Print the version number of the ODF document
  193. \fIformat\fR\&. If you use \-V it will print "version:" before the number for compatibility with \-X\&. The version number can\'t be modified\&.
  194. .RE
  195. .PP
  196. \-c
  197. .RS 4
  198. Make field values continous by normalizing white space\&. Might be convenient when postprocessing with standard (line oriented) text utilities\&.
  199. .RE
  200. .PP
  201. \-d
  202. .RS 4
  203. Update the modification date to the current date and time\&.
  204. .RE
  205. .PP
  206. \-x \fImetafield\fR
  207. .RS 4
  208. Extract the contents of this metafield from the file\&. Known field names are creation\-date, creator, date, description, editing\-cycles, editing\-duration, generator, initial\-creator, keyword, language, print\-date, printed\-by, subject, title, user\-defined\&. All other names are assumed to be user defined\&.
  209. .RE
  210. .PP
  211. \-X \fImetafield\fR
  212. .RS 4
  213. Same as \-x, but also preserves/includes the field name\&.
  214. .RE
  215. .PP
  216. \-a \fImetafield\fR
  217. .RS 4
  218. Append a custom metafield to the metadata; but only if a similar field does not exist yet\&.
  219. .RE
  220. .PP
  221. \-A \fImetafield\fR
  222. .RS 4
  223. Append a custom metafield to the metadata in any case\&.
  224. .RE
  225. .PP
  226. \-I \fImetafield\fR
  227. .RS 4
  228. Append a custom metafield to the metadata and remove any existing similar field\&.
  229. .RE
  230. .PP
  231. \-o \fIpath\fR
  232. .RS 4
  233. Filename to write modified ODT file to\&. If no
  234. \fB\-o\fR
  235. option is provided, the ODT file will be written to stdout\&.
  236. .RE
  237. .SH "Examples"
  238. .sp
  239. .if n \{\
  240. .RS 4
  241. .\}
  242. .fam C
  243. .ps -1
  244. .nf
  245. .if t \{\
  246. .sp -1
  247. .\}
  248. .BB lightgray adjust-for-leading-newline
  249. .sp -1
  250. odfmeta \-l odf\-file\&.odt
  251. odfmeta \-I "title:The Little Engine That Could" \-A subject:I\-think\-I\-can \-o newfile\&.odt source\&.odt
  252. .EB lightgray adjust-for-leading-newline
  253. .if t \{\
  254. .sp 1
  255. .\}
  256. .fi
  257. .fam
  258. .ps +1
  259. .if n \{\
  260. .RE
  261. .\}
  262. .SH "See Also"
  263. .PP
  264. \fBformail\fR(1),
  265. \fBid3tag\fR(1)
  266. .SH "Bugs"
  267. .PP
  268. All known versions of OpenOffice\&.org keep only four <meta:user\-defined> elements\&. If you add more than those, you\'ll loose them next time you save with OpenOffice\&.org\&. KOffice keeps only one <meta:keyword> element\&.
  269. .SH "Author"
  270. .PP
  271. \fBS\(/oren Roug\fR
  272. .RS 4
  273. Original author
  274. .RE