ODFUSERFIELD(1)

💖 odfuserfield — the manual, but make it a group chat 💖

okay bestie, grab your iced coffee because today we're talking about odfuserfield, a User commands classic. She lives in section 1 of the manual. Let's get into it ✨

---

🌸 NAME 🌸

odfuserfield — list or change the user-field declarations in an ODF file 🦋

---

✨ SYNOPSIS ✨

odfuserfield [-l] [-L] [-x field...] [-X field...] [-s field:value...]
             [-o path] path

---

💅 DESCRIPTION 💅

so. odfuserfield is a program that will list or change the user variable declarations in an OpenDocument file. that's the whole vibe. 👑

here's the tea tho — there are two kinds of variables in OpenDocument and you gotta know the difference:

• Simple variables can take different values at different positions, throughout a document. (wandering little free spirits 🌈)
• User variables have the same value throughout a document. (main character energy, one value, everywhere, no cap ✋)

and because user variables are global like that, it's safe to change them with an external application. periodt. 💚

use odfuserfield to fill out form letters before printing, or before handing them over to the user. it's giving automated stationery. 💌

Path is assumed to be an OpenDocument file of text, spreadsheet or presentation type.

---

🎀 OPTIONS 🎀

• -l — List (extract) all known user-fields. just gimme the names bestie 👀
• -L — List (extract) all known user-fields with type and value. the full package, the deluxe version, the one with receipts 💅
• -x field — Extract the contents of this field from the file. one field, one scoop 🍓
• -X field — Same as -x, but also preserves/includes the field name and type. so you know exactly who's talking 🏷️
• -s field:value — Set the value of an existing user field. The field type will be the same. (note: existing!! don't come for me if the field isn't there 🙈)
• -o path — Filename to write the modified ODT file to. If no -o option is provided, the ODT file will be written to stdout. yes, stdout. pipe it, redirect it, live your truth 🫶

---

🌟 EXAMPLE 🌟

go off:

odfuserfield -L odf-file

---

👯 SEE ALSO 👯

• formail(1)
• id3tag(1)

---

🚧 TODO 🚧

Implement formulas. See OpenDocument v1.0 specification section 6.3.5. This requires a different syntax for -s arguments.

fr fr, this one's still on the to-do list — so if you're out here expecting formulas, that's a no for now 😭

---

👑 AUTHORS 👑

• Søren Roug — Original author
• Michael Howitz — gocept gmbh & co. kg — Refactoring

---

and that's the whole page diva 💜 this cutie ships as part of odfpy, dated 02/11/2025 ✨ go forth and fill out those form letters, you absolute icon 👑🎀