O que é uma página de manual ?
Uma página de manual (abreviação de página de manual) é a forma tradicional de documentação de software em um sistema operacional tipo Unix como o Ubuntu. Para a grande maioria dos comandos e programas, há uma página de manual que lista suas opções e explica seu uso.
Como posso encontrar e visualizar páginas de manual?
Off-line em um terminal
As páginas de manual são instaladas automaticamente no seu sistema, juntamente com os comandos que descrevem. Para visualizar e pesquisar páginas de manual, existe o comando man
:
man mv
exibe a página de manual mv
enquanto
man -k mv
pesquisa nomes e descrições curtas de todas as páginas de manual instaladas para a sequência mv
. Expressões regulares estendidas do POSIX são permitidas e é uma pesquisa ; portanto, também será encontrado, por exemplo , git-mv
e semver
, se você deseja pesquisar, mv
use exatamente ^mv$
.
Veja Qual é a diferença entre `man` e` man (#) `? para ler sobre as seções da página de manual. Para mais informações, leia man
a página do manual. ;)
Como posso influenciar como uma página de manual é exibida?
O programa padrão para exibir páginas de manual é less
. Este chamado pager fornece uma função de pesquisa útil, basta digitar /
seguido pelo termo de pesquisa, por exemplo
/--version
e pressione Enter. Isso marcará todas as descobertas e rolará para a primeira. Pressione Npara ir para a próxima descoberta e ⇧ Shift+ Npara ir para a descoberta anterior (consulte Como posso pesquisar em uma página de manual? ). Para obter uma lista de comandos H, pressione , para sair, less
pressione Q.
Ao lado less
há outros pagers disponíveis: pg
, most
e w3m
apenas a lista de três. Eu recomendo most
: ele vem com uma coloração muito útil das palavras-chave, tornando a página de manual muito mais fácil de ler e navegar, veja você mesmo:
Para visualizar uma página de manual em um pager diferente do seu pager padrão, use a -P
opção, por exemplo:
man -P most mv
Se você deseja alterar, as páginas de manual do pager padrão são exibidas com duas opções:
alterar o pager padrão apenas de man
export MANPAGER=most
Para tornar a alteração persistente, adicione este comando ao seu ~/.bashrc
arquivo.
altere o pager padrão de todo o seu sistema
sudo update-alternatives --config pager
Os fãs podem até (ab) usar vim
como o MANPAGER
, consulte este artigo escrito por muru .
As páginas de manual são exibidas na fonte especificada nas configurações do emulador de terminal. Se você trabalha com o terminal regularmente, pode querer alterar essa fonte; Só posso recomendar o Hack - um tipo de letra criado para o código-fonte ; veja a captura de tela acima por sua beleza.
Off-line via GUI
Uma maneira fácil e agradável de exibir páginas de manual com uma GUI simples é o yelp
programa pré-instalado . Para iniciar uma página de manual com yelp
execute yelp man:PROGRAM
ou gnome-help man:PROGRAM
, por exemplo:
yelp man:mv
Você também pode visualizar as páginas de manual com seu navegador preferido , consulte Como faço para abrir as páginas de manual em um navegador da web? , por exemplo, para man mv
em firefox
:
man -Hfirefox mv
Por fim, mas não menos importante, você pode converter páginas de manual em PDF e visualizá-las com o visualizador de PDF preferido, consulte: Existe uma maneira de imprimir informações / páginas de manual em PDF?
Conectados
Você pode visualizar as páginas de manual dos programas disponíveis nos repositórios de todas as versões atualmente suportadas do Ubuntu com a URL abreviada manpg.es/PROGRAM
, por exemplo, http://manpg.es/mv . Isso abre mv
a página de manual da última versão do Ubuntu, você pode escolher uma versão diferente na barra superior. Para procurar páginas de manual, você pode usar, por exemplo, http://manpages.ubuntu.com/cgi-bin/search.py?q=mv .
Conforme explicado acima, man
só é possível exibir páginas de manual do software instalado no sistema. Para visualizar as páginas do manual em http://manpages.ubuntu.com usando um pager de terminal, está dman
disponível no bikeshed
pacote.
Outras fontes
Ao ler a documentação de outras fontes on-line, é uma boa ideia ficar de olho na versão do programa. A maioria dos programas possui uma --version
opção que exibe a versão do programa em questão, por exemplo,
$ mv --version
mv (GNU coreutils) 8.25
Existem muitos sites que se dedicam a disponibilizar facilmente as páginas de manual, apenas apresentarei os dois que mais gosto:
- O man7.org vem com destaque útil para sintaxe, mas apresenta apenas a última versão do programa.
- manpag.es hospeda páginas de manual do Ubuntu, lançadas há muito tempo EOL
Fonte ainda não vinculada: https://wiki.ubuntuusers.de/man/