udo(1)

💖 udo(1) — General Commands Manual 💖

okay bestie, sit down, we're learning udo(1) and it's genuinely so much. this is the manual page for udo, a command that lives in the General Commands Manual section of the manual (section 1, the "commands you actually type" section, iykyk). let's get into it 🫶

---

✨ NAME ✨

udo — convert files from UDO into different formats

like. that's it. that's the whole job description. it takes your UDO files and turns them into Other Things. iconic behavior honestly 💅

---

🌸 SYNOPSIS 🌸

udo [-adDghHilmnpqrstvwWxy] source file
udo [-adDghHilmnpqrstvwWxy] -o destination file source file

two whole shapes, pick your fighter 🎀

---

🦋 DESCRIPTION 🦋

bestie. UDO converts files from the UDO format into Apple-QuickView, ASCII, HTML, Texinfo, Linuxdoc-SGML, Manualpage, Pure-C-Help, Rich Text Format, ST-Guide, LaTeX, Turbo Vision Help or Windows Help. the range?? not her doing the absolute most but also doing it flawlessly 😭

now, method one: UDO prints the destination format to the standard output (STDOUT) and error messages to the standard error output (STDERR). method two: UDO writes the destination format to the destination file and error messages to a log file with the suffix .ul?.

⚠️ the one thing you cannot mess up: you have to pass single options to UDO. -al isn't the same as -a -l! not me learning this the hard way fr fr. one flag at a time, babe.

and also: the name of the source file has to be the last option. the very last one. end of the line. main character position 👑

---

👑 OPTIONS 👑

every single one, no skips, we're thorough in this household:

• -a, --ascii — the source file will be converted to ASCII. the classic, the default vibe.
• --amg — the source file will be converted to AmigaGuide.
• --aqv, --quickview — the source file will be converted to Apple QuickView.
• -c, --c — a C sourcecode will be generated from the source file. normal text becomes comment, the content of the sourcecode environment becomes C code. two lives at once, she's versatile ✨
• --check — additional checkings will be activated. yes she's double-checking everything, as she should.
• -d, --no-idxfile — suppresse the generation of index files. no index files today, sorry, not in the mood.
• --drc — the source file will be converted to David's Readme Compiler format.
• -D symbol — set the symbol symbol which can be tested in the source file with !ifset
• --force-long — force files with long file names.
• --force-short — force files with short file names (8+3).
• -f, --pdflatex — the source file will be converted to PDFLaTeX sourcecode.
• -g, --helptag — the source file will be converted to HP Helptag SGML.
• --help — outputs a help page and quits. the "hello?? help??" button 🆘
• -h, --html — the source file will be converted to HTML.
• -hh, --htmlhelp — the source file will be converted to HTML-Help. yes, double h. she means it.
• -H, --hold — you have to press a key before UDO finishes. she wants a little goodbye kiss before she leaves 🥺
• -i, --info — the source file will be converted to GNU Texinfo.
• --ipf — the source file will be converted to OS/2 IPF format.
• --lyx — the source file will be converted to LyX.
• -l, --no-logfile — when using the Option -o UDO doesn't save a log file.
• -m, --man — the source file will be converted to a manualpage. (hi, that's this format. we're in the format, bestie.)
• --map — generate a C header file with jump id's for the WinHelp format.
• --map-gfa — generate a GFA Basic header file with jump id's for the WinHelp format.
• --map-pas — generate a Pascal header file with jump id's for the WinHelp format.
• --map-vb — generate a VisualBasic header file with jump id's for the WinHelp format.
• -n, --nroff — the source file will be converted to Nroff.
• -o F, --outfile F — UDO writes the output into the file named F.
• -P, --pascal — a Pascal sourcecode will be generated from the source file. normal text becomes comment, the content of the sourcecode environment becomes Pascal code.
• -p, --pchelp — the source file will be converted to Pure C Help.
• --ps — the source file will be converted to PostScript.
• -q, --quiet — UDO won't print anything to STDOUT or STDERR. silent. mysterious. leaving no trace 💀
• -r, --rtf — the source file will be converted to RTF.
• --save-upr — generate an additional project filr (.upr). there information about outfiles, infiles, nodes and index entries are listed.
• -s, --stg — the source file will be converted to ST-Guide.
• --test — when using this option UDO won't save a destination file. just vibes, no output.
• -t, --tex — the source file will be converted to LaTeX.
• --tree — when using this option UDO will save a file with the suffix .ut?. in this file you will see a tree with all files your source file includes. it's giving family tree but for includes 🌳
• -u, --udo — generate one file in udo format containing all included source files. this allows one to put all source files into one udo file. pack it up, pack it in 🎁
• --verbose — UDO will print some status information wile converting the source file. she's narrating her own process, and honestly? we're listening.
• --version — outputs version information and quits UDO
• -v, --vision — the source file will be converted to Turbo Vision Help.
• -w, --win — the source file will be converted to Windows Help.
• -w4, --win4 — the source file will be converted to Windows Help 4.
• -W, --no-warnings — warnings will be suppressed. error messages will still be printed. so she'll keep the real problems but drop the drama 🎭
• -x, --linuxdoc — the source file will be converted to Linuxdoc-SGML.
• -y, --no-hypfile — UDO doesn't save a file with syllabification hints (.uh?) when using the option -o.
• -@ F — UDO will read the options from the file named F.

---

🌈 EXAMPLES 🌈

she's showing her work, periodt:

udo file.u

convert the source file file.u to ASCII (default) and print the output to the standard output and error messages to the standard error output.

udo --tex -o output.tex file.u

convert the source file file.u to LaTeX and write the output to the file named output.tex. warnings, error messages and additional information will be written to the log file named output.ult.

udo -s -y -l -o ! file.u

convert the source file file.u to ST-Guide and write the output to file.stg. UDO won't save a log file or a file with syllabification patterns.

---

🧚 ENVIRONMENT 🧚

• HOME — UDO looks for the file udo.ini in your home directory if

UDOPATH doesn't exist.

• LANG — sets the language UDO shall use for error messages if neither LC_ALL nor LC_MESSAGES exists.
• LC_ALL — if this is set to german UDO prints German messages. if this variable doesn't exist LC_MESSAGES it tested instead.
• LC_MESSAGES — see LC_ALL. if this variable doesn't exist, too,

LANG is tested instead.

• UDOPATH — UDO looks for the file udo.ini in the directory defined by this variable. if UDOPATH doesn't exist HOME is tested instead.

so there's a whole fallback chain happening, she's nothing if not prepared 🫶

---

⭐ EXIT STATUS ⭐

• 0 — everything was OK. slay.
• >0 — an error has appeared. 💀

---

💜 AUTHOR 💜

copyright (c) 1995, 1996, 1997 by Dirk Hagedorn (Dirk Hagedorn @ MK2, DirkHage@aol.com)

---

🎀 SEE ALSO 🎀

(no SEE ALSO section on this one bestie, she stands alone, independent, self-sufficient 👑)

---

okay that's the whole page!! huge shoutout to webmaster@udo-open-source.org and the date on this one, November 08, 2003 — genuinely an elder in the game and we respect her 💖 and yes this is page udo(1) from the General Commands Manual, exactly where we found it. bye bestie, go convert something 🌸🦋✨