Provided by: doc-base_0.10.9_all
NAME
install-docs - Debian-Dokumentation online verwalten
ÜBERSICHT
install-docs [Optionen] -i,--install | -r,--remove | -c,--check Datei [ Datei ... ] install-docs [Optionen] -I,--install-all | -C,--install-changed | -R,--remove-all install-docs [Optionen] -s,--status docid [ docid ... ] install-docs [Optionen] --dump-db dbname install-docs -h,--help | -V,--version
BESCHREIBUNG
install-docs ist ein Werkzeug, das es Debian-Paketverwaltern erlaubt Dokumentationen in unterschiedlichen Dokumentationssystemen zu registrieren. Es unterstützt derzeit dhelp-, dwww-, doc-central- und scrollkeeper-Browser. Diese Handbuchseite stellt eine kurze Übersicht über den install-docs-Aufruf zur Verfügung, einschließlich einer Beschreibung der Rechtschreibung und Grammatik der Steuerungsdatei.
OPTIONEN
-v, --verbose Mit detaillierter Ausgabe arbeiten. -d, --debug Einige Fehlersuchinformationen ausgeben. --no-update-menus Verhindern, dass dwww-build-menu(8), dhelp_parse(8) und scrollkeeper-update(8) ausgeführt werden. --rootdir Verz Setzt das Wurzelverzeichnis auf Verz anstelle von »/«. Hilfreich und gültig nur mit der --check-Aktion.
AKTIONEN
Nachfolgend ist eine Liste mit möglichen Aktionen, die install-docs behandeln kann. Es kann dort nur eine Aktionsoption geben, die an install-docs übergeben wird, zudem muss die Aktion mit ihren Argumenten die letzte übergebene Option sein. Jedes Datei-Argument sollte den kompletten Pfad für die doc-base-Steuerungsdatei (z.B. »/usr/share/doc-base/irgendeine_Datei«), und jedes docid könnte einen Dokument-Bezeichner darstellen (Dokument-Bezeichner sind im »Document«-Feld der Steuerungsdatei gesetzt und entsprechen üblicherweise dem Paketnamen.) Wenn Datei oder docid gleich »-« sind (dem Minus-Zeichen), wird die Argumenteliste von der Standardeingabe gelesen (jeder Dateiname oder Dokument-ID in einer separaten Zeile). -i Datei [Datei ...], --install Datei [Datei ...] Die Dokumentation installieren, die durch die Steuerungsdatei Datei beschrieben wird. -r Datei [Datei ...], --remove Datei [Datei ...] Die Dokumentation entfernen, die durch die Steuerungsdatei Datei beschrieben wird. -c Datei [Datei ...], --check Datei [Datei ...] Die Steuerungsdatei Datei prüfen und die Anzahl gefundener möglicher Probleme anzeigen. Benutzen Sie es mit --verbose, um die aktuellen Stellen von Fehlern und Warnungen zu erhalten. Wenn außerdem --rootdir angegeben wurde und die »Files«- und »Index«-Felder von der Datei gegeben sind, werden seine Argumente den Namen der angegebenen Dateien vorangestellt. -R, --remove-all Alle registrierten Dokumente deregistrieren. -I, --install-all (Wieder)registrieren aller Dokumente von /usr/share/doc-base und /etc/doc-base/documents. -C, --install-changed Inhalte von /usr/share/doc-base- und /etc/doc-base/documents-Verzeichnissen mit registrierter Dokumentendatenbank vergleichen und einige fehlende Dateien deregistrieren und nur geänderte oder neue Dateien (wieder) registrieren. -s docid [docid ...], --status docid [docid ...] Zeigt den Status des Dokumentbezeichners docid. -L docid [docid ...], --listfiles docid [docid ...] Missbilligte Option. Tut nichts. --dump-db dbname Zu Fehlersuche-Zwecken einen Auszug des Inhalts interner Datenbanken erstellen. dbname kann entweder files.db oder status.db sein. -h, --help Ein kurze Hilfe-Nachricht anzeigen. -V, --version Versions-Information anzeigen.
KOMPATIBILITÄTSPROBLEME
Die folgenden Funktionen wurden in Version 0.8.4 hinzugefügt; bitte stellen Sie sicher, dass ordentliche »Conflicts«- oder »Depends«-Zeilen hinzugefügt werden, wenn Sie sie in Ihren Paket-Skripten benutzen möchten: • Unterstützung, um mehr als ein Argument an die -i- und -r-Aktionen übergeben zu können, • Argumente werden von Standardeingabe gelesen, • -I, --install-all, -R, ---remove-all, -c, --check Aktionen, • Optionen -d, --debug, -h, --help. Die Optionen -C, --install-changed, --dump-db, -V, --version wurden in 0.8.12 hinzugefügt.
DATEIEN
/usr/share/doc-base/ Der Ort von doc-base-Steuerungsdateien wird von verschiedenen Paketen zur Verfügung gestellt. /etc/doc-base/documents/ Der Ort von doc-base-Steuerungsdateien wird vom lokalen Administrator zur Verfügung gestellt. /var/lib/doc-base/info/documents/ Der Ort von registrierten Steuerungsdateien. /var/lib/doc-base/info/status.db Status der registrierten Dokumente. /var/lib/doc-base/info/files.db Zeitstempel und Dokument-IDs von registrierten doc-base-Dateien. /var/lib/doc-base/omf/ der Ort von erzeugten scrollkeeper-OMF-Dateien. Anmerkung: /usr/share/omf/doc-base sollte ein symbolischer Verweis sein, der auf ein Verzeichnis zeigt.
FEHLER
Lesen Sie <http://bugs.debian.org/doc-base>.
SIEHE AUCH
dhelp(1), doccentral(1), dwww(7), scrollkeeper(7), Debian doc-base-Handbuch /usr/share/doc/doc-base/doc-base.html/index.html
AUTOR
Dieses Programm wurde ursprünglich von Christian Schwarz <schwarz@debian.org> für das Debian GNU/Linux-System geschrieben und der nächste Betreuer war Adam Di Carlo <aph@debian.org>. Robert Luberda <robert@debian.org> betreut und erweitert es derzeit. Diese Software war zum Nutzen sämtlicher Debian-Anwender und -Entwickler gedacht. Wenn Sie daran interessiert sind, an dieser Software beteiligt zu werden, treten Sie bitte der Mailing-Liste <debian-doc@lists.debian.org> bei.