336 lines
10 KiB
HTML
336 lines
10 KiB
HTML
|
||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<HTML><HEAD><TITLE>Man page of DH_INSTALLDOCS</TITLE>
|
||
</HEAD><BODY>
|
||
<H1>DH_INSTALLDOCS</H1>
|
||
Section: Debhelper (1)<BR>Updated: 2020-03-27<BR><A HREF="#index">Index</A>
|
||
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<A NAME="lbAB"> </A>
|
||
<H2>NOME</H2>
|
||
|
||
|
||
|
||
dh_installdocs - instala documentação em directórios de compilação de
|
||
pacotes
|
||
<A NAME="lbAC"> </A>
|
||
<H2>RESUMO</H2>
|
||
|
||
|
||
|
||
<B>dh_installdocs</B> [<I>debhelper opções</I>] [<B>-A</B>] [<B>-X</B><I>item</I>]
|
||
[<I>ficheiro</I> ...]
|
||
<A NAME="lbAD"> </A>
|
||
<H2>DESCRIÇÃO</H2>
|
||
|
||
|
||
|
||
<B>dh_installdocs</B> é um programa debhelper que é responsável por instalar
|
||
documentação em <I>usr/share/doc/package</I> nos directórios de compilação de
|
||
pacotes.
|
||
<P>
|
||
|
||
Em compatibilidade 10 e anterior, <B><A HREF="/cgi-bin/man/man2html?1+dh_install">dh_install</A></B>(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 <B>dh_installdocs</B> ainda é útil para instalar
|
||
documentação relacionada com o empacotamento (ex. o ficheiro
|
||
<I>debian/copyright</I>).
|
||
<P>
|
||
|
||
Desde nível de compatibilidade 11 do debhelper em diante, o <B>dh_install</B>
|
||
irá procurar os ficheiros em <I>debian/tmp</I>, se não os encontrar no
|
||
directório actual (ou onde você o mandou procurar usando <B>--sourcedir</B>).
|
||
<P>
|
||
|
||
Em compatibilidade 11 e posterior, <B>dh_installdocs</B> oferece muitas das
|
||
características que o <B><A HREF="/cgi-bin/man/man2html?1+dh_install">dh_install</A></B>(1) também tem. Mais ainda, o
|
||
<B>dh_installdocs</B> também suporta o perfil de compilação <B>nodoc</B> para
|
||
excluir documentação (independentemente do nível de compatibilidade).
|
||
<A NAME="lbAE"> </A>
|
||
<H2>FICHEIROS</H2>
|
||
|
||
|
||
|
||
<DL COMPACT>
|
||
<DT id="1">debian/<I>pacote</I>.docs<DD>
|
||
|
||
|
||
Lista os ficheiros de documentação a serem instalados em <I>pacote</I>.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Supports substitution variables in compat 13 and later as documented in
|
||
<B><A HREF="/cgi-bin/man/man2html?7+debhelper">debhelper</A></B>(7).
|
||
<DT id="2"><I>debian/copyright</I><DD>
|
||
|
||
|
||
O ficheiro de copyright é instalado em todos os pacotes, a menos que esteja
|
||
disponível um ficheiro de copyright mais específico.
|
||
<DT id="3">debian/<I>pacote</I>.copyright<DD>
|
||
|
||
|
||
|
||
<DT id="4">debian/<I>pacote</I>.README.Debian<DD>
|
||
|
||
|
||
<DT id="5">debian/<I>pacote</I>.TODO<DD>
|
||
|
||
|
||
|
||
Cada um destes ficheiros são instalados automaticamente se presentes para um
|
||
<I>pacote</I>.
|
||
<DT id="6"><I>debian/README.Debian</I><DD>
|
||
|
||
|
||
|
||
<DT id="7"><I>debian/TODO</I><DD>
|
||
|
||
|
||
|
||
Estes ficheiros são instalados no primeiro pacote binário listado em
|
||
debian/control.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Note que os ficheiros <I></I><FONT SIZE="-1"><I>README</I></FONT><I>.debian</I> são também instalados como
|
||
<I></I><FONT SIZE="-1"><I>README</I></FONT><I>.Debian</I>, e os ficheiro <I></I><FONT SIZE="-1"><I>TODO</I></FONT><I></I> serão instalados como <I></I><FONT SIZE="-1"><I>TODO</I></FONT><I>.Debian</I>
|
||
em pacotes não nativos.
|
||
<DT id="8">debian/<I>pacote</I>.doc-base<DD>
|
||
|
||
|
||
instalado como ficheiros de controle doc-base. Note que o doc-id será
|
||
determinado a partir da entrada <B>Document:</B> 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.
|
||
<DT id="9">debian/<I>pacote</I>.doc-base.*<DD>
|
||
|
||
|
||
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.
|
||
</DL>
|
||
<A NAME="lbAF"> </A>
|
||
<H2>OPÇÕES</H2>
|
||
|
||
|
||
|
||
<DL COMPACT>
|
||
<DT id="10"><B>-A</B>, <B>--all</B><DD>
|
||
|
||
|
||
Instala todos os ficheiros especificados pelos parâmetros de linha de
|
||
comandos em <FONT SIZE="-1">TODOS</FONT> os pacotes em que actua.
|
||
<DT id="11"><B>-X</B><I>item</I>, <B>--exclude=</B><I>item</I><DD>
|
||
|
||
|
||
Exclui da instalação ficheiros que contenham <I>item</I> em qualquer ponto do
|
||
seu nome de ficheiro. Note que isto inclui ficheiros baseados em doc.
|
||
<DT id="12"><B>--sourcedir=</B><I>directório</I><DD>
|
||
|
||
|
||
Procura no directório especificado por ficheiros para serem instalados. Esta
|
||
opção requer compatibilidade 11 ou posterior (é ignorada em silêncio na
|
||
compatibilidade 10 ou anterior).
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Note que isto não é o mesmo que a opção <B>--sourcedirectory</B> usada pelos
|
||
comandos <B>dh_auto_</B><I>*</I>. Você raramente vai precisar de usar esta opção,
|
||
pois o <B>dh_installman</B> procura automaticamente por ficheiros em
|
||
<I>debian/tmp</I> no nível de compatibilidade 11 e superiores do debhelper.
|
||
<DT id="13"><B>--doc-main-package=</B><I>main-package</I><DD>
|
||
|
||
|
||
Define o pacote principal para pacote de documentação. Isto é usado para a
|
||
documentação do pacote de documentação em <I>/usr/share/doc/main-package</I> como recomendado pelo manual de politicas Debian 3.9.7 em §12.3.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
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.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Esta opção não pode ser usada quando o <B>dh_installdocs</B> é instruído a
|
||
actuar em múltiplos pacotes. Se precisar desta opção, você irá geralmente
|
||
precisar de combiná-la com <B>-p</B> para assegurar exactamente que um pacote é
|
||
actuado.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Por favor tenha em mente que alguma documentação (o ficheiro de copyright,
|
||
<FONT SIZE="-1">README</FONT>.Debian, etc.) não serão afectados por esta opção.
|
||
<DT id="14"><B>--link-doc=</B><I>pacote</I><DD>
|
||
|
||
|
||
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 <I>pacote</I>. Isto não
|
||
tem nenhum efeito quando se actual no próprio <I>pacote</I>, ou se o directório
|
||
de documentação a ser criado já existir quando o <B>dh_installdocs</B> é
|
||
executado. Para estar em conformidade com a política, o <I>pacote</I> tem de ser
|
||
um pacote binário que vem do mesmo pacote fonte.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
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 <B>-A</B> não terá nenhum efeito em pacotes com directórios
|
||
de documentação ``linkados'', e os ficheiros <I>copyright</I>, <I>changelog</I>,
|
||
<I></I><FONT SIZE="-1"><I>README</I></FONT><I>.Debian</I>, e <I></I><FONT SIZE="-1"><I>TODO</I></FONT><I></I> não serão instalados.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
(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 <B>dh_installdocs</B>.)
|
||
|
||
|
||
<P>
|
||
|
||
|
||
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 <B>--doc-main-package</B>), não irá usar um link
|
||
simbólico para a documentação do outro pacote.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
<B></B><FONT SIZE="-1"><B>CAVEAT 1</B></FONT><B></B>: 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.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Isto pode ser feito ao fornecer um ficheiro "debian/<I>pacote</I>.maintscript" e
|
||
usar o <B><A HREF="/cgi-bin/man/man2html?1+dh_installdeb">dh_installdeb</A></B>(1) para fornecer os fragmentos relevantes do script
|
||
do mantenedor.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
<B></B><FONT SIZE="-1"><B>CAVEAT 2</B></FONT><B></B>: O uso de <B>--link-doc</B> 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.
|
||
<DT id="15"><I>ficheiro</I> ...<DD>
|
||
|
||
|
||
Instala estes ficheiros como documentação no primeiro pacote em que se
|
||
actua. (Ou em todos os pacotes se for especificado <B>-A</B>).
|
||
</DL>
|
||
<A NAME="lbAG"> </A>
|
||
<H2>EXEMPLOS</H2>
|
||
|
||
|
||
|
||
Este é um exemplo de um ficheiro <I>debian/package.docs</I>:
|
||
<P>
|
||
|
||
|
||
|
||
<PRE>
|
||
README
|
||
TODO
|
||
debian/notes-for-maintainers.txt
|
||
docs/manual.txt
|
||
docs/manual.pdf
|
||
docs/manual-html/
|
||
|
||
</PRE>
|
||
|
||
|
||
<A NAME="lbAH"> </A>
|
||
<H2>NOTAS</H2>
|
||
|
||
|
||
|
||
Note que <B>dh_installdocs</B> irá alegremente copiar as hierarquias completas
|
||
dos directórios se você lhe pedir (semelhante a <B>cp -a</B>). Se lhe for pedido
|
||
para instalar um directório, irá instalar o conteúdo completo desse
|
||
directório.
|
||
<A NAME="lbAI"> </A>
|
||
<H2>VEJA TAMBÉM</H2>
|
||
|
||
|
||
|
||
<B><A HREF="/cgi-bin/man/man2html?7+debhelper">debhelper</A></B>(7)
|
||
<P>
|
||
|
||
Este programa é parte do debhelper.
|
||
<A NAME="lbAJ"> </A>
|
||
<H2>AUTOR</H2>
|
||
|
||
|
||
|
||
Joey Hess <<A HREF="mailto:joeyh@debian.org">joeyh@debian.org</A>>
|
||
<A NAME="lbAK"> </A>
|
||
<H2>TRADUÇÃO</H2>
|
||
|
||
|
||
|
||
Américo Monteiro
|
||
<P>
|
||
|
||
Se encontrar algum erro na tradução deste documento, por favor comunique para
|
||
Américo Monteiro <I><A HREF="mailto:a_monteiro@gmx.com">a_monteiro@gmx.com</A></I>
|
||
ou
|
||
Equipa Debian de Tradução Portuguesa <I><A HREF="mailto:traduz@debianpt.org">traduz@debianpt.org</A></I>.
|
||
<P>
|
||
|
||
<HR>
|
||
<A NAME="index"> </A><H2>Index</H2>
|
||
<DL>
|
||
<DT id="16"><A HREF="#lbAB">NOME</A><DD>
|
||
<DT id="17"><A HREF="#lbAC">RESUMO</A><DD>
|
||
<DT id="18"><A HREF="#lbAD">DESCRIÇÃO</A><DD>
|
||
<DT id="19"><A HREF="#lbAE">FICHEIROS</A><DD>
|
||
<DT id="20"><A HREF="#lbAF">OPÇÕES</A><DD>
|
||
<DT id="21"><A HREF="#lbAG">EXEMPLOS</A><DD>
|
||
<DT id="22"><A HREF="#lbAH">NOTAS</A><DD>
|
||
<DT id="23"><A HREF="#lbAI">VEJA TAMBÉM</A><DD>
|
||
<DT id="24"><A HREF="#lbAJ">AUTOR</A><DD>
|
||
<DT id="25"><A HREF="#lbAK">TRADUÇÃO</A><DD>
|
||
</DL>
|
||
<HR>
|
||
This document was created by
|
||
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
||
using the manual pages.<BR>
|
||
Time: 00:06:21 GMT, March 31, 2021
|
||
</BODY>
|
||
</HTML>
|