Como ler a sintaxe do exemplo de comando nas seções de sinopse das páginas MAN?

Question

Estou tentando melhorar o uso da documentação para entender a sintaxe de comandos, mas percebi que não entendo completamente os símbolos usados que mostram todas as opções e parâmetros que podem ser passados para o comando.

Por exemplo, man zip :

SYNOPSIS

   zip  [-aABcdDeEfFghjklLmoqrRSTuvVwXyz!@$] [--longoption ...]  [-b path]
   [-n suffixes] [-t date] [-tt date] [zipfile [file ...]]  [-xi list]

Ou man bzip2 :

SYNOPSIS
       bzip2 [ -cdfkqstvzVL123456789 ] [ filenames ...  ]
       bzip2 [ -h|--help ]
       bunzip2 [ -fkvsVL ] [ filenames ...  ]
       bunzip2 [ -h|--help ]
       bzcat [ -s ] [ filenames ...  ]
       bzcat [ -h|--help ]
       bzip2recover filename

Existe algum recurso que explique como ler esta sintaxe e pode me dizer o que cada símbolo significa?

    

Answer 1

Um bom recurso é este (copiei descaradamente)

Uma das partes mais difíceis do unix para iniciantes é encontrar documentação. Quando você ouve o sistema vem com um manual on-line, geralmente causa um suspiro de alívio. O que você não sabe é que as páginas de manual são referências técnicas. Enquanto isso pode soar muito ruim - não é! Depois de aprender o básico das páginas do manual, você perceberá como elas são escritas. Se você precisar de informações e não tiver tempo a perder, o comando do homem é para quem você se dirige.

Este documento tenta ensiná-lo a ler o manual unix - comumente chamado de man pages. Citações comuns

Antes de entrarmos na nossa primeira página man, vamos dar uma olhada em alguns símbolos comuns usados neles. Estes símbolos são por vezes referidos como citações.

O uso principal de uma página man é procurar parâmetros para um programa. Como a maioria dos parâmetros é opcional, eles serão colocados entre colchetes.

[optional]
[-abcgln]

Algumas opções terão uma lista limitada de opções. Uma lista de opções será separada por vírgulas e colocada entre chaves.

{choice1,choice2}
{yes,no}

Muitas fontes de documentação de ajuda incluem parâmetros mandatórios entre os símbolos menor que / maior que.

<manditory>
<program_name>

Embora as citações mandatórias acima não sejam normalmente usadas em páginas man, é bom saber.

    

Answer 2

Da página de manual man :

  

As seguintes convenções aplicam-se à seção SINOPSE e podem ser usadas como um guia em outras seções.   

     

A renderização exata pode variar dependendo do dispositivo de saída. Por exemplo,   o homem normalmente não será capaz de renderizar itálico quando estiver rodando em um terminal,   e normalmente usará texto sublinhado ou colorido.

     

A ilustração de comando ou função é um padrão que deve corresponder a todos   possíveis invocações. Em alguns casos, é aconselhável ilustrar vários   invocações exclusivas, como é mostrado na seção SINOPSE desta página de manual.