Como buscar ajuda no Linux usando a documentação local
A documentação do Linux é bastante completa, e pode fornecer uma ajuda bem interessante. Você não precisa do Google para saber como funciona determinado comando ou “como fazer”
Antes, precisamos tecer algumas definições sobre termos usados para documentação são necessárias:
- HOWTOs: Como Fazer – São documentos que detalham os procedimentos para completar uma determinada tarefa;
- Man: Página Manual – São manuais tradicionais que cobrem uma variedade de assuntos muito grande;
- Info: Páginas Info – Documentação fornecida pela Free Software Foundation para software GNU;
- LDP: Linux Documentation Project – Projeto para fazer e distribuir documentação sobre o Linux.
Encontrando a Documentação em /usr/share/doc
O diretório /usr/share/doc possui grande parte da documentação de uma distribuição Linux e diversos aplicativos na forma de HOWTOS, FAQs, arquivos README, guias de instalação e manuais de usuário.
O subdiretório /usr/share/doc/howto possui quase 2000 páginas de documentação detalhando passo a passo diversas tarefas.
Veja um exemplo:
3Dfx-HOWTO.html
AI-Alife-HOWTO.html
Acer-Laptop-HOWTO.html
Alpha-HOWTO.html
Bash-Prog-Intro-HOWTO.html
Benchmarking-HOWTO.html
(…)
Este tipo de documentação é útil quando não se sabe como começar uma determinada tarefa ou quais ferramentas devem ser utilizadas.
No subdiretório /usr/share/doc/packages podem ser encontradas informações sobre quase todos os pacotes de software instalado no sistema. Esta informação pode incluir arquivos com conteúdos distintos como README, INSTALL, CHANGES, INFO, FAQ, etc.
Nem sempre os how-tos podem estar instalados na distribuição, e seu caminho pode ser diferente.
Utilizando as Páginas Info
Uma fonte interessante de consulta são as páginas info. Esta documentação foi desenvolvida pelo projeto GNU e cobre grande parte das ferramentas do projeto.
Para ter acesso a esta documentação, é preciso utilizar o comando info seguido do nome do comando desejado. Veja um exemplo, digitando o comando no shell:
# info test
O info possibilita a navegação entre os tópicos relacionados. Para navegar no info, basta encontrar um “link” que é formado pelo símbolo “*” e uma palavra e apertar a tecla enter.
Para passar para a próxima página do conteúdo, digite “N” (Next) e, para voltar, digite “P” (Previous). A tecla “q” sai do info.
O comando info sem nenhum argumento lista todas as páginas existentes.
# info
Utilizando as Páginas do Manual
As páginas de manual acompanham quase todos os programas GNU/Linux. Elas trazem uma descrição básica de comandos e detalhes sobre o funcionamento de suas opções.
Uma página de manual é visualizada na forma de texto único com rolagem vertical. Também documenta parâmetros usados em alguns arquivos de configuração.
Os documentos do manual são divididos em sessões de acordo com o assunto abordado. As sessões são numeradas de 1 a 9, a seguir:
- 1 Programas executáveis ou comandos de shell;
- 2 Chamadas do Sistema (funções fornecidas pelo Kernel);
- 3 Chamadas de Biblioteca (funções fornecidas pelas bibliotecas);
- 4 Arquivos especiais, especialmente aqueles localizados em /dev;
- 5 Formatos de arquivos e convenções;
- 6 Jogos;
- 7 Pacotes Macro;
- 8 Comandos administrativos;
- 9 Rotinas do kernel.
É possível que uma mesma palavra possa referenciar a uma função de programação, comando ou arquivo de configuração. Desta maneira é importante saber em qual sessão iremos encontrar a documentação desejada.
Cada página do manual é dividida em partes:
- NAME: Nome do item procurado com uma descrição curta;
- SYNOPSIS: Descrição completa do uso e sintaxe;
- DESCRIPTION: Descrição breve das funcionalidades;
- OPTIONS: Descrição de cada opção e argumentos;
- FILES: Uma lista de arquivos importantes;
- SEE ALSO: Uma lista de itens relacionados ao procurado;
- BUGS: Descrição de possíveis problemas com o item;
- AUTHOR: Lista de pessoas responsáveis pelo item.
Para acessar o manual, o comando é o man seguido do item procurado. Como opção, o número da sessão pode ser passada como parâmetro.
# man passwd
Neste exemplo o man visualiza o manual do comando passwd, pertencente à sessão 1.
# man 5 passwd
Já neste exemplo o man exibirá o manual do arquivo /etc/passwd.
A navegação dentro das páginas de manual é feita usando-se as teclas:
- q Sai da página de manual;
- PageDown ou f Rola 25 linhas abaixo;
- PageUP ou w Rola 25 linhas acima;
- SetaAcima ou k Rola 1 linha acima;
- SetaAbaixo ou e Rola 1 linha abaixo;
- r Redesenha a tela (refresh);
- p ou g Início da página;
- h Ajuda sobre as opções da página de manual;
- s Salva a página de manual em formato texto no arquivo especificado.
Utilizando o Help On-line
O recurso de ajuda rápida é útil para se saber quais opções podem ser usadas com um determinado comando. Quase todos os programas GNU/Linux oferecem este recurso para consultas rápidas. Para acionar o help on-line, digite:
# [comando] —help
Por exemplo:
# ls —help
Quer saber se uma certificação vale a pena ? Saiba porque os salários são bons, e porque as empresas estão procurando profissionais de Linux.
Você vai ententer que os benefícios superam de longe o sacrifício.
E se você já se decidiu, veja nosso Guia de Certificação.
E se quer saber onde fazer as provas, consulte a lista de cidade.
Se quiser saber o idioma das provas, veja esse post.
Aprenda muito mais sobre Linux em nosso curso online. Você pode fazer a matrícula aqui com trial de 7 dias grátis. Se você já tem uma conta, pode acessar aqui.
Gostou? Compartilhe 🙂
Tag:/usr/share/doc, help, how-to, info, man