4. Convenções utilizadas neste livro

4.1. Convenções Tipográficas

Para realmente diferenciar as palavras especiais do fluxo do texto, a equipe de documentação utiliza diferentes interpretações. A tabela a seguir demonstra um exemplo de cada palavra especial ou grupo de palavras com a sua interpretação atual e o que cada uma significa.

Exemplo FormatadoSignificado
inodeUtilizado para enfatizar um termo técnico explicado no Apêndice 1, Glossário.
ls -ltaUtlizado para comandos e seus argumentos. (veja Seção 4.2.1, “Sinopse dos Comandos”).
um_arquivoUtilizado para nomes de arquivo. Também poed ser encontrado em nome de pacotes RPM.
ls(1)Referência para uma man page. Para ler a página, simplesmente digite man 1 ls, na linha de comando.
$ ls *.pid
Formatação usada para representações textuais do que pode estar sendo exibido na sua tela, incluindo interações com o computador, listagem de programas, e outros.
localhostInformações literais que não se encaixam em nenhuma das categorias definidas anteriormente. Por exemplo, uma palavra-chave retirada de um arquivo de configuração.
OpenOffice.orgDefine nomes de aplicação. Dependendo do contexto, o nome da aplicação e o do comando podem ser o mesmo, mas formatados de maneira diferente. Por exemplo, a maior parte dos comandos estão escritos com letras minúsculas, enquanto nomes de aplicações normalmente começam com letra maiúscula.
AquivosIndica entrada de menus ou rótulos da interface gráfica. A letra sublinhada, quando presente, informa um atalho, que pode ser acessado pressionando a tecla Alt mais a letra em questão.
Le petit chaperon rougeIdentifica palavras em outros idiomas.
Aviso!Reservedo para avisos especiais, para dar ênfase à importância das palavras. Leia em voz alta.
[Nota]Nota

Este ícone destaca uma nota. Geralmente, é uma remarca no contexto atual, dando informação adicional.

[Dica]Dica

Representa uma dica. Ele pode ser um conselho geral de como executar uma ação específica, ou uma bela funcionalidade que poderá tornar a sua vida mais fácil, como teclas de atalho, por exemplo.

[Atenção]Atenção

Tenha bastante cuidado ao ver este ícone. Ele sempre significa que uma informação bastante importante sobre um tópico específico que precisa ser abordado.

4.2. Convenções Gerais

4.2.1. Sinopse dos Comandos

O exemplo abaixo demonstra os símbolos que você encontrará quando o autor descreve os argumentos de um comando:

comando <argumento não literal> [--opção={arg1,arg2,arg3}] [argumento opcional ...]

Essas convenções são padronizadas e você poderá encontrá-las em outros lugares, como as páginas do manual.

Os símbolos “<” (menor que) e “>” (maior que) denotam um argumento mandatório a não ser copiado verbatim, mas a ser substituído de acordo com as suas necessidades. Por exemplo, <nome_do_arquivo> refeer ao nome de um arquivo. Se o nome é foo.txt você deve digitar foo.txt, e não <foo.txt> ou <nome_do_arquivo>.

Os colchetes (“[ ]”) denotam argumentos opcionais, que podem ou não ser incluídos no comando.

As reticências (“...”) significam um número arbitrário de argumentos que podem ser incluídos.

As chaves (“{ }”) contém os argumentos autorizados neste lugar específico. Um deles deverá ser colocado aqui.

4.2.2. Anotações Especiais

De tempo em tempo você será direcionado a pressionar, por exemplo, as teclas Ctrl-R, o que significa que você deve pressionar e manter pressionada a tecla Ctrl e então pressionar a tecla R em seguida. O mesmo caso se aplica para as teclas Alt e Shift.

[Nota]Nota

Nós utilizamos letras maiúsculas para representar as teclas, mas isto não significa que você tem que digitá-las em maiúscula também. Entretanto, pode haver programas em que R não significa o mesmo que r. Você será informado quando estiver trabalhando com estes programas.

Em relação aos menus, acessar o item ArquivoRecarregar configuração do usuário (Ctrl-R) significa: clique no texto Arquivo exibido no menu (normalmente localizado na diagonal superior esquerda da janela). Então, quando o menu desdobrar, clique no item Reacrregar configuração do usuário. Além disto, você é informado que pode utilizar a combinação de teclas Ctrl-R para obter o mesmo resultado.

4.2.3. Usuários Genéricos do Sistema

Sempre que possível nós utilizamos dois usuários genéricos em nossos exemplos:

Fulano Pingususuario1Este é o nosso usuário padrão, utilizado na maior parte dos exemplos neste livro.
Ciclano Pingususuario2Este usuário pode ser criado mais tarde pelo administrador do sistema e, às vezes, é utilizado para variar durante o texto.