Scroll to navigation

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

NOMBRE

install-docs - gestión de documentación de Debian en línea

SINOPSIS

 install-docs [opciones] -i,--install | -r,--remove | -c,--check file [ archivo ]
 install-docs [opciones] -I,--install-all | -C,--install-changed | -R,--remove-all
 install-docs [opciones] -s,--status iddoc [ id_del_documento ... ]
 install-docs [opciones] --dump-db nombre_de_la_base_de_datos
 install-docs -h,--help | -V,--version

DESCRIPCIÓN

install-docs es una herramienta que permite a los responsables de paquetes de Debian registrar documentación en varios sistemas de documentación. Es compatible con los navegadores dhelp, dwww, dochelp, y doc-central.

Esta página de manual ofrece una corta sinopsis del uso de install-docs. Encontrará información completa en la documentación, incluyendo una descripción de la sintaxis y la gramática del archivo de control.

OPCIONES

Ejecutarse con verbosidad.
Muestra información de depuración de fallos.
Impide que se ejecuten dwww-build-menu(8) y dhelp_parse(8).
Configura el directorio raíz como dir en lugar de «/». Útil y válido solo junto con la acción --check.

ACCIONES

A continuación hay una lista de las acciones posibles que install-docs ofrece. Sólo se puede introducir una opción de acción a «install-docs», y más aún, la acción y sus argumentos deben ser la última opción introducida.

Cada argumento archivo debería ser la ruta absoluta del archivo de control de doc-base (p. ej., «/usr/share/doc-base/archivo» o «/etc/doc-base/documents/archivo»), y cada iddoc debería ser la identificación del documento (Los identificadores de documentos se definen en el campo de «Document» en el archivo de control, y normalmente se corresponden con el nombre del paquete).

Si archivo o iddoc equivalen a «-», la lista de argumentos se leerá por la entrada estándar (cada nombre de archivo o id de documento debe estar en una línea separada).

Instala la documentación que se describe en el archivo de control archivo.
Elimina la documentación identificada por el archivo de control archivo.
Revisa el archivo de control archivo y muestra el número de los posibles problemas encontrados. Úselo con --verbose para obtener la ubicación real de los errores y avisos. Si también se introduce --rootdir, su argumento se anexará a los nombres de los archivos presentes en los campos de «Files» e «Index» del archivo.
Elimina del registro todos los documentos registrados.
Registrar nuevamente todos los documentos en «/usr/share/doc-base» y «/etc/doc-base/documents».
Compara los contenidos de los directorios «/usr/share/doc-base» y «/etc/doc-base/documents» con la base de datos de los documentos registrados, elimina del registro todo archivo ausente y registra nuevamente solo los archivos nuevos o modificados.
Muestra el estado del identificador del documento iddoc.
Esta opción está obsoleta. No hace nada.
Vuelca los contenidos de las bases de datos internas, por razones de depuración de fallos. nombrebd puede ser files.db o status.db.
Muestra un corto mensaje de ayuda.
Muestra la versión.

PROBLEMAS DE COMPATIBILIDAD

Las siguientes características se añadieron en la versión 0.8.4., asegúrese de añadir las líneas apropiadas de «Conflicts» o «Depends» si desea utilizarlas en los scripts de su paquete:

  • soporte para introducir más de un argumento en las acciones -i y -r.
  • leyendo los argumentos por la entrada estándar,
  • acciones -I,--install-all, -R, ---remove-all, -c, --check,
  • opciones -d, --debug, -h, --help.

Las opciones -C, --install-changed, --dump-db, -V, --version se añadieron en la versión 0.8.12.

ARCHIVOS

/usr/share/doc-base/
La ubicación de los archivos de control de doc-base que los paquetes han proporcionado.
/etc/doc-base/documents/
La ubicación de los archivos de control de doc-base facilitados por el administrador local.
/var/lib/doc-base/info/documents/
La ubicación de los archivos de control registrados.
/var/lib/doc-base/info/status.db
Los estados de los documentos registrados.
/var/lib/doc-base/info/files.db
Las marcas de código de tiempo y las id de los documentos

FALLOS

Véase <http://bugs.debian.org/doc-base>.

VÉASE TAMBIÉN

dhelp(1), doccentral(1), dochelp(1), dwww(7), Manual de doc-base para Debian «/usr/share/doc/doc-base/doc-base.html/index.html»

AUTOR

Este programa fue originalmente escrito por Christian Schwarz schwarz@debian.org para el sistema Debian GNU/Linux, seguido de Adam Di Carlo <aph@debian.org>. Actualmente, lo desarrolla y extiende Robert Luberda <robert@debian.org>.

Este software se diseñó para el beneficio de toda la comunidad de usuarios y desarrolladores de Debian. Si está interesado en contribuir a este proyecto, únase a la lista de correo <debian-doc@lists.debian.org>.

21 January 2024 doc-base v0.11.2