NOME

       install-docs - gere documentação online de Debian

SUMÁRIO

        install-docs [options] -i,--install | -r,--remove | -c,--check file [ file ... ]

        install-docs [options] -I,--install-all | -C,--install-changed | -R,--remove-all

        install-docs [options] -s,--status docid [ docid ... ]

        install-docs [options] --dump-db dbname

        install-docs -h,--help | -V,--version

DESCRIÇÃO

       install-docs é uma ferramenta que permite a maintainers de pacotes Debian registarem
       documentação em vários sistemas de documentação. Actualmente suporta os navegadores dhelp,
       dwww, dochelp, e doc-central.

       Este manual fornece um sumário rápido da utilização de install-docs. A documentação
       completa pode ser encontrada na documentação, incluindo a descrição da sintaxe e gramática
       do ficheiro de controle.

OPÇÕES

       -v, --verbose
           Opera em modo detalhado.

       -d, --debug
           Escreve alguma informação de depuração.

       --no-update-menus
           Inibe a execução de dwww-build-menu(8), e dhelp_parse(8).

       --rootdir dir
           Define o directório raiz para dir em vez de `/'. Útil e válido apenas com a opção
           --check.

ACÇÕES

       Em baixo está uma lista de possíveis acções que o install-docs pode manusear. Só pode
       existir uma opção de acção passada ao install-docs, mais ainda, a acção e os seus
       argumentos têm de ser a última opção passada.

       Cada argumento file deve ser o caminho completo para o ficheiro de controle do doc-base
       (isto é, `/usr/share/doc-base/some_file' ou `/etc/doc-base/documents/some_file'), e cada
       docid deve ser o identificador do documento (Identificadores de documentos são definidos
       no campo `Document' do ficheiro de controle, e geralmente correspondem ao nome do pacote.)

       Se file ou docid for igual a `-' (o sinal menos), a lista de argumentos é lida a partir da
       entrada standard (cada nome de ficheiro ou documento numa linha separada).

       -i file [file ...], --install file [file ...]
           Instala a documentação descrita pelo ficheiro de controle file.

       -r file [file ...], --remove file [file ...]
           Remove a documentação identificada pelo ficheiro de controle file.

       -c file [file ...], --check file [file ...]
           Verifica o ficheiro de controle file e mostra número de possíveis problemas
           encontrados. Use com --verbose para obter as localizações actuais dos erros e avisos.
           Se for também dado --rootdir, os seus argumentos serão juntados aos nomes dos
           ficheiros dados nos campos `Files' e `Index' de file.

       -R, --remove-all
           Apaga o registo de todos os documentos registados.

       -I, --install-all
           (Re)regista todos os documentos de /usr/share/doc-base e /etc/doc-base/documents.

       -C, --install-changed
           Compara o conteúdo dos directórios /usr/share/doc-base e /etc/doc-base/documents com a
           base de dados de documentos registados e apaga o registo de quaisquer ficheiros que
           estejam em falta e re-regista apenas os ficheiros alterados ou novos.

       -s docid [docid ...], --status docid [docid ...]
           Mostra o estado do identificador do documento docid.

       -L docid [docid ...], --listfiles docid [docid ...]
           Opção descontinuada. Nada faz.

       --dump-db dbname
           Despeja o conteúdo das bases de dados internas, para objectivos de depuração. dbname
           pode ser ou files.db ou status.db.

       -h, --help
           Mostra uma mensagem curta de ajuda.

       -V, --version
           Mostra informação da versão.

PROBLEMAS DE COMPATIBILIDADE

       As seguintes funcionalidades foram adicionadas na versão 0.8.4, por favor certifique-se de
       adicionar as linhas `Conflicts' ou `Depends' apropriadas se deseja usa-las nos scripts do
       seu pacote:

       •   suporte para passar mais do que um argumento às acções -i e -r,

       •   lendo argumentos a partir da entrada standard,

       •   acções -I,--install-all, -R, ---remove-all, -c, --check,

       •   opções -d, --debug, -h, --help.

       As opções -C, --install-changed, --dump-db, -V, --version foram adicionadas em 0.8.12.

FICHEIROS

       /usr/share/doc-base/
           A localização de ficheiros de controle doc-base fornecidos por vários pacotes.

       /etc/doc-base/documents/
           A localização de ficheiros de controle doc-base fornecidos pelo administrador local.

       /var/lib/doc-base/info/documents/
           A localização de ficheiros de controle registados.

       /var/lib/doc-base/info/status.db
           Estados dos documentos registados.

       /var/lib/doc-base/info/files.db
           Carimbos temporais e ids de documentos de ficheiros doc-base registados.

BUGS

       Veja <http://bugs.debian.org/doc-base>.

VEJA TAMBÉM

       dhelp(1), doccentral(1), dochelp(1), dwww(7), Manual doc-base de Debian
       /usr/share/doc/doc-base/doc-base.html/index.html

AUTOR

       Este programa foi originalmente escrito por Christian Schwarz <schwarz@debian.org>, para o
       sistema Debian GNU/Linux, e o seguinte responsável de manutenção foi Adam Di Carlo
       <aph@debian.org>. Robert Luberda <robert@debian.org> é actualmente quem o mantêm e
       expande.

       Este software foi destinado ao benefício da inteira comunidade de desenvolvedores e
       utilizadores de Debian. Se você está interessado em envolver-se com este software,  por
       favor junte-se à lista de mail <debian-doc@lists.debian.org>.