Scroll to navigation

INSTALL-DOCS(8) Debian INSTALL-DOCS(8)

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-, dochelp-, und doc-central-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

Mit detaillierter Ausgabe arbeiten.
Einige Fehlersuchinformationen ausgeben.
Verhindern, dass dwww-build-menu(8) und dhelp_parse(8) ausgeführt werden.
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).

Die Dokumentation installieren, die durch die Steuerungsdatei Datei beschrieben wird.
Die Dokumentation entfernen, die durch die Steuerungsdatei Datei beschrieben wird.
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.
Alle registrierten Dokumente deregistrieren.
(Wieder)registrieren aller Dokumente von /usr/share/doc-base und /etc/doc-base/documents.
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.
Zeigt den Status des Dokumentbezeichners docid.
Missbilligte Option. Tut nichts.
Zu Fehlersuche-Zwecken einen Auszug des Inhalts interner Datenbanken erstellen. dbname kann entweder files.db oder status.db sein.
Ein kurze Hilfe-Nachricht anzeigen.
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.

FEHLER

Lesen Sie <http://bugs.debian.org/doc-base>.

SIEHE AUCH

dhelp(1), doccentral(1), dochelp(1), dwww(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.

21 January 2024 doc-base v0.11.2