mkhindex - Dokumentation

Parameter

-h, --help

Zeigt eine kurze Übersicht aller Parameter an und beendet das Programm.

-V, --version

Gibt die Versionsinformationen aus und beendet das Programm.

-r, --no-recurse

Nur das angegebene (oder aktuelle) Verzeichniss wird durchsucht, Unterverzeichnisse werden jedoch nicht eingeschlossen.

-q, --quiet

Standardmäßig werden die durchsuchten Verzeichnisse sowie eine Erfolgsmeldung auf dem Bildschirm ausgegeben. Mit der Angabe der quiet-Option werden diese unterdrückt.

-o DATEINAME

Name unter dem die Indexdatei gespeichert wird, Standard ist 'index.html'

-d VERZEICHNIS, --directory VERZEICHNIS

Name des Verzeichnisses in dem die Suche startet, wird diese Option nicht angegeben, beginnt mkhindex im aktuellen Verzeichnis.

-a, --allow-overwrite

Wenn angegeben, werden vorhanden Indexdateien überschrieben, dies ist nötig wenn bereits durchsuchte Verzeichnisse erneut durchsucht werden. ACHTUNG: es gibt dabei keine Rückfrage!

-t TEMPLATE, --template TEMPLATE

Übergibt eine Templatedatei, die das Layout für den Index enthält. (Siehe den Punkt Templates)

[top]

Beispiele

mkhindex -r

durchsucht nur das aktuellen Verzeichnis (ohne Unterverzeichnisse) und legt dort eine index.html an, sofern diese noch nicht existiert

mkhindex -d /opt/www -o index.htm

durchsucht das Verzeichnis /opt/www und seine Unterverzeichnisse und legt in jedem eine index.htm an, sofern diese noch nicht existiert

mkhindex -d /mnt/win_d/Bilder -a

durchsucht das Verzeichnis /mnt/win_d/Bilder und seine Unterverzeichnisse und legt in jedem eine index.html an, existiert bereits eine Datei mit diesem Namen, wird sie überschrieben

mkhindex -d C:\ -q

durchsucht das Verzeichnis C:\ und seine Unterverzeichnisse und legt in jedem eine index.html an, sofern diese noch nicht existiert; es werden dabei keine Meldungen auf dem Bildschirm ausgegeben

mkhindex -d /var/www/downloads -o files.html -t /var/www/templates/file_listing.html --no-recurse -a

durchsucht nur das Verzeichnis /var/www/downloads (ohne Unterverzeichnisse) und legt dort eine files.html an, existiert bereits eine Datei mit diesem Namen, wird sie überschrieben; als Vorlage wird dabei die Datei /var/www/templates/file_listing.html genutzt

[top]

Templates

Ein Template kann eine beliebige Textdatei sein (wobei eigentlich nur HTML-Dateien sinnvoll sind). Darin können Sie Pseudo-Tags einfügen, die dann von mkhindex ersetzt werden:

<mkhindex type="DirectoryName">

mit dem Name des durchsuchten Verzeichnisses

<mkhindex type="DirectoryListing">

mit einer HTML-Tabelle die das eigentliche Listing enthält

<mkhindex type="ProgramInfo">

mit einer kurzen Info zu mkhindex

<mkhindex type="CreatingDate">

mit dem aktuellen Datum.

Die Listing-Tabelle kann mit Hilfe von CSS formatiert werden. Dafür werden folgende CSS-Klassen in die Tabelle eingefügt:

mkhindex_table

in die TABLE

mkhindex_head

in den THEAD

mkhindex_body

in denTBODY.

[top]