'\" t
.\"     Title: odfuserfield
.\"    Author: S\(/oren Roug
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 10/12/2014
.\"    Manual: User commands
.\"    Source: odfpy
.\"  Language: English
.\"
.TH "ODFUSERFIELD" "1" "10/12/2014" "odfpy" "User commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
odfuserfield \- List or change the user\-field declarations in an ODF file
.SH "SYNOPSIS"
.HP \w'\fBodfuserfield\fR\ 'u
\fBodfuserfield\fR [\-l] [\-L] [\-x\ \fIfield\fR...] [\-X\ \fIfield\fR...] [\-s\ \fIfield:value\fR...] [\-o\ \fIpath\fR] \fIpath\fR
.SH "DESCRIPTION"
.PP
\fBOdfuserfield\fR
is a program that will list or change the user variable declarations in an OpenDocument file\&. There are two kinds of variables in OpenDocument\&. Simple variables can take different values at different positions, throughout a document\&. User variables have the same value throughout a document\&. Due to the latter\*(Aqs global nature it is safe to change them with an external application\&.
.PP
Use
\fBodfuserfield\fR
to fill out form letters before printing or giving to the user\&.
.PP
\(lqPath\(rq
is assumed to be an OpenDocument file of text, spreadsheet or presentation type\&.
.SH "OPTIONS"
.PP
\-l
.RS 4
List (extract) all known user\-fields\&.
.RE
.PP
\-L
.RS 4
List (extract) all known user\-fields with type and value\&.
.RE
.PP
\-x \fIfield\fR
.RS 4
Extract the contents of this field from the file\&.
.RE
.PP
\-X \fIfield\fR
.RS 4
Same as \-x, but also preserves/includes the field name and type\&.
.RE
.PP
\-s \fIfield:value\fR
.RS 4
Set the value of an existing user field\&. The field type will be the same\&.
.RE
.PP
\-o \fIpath\fR
.RS 4
Filename to write modified ODT file to\&. If no
\fB\-o\fR
option is provided, the ODT file will be written to stdout\&.
.RE
.SH "EXAMPLE"
.sp
.if n \{\
.RS 4
.\}
.nf
odfuserfield \-L odf\-file
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBformail\fR(1),
\fBid3tag\fR(1)
.SH "TODO"
.PP
Implement formulas\&. See OpenDocument v1\&.0 specification section 6\&.3\&.5\&. This requires a different syntax for \-s arguments\&.
.SH "AUTHORS"
.PP
\fBS\(/oren Roug\fR
.RS 4
Original author
.RE
.PP
\fBMichael Howitz\fR
.br
gocept gmbh & co\&. kg
.RS 4
Refactoring
.RE