O que é uma página de manual ?
Uma página man (abreviação de página de manual) é a forma tradicional de documentação de software em um SO semelhante ao Unix, como o Ubuntu. Para a grande maioria dos comandos e programas, há uma página man que lista suas opções e explica seu uso.
Como posso encontrar e visualizar páginas de manual?
Offline em um terminal
As páginas do manual são instaladas automaticamente em seu sistema, juntamente com os comandos que descrevem. Para ver e pesquisar páginas man existe o comando man
:
man mv
exibe a página do manual de mv
enquanto
man -k mv
procura nomes e descrições curtas de todas as páginas man instaladas para a string mv
. Expressões regulares estendidas POSIX são permitidas e é uma pesquisa , portanto, isso também encontrará, por exemplo, git-mv
e semver
, se você quiser pesquisar exatamente mv
use ^mv$
.
Veja Qual é a diferença entre 'man' e 'man (#)'? para ler sobre as seções da página man . Para mais informações, leia a página man do man
. ;)
Como posso influenciar como uma página de manual é exibida?
O programa padrão para exibir páginas man é less
. Esse chamado pager fornece uma função de pesquisa útil, basta digitar /
seguido pelo termo de pesquisa, por exemplo
/--version
e pressione Enter . Isso marcará todos os achados e rolará para o primeiro. Pressione N para ir para a próxima descoberta e ⇧ Desloque + N para ir para a anterior (veja Como posso pesquisar em uma página manpage? . Para uma lista de comandos, pressione H , para sair de less
press Q .
Além de less
, há outros pagers disponíveis: pg
, most
e w3m
apenas na lista três. Eu recomendo most
: Ele vem com uma coloração muito útil de palavras-chave que facilitam a leitura de uma página man :
Para ver uma página man em um pager diferente do padrão, use a opção -P
, por exemplo:
man -P most mv
Se você quiser alterar as páginas de manual do pager padrão, você terá duas opções:
-
altere o pager padrão somente de
man
export MANPAGER=most
Para tornar a alteração persistente, adicione este comando ao seu arquivo
~/.bashrc
. -
altere o pager padrão de todo o seu sistema
sudo update-alternatives --config pager
Os fãs podem até (ab) usar vim
como MANPAGER
, consulte este artigo escrito por muru .
As páginas do manual são exibidas na fonte especificada nas configurações do emulador de terminal. Se você trabalha com o terminal regularmente, talvez queira alterar essa fonte; Eu só posso recomendar Hack - um tipo de letra projetado para o código-fonte , veja a imagem acima por sua beleza.
Offline via GUI
Uma maneira fácil e simples de exibir páginas man com uma GUI simples é o programa yelp
pré-instalado. Para iniciar uma página man com yelp
execute yelp man:PROGRAM
ou gnome-help man:PROGRAM
, por exemplo:
yelp man:mv
Você também pode ver páginas de manual com seu navegador preferido, veja Como faço para abrir páginas de manual em um navegador da Web? , por exemplo para man mv
em firefox
:
man -Hfirefox mv
Por último, mas não menos importante, você pode converter páginas de manual em PDF e visualizá-las com seu visualizador de PDF preferido, consulte: Existe uma maneira de imprimir info / man pages em PDF?
Online
link
Você pode ver as páginas de manual dos programas disponíveis através dos repositórios de todas as versões do Ubuntu atualmente suportadas com o URL abreviado manpg.es/PROGRAM
, por exemplo. link . Isto abre a página man do mv
para o lançamento do latest Ubuntu, você pode escolher um release diferente na barra superior. Para procurar por páginas man, você pode usar, por exemplo, link .
Como explicado acima, man
só pode exibir páginas man do software instalado no sistema. Para ver páginas man do link usando um pager de terminal, há dman
disponível no pacote bikeshed
.
Outras fontes
Quando você lê a documentação de outras fontes on-line, é uma boa ideia ficar de olho na versão do programa. A maioria dos programas tem uma opção --version
que exibe a versão do programa em questão, por exemplo,
$ mv --version
mv (GNU coreutils) 8.25
Existem muitos sites que se dedicaram a tornar as páginas do manual facilmente disponíveis. Vou apresentar as duas que mais gosto:
- man7.org vem com realce de sintaxe útil, mas apresenta apenas a última versão lançada do programa
- manpag.es hospeda páginas man de lançamentos do Ubuntu há muito desaparecido EOL
A fonte ainda não está vinculada: link