Unix - ler a sinopse de um man

Janeiro 2017

A sinopse de um man, é a parte de uma página de manual chamada com o comando man que descreve o uso de uma linha de comando em um Sheda da mesma maneira a organização das opções.

Nem sempre é evidente de ler a sinopse de um man. Nem todos explicam da mesma maneira a organização das opções.

Felizmente, pode-se encontros pontos comuns importantes.

Geralmente, as páginas de man utilizam os colchetes para delimitar um bloco opcional.

Exemplo com a sinopse de "man lynx" :

Lynx [opções] [path or URL]


Pelo menos, este é claro e intuitivo, e lhe economizará confusões diante da tela... . Com efeito, esta sinopse se parece com a parte « uso » de um man.
Indicam-se então as opções (que estão assinaladas mais abaixo no man), depois o caminho para o arquivo ou diretório, ou então uma URL.

Por exemplo:
lynx -color [www.commentcamarche.net]

Para afixar a página de Incio de CCM em cores.

A priori, até aqui, tudo está indo bem.
Agora, se encontra diversas opções possíveis na sinopse. E se tem a escolha entre diversas alternativas, para um mesmo argumento:
_Uma opção curta do tipo -f ou -a etc...
_Uma opção longa do tipo "--força"

Então no mesmo bloco, você, você poderá encontrar estes dois alternativas separadas por uma « pipa », quer dizer o caractere | que significa « ou ».
Então exemplo :
comando [-f | --força] [filename]

Para dizer que você pode digitar -f ou --força, a escolha, pois dois argumentos terão o mesmo sentido. Depois você pode fazer este opção por um espaço, depois o caminho para um arquivo.

Com isto, a sinopse de "man mysql" deveria estar clara par exemple

Você observará algumas exceções:

Para [-p[pwd]] você tem um bloco no interior de um bloco, e sem espaço para os separar.
Isto significa que você pode digitar a senha (opcional, você pode não ter) justo depois do argumento -p (opcional ele também) sem espaço.
Exemplo para uma conexão com base mysql local com o usuário root, e o password "bidule":

mysql -u root -pbidule -h localhost


Depois tem sinopses um pouco mais complexas
comme celui de tar

Lá, os | para significar « ou » são de vez em quando substituídos por vírgulas.
Os comandos maiores são assinalados no início, começando por um [-] para precisar que os argumentos curtos podem (opcional) tomar um hífen, depois vem o grande bloco.
Você tem a escolha entre -A (que você pode substituir por --catenate ou --concatenate) ou -c ou -x etc.... São comandos maiores de tar que são « extrair », « criar um arquivo »... Então você deve escolher somente um comando maior, é por isso que tem um | entre cada.
Em seguida você é livre para adicionar uma opção, depois você deve colocar um arquivo (ou vários) ou então um diretório.

Grosseiramente isto se parece aquilo para extrair um arquivo.tar.gz:

tar -zxvf machin.tar.gz


x é a opção maior (extrair), as opções são z, v et f, respectivamente : compactada com gzip, verbal (afixar os detalhes), e para f arquivo (o fluxo para extrair será um arquivo ).

Fonte e informações mais completas


Tradução feita por Ana Spadari

Veja também

Artigo original publicado por . Tradução feita por ninha25. Última modificação: 11 de outubro de 2011 às 09:28 por ninha25.
Este documento, intitulado 'Unix - ler a sinopse de um man', está disponível sob a licença Creative Commons. Você pode copiar e/ou modificar o conteúdo desta página com base nas condições estipuladas pela licença. Não se esqueça de creditar o CCM (br.ccm.net) ao utilizar este artigo.