NOME¶

debhelper - a suite de ferramentas debhelper

SINOPSE¶

dh_* [-v] [-a] [-i] [-s] [--no-act] [ -ppacote] [ -Npacote] [-P tmpdir]

DESCRIÇÃO¶

Debhelper é usado para ajudá-lo a compilar um pacote Debian. A filosofia por detrás de debhelper é disponibilizar uma colecção de ferramentas pequenas, simples e de fácil compreensão que são usadas em debian/rules para automatizar vários aspectos comuns da compilação de um pacote. Isto significa menos trabalho para si, o empacotador. Também significa, até certo ponto, que estas ferramentas podem ser alteradas se a política de Debian alterar, e os pacotes que as usam irão precisar apenas de uma recompilação para ficarem em conformidade com a nova política. Um ficheiro debian/rules típico que usa debhelper irá chamar vários comandos debhelper em sequência, ou usar dh(1) para automatizar este processo. Em /usr/share/doc/debhelper/examples/ estão exemplos de ficheiros de regras que usam debhelper. Para criar um novo pacote Debian usando o debhelper, você pode copiar um dos ficheiros de regras exemplo e editá-lo à mão. Ou pode tentar o pacote dh-make, o qual contém um comando dh_make que automatiza parcialmente o processo Para uma introdução mais gentil, o pacote Debian maint-guide contém um tutorial acerca de como fazer o seu primeiro pacote usando o debhelper.

COMANDOS DO DEBHELPER¶

Aqui está a lista dos comandos debhelper que você pode usar. Veja os seus manuais para documentação adicional.

Comandos Descontinuados¶

Alguns comandos debhelper estão descontinuados e não devem ser usados.

Outros comandos¶

Se o nome dum programa começa com dh_, e o programa não está nas listas em cima, então não faz parte do pacote debhelper, mas mesmo assim deverá funcionar como os outros programas descritos nesta página.

FICHEIROS DE CONFIGURAÇÃO DO DEBHELPER¶

Muitos comandos do debhelper usam ficheiros em debian/ para controlar o que fazem. Para além dos comuns debian/changelog e debian/control, que estão em todos os pacotes, e não apenas aqueles que usam debhelper, alguns ficheiros adicionais podem ser usados para configurar o comportamento de comandos debhelper específicos. Estes ficheiros são chamados tipicamente debian/ pacote.foo (onde pacote é claro, é substituído pelo nome do pacote no qual se está a actuar). Por exemplo, dh_installdocs usa ficheiros chamados debian/package.docs para listar os ficheiros de documentação que ira instalar. Veja os manuais individuais dos comandos para detalhes acerca dos nomes e formatos dos ficheiros que usam. Geralmente, estes ficheiros irão listar ficheiros onde se vai actuar, um ficheiro por linha. Alguns programas no debhelper usam pares de ficheiros e destinos ou formatos ligeiramente mais complicados. Note que para o primeiro (ou único) pacote binário listado em <debian/control>, o debhelper irá usar debian/foo quando não existe nenhum ficheiro debian/package.foo. Em alguns casos raros, você pode querer ter versões diferentes destes ficheiros para arquitecturas ou sistemas operativos diferentes. Se existirem ficheiros chamados debian/ pacote.foo.ARCH ou debian/ pacote.foo.OS, onde ARCH e OS são o mesmo que o resultado de " dpkg-architecture -qDEB_HOST_ARCH" / " dpkg-architecture -qDEB_HOST_ARCH_OS", então eles irão ser usados em preferência de outros ficheiros mais gerais. Maioritariamente, estes ficheiros de configuração são usados para especificar listas de vários tipos de ficheiros. Documentação ou ficheiros exemplo para instalar, ficheiros para mover, e etc. Quando apropriado, em casos como estes, você pode usar caracteres "wildcard" de shell standard (classes de caracteres ? e * e [..]) nos ficheiros. Também pode meter comentários neste ficheiros; as linhas começadas com # são ignoradas. A sintaxe destes ficheiros é mantida propositadamente simples para os tornar fáceis de ler, perceber, e modificar. Se você preferir o poder e a complexidade, pode tornar o ficheiro executável, e escrever um programa que gere um conteúdo apropriado para uma dada situação seja ela qual for. Quando o fizer, o resultado já não é mais processado para expandir wildcards ou despojar comentários.

OPÇÕES DO DEBHELPER PARTILHADAS¶

As seguintes opções de linha de comandos são suportadas por todos os programas do debhelper.

-v, --verbose

Modo detalhado: mostra todos os comandos que modificam o directório de compilação de pacotes.

--no-act

Não faz nada na realidade. Se usado com -v, o resultado é que o comando mostra o que iria fazer.

-a, --arch

Actua em pacotes dependentes da arquitectura que devem ser compilados para a arquitectura de compilação.

