man - páginas do manual - dicas e indicações

Atualizado em: 12/08/2006



Sobre este documento

Dicas, indicações de tutoriais e assuntos relacionados ao sistema de ajuda, páginas do manual (man)

man - Man pages. Páginas do manual sobre comandos e programas em geral.

Os comandos e dicas podem não atender as suas necessidades, não ser compatível com sua instalação ou ambiente, use como referencia, tente adaptar ao seu ambiente.

Ambiente gráfico - Páginas do man e docs.

Quase todas as distro tem opção para instalar em idioma Português, algumas tem poucas páginas traduzidas e outras tem até documentação extra em Português, como exemplo o SUSE 10.1, tem dois manuais em PDF para download e um pacote especifico sobre o manual em Português.

  suselinux-manual_pt_BR - SUSE Linux Manual  (Brazilian Portuguese)

Instale o pacote suselinux-manual_pt_BR e cole na URL do navegador

  /usr/share/doc/manual/suselinux-manual_pt_BR/manual/index.html

Sobre o download dos PDF, mais dicas e endereços, consulte o tutorial sobre SUSE e outras distros, indicação no final deste documento.

Páginas do manual (man) em ambiente gráfico, quem tem medo ou não gosta da coisa preta (shell, Konsole, terminal prompt da linha de comando ....)

Via KDE use o Konqueror, além de navegador web e gerenciador de arquivos local, aceita diversos comandos na URL, entre eles comandos para acessar as páginas do manual.

Navegar nestas páginas depende da versão do KDE, em versões mais recentes tudo é muito fácil, basta digitar na URL: man:/ ou info: e navegar, dar seus cliques...

Konqueror exibe as seções de paginas no man, digite na barra de endereço, localização, URL:

man:/ exibe a lista de páginas, selecione a desejada ou digite também o comando.

man:/comando abre a página do comando indicado, ou exibe a lista quando tiver mais de uma disponível, exemplo; man:/ls, man:/find e assim por diante...

Abrevie com # em lugar de man, digite #comando que o konqueror substitui automaticamente por man:/comando, por exemplo: #ls, #find e etc....

Veja os resultados de:

  man:/man
  man:/help
  man:/info
  info:
  help:

Outra opção, pressione as teclas ALT+F2 e digite na caixa de dialogo para executar programas.

xman

Ou diretamente no konsole (linha de comando de um terminal), digite: xman

Mesmo chamando a partir da linha de comando, abre no desktop a janela com opções de consulta, tem caixa de pesquisa e muito mais, use a abuse, documentação tem à vontade.

Tente posicionar o ponteiro do mouse na barra de rolagem e clique com com botão acionador e botão auxilar, use também as teclas PageUp e PageDow, barra de espaço

Páginas do manual em HTML: man man2html

  man2html - convert UNIX nroff(1) manual pages to HTML format

Páginas do manual em formatos diferente, consulta no terminal, impressão ou salvar em arquivo, compare as diferenças na saída destes comandos:

    man bash
    man bash -Pcat

No prompt pode consultar um "man customizado" do bash, para refinar pequisa no manual do bash, help <recurso_bash>

Exemplos para pesquisar somente sobre echo e eval

help echo

help eval

somente help no prompt retorna as opções de uso.

Veja também.

  man nroff
  
  nroff - emulate nroff command with groff

Alguns pacotes tem seu diretório com mais documentação em:

   /usr/share/doc/<pacote>

Pelo gerenciador de arquivos ou navegador, inicie com o endereço abaixo na URL:

    /usr/share/doc/

Na página do manual tem o significado de cada opção e tem muito mais em: man man

Instalar manual - Ambiente texto, shell, console, linha de comando.....

O man é um leitor de páginas do manual, portanto requer o programa man instalado, também as respectivas páginas do manual que são instaladas automaticamente junto com seus respectivos pacotes, isto para pacotes que tenha a página, portanto a simples instalação do man não inclui todas as páginas do manual.

