Manpages

NOMBRE

dh_installdocs − Instala documentación en los directorios de construcción del paquete

SINOPSIS

dh_installdocs [opciones-de-debhelper] [−A] [−Xelemento] [fichero ...]

DESCRIPCIÓN

dh_installdocs es un programa de debhelper responsable de instalar documentación en usr/share/doc/paquete en los directorios de construcción del paquete.

In compat 10 and earlier, dh_install(1) may be a better tool for handling the upstream documentation, when upstream’s own build system installs all the desired documentation correctly. In this case, dh_installdocs is still useful for installing packaging related documentation (e.g. the debian/copyright file).

In compat 11 and later, dh_installdocs offers many of the features that dh_install(1) also have. Furthermore, dh_installdocs also supports the nodoc build profile to exclude documentation (regardless of compat level).

FICHEROS

debian/paquete.docs

Lista los ficheros de documentación a instalar en el package.

debian/copyright

El fichero «copyright» se instala en todos los paquetes, a menos que se disponga de un fichero «copyright» más específico.

debian/paquete.copyright
debian/paquete.README.Debian
debian/paquete.TODO

Se instalará automáticamente cada uno de estos ficheros si están presentes para el paquete.

debian/README.Debian
debian/TODO

Estos ficheros se instalan en el primer paquete binario listado en «debian/control».

Tenga en cuenta que README .debian también se instala como README .Debian, y que TODO se instalará como TODO .Debian en paquetes no nativos.

debian/paquete.doc−base

Installed as doc-base control files. Note that the doc-id will be determined from the Document: entry in the doc-base control file in question. In the event that multiple doc-base files in a single source package share the same doc-id, they will be installed to usr/share/doc−base/package instead of usr/share/doc−base/doc−id.

debian/paquete.doc−base.*

If your package needs to register more than one document, you need multiple doc-base files, and can name them like this. In the event that multiple doc-base files of this style in a single source package share the same doc-id, they will be installed to usr/share/doc−base/package−* instead of usr/share/doc−base/doc−id.

OPCIONES

−A, −−all

Instala todos los ficheros especificados en los parámetros de la línea de órdenes en TODOS los paquetes sobre los que actúa.

−Xelemento, −−exclude=elemento

No instala ficheros que contienen elemento en cualquier lugar de su nombre. Tenga en cuenta que esto incluye ficheros de doc-base.

−−link−doc=paquete

Hace que el directorio de documentación de todos los paquetes sobre los que se actúa sea un enlace simbólico al directorio de documentación del paquete. No tiene efecto cuando se actúa sobre el mismo paquete, o si el directorio de documentación a crear ya existe al ejecutar dh_installdocs. Para cumplir las normas, el paquete debe ser un paquete binario que se origina del mismo paquete fuente.

debhelper intentará evitar instalar ficheros en directorios de documentación enlazados que podrían causar un conflicto con el paquete enlazado. La opción −A no tendrá efecto sobre los paquetes con directorios de documentación enlazados, y no se instalarán los ficheros copyright, changelog, README .Debian y TODO .

(Otro método, aún permitido, es hacer del directorio de documentación un enlace simbólico colgante, «dangling», antes de invocar dh_installdocs.)

CAVEAT 1 : If a previous version of the package was built without this option and is now built with it (or vice-versa), it requires a "dir to symlink" (or "symlink to dir") migration. Since debhelper has no knowledge of previous versions, you have to enable this migration itself.

This can be done by providing a "debian/package.maintscript" file and using dh_installdeb(1) to provide the relevant maintainer script snippets.

CAVEAT 2 : The use of −−link−doc should only be done when the packages have same "architecture" type. A link from a architecture independent package to a architecture dependent package (or vice versa) will not work. Since compat 10, debhelper will actively reject unsupported combinations.

fichero ...

Instala esos ficheros como documentación en el primer paquete sobre el que actúa (o en todos si se especifica −A).

EJEMPLOS

A continuación se muestra un ejemplo de un fichero debian/paquete.docs:

  README
  TODO
  debian/notes−for−maintainers.txt
  docs/manual.txt
  docs/manual.pdf
  docs/manual−html/

NOTAS

Tenga en cuenta que dh_installdocs copiará sin problemas jerarquías de directorio enteras si se le indica (similar a cp −a). Si le indica instalar un directorio instalará todos los contenidos de éste.

VÉASE TAMBIÉN

debhelper(7)

Este programa es parte de debhelper.

AUTOR

Joey Hess <joeyh [AT] debian.org>

TRADUCTOR

Traducci�n de Rub�n Porras Campo <debian−l10n−spanish [AT] lists.org> Actualizaci�n de Omar Campagne Polaino

COMMENTS