-i, --indep

Actua em todos os pacotes independentes da arquitectura.

-ppacote, --package=pacote

Actua no pacote chamado pacote. Esta opção pode ser especifica várias vezes para fazer o debhelper operar num determinado conjunto de pacotes.

-s, --same-arch

Isto costumava ser uma versão mais inteligente da bandeira -a, mas a bandeira -a é agora igualmente inteligente.

-Npacote, --no-package=pacote

Não actua no pacote especificado mesmo se uma opção -a, -i, ou -p listarem o pacote como um em que se deverá actuar.

--remaining-packages

Não actua nos pacotes que já foram actuados antes por este comando do debhelper (isto é, se o comando estiver presente no debhelper log do pacote). Por exemplo, se você precisar de chamar o comando com opções especiais apenas para um par de pacotes binários, passe esta opção para a última chamada do comando para processar o resto dos pacotes com as definições predefinidas.

--ignore=ficheiro

Ignora o ficheiro especificado. Isto pode ser usado se debian/ conter um ficheiro de configuração de debhelper que um comando debhelper não deve usar. Note que debian/compat, debian/control, e debian/changelog não podem ser ignorados, mas também, nunca deverá existir uma razão para ignorar estes ficheiros.

Por exemplo, se o autor do programa juntar um debian/init que você não quer que dh_installinit instale, use --ignore=debian/init

-Ptmpdir, --tmpdir=tmpdir

Usa tmpdir para directório de compilação de pacotes. A predefinição é debian/ pacote

--mainpackage=pacote

Esta opção pouco usada muda o pacote que o debhelper considera o "pacote principal", isto é, o primeiro listado em debian/control, e aquele para o qual os ficheiros debian/foo podem ser usados em vez dos ficheiros debian/package.foo usuais.

-O=opção|bundle

Isto é usado pelo dh(1) quando se passa opções específicas do utilizador a todos os comandos que corre. Se o comando suportar a opção ou opções especificadas, irá fazer efeito. Se o comando não suportar a opção (ou alguma parte do conjunto de opções), será ignorado.

OPÇÕES COMUNS DO DEBHELPER¶

As seguintes opções de linha de comandos são suportadas por alguns programas do debhelper. Veja o manual de cada programa para uma explicação completa sobre o que cada opção faz.

-n

Não modifique os scripts postinst, postrm, etc.

-Xitem, --exclude=item

Exclui um item do processamento. Esta opção pode ser usada várias vezes, para excluir mais do que uma coisa. O \fIitem\fR é tipicamente parte de um nome de ficheiro, e qualquer ficheiro que contenha o texto especificado será excluído.

-A, --all

Faz com que ficheiros ou outros itens que são especificados na linha de comandos tenham efeito em TODOS os pacotes em que se actua, e não apenas o primeiro.

OPÇÕES DO SISTEMA DE COMPILAÇÃO¶

As seguintes opções de linha de comandos são suportadas por todos os comandos dh_auto_* do debhelper. Estes programas suportam uma variedade de sistemas de compilação, e normalmente determinam heurísticamente qual usar, e como os usar. Você pode usar estes opções de linha de comandos para sobrepor o comportamento predefinido. Tipicamente estas são passadas ao dh(1), o qual passa-as a todos os programas dh_auto_*.

-Ssistemacompilação, --buildsystem=sistemacompilação

Força a utilização do |<sistemacompilação> especificado, em vez de tentar auto-seleccionar um que pode ser aplicável para o pacote.

-Ddirectório, --sourcedirectory=directório

Assume que a árvore fonte do pacote original está no directório especificado em vez de estar no directório de nível de topo da árvore de pacotes fonte de Debian.

-B[directório], --builddirectory=[directório]

Activa a compilação da fonte e usa o directório especificado como o directório de compilação. Se o parâmetro directório for omitido, é escolhido o directório de compilação predefinido.

Se esta opção não for especificada, a compilação será feita por predefinição na fonte a menos que o sistema de compilação requeira ou prefira a compilação da árvore de fonte. Em tal caso, será usado o directório de compilação predefinido mesmo se --builddirectory não seja especificado.

Se o sistema de compilação preferir a compilação da árvore fonte mas ainda permitir a compilação da fonte, a última pode ser re-activada ao passar-lhe um caminho para um directório de compilação que é o mesmo que o caminho para o directório fonte.

--parallel

Activa compilações paralelas se o sistema de compilação o suportar. O número de trabalhos paralelos é controlado pela variável de ambiente DEB_BUILD_OPTIONS ("Debian Policy, secção 4.9.1") durante a compilação. Também pode servir como um limite específico do sistema de compilação.

Se esta opção não for especificada, presentemente o debhelper usa por predefinição a não autorização de compilação de pacotes em paralelo.

--max-parallel=máximo

