GNU/Linux - Classificação de Documentos

Os documentos são classificados de acordo com o nosso objetivo:

• How-to – ou, como fazer - como o próprio nome diz, é utilizado para instruir como se faz uma determinada tarefa ou projeto. É mais voltado para objetivos didáticos, geralmente fornecendo procedimentos passo-a-passo, podendo também ser chamado de tutorial. Não importa seu tamanho, pois alguns chegam a centenas de páginas; porém alguns mais curtos, são chamados de mini-howtos.
• Manual ou guia - é mais específico que um how-to, tem como objetivo principal de ser uma fonte de referência sobre um tópico, sem muitos objetivos didáticos, fornecendo uma forma completa e fácil de encontrar toda a informação sobre determinado assunto.
• FAQ - é um acrônimo de Frequently Asked Questions - ou perguntas frequentes - é um documento baseado em perguntas e respostas dos usuários.
• man - ou páginas de manual - é o manual do comando ou arquivo invocado através do comando man. Geralmente acompanha um pacote de software.

Páginas de manual - man

Presente em todos os sistemas Unix e é utilizado principalmente para documentar sintaxe de comandos, arquivos de configuração e funções de programas. O man apresenta suas informações em páginas, armazenadas em arquivos de páginas de manual.

Instalação

Por padrão, o utilitário man é instalado e os arquivos de páginas de manual são opcionalmente instalados, uma vez que ocupam em disco.

• man - é o pacote do utilitário man.
• man-pages - é o pacote dos arquivos de páginas de manual.
• man-pages-pt_BR - é o pacote dos arquivos das páginas de manual traduzidas em português do Brasil.

Utilização básica

A forma de uso mais simples do man segue a sintaxe:

man [objeto]

Quando citamos [objeto], estamos fazendo referência a um comando, função ou arquivo de configuração.

Por exemplo, execute:

# man gzip
GZIP(1)                    GZIP(1)

NOME

      gzip, gunzip, zcat - compacta ou expande arquivos

SINOPSE

      gzip [ -acdfhlLnNrtvV19 ] [-S sufixo] [ nome ...]

      gunzip [ -acfhlLnNrtvV ] [-S sufixo] [ nome ...]

      zcat [ -fhLV ] [ nome ...  ]

DESCRIÇÃO

      O  gzip reduz o tamanho dos arquivos usando um código Lem-
      pel-Ziv (LZ77). Sempre que possível cada arquivo  é  sub-
      stituído    por  outro  com a extensão .gz, mantendo o dono,
      permissões e datas de modificação.  (A extensão   padrão é
      -gz  para  VMS,   z para MSDOS, FAT OS/2 , FAT Windows NT e
      Atari.) ...

Como o man utiliza o comando less em segundo plano, para paginar e controlar a informação em tela, você pode navegar por uma página de manual, da mesma forma que se navega no less:

h - Mostra um texto de ajuda dos comandos do less.

q - sai do texto.

/padrão - procura dentro do texto todas as ocorrências de padrão especificado

n - repete a busca, indicando a próxima ocorrência do padrão encontrado

N - repete a busca, no sentido do fim para o início

Além destes comandos, as teclas de PgUp, PgDown funcionam normalmente.

Alguns Tópicos das Man-pages:

NOME - indica a sua descrição breve, geralmente somente uma frase. Pode citar outros objetos (comandos) equivalentes, ou bastante semelhantes. Por exemplo, várias funções do gzip são encontradas nos comandos gunzip e zcat.
SINOPSE - quando o objeto é um comando, geralmente indica a sua sintaxe de uso. Esta parte é uma das mais importantes, podendo ser um pouco complexa em alguns casos. Saber interpretá-la é essencial para poder extrair o máximo de um comando.
DESCRIÇÃO - é onde se descreve mais detalhadamente sobre o objeto como informações sobre o seu uso, suas exceções, etc.
OPÇÕES - é onde se documentam as opções do objeto, quando o objeto é um comando.

TRADUÇÃO E REVISÃO PARA A LÍNGUA PORTUGUESA - é a seção utilizada para registrar os méritos da tradução e revisão da língua. Em alguns manuais também é mostrado a seção AUTHOR, que indica o autor do comando ou objeto.

Sintaxe de comandos

Cada comando pode seguir sua própria sintaxe, mas em geral, os seguintes símbolos padrões são utilizados:

• hífem “-” ou dois hífens seguidos “- -” são utilizados para indicar uma opção. Por exemplo: “ls -l” e “ls –full-time”

• colchetes “[]“ - são geralmente utilizados para indicar uma opção não-obrigatória. Por exemplo, a sintaxe do comando ls é indicado assim: ls [opções] [arquivo...]; isto indica que você pode executar ls isoladamente, com ou sem especificação de opções e arquivo.

• chaves “{}” - são geralmente utilizados para agrupar uma opção necessária. Por exemplo, a sintaxe do comando ls com a opção –sort é apresentada assim: [--sort={none, time, size, extension}]. Isto signfica que uma vez utilizado a opção –sort, você deve necessariamente especificar o critério de ordenação (nenhum, tempo, tamanho ou extensão). Por exemplo, “ls -l –sort=size”, “ls -l –sort=time”

• barra vertical “|” - é utilizada para denotar opções excludentes entre si. Por exemplo, o comando tar, possui a obrigatoriedade de utilizar uma das letras (ou palavra longa): A, c, d, r, t, u, x; conforme pode ser visto na especificação de sua sintaxe: tar [ - ] A –catenate –concatenete | c –create | d –diff –compare | r –append | t –list | u –update | x –extract –get …

• objeto sublinhado - indica o argumento do comando. Por exemplo, note que o comando gzip sublinha a palavra nome, para denotar que nome é o argumento do comando. Veja a sintaxe: gzip [ -acdfhlLnNrtvV19 ] [-S sufixo] [ nome ...]

• reticências sublinhadas “…” - indica que o comando suporta como argumento vários objetos. Por exemplo, veja a especificação da sintaxe do comando