Inhalt

1. Kurzübersicht
2. Aufruf
3. Dateien

1. Kurzübersicht

hdocu dient zum Dokumentieren installierter Software, v.a. in verteilten Umgebungen. Üblicherweise werden Softwarepakete in ihr eigenes Verzeichnis entpackt (etwa /usr/local/src/paketname) und übersetzt. Bei der Installation werden dann aber oft eine Menge an Binaries, Libraries, Headrs usw. im ganzen System verteilt.

hdocu wurde dazu entworfen, den Benutzer mit Informationen über alle installierten (und dokumentierten) Pakete zu versorgen, und um das zu einem gegebenen Binary, Header oder einer Library passende Paket zu finden.

Der Softwareadministrator legt für jedes installierte Paket in des Verzeichnis eine Datei namens INFO.LDV an und füllt sie mit den nötigen Informaionen. Aus allen diesen Datein werden dann HTML-Datein erzeugt.

2. Aufruf

hdocu [options] [-[no]make] [-[no]man] [-[no]check]

In den meisten Fällen wird man nur das Konfigurationsfile anpassen und lediglich die Optionen -man und -check benutzen. Nachfolgende alle verfügbaren Optionen:

-help

Hilfe anzeigen und beenden

-verbose [level]

Mehr Informationen während der Ausführung erzeugen. Der Level kann auch durch mehrere -v in Serie erhöht werden

-version

Gibt die Version von hdocu aus

-[no]old

Historisch bedingt: altes Format von INFO.LDV Dateien

-[no]table

Schaltet das Benutzen von HTML-Tabellen ein bzw. aus

-[no]make

Schaltet das Erzeugen von HTML-Dateien ein bzw. aus (Default: ein). Sinnvoll beim Erzeugen von HTML-Manpages oder beim Verifizieren.

-[no]man

Erzeugten von HTML-Versionen der Man-Pages. Die HTML-Dateien landen im man/html.<section> Unterverzeichnis innerhalb des konfigurieeten HTML-Verzeichnisses. Ein Manpage aus /usr/local/man/man1 würde also in man/html1 landen.

-[no]rman

Benutzt rman (RosettaMan oder PolyglottMan), um besseren HTML-Code zu erzeugen als der eingebaute MAN zu HTML Filter. Defaultmäßig ein.

-[no]check

Führt einige zusätzliche Konsistenzprüfungen durch. Erkennt z.B., ob alle vorhanden Files dokumentiert sind.

-nocheckman

Läßt bei -check das Überprüfen der installierten Man-Pages aus, da dieser Test rel. lange dauern kann und evtl. sehr viele Fehlermeldungen erzeugt, gerade bei man-pages, die über verschiedene Namen zu ereichen sind.

-libdir

Verzeichnis mit hdocu Konfiguration und HTML-Vorlagen

-in

Wo soll nach INFO.LDV Dateien gesucht werden

-mandir

Wo soll nach man-Pages gesucht werden

-pub

Wie -in, wird aber speziell behandelt

-out

Verzeichnis, in dem die HTML-Dateien abgelegt werden sollen.

Alle Optionen können abgekürzt werden.

3. Dateien

/usr/local/lib/hdocu/config

Konfiguration von hdocu. Die Optionen sind in eben diesem File erklärt

/usr/local/lib/hdocu/hdocu_table.tml

Vorlage zum Erzeugen von hdocu-HTML-Dateien, wenn HTML-Tabellen benutzt werden sollen

/usr/local/lib/hdocu/hdocu_notable.tml

Dito, aber ohne Tabellen

/usr/local/lib/hdocu/index.tml

Vorlage für Index-Dateien (z.B. Index aller Pakete, Binaries, Stichwörter). Tabellen werden bei Bedarf von hdocu erzeugt, daher ist hier nur eine Version nötig

/usr/local/lib/hdocu/man.tml

Vorlage für HTML-Versionen der man-Pages. Das Übersetzen der man-Pages nach HTML kann nach zwei Verfahren erfolgen:

• Nachahmung des man Kommandos
• Benutzung von PolyglottMan (rman; muß getrennt installiert werden). Dieses Kommando erzeugt ziemlich guten HTML-Code

/usr/local/lib/hdocu/INFO.LDV

Vorlage für die INFO.LDV Dateien. Enthält Informationen wie das File auszufüllen sit.

/usr/local/lib/hdocu/DEFAULT.LDV

Enthält Default-Einträge falls Felder in einer INFO.LDV Datei nicht ausgefüllt wurden. Dies kann durchaus sinnvoll sein, da z.B. nicht jedes Paket Libraries und Binaries installiert.