Esta opção implica --parallel e permite mais limitação ao número de trabalhos que podem ser usados numa compilação paralela. Se a compilação do pacote é conhecida por apenas funcionar em certos níveis de concorrência, você pode definir isto para o nível máximo que é sabido funcionar, ou que deseje suportar.

--list, -l

Lista todos os sistemas de compilação suportados pelo debhelper neste sistema. A lista inclui ambos sistemas de compilação predefinidos e de terceiros (marcados como tal). Também mostra qual o sistema de compilação será seleccionado automaticamente, ou qual está especificado manualmente com a opção --buildsystem.

NÍVEIS DE COMPATIBILIDADE¶

De tempos a tempos, precisam de ser feitas grandes alterações no debhelper que não compatíveis com as versões anteriores, para o manter limpo e bem construído quando as necessidades alteram e o seu autor ganha mais experiência. Para prevenir que tais grandes alterações danifiquem os pacotes existentes, foi introduzido o conceito de níveis de compatibilidade no debhelper. Você diz ao debhelper qual o nível de compatibilidade que ele deve usar, e ele modifica o seu comportamento de várias maneiras. Diz ao debhelper qual nível de compatibilidade deve usar ao escrever um número em debian/compat. Por exemplo, para activar o modo v9:

  % echo 9 > debian/compat

O seu pacote também vai precisar de uma dependência de compilação de versão de uma versão do debhelper igual (ou maior que) ao nível de compatibilidade que o seu pacote usa. Portanto para nível de compatibilidade 9, certifique-se que debian/control tem:

  Build-Depends: debhelper (>= 9)

A menos que seja indicado o contrário, toda a documentação do debhelper assume que você está a usar o nível de compatibilidade mais recente, e na maioria dos casos não indica se o comportamento é diferente num nível de compatibilidade anterior, portanto se não está a usar o nível de compatibilidade mais recente, você é aconselhado a procurar em baixo por notas acerca do que é diferente nos níveis de compatibilidade anteriores. Estes são os níveis de compatibilidade disponíveis:

v1

Este é o nível de compatibilidade original do debhelper, e por isso é o predefinido. Neste modo, o debhelper irá usar debian/tmp como o directório da árvore do pacote para o primeiro pacote binário listado no ficheiro de controle, enquanto usa debian/ pacote para todos os outros pacotes listados no ficheiro control.

Este modo está descontinuado.

v2

Neste modo, o debhelper irá consistentemente usar debian/pacote como o directório da árvore do pacote para cada pacote que é compilado.

Este modo está descontinuado.

v3

Este modo funciona como v2, com as seguintes adições:

v4

As alterações a partir de v3 são:

v5

As alterações a partir de v4 são:

v6

As alterações a partir de v5 são:

v7

As alterações a partir de v6 são:

v8

As alterações a partir de v7 são:

v9

Este é o modo de operação recomendado.

As alterações a partir de v8 são:

v10

Este nível de compatibilidade ainda está aberto em desenvolvimento; use com cuidado.

As alterações a partir de v9 são:

NOTAS¶

Suporte a pacotes de múltiplos binários¶

Se o seu pacote fonte gerar mais do que um pacote binário, os programas do debhelper, por predefinição, irão actuar em todos os pacotes binários quando correm. No caso do seu pacote fonte gerar um pacote dependente de arquitectura, e outro pacote independente da arquitectura, este não é o comportamento correcto, porque você precisa de gerar os pacotes dependentes de arquitectura na meta debian/rules binary-arch, e os pacotes independentes de arquitectura na meta debian/rules binary-indep. Para facilitar isto, e também para lhe dar mais controle sobre em quais pacotes os programas debhelper actuam, todos os programas debhelper aceitam os parâmetros -a, -i, -p, e -s. Estes parâmetros são cumulativos. Se nenhum for usado, os programas debhelper por predefinição actuam em todos os pacotes listados no ficheiro de controle, com as excepções em baixo. Primeiro, qualquer pacote cujo campo Architecture em debian/control não corresponda à arquitectura de compilação será excluído ("Debian Policy, secção 5.6.8"). Também, alguns pacotes adicionais podem ser excluídos com base no conteúdo da variável de ambiente DEB_BUILD_PROFILES e nos campos Build-Profiles nas estrofes de pacotes binários em debian/control, de acordo com a política proposta em <https://wiki.debian.org/BuildProfileSpec>.

Geração automática de scripts de instalação Debian¶

