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.
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
- Se instala como un fichero de control de doc-base. Tenga en
cuenta que el identificador del documento, doc-id, se determinará de
la entrada Document: en el fichero de control de doc-base en
cuestión.
- debian/paquete.doc-base.*
- Si su paquete necesita registrar más de un documento,
necesita múltiples ficheros de doc-base, y puede nombrarlos de la
siguiente manera.
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.)
- 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.
Esta orden no es idempotente. Debería invocar
dh_prep(1) entre cada
invocación de esta orden. De otro modo, puede causar que los scripts del
desarrollador contengan partes duplicadas.
VÉASE TAMBIÉN¶
debhelper(7)
Este programa es parte de debhelper.
AUTOR¶
Joey Hess <joeyh@debian.org>
TRADUCTOR¶
Traducci�n de Rub�n Porras Campo
<debian-l10n-spanish@lists.debian.org> Actualizaci�n de Omar
Campagne Polaino