Die Kommandozeilenversionen für die verschiedenen Betriebssysteme lassen sich alle identisch bedienen (was kein Wunder ist, da alle mit demselben Sourcecode compiliert wurden).
Die Bedienung der Kommandozeilenversion wird nun im typischen Manualpage-Stil beschrieben:
udo – Dateien vom UDO-Format in andere Formate umwandeln
udo [-acdDfghHilmnpPqrstuvwWxy4]
Quelldatei
udo [-acdDfghHilmnpPqrstuvwWxy4] -o
Zieldatei
Quelldatei
UDO wandelt Dateien vom eigenen UDO-Format in folgende Formate um:
In der ersten Form erfolgen Ausgaben auf die Standardausgabe (stdout), Fehlermeldungen werden auf die Standardfehlerausgabe (stderr) ausgegeben. In der zweiten Form werden Ausgaben in die Zieldatei geschrieben, Fehlermeldungen in eine Protokolldatei mit der Dateimaske *.ul*.
Die Optionen müssen einzeln übergeben werden: -al wird nicht als -a -l interpretiert!
Der Name der Quelldatei muss als letzter Parameter übergeben werden.
-@ F | UDO liest dann aus der Datei Fdie Optionen. Sie können pro Zeile eine Option eintragen (wie vor UDO 7 üblich) oder auch die Optionen durch Leerzeichen oder [Tab] voneinander trennen, wie in einer Kommandozeile. |
-a, --asc | Die Quelldatei wird ins ASCII-Format umgewandelt. |
--amg | Die Quelldatei wird ins AmigaGuide-Format umgewandelt. |
--aqv, --quickview | Die Quelldatei wird ins Apple-QuickView-Format umgewandelt. |
-c, --c | Die Quelldatei wird in C-Sourcecode umgewandelt. Normaler Text wird Kommentar, der Inhalt der Sourcecode-Umgebung wird C-Code. |
--check | Zusätzliche Überprüfungen aktivieren. |
-d, --no-idxfile | Erzeugung von Indexdateien unterdrücken. |
--drc | Die Quelldatei wird ins DRC-Format (David's Readme Compiler) umgewandelt. |
-D symbol | Setzen des Symbols symbol, welches sich im Quelltext mit dem Befehl !ifset abfragen lässt. |
--force-long | Wird diese Option benutzt, versucht UDO auch auf den Systemen, die standardmässig keine langen Dateinamen unterstützen (TOS, DOS), lange Dateinamen zu erzeugen (Suffix .html anstatt .htm). |
--force-short | Erzwingt unter Betriebssystemen, die lange Dateinamen beherrschen, die Erzeugung von kurzen Dateinamen (8+3). |
-f, --pdflatex | Die Quelldatei wird in PDFLaTeX-Quellcode umgewandelt. |
-g, --helptag | Die Quelldatei wird ins HP-Helptag-SGML-Format umgewandelt. |
--help | Ausgabe einer Hilfsseite, die diese Optionen erklärt. |
-h, --html | Die Quelldatei wird ins HTML-Format umgewandelt. |
--hah | Die Quelldatei wird ins HTML Apple Help Format umgewandelt. |
-hh, --htmlhelp | Die Quelldatei wird ins HTML-Help-Format umgewandelt. |
-H, --hold | UDO wartet am Programmende auf einen Tastendruck. |
-i, --info | Die Quelldatei wird ins GNU-Texinfo-Format umgewandelt. |
--ipf | Die Quelldatei wird ins OS/2 IPF-Format umgewandelt. |
-l, --no-logfile | UDO legt (bei gleichzeitiger Verwendung von -o) keine Protokolldatei an. |
--lyx | Die Quelldatei wird ins LyX-Format umgewandelt. |
-m, --man | Die Quelldatei wird ins Manualpage-Format umgewandelt. |
--map | Erzeugt eine Header-Datei für C, in denen Konstanten mit allen WinHelp-Jump-IDs ausgegeben werden. |
--map-pas | Erzeugt eine Map-Datei der WinHelp-Jump-IDs für Pascal/Delphi. |
--map-gfa | Erzeugt eine Map-Datei der WinHelp-Jump-IDs für GFA Basic. |
--map-vb | Erzeugt eine Map-Datei der WinHelp-Jump-IDs für Visual Basic. |
-n, --nroff | Die Quelldatei wird ins Nroff-Format umgewandelt. |
-o F, --outfile F | UDO schreibt seine Ausgaben in die Datei namens F. Mit -o wird als Ausgabedateiname der Name der Quelldatei plus neuer Extension verwendet (z.B. file.u wird zu file.stg). |
-p, --pchelp | Die Quelldatei wird ins Pure-C-Hilfe-Quelltextformat umgewandelt. |
-P, --pascal | Die Quelldatei wird in Pascal-Sourcecode umgewandelt. Normaler Text wird Kommentar, der Inhalt der Sourcecode-Umgebung wird C-Code. |
--ps | Die Quelldatei wird ins PostScript-Format umgewandelt. |
-q, --quiet | Die Ausgabe von Statusmeldungen wird unterdrückt. |
-r, --rtf | Die Quelldatei wird ins Rich-Text-Format (RTF) umgewandelt. |
-s, --stg | Die Quelldatei wird ins ST-Guide-Format umgewandelt. |
--save-upr | Wird diese Option benutzt, legt UDO eine Projekt-Datei mit dem Suffix .upr mit einer Liste der benutzten und erzeugten Dateien an. |
-t, --tex | Die Quelldatei wird ins LaTeX-Format umgewandelt. |
--test | Bei zusätzlicher Angabe dieser Option, wird keine Ausgabedatei erzeugt, sondern nur eine Protokolldatei und ggf. die Datei mit den Rohlingen für die Trennvorschläge. |
--tree | Wird diese Option benutzt, legt UDO in einer Datei mit dem Suffix .ut? eine baumartige Übersicht der benutzten Dateien an. Bei intensiver Benutzung des Befehls !include sehen Sie damit, welche Dateien andere Dateien nachladen. |
-u, --udo | Erzeugt eine Datei im UDO-Format, die sämtliche inkludierten UDO-Quelltexte enthält. |
-v, --vision | Die Quelldatei wird ins Turbo-Vision-Help-Format umgewandelt. |
--verbose | Bei der Konvertierung werden zusätzlich Informationen über die gerade bearbeitete Datei und das gerade bearbeitete Kapitel ausgegeben. |
--version | Ausgabe der Version von UDO. |
-w, --win | Die Quelldatei wird ins WinHelp-Quelltextformat umgewandelt. |
-4, --win4 | Die Quelldatei wird ins WinHelp4-Quelltextformat umgewandelt. |
-W, --no-warnings | UDO gibt keine Warnungen, sondern nur Fehler aus. |
-Wl, --no-warningslines | Warnungen für Zeilenlänge unterdrücken. Ergibt nur Sinn, wenn UDO Warnungen ausgeben soll. |
-x, --linuxdoc | Die Quelldatei wird ins Linuxdoc-SGML-Format umgewandelt. |
-y, --no-hypfile | UDO legt (bei gleichzeitiger Verwendung von -o) keine Datei mit Trennvorschlägen an. |
HOME | Im Homeverzeichnis wird nach der Datei udo.ini gesucht, falls UDOPATH nicht existiert (udo.ini betrifft nur die Atari-GEM-Version von UDO). |
LANG | Legt die zu benutzende Landessprache für Fehlermeldungen fest, wenn weder LC_ALL noch LC_MESSAGES existiert. |
LC_ALL | Wenn diese Environmentvariable auf germangesetzt ist, benutzt UDO deutschsprachige Meldungen. Für andere Werte werden englischsprachige Meldungen benutzt. Existiert diese Variable nicht, wird stattdessen LC_MESSAGES überprüft. |
LC_MESSAGES | Siehe LC_ALL. Wenn auch diese Variable nicht existiert, wird stattdessen LANG benutzt. |
UDOPATH | In diesem Verzeichnis sucht UDO nach der Datei udo.ini. Falls UDOPATH nicht existiert, wird stattdessen in $HOME gesucht. |
UDOINPUTPATH | In diesem Verzeichnis sucht UDO nach Dateien, die mit dem Befehl !input eingebunden werden. |
0 | Alles in Ordnung. |
>0 | Es ist ein Fehler aufgetreten. |