Alguns comandos do debhelper irão gerar automaticamente partes de scripts de mantenedor Debian. Se desejar que estas coisas geradas automaticamente sejam incluídas nos sues scripts de mantenedor Debian existentes, então você precisa adicionar #DEBHELPER# aos seus scripts, no local onde o código deverá ser adicionado. #DEBHELPER# será substituído por qualquer código auto-gerado quando você correr o dh_installdeb. Se não existir nenhum script e o debhelper precisar de adicionar algo a ele, então o debhelper irá criar o script completo. Todos os comandos debhelper que geram código automaticamente deste modo permitem que o seja desactivado pelo parâmetro -n (ver em cima). Note que o código inserido será código shell, portanto você não pode usá-lo directamente num script de Perl. Se desejar embebê-lo num script Perl, aqui está um modo de o fazer (note que Eu certifico-me que $1, $2, etc são definidos com o comando "set"):

  my $temp="set -e\nset -- @ARGV\n" . << 'EOF';
  #DEBHELPER#
  EOF
  system ($temp) / 256 == 0
        or die "Problem with debhelper scripts: $!";

Geração automática de dependências variadas.¶

Alguns programas debhelper podem fazer com que o pacote gerado precise de depender de alguns outros pacotes. Por exemplo, se você usar o dh_installdebconf(1), o seu pacote irá geralmente depender do debconf. Ou se você usar dh_installxfonts(1), o seu pacote irá geralmente depender de uma versão particular do xutils. Acompanhar estas dependências variadas pode ser aborrecido pois elas dependem de como o debhelper faz as coisas, então o debhelper oferece um modo de automatizar isto. Todos os comandos deste tipo, além de documentar quais dependências podem ser necessárias nos seus manuais, irão gerar automaticamente um substvar chamado ${misc:Depends}. Se você colocar esse testemunho no seu ficheiro debian/control, será expandido às dependências que o debhelper descobre que você precisa. Isto é inteiramente independente do standard ${shlibs:Depends} gerado pelo dh_makeshlibs(1), e do ${perl:Depends} gerado pelo dh_perl(1). Você pode escolher usar qualquer um destes, se as escolhas do debhelper não corresponderem à realidade.

Directórios de compilação de pacotes¶

Por predefinição, todos os programas do debhelper assumem que o directório temporário usado para montar a árvore de ficheiros num pacote é debian/ pacote. Por vezes, você pode querer usar outro directório temporário. Isto é suportado pela bandeira -P, por exemplo, " dh_installdocs -Pdebian/tmp", irá usar debian/tmp como directório temporário. Note que se você usar -P, os programas debhelper só podem actuar num pacote de cada vez. Por isso se tem um pacote que compila muitos pacotes binários, irá também precisar de usar a bandeira -p para especificar em qual pacote binário o programa debhelper irá actuar.

udebs¶

Debhelper inclui suporte para udebs. Para criar um udeb com o debhelper, adicione " Package-Type: udeb" à estrofe do pacote em debian/control. O Debhelper irá tentar criar udebs em conformidade com a política do instalador debian, ao finalizar os ficheiros de pacotes gerados com .udeb, não instalando nenhuma documentação num udeb, saltando os scripts preinst, postrm, prerm, e config, etc.

AMBIENTE¶

DH_VERBOSE

Defina para 1 para activar o modo detalhado. O debhelper irá mostrar os resultados de cada comando que corre. Também activa relatórios de compilação detalhados para alguns sistemas de compilação como o autoconf.

DH_COMPAT

Especifica temporariamente em que nível de compatibilidade o debhelper deve correr, sobrepondo qualquer valor em debian/compat.

DH_NO_ACT

Defina para 1 para activar o modo no-act.

DH_OPTIONS

Qualquer coisa nesta variável será pre-confinada aos argumentos de linha de comandos de todos os comandos do debhelper.

Quando se usa dh(1), podem-se passar opções que irão ser passadas a cada comando do debhelper, o que é geralmente melhor do que usar DH_OPTIONS.

DH_ALWAYS_EXCLUDE

Se definido, isto adiciona o valor que está definido na variável às opções -X de todos os comandos que suportam a opção -X. Ainda mais, o dh_builddeb irá fazer rm -rf a tudo o que corresponda a esse valor na sua árvore de compilação do pacote.

Isto pode ser útil se você está a fazer uma compilação a partir de uma árvore fonte CVS, que no caso definindo DH_ALWAYS_EXCLUDE=CVS irá prevenir que quaisquer directórios CVS se esgueirem para o pacote que está a compilar. Ou, se um pacote tem um tarball de fonte que (não inteligentemente) inclui directórios CVS, você pode querer exportar DH_ALWAYS_EXCLUDE=CVS em debian/rules, para o fazer ter efeito onde o seu é compilado.

Várias coisas a excluir podem ser separadas com "dois pontos", como em DH_ALWAYS_EXCLUDE=CVS:.svn

VEJA TAMBÉM¶

/usr/share/doc/debhelper/examples/

Um conjunto de ficheiros debian/rules exemplo que usam debhelper.

<http://joeyh.name/code/debhelper/>

Sítio web 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.