man page (Português)

Status de tradução: Esse artigo é uma tradução de Man page. Data da última tradução: 2020-03-20. Você pode ajudar a sincronizar a tradução, se houver alterações na versão em inglês.

Artigos relacionados

• Color output in console#man

man pages — abreviação para "páginas de manual" — são a forma de documentação que está disponível na maioria dos sistemas operacionais tipo UNIX, incluindo o Arch Linux. O comando usado para exibi-los é man.

Apesar de seu escopo, páginas man são projetadas para serem documentos autocontidos, consequentemente limitando-as a fazer referência a outras páginas man ao discutir assuntos relatados. Esse é um contraste nítido com os documentos info compatíveis com hiperlinks, a tentativa do GNU de substituir o formato tradicional de página man.

Instalação

man-db implementa man no Arch Linux, e o less é o paginador padrão usado com man.

man-pages fornece as páginas man do Linux.

Algumas páginas man localizadas também estão disponíveis:

• man-pages-cs para tcheco
• man-pages-de para alemão
• man-pages-zh_cn para chinês simplificado
• man-pages-zh_tw para chinês tradicional

Acessando páginas man

Para ler uma página man, basta digitar:

$ man nome_página

Manuais são ordenados em diversas seções. Para uma listagem completa, veja a seção intitulada "Sections of the manual pages" no man-pages(7).

Páginas man geralmente são referenciadas por seu nome, seguido do número de sua seção em parênteses. Geralmente há múltiplas páginas man com o mesmo nome, tal como man(1) e man(7). Neste caso, forneça ao man o número da seção seguido pelo nome da página man. Por exemplo:

$ man 5 passwd

para ler a página man sobre /etc/passwd, em vez do utilitário passwd.

Formato

Todas as páginas man seguem um formato razoavelmente padronizado, o que ajuda a navegá-las. Veja a seção intitulada "Sections within a manual page" em man-pages(7).

Pesquisando por manuais

As páginas man podem ser pesquisadas quando o nome exato de uma página não é conhecido usando qualquer um dos seguintes comandos equivalentes:

$ man -k expressão
$ man --apropos expressão
$ apropos expressão

expressão é interpretada como uma expressão regular por padrão.

Para pesquisar palavras-chaves em textos de páginas inteiras, use a opção -K.

Nota: O recurso de pesquisa é fornecido por um cache dedicado. Por padrão, a manutenção desse cache é tratada pelo man-db.service, que é acionada periodicamente pelo man-db.timer. Se você estiver recebendo uma mensagem "nada apropriado" para cada pesquisa, tente gerar novamente manualmente o cache executando mandb como root.

Descrições de uma linha podem ser exibidas usando o comando whatis. Por exemplo, para uma descrição breve das seções de página man sobre ls, digite:

$ whatis ls

ls (1p)              - list directory contents
ls (1)               - list directory contents

Largura de página

A largura de páginas man é controlada pela variável de ambiente MANWIDTH.

Se o número de colunas no terminal é pequeno demais (ex.: a largura da janela é estreita), as quebras de linha ficarão erradas. Isso pode ser bem incômodo para ler. Você pode corrigir isso definindo MANWIDTH na invocação de man. Com Bash, isso seria:

~/.bashrc

man() {
    local width=$(tput cols)
    [ $width -gt $MANWIDTH ] && width=$MANWIDTH
    env MANWIDTH=$width \
    man "$@"
}

Lendo páginas man locais

Em vez da interface padrão, o uso de navegadores como lynx e Firefox para visualizar páginas man permite que os usuários colham o principal benefício de texto hiperlink das páginas info. As alternativas incluem o seguinte:

Aplicativos de visualização

• GNOME Help — Visualização de ajuda para o GNOME. Ele pode mostrar páginas man via yelp man:<nome> ou a combinação de teclas não documentada CTRL+L a partir de uma janela existente.

https://wiki.gnome.org/Apps/Yelp || yelp

• KHelpCenter — Aplicativo para mostrar documentação dos aplicativos do KDE. Páginas man estão em Páginas de manual do UNIX ou executando khelpcenter man:<nome>.

https://userbase.kde.org/KHelpCenter || khelpcenter

• Konqueror — Gerenciador de arquivos e navegador web do KDE. Ele pode mostrar páginas man via man:<nome>.

https://konqueror.org/ || konqueror

• xman — Fornece um visual categorizado em páginas man.

https://xorg.freedesktop.org/ || xorg-xman

Conversão para HTML

mandoc

Instale o pacote mandoc^AUR. Para converter uma página, por exemplo free(1):

$ mandoc -Thtml -Ostyle=style.css /usr/share/man/man1/free.1.gz > free.html

Agora, abra o arquivo chamado free.html em seu navegador favorito.

man2html

Primeiro, instale man2html dos repositórios oficiais.

Agora, converta uma página man:

$ man free | man2html -compress -cgiurl man$section/$title.$section$subsection.html > ~/man/free.html

Outro uso para man2html é exportar para texto não tratado, no formato de impressão:

$ man free | man2html -bare > ~/free.txt

man -H

A implementação GNU do man nos repositórios Arch também possuem a habilidade de fazer isso por conta própria:

$ man -H free

Isso vai ler sua variável de ambiente BROWSER para determinar o navegador. Você pode sobrepor isso passando o executável para a opção -H.

roffit

Primeiro, instale roffit^AUR do AUR.

Para converter uma página man:

$ gunzip -c /usr/share/man/man1/free.1.gz | roffit > free.html

Conversão para PDF

Páginas man sempre foram imprimíveis: elas são escritas em troff, que é fundamentalmente uma linguagem de formatação de texto. Se você tiver o ghostscript instalado, você pode converter uma página man para PDF usando man -t <página-man> | ps2pdf - <pdf>.

Ressalvas: Fontes são geralmente limitadas a Times em tamanhos fixos. Não há hyperlinks. Algumas páginas man foram projetadas especificamente para ver no terminal e não ficarão bem na forma de PS ou PDF.

Páginas man online

Há vários bancos de dado online de páginas man, incluindo:

• man7.org — O projeto man-pages do Linux. Upstream do pacote man-pages.
• Páginas man do Arch — contém páginas man dos pacotes do Arch Linux. Usado para links de página man do wiki.
• manned.org — coleção de várias distribuições Linux, BSD, etc. com múltiplas versões de pacotes
• linux.die.net
• man.cx
• Páginas man do Debian
• Páginas man do Ubuntu
• Páginas man do DragonFlyBSD
• Páginas man do FreeBSD
• Páginas man do NetBSD
• Páginas man do OpenBSD
• Páginas man do Mac OS X^{[link inativo 2019-01-17]}
• Manual do Plan 9 — Volume 1
• Manual do Inferno — Volume 1
• Páginas man do Storage Foundation^{[link inativo 2020-02-25]}
• Repositório de páginas man do UNIX and Linux Forums

Dica: Você pode usar o !Bang !archman do DuckDuckGo para pesquisar pelas páginas man do Arch Linux diretamente

Atenção: Algumas distribuições fornecem páginas man alteradas ou desatualizadas que se diferem daquelas fornecidas pelo Arch. Exercite o cuidado ao usar páginas man online.

Páginas man notáveis

Aqui está uma lista não exaustiva de páginas dignas de nota que podem lhe ajudar a entender muitas coisas em profundidade. Alguns deles podem servir como uma boa referência (como a tabela ASCII).

• ascii(7)
• boot(7)
• charsets(7)
• chmod(1)
• credentials(7)
• fstab(5)
• hier(7)
• systemd(1)
• locale(1p), locale(5), locale(7)
• printf(3)
• proc(5)
• regex(7)
• signal(7)
• term(5), term(7)
• termcap(5)
• terminfo(5)
• utf-8(7)

De forma mais geral, dê uma olhada nas páginas de categoria 7 (miscelânea):

$ man -s 7 -k ".*" 

Páginas específicas do Arch Linux:

• archlinux(7)
• mkinitcpio(8)
• pacman(8)
• pacman-key(8)
• pacman.conf(5)

Veja também

• man page - artigo wiki do Gentoo
• Escrevendo o bom manual com pod2man