A instalação default das distro inclui automaticamente diversos programas de uso na linha de comando, incluindo o man leitor de manual e respectivo manual destes programas, caso tenha feito instalação personalizada e não selecionou as páginas do man, pode instalar a qualquer momento, isto é raro, caso precise instalar, use o gerenciador de pacotes da distro para instalar o pacote man, mais dicas especificas sobre algumas distro e gerenciadores de pacotes, veja indicação no final deste documento.

O que chamamos de comandos como find, cp, ls e muitos outros, na realidade são programas ou scripts específicos para estas tarefas, a maioria deles são aplicativos que estão instalados em /bin/ e /usr/bin/, alguns em outros locais, o pacote coreutils instala diversos, descrever quais são de cada pacote vai gerar uma lista muito grande, para saber mais, pesquise por eles com seu gerenciador de pacotes, ver quais os aplicativos do pacote coreutils, execute:

info coreutils

Acessar o help especifico de um aplicativo listado em info coreutils digite info aplicativo, exemplos:

info coreutils cat

Outros formatos e resultados sobre cat

     man cat
     cat --help
     info cat

Versão do programa utilize o parametro --version: cat --version

Cada programas ou pacotes tem seu manual, forma de executar e suas peculiaridades, mas tudo de forma organizada, com manual dentro das regras, quando não segue tem que procurar pela documentação dentro do diretório do pacote ou comandos específicos sobre ele.

Exemplo de como identificar um programa em distribuições que usam pacotes rpm, (RedHat, Fedora, Mandriva, SUSE ...), descobrir qual pacote instalou determinado programa, whereis programa indica o caminho, exemplo.

whereis tail retorna o endereço do executável, retorna este endereço /usr/bin/tail

rpm -qif /usr/bin/tail

informa o pacote coreutils.

Faça o mesmo para os demais executáveis como ls, cp, dd e etc..

Veja a lista completa dos utilitários que fazem parte do pacote coreutils

rpm -ql coreutils

Além da página no manual, muitos pacotes tem documentação extra, exemplos de arquivos de configuração comentado, arquivos em formato texto, no site do desenvolvedor ou mantenedor do pacote, até scripts trazem texto explicativo.

No mesmo local do download ou no site do mantenedor do pacote você encontra vasta documentação, FAQ, lista de discussão e até e-mail pra contato.

Tendo dificuldade com o idioma, use tradutores. Encontrando bug avise o desenvolvedor. Acredite, se ninguém contar os problemas ao desenvolvedor ou distro, claro que pelos meios corretos, Bugzilla página para registrar bug ou e-mail de contato, sem comunica-los eles nunca vão adivinhar o problema e provavelmente nem corrigir e soltar atualização.

Neste FAQ tem alguns arquivos específicos, com exemplos de uso, dicas e FAQ com mensagens que circulou na lista Linux-br, procure neste site pelo arquivo com o nome do comando pacote ou serviço.

Não esqueça do melhor manual de todos, Google.

Exemplos de pesquisa em linha de comando (modo texto)

Na linha de comando digite man espaço nome do comando enter, exemplos.

  man ls
  man rm

Aproveite para consultar o manual do man:

man man

Na página do man não vai encontrar instrução de como sair, o man executa less -is <pagina>, para sair do man pressione q minúsculo

ler qualquer texto no formato de paginação do man, execute

less -is arquivo.txt

Refinar a pesquisa nas paginas do man ou texto longo, dentro do texto, digite barra normal e o termo que procura, ex.:

/palavraqueprocura

scroll - voltar no texto, navegar para frente e para traz use as teclas:

setas de direção pra cima e pra baixo, tente também as teclas,

pageUP, pageDown, barra de espaços.

Outras formas de comando:

  info <comando ou aplicativo>
  <comando ou aplicativo> --help
  <comando ou aplicativo> --h

exemplos:

    info ls
  
    ls --help
  
  ou simplesmente comando --h
  
    ls --h

Neste formato, mostra o resultado e retorna ao prompt, quando não existir o comando informado o resultado é o mesmo que digitar somente info

Depois que saiu da página, ou acessar parte da informação que passou da tela, para rolar a tela na linha de comando, use

  CTRL+PageUP    volta tela para exibir o que já não é visto na tela atual
  CTRL+PageDown  Desfazer ação de CTRL+PageUP, avança tela.

Quando você sabe qual o comando pode digitar o nome completo ou somente as iniciais mais a tecla tab para completar o nome, quando a parte digitada coincide com mais de uma opção, não completa o nome, neste caso tecle tat duas vezes para listar todas as opções, man mais a tecla tab duas vezes retorna todas a quantidade de páginas disponíveis, exemplos.

man e tecla tab duas vezes retorna.

  man
  Display all 2501 possibilities? (y or n) 

man ba e tecla tab duas vezes retorna.

  man ba
  basename  bash      bashbug   batch

Quando você sabe o que quer fazer, mas desconhece o comando apropriado

man -k keyword = apropos keyword

onde keywork é o termo, comando ou palavra que procura, ( -k ) é equivalente ao comando apropos, ( -K ) pesquisa por uma determinada cadeia de caracteres em TODAS as página de manual, keyword pode ser qualquer verbo ou nome que possa descrever o que você está tentando fazer, bom lembrar que tudo em inglês, procurar por páginas sobre copia, use copy como neste exemplo.

man -k copy

Neste tutorial tem tópico especifico, procure no menu por

man apropos man whatis man less man groff

Imprimir o manual do comando, por exemplo o manual do find:

man -t find |lpr

Pesquisei no google:

man site:dicas-l.unicamp.br

Entre varios links encontrei este texto:

  Man Pages
  Às vezes se deseja imprimir algumas páginas do manual do sistema.
  Normalmente se executa o comando man redirecionando a saída para um arquivo:

man ls > ls.doc

Alguns sistemas operacionais entretanto costumam sublinhar determinadas partes do documento e às vezes a impressora não suporta este tipo de impressão.

Para retirar os sublinhados, basta redirecionar a saída do comando man através do comando col invocado com a opção -b:

man ls | col -b > ls.doc

O documento gerado, no nosso caso, ls.doc, pode então ser impresso em qualquer tipo de impressora.

Podemos utilizar filtrar parte da página, como no exemplo acima que utiliza o pipe |, segue outros exemplos.

Contar quantas linhas tem a página. `` zago@suse64:~> man screen | wc -l 3423 ``

Descobrir quais as linhas do manual sobre o tar contém zip, veja que exibe as linhas numeradas, depois é só executar o man tar e ir direto na linha desejada.

man tar | cat -n | grep -i zip

info

Além do man tem as paginas info, nem todos os comando tem uma página info, vale tentar, exemplo para o comando find:

     man find
     info find

Compare os resultados, na URL do konqueror digite:

    man:/find
    info:/find 

Aplique o exemplo acima pra consultar as paginas de outros comandos.

Apropos e whatis - procura nas páginas do man

Quando você sabe o que quer fazer, mas desconhece o comando apropriado

man -k keyword

Onde keywork é o termo, comando ou palavra que procura, ( -k ) é equivalente ao comando apropos, ( -K ) pesquisa por uma determinada cadeia de caracteres em TODAS as página de manual, ou

apropos keyword

Quanto mais abrangente a keyword, maiores as chances de encontrar o que procura.

Nota: keyword pode ser qualquer verbo ou nome que possa descrever o que você está tentando fazer, bom lembrar que tudo em inglês, veja os resultados na procura por copia:

  man -k copia
  copia: nothing appropriate
  
  man -k copiar
  copiar: nothing appropriate

Agora com a keyword em ingles, veja o resultado de: man -k copy

  man -k copy
  cp                   (1)  - copy files and directories
  cpio                 (1)  - copy files to and from archives
  dd                   (1)  - convert and copy a file
  ginstall [install]   (1)  - copy files and set attributes
  mcopy                (1)  - copy MSDOS files to/from Unix
  scp                  (1)  - secure copy (remote file copy program)
  xfs_copy             (8)  - copy the contents of an XFS filesystem
  xfs_rtcp             (8)  - XFS realtime copy command

Quem quem não entenda o ingles faça como eu, use a intuição que funciona, tente com variações da palavra, partes da palavra que você acha que possa ser, sinominos, e etc..., vale também usar um tradutor, mesmo que seja o google ou altavista para traduzir palavras do inglês para português, pode acreditar, é muito simples, fácil e prático, basta tentar.

Diretamente do man whatis

         whatis - procura por palavras no banco de dados do whatis.
  
  SINOPSE
         whatis palavra_chave ...
  
  DESCRIÇÃO
         O whatis procura palavras-chaves em um conjunto de arquivos de banco de
         dados contendo pequenas descrições de comandos do sistema,  e  exibe  o
         resultado  na  saída padrão. Somente serão exibidas palavras em caso de
         concordância completa.

Resultado da procura por find

  whatis find
  find                 (1)  - search for files in a directory hierarchy

FAQ sobre as páginas do man
http://www.zago.eti.br/man.txt

whereis, which, rpm (pacotes)

whereis - exibe a localização do arquivo informado, binários(executáveis), incluindo as páginas do manual (man page) .

whereis nome_do_pacote

  whereis ping
  ping: /bin/ping /usr/share/man/man8/ping.8.gz

man whereis

which - exibe o caminho completo quando o executavel está no PATH. man which

  which ping
  /bin/ping
  
  echo `which ping`
  /bin/ping

rpm para localizar pacote instalado.

rpm -qa |grep nome_do_pacote

  # rpm -qa |grep ping
  perl-net-ping-2.16-28204cl
  kdegames-kjumpingcube-3.1.1-26657cl
  ping-0.17-25611cl
  fping-2.2b1-11524cl
  kde-i18n-es-docs-kdegames-kjumpingcube-3.1.1-26675cl

Use o gerenciador de pacotes da distro para obter mais informações sobre os pacotes do sistema.

Converter páginas do man em HTML, PDF, PS .txt e etc...

Converter para HTML.

O mais fácil é pelo konqueror que abre as páginas do man em HTML, para criar um HTML basta salvar (menu localização -> salvar como)

Procure nos pacotes da sua distro, geralmente tem diversos pacotes para conversão de documentos, incluindo as páginas do man que pode converter para diversos formatos, caso não encontre então veja estes endereços sobre HTML.

Script em perl (man2html) para converter páginas do man em HTML
http://www.oac.uci.edu/indiv/ehood/man2html.html

Em Maio de 2006 baixei este arquivo man2html3.0.1.tar.gz.

Descompactar e instalar, execute no diretório onde salvou:
  tar -zxvf man2html3.0.1.tar.gz
  cd man2html3.0.1/
  perl install.me

Exemplo: pegar o resultado do comando find e criar o find.html
  man find | man2html > find.html

Usando copias das páginas do man em outro local, precisa informar o caminho, também pode salvar em outro local, exemplo para pegar o find no diretório local em /tmp/pt_BR
  cd /tmp/pt_BR
  man ./find.1.gz | man2html > find.html
  
  man ./$i | man2html -title man\ $nome -topm 5 > $nome.html

Conforme a configuração do idioma pode truncar os acentos e c cedilha, no SUSE 10 resolvo este problema com esta linha de comando.export LANG=pt_BR,UTF-8
Ver também
http://br.kernelnewbies.org/docs/howto/kernel-new/x983.html

Páginas em Português

Na instalação do pacote também instala a página correspondente, portanto não deve existir páginas de pacotes não instalados.

Mesmo selecionando o perfil de instalação e idioma Português, são poucas páginas instaladas.

Quando consulta as páginas, se não encontra a traduzida, então exibe a página em Inglês.

Ocorre também quando não configura idioma no console para "LANG=pt_BR", quando existe e não acessa as páginas em Português, verifique a configuração do idioma.

Mesmo que não tenha no CD de instalação da distro, pode baixar estas páginas traduzidas, pode copiar de outra distro que tenha estas páginas.

Pode salvar em local diferente do padrão, neste caso tem que informar o caminho para consulta-las, o mais prático é salvar no diretório default.

Na maioria das distros, estas páginas traduzidas para pt_BR ficam em;

  /usr/share/man/pt_BR/

Alguns exemplos.

Baixar páginas traduzidas, acesse;
http://br.tldp.org/projetos/man/arquivos/

baixar cp.1 para dentro do diretório man1, acesse;

http://br.tldp.org/projetos/man/arquivos/man1/cp.1

faça download e salve no diretório /usr/share/man/pt_BR/man1

Fazer dowload via wget direto no diretório, entre no diretório /usr/share/man/pt_BR/man1

digite wget e cole o endereço do link que aponta para cp.1, acesse via navegador, clique com botão auxiliar para copiar o link e depois cole na linha de comando, para cp.1 a linha de comando fica assim;
  cd /usr/share/man/pt_BR/man1
  wget http://br.tldp.org/projetos/man/arquivos/man1/cp.1
Ou baixe todos
  wget http://br.tldp.org/projetos/man/arquivos/man-todas.tgz
descompacte em um diretório e depois faça a copia para o diretório correspondente.
  tar -xzvf man-todas.tgz

Ou salve em outro local e indique o caminho, exemplo

Veja também opção para baixar as mensagens em HTML, consultar no raiz da URL acima.

Normalmente as páginas do manual em Inglês estão em /usr/share/man/man1/, páginas em Português estão em /usr/share/man/pt_BR/man1/, veja o que tem em cada diretório.

Algumas dicas para obter páginas traduzidas de outras distribuições, como seguem um padrão, pode copiar sem problemas, como exemplo do CL10 que tem o arquivo.

/usr/share/man/pt_BR/man1/find.1.gz

No SUSE 10.1 não tem este arquivo, então fiz copia e configurei o idioma no console, execute na linha de comando.

export LANG=pt_BR.

Agora man find retorna a página em Português, caso queira acessar as páginas em Inglês, indique o caminho completo, exemplo

  man /usr/share/man/man1/find.1.gz
  
  Ou não altere o idioma e informe o caminho.
  
  man /usr/share/man/pt_BR/man1/find.1.gz
  
  Ou entre no diretório e execute man ./find.1.gz

Pode salvar a copia em qualquer local, o endereço indicado acima facilita e fica mais organizado, caso queira salvar em outro local, como exemplo em /tmp/man, neste caso é obrigatório indicar o caminho ou entrar no diretório e acrescentar ./ para indicar arquivo local, exemplos.

  cd /tmp/man
  man ./find.1.gz

Estas páginas do manual tem a indicação da origem no manual.html, servem como referencia, não devem substituir as originais, mesmo porque podem ser mais antigas que o pacote de sua instalação.

Evite a substituição, antes da copia verifique se já existe em sua instalação.

Indicações de sites relacionados a páginas do man

Em Português.

Algumas páginas do manual em português (em HTML)
http://200.204.198.164/zago/pt_BR/A-man.html

O que são man-pages ou páginas de manual?
http://br.tldp.org/projetos/man/man.html
O LDP-BR é o braço brasileiro do Projeto de Documentação do Linux.
Temos como objetivo gerar documentação nova e traduzir para o português brasileiro a documentação existente.
Excelente material sobre muitos assuntos Linux.
http://br.tldp.org/
http://br.tldp.org/documentos/comofazer/
http://br.tldp.org/documentos/comofazer/txt/
http://br.tldp.org/documentos/comofazer/sgml/
http://br.tldp.org/projetos/howto/arquivos/indice_txt.html
http://br.tldp.org/projetos/howto/howtos.html

Excelente guia sobre Linux em geral.
http://focalinux.cipsga.org.br/

Como obter melhor ajuda na web.
http://www.zago.eti.br/google.txt

Em Inglês.

Documentação do Linux, em inglês.
http://tldp.org/
http://www.ibiblio.org/pub/Linux/docs/HOWTO/

Indicações

Tutoriais sobre diversas distribuições Linux, comandos específicos da distro e FAQ
http://www.zago.eti.br/distro/A-distro.html

Resumo de alguns comandos e de outros documentos (FAQ) sobre comandos e shel-script.
http://www.zago.eti.br/comandos.html
http://www.zago.eti.br/script/A-menu-scripts.html

Página principal deste site (FAQ)
http://www.zago.eti.br/menu.html