NOME¶
dh_installdocs - instala documentação em directórios de
compilação de pacotes
RESUMO¶
dh_installdocs [
debhelper opções] [
-A]
[
-Xitem] [
ficheiro ...]
DESCRIÇÃO¶
dh_installdocs é um programa debhelper que é
responsável por instalar documentação em
usr/share/doc/package nos directórios de
compilação de pacotes.
FICHEIROS¶
- debian/pacote.docs
- Lista os ficheiros de documentação a serem instalados em
pacote.
No nível de compatibilidade 11 (ou posterior), estes serão
instalados em /usr/share/doc/mainpackage. Previamente seria
/usr/share/doc/package.
- debian/copyright
- O ficheiro de copyright é instalado em todos os pacotes, a menos
que esteja disponível um ficheiro de copyright mais
específico.
- debian/pacote.copyright
- debian/pacote.README.Debian
- debian/pacote.TODO
- Cada um destes ficheiros são instalados automaticamente se
presentes para um pacote.
- debian/README.Debian
- debian/TODO
- Estes ficheiros são instalados no primeiro pacote binário
listado em debian/control.
Note que os ficheiros README.debian são também
instalados como README.Debian, e os ficheiro TODO
serão instalados como TODO.Debian em pacotes não
nativos.
- debian/pacote.doc-base
- instalado como ficheiros de controle doc-base. Note que o doc-id
será determinado a partir da entrada Document: no ficheiro
de controle de doc-base em questão. Na eventualidade de
múltiplos ficheiros doc-base num pacote fonte partilharem o mesmo
doc-id, eles serão instalados em usr/share/doc-base/package em vez
de usr/share/doc-base/doc-id.
- debian/pacote.doc-base.*
- Se o seu pacote precisa de registar mais do que um documento, você
precisa de vários ficheiros baseados em doc, e pode
nomeá-los desta maneira. Na eventualidade de vários
ficheiros baseados em doc deste estilo num único pacote fonte
partilharem o mesmo doc-id, serão instalados em
usr/share/doc-base/package-* em vez de usr/share/doc-base/doc-id.
OPÇÕES¶
- -A, --all
- Instala todos os ficheiros especificados pelos parâmetros de linha
de comandos em TODOS os pacotes em que actua.
- -Xitem, --exclude=item
- Exclui da instalação ficheiros que contenham item em
qualquer ponto do seu nome de ficheiro. Note que isto inclui ficheiros
baseados em doc.
- --link-doc=pacote
- Faz com que o directório de documentação de todos os
pacotes onde actua seja um link simbólico para o directório
de documentação do pacote. Isto não tem nenhum
efeito quando se actual no próprio pacote, ou se o
directório de documentação a ser criado já
existir quando o dh_installdocs é executado. Para estar em
conformidade com a política, o pacote tem de ser um pacote
binário que vem do mesmo pacote fonte.
O debhelper irá tentar evitar instalar ficheiros em
directórios de documentação "linkados" que
poderão causar conflitos com o pacotes "linkado". A
opção -A não terá nenhum efeito em
pacotes com directórios de documentação
"linkados", e os ficheiros copyright, changelog,
README.Debian, e TODO não serão instalados.
(Um outro método de consegui o mesmo, o qual ainda é
suportado, é tornar o directório de
documentação de um pacote num link simbólico
pendente, antes de chamar o dh_installdocs.)
CAVEAT: Se uma versão anterior do pacote foi compilada sem
esta opção e for agora compilada com ela (ou vice-versa),
precisa de uma migração de dir para symlink" (ou de
"symlink para dir"). Como o debhelper não tem
conhecimento das versões anteriores, você terá que
ser o próprio a activar esta migração.
Isto pode ser feito ao fornecer um ficheiro "debian/
pacote.maintscript" e usar o dh_installdeb(1) para
fornecer os fragmentos relevantes do script do mantenedor.
- ficheiro ...
- Instala estes ficheiros como documentação no primeiro pacote
em que se actua. (Ou em todos os pacotes se for especificado
-A).
EXEMPLOS¶
Este é um exemplo de um ficheiro
debian/package.docs:
README
TODO
debian/notes-for-maintainers.txt
docs/manual.txt
docs/manual.pdf
docs/manual-html/
NOTAS¶
Note que
dh_installdocs irá alegremente copiar as hierarquias
completas dos directórios se você lhe pedir (semelhante a
cp
-a). Se lhe for pedido para instalar um directório, irá
instalar o conteúdo completo desse directório.
VEJA TAMBÉM¶
debhelper(7)
Este programa é parte do debhelper.
AUTOR¶
Joey Hess <joeyh@debian.org>
TRADUÇÃO¶
Américo Monteiro
Se encontrar algum erro na tradução deste documento, por favor
comunique para Américo Monteiro
a_monteiro@gmx.com ou Equipa
Debian de Tradução Portuguesa
traduz@debianpt.org.