Em compatibilidade 10 e anterior, dh_install(1) pode ser a melhor ferramenta para lidar com a documentação do autor, quando o sistema de compilação próprio do autor instala toda a documentação desejada correctamente Neste caso, o dh_installdocs ainda é útil para instalar documentação relacionada com o empacotamento (ex. o ficheiro debian/copyright).
Desde nível de compatibilidade 11 do debhelper em diante, o dh_install irá procurar os ficheiros em debian/tmp, se não os encontrar no directório actual (ou onde você o mandou procurar usando --sourcedir).
Em compatibilidade 11 e posterior, dh_installdocs oferece muitas das características que o dh_install(1) também tem. Mais ainda, o dh_installdocs também suporta o perfil de compilação nodoc para excluir documentação (independentemente do nível de compatibilidade).
Supports substitution variables in compat 13 and later as documented in debhelper(7).
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.
Note que isto não é o mesmo que a opção --sourcedirectory usada pelos comandos dh_auto_*. Você raramente vai precisar de usar esta opção, pois o dh_installman procura automaticamente por ficheiros em debian/tmp no nível de compatibilidade 11 e superiores do debhelper.
Em compatibilidade 11 (ou posterior), esta opção apenas é útil se a auto-detecção do debhelper do pacote principal está errada. A opção também pode ser usada para silenciar um aviso do debhelper quando a auto-detecção falha mas acontece a predefinição estar correcta.
Esta opção não pode ser usada quando o dh_installdocs é instruído a actuar em múltiplos pacotes. Se precisar desta opção, você irá geralmente precisar de combiná-la com -p para assegurar exactamente que um pacote é actuado.
Por favor tenha em mente que alguma documentação (o ficheiro de copyright, README.Debian, etc.) não serão afectados por esta opção.
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.)
Por favor note que esta opção apenas é aplicada ao directório de documentação para o próprio pacote. Quando o pacote embarca documentação para outro pacote (ex. veja --doc-main-package), não irá usar um link simbólico para a documentação do outro pacote.
CAVEAT 1: 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.
CAVEAT 2: O uso de --link-doc apenas deve ser feito quando os pacotes têm o mesmo tipo de ``arquitectura''. Um link de um pacote independente de uma arquitectura para um pacote depende de uma arquitectura (ou vice-versa) não irá funcionar. Desde compatibilidade 10, o debhelper irá rejeitar activamente combinações não suportadas.
README TODO debian/notes-for-maintainers.txt docs/manual.txt docs/manual.pdf docs/manual-html/
Este programa é parte do debhelper.
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.