Linux Manpages Online - man.cx manual pages

NOME

dh_installman - instala manuais (man pages) em directórios de compilação de pacotes

RESUMO

dh_installman [debhelper opções] [manpage ...]

DESCRIÇÃO

dh_installman é um programa debhelper que lida com a instalação de paginas de manual (man pages) nas localizações correctas nos directórios de compilação de pacotes.

Em compatibilidade 10 e anteriores, este programa servia principalmente para quando o sistema de compilação do autor não os instalava apropriadamente como uma parte do seu passo de instalação (ou não possuía um passo de instalação). Em compatibilidade 11 e posterior, também suporta o predefinido searchdir plus --sourcedir como dh_install(1) e tem a vantagem de respeitar o perfil de compilação nodoc (ao contrário de dh_install(1)).

Mesmo que prefira usar dh_install(1) para instalar os manuais, o dh_installman pode ainda ser útil para converter a codificação da pagina de manual para UTF-8 e para converter links .so (como descrito abaixo). No entanto, essa parte acontece automaticamente sem nenhuma configuração explícita.

Você diz ao dh_installman quais manuais vão para os seus pacotes, e ele descobre onde os instalar com base no campo secção na sua linha .TH ou .Dt. Se você tem uma linha .TH ou .Dt correctamente formatada, o seu manual será instalado no directório correcto, com o nome correcto (isto inclui o manuseamento apropriado de páginas com uma sub-secção, como 3perl, a qual é colocada em man3, e é-lhe dada uma extensão .3perl). Se a sua linha .TH ou .Dt está incorrecta ou em falta, o programa pode adivinhar errado com base na extensão do ficheiro.

Também suporta manuais traduzidos, ao procurar extensões como .ll.8 e .ll_LL.8, ou pelo uso do switch --language.

Se o dh_installman parecer instalar um manual numa secção errada ou com a extensão errada, é porque o manual tem a secção errada listada nas suas linhas .TH or .Dt. Edite o manual e corrija a secção, e o dh_installman funcionará bem. Veja man(7) para detalhes acerca da secção .TH, e mdoc(7) para a secção .Dt. Se o dh_installman parecer instalar um manual num directório como /usr/share/man/pl/man1/, é porque o seu programa tem um nome como foo.pl, e o dh_installman assume que isso significa que está traduzido em Polaco. Use --language=C para evitar isto.

Após o passo da instalação do manual, o dh_installman irá verificar se algum dos manuais nos directórios temporários de todos os pacotes em que actua se contêm links .so. Se sim, altera-os para links simbólicos.

O dh_installman também irá usa o man para adivinhar a codificação de caracteres de cada manual e convertê-los para UTF-8. Se o trabalho de adivinhar falhar por alguma razão, você pode-o sobrepor usando uma declaração de codificação. Veja manconv(1) para detalhes.

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).

FICHEIROS

debian/pacote.manpages

Lista os manuais (man pages) a serem instalados.

Suporta variáveis de substituição em compatibilidade 13 e posterior como documentado em debhelper(7).

OPÇÕES

-A, --all

Instala todos os ficheiros especificados pelos parâmetros de linha de comandos em TODOS os pacotes em que actua.

--language=ll

Use isto para especificar que os manuais onde se vai actuar estão escritos na linguagem especificada.

--sourcedir=directório

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).

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.

manpage ...

Instala estes manuais no primeiro pacote onde se actua. (Ou em todos os pacotes caso for especificado -A).

EXEMPLOS

Um exemplo de ficheiro debian/manpages poderá parecer como isto:

  doc/man/foo.1
  # Translations
  doc/man/foo.da.1
  doc/man/foo.de.1
  doc/man/foo.fr.1
  # NB: The following line is considered a polish translation
  # of "foo.1" (and not a manpage written in perl called "foo.pl")
  doc/man/foo.pl.1
  # ...

NOTAS

Uma versão mais antiga deste programa, o dh_installmanpages(1), é ainda usado por alguns pacotes, e por isso ainda é incluída no debhelper. No entanto, está descontinuada, devido à sua interface contra-intuitiva e inconsistente. Use antes este programa.

Manpages