aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/pt-br/books/fdp-primer/manual-pages/_index.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/content/pt-br/books/fdp-primer/manual-pages/_index.adoc')
-rw-r--r--documentation/content/pt-br/books/fdp-primer/manual-pages/_index.adoc141
1 files changed, 86 insertions, 55 deletions
diff --git a/documentation/content/pt-br/books/fdp-primer/manual-pages/_index.adoc b/documentation/content/pt-br/books/fdp-primer/manual-pages/_index.adoc
index 2804b37f58..36f986ed43 100644
--- a/documentation/content/pt-br/books/fdp-primer/manual-pages/_index.adoc
+++ b/documentation/content/pt-br/books/fdp-primer/manual-pages/_index.adoc
@@ -1,9 +1,12 @@
---
description: 'Como trabalhar com as Páginas de Manual do FreeBSD'
next: books/fdp-primer/writing-style
-prev: books/fdp-primer/po-translations
+path: "/books/fdp-primer/manual-pages/"
+prev: books/fdp-primer/weblate
+showBookMenu: 'true'
tags: ["manual pages", "introduction", "guide", "reference"]
-title: 'Capítulo 10. Páginas de Manual'
+title: 'Capítulo 11. Páginas de Manual'
+weight: 11
---
[[manual-pages]]
@@ -14,16 +17,35 @@ title: 'Capítulo 10. Páginas de Manual'
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 11
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 10
-:toc-title: Índice
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+ifndef::env-beastie[]
toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
[[manual-pages-introduction]]
== Introdução
@@ -42,36 +64,36 @@ As páginas de manual são agrupadas em _seções_. Cada seção contém página
[.informaltable]
[cols="1,8", options="header"]
|===
-| Section Number
-| Category
+| Número da Seção
+| Categoria
|1
-|General Commands
+|Comandos Gerais
|2
-|System Calls
+|Chamadas de Sistema
|3
-|Library Functions
+|Funções de Biblioteca
|4
-|Kernel Interfaces
+|Interfaces do Kernel
|5
-|File Formats
+|Formatos de Arquivo
|6
-|Games
+|Jogos
|7
-|Miscellaneous
+|Diversos
|8
-|System Manager
+|Gerenciamento do Sistema
|9
-|Kernel Developer
+|Desenvolvedor do Kernel
|===
[[manual-pages-markup]]
@@ -91,45 +113,45 @@ Páginas de manual são compostas por várias seções padrão. Cada seção tem
[.informaltable]
[cols="2,4", options="header"]
|===
-| Section Name
-| Description
+| Nome da Seção
+| Descrição
|NAME
-|Name of the command
+|Nome do comando
|SYNOPSIS
-|Format of options and arguments
+|Formato de opções e argumentos
|DESCRIPTION
-|Description of purpose and usage
+|Descrição da finalidade e uso
|ENVIRONMENT
-|Environment settings that affect operation
+|Configurações de ambiente que afetam a operação
|EXIT STATUS
-|Error codes returned on exit
+|Códigos de erro retornados na saída
|EXAMPLES
-|Examples of usage
+|Exemplos de uso
|COMPATIBILITY
-|Compatibility with other implementations
+|Compatibilidade com outras implementações
|SEE ALSO
-|Cross-reference to related manual pages
+|Referência cruzada para páginas de manual relacionadas
|STANDARDS
-|Compatibility with standards like POSIX
+|Compatibilidade com padrões como POSIX
|HISTORY
-|History of implementation
+|Histórico de implementação
|BUGS
-|Known bugs
+|Erros conhecidos
|AUTHORS
-|People who created the command or wrote the manual page.
+|Pessoas que criaram o comando ou escreveram a página de manual.
|===
Algumas seções são opcionais e a combinação de seções para um tipo específico de página manual pode variar. Exemplos dos tipos mais comuns são mostrados mais adiante neste capítulo.
@@ -220,7 +242,7 @@ Apresentando exemplos::
Apresente exemplos ao leitor sempre que possível. Mesmo exemplos triviais são valiosos, porque o que é trivial para o escritor não é necessariamente trivial para o leitor. Três exemplos são um bom objetivo. Um exemplo trivial mostra os requisitos mínimos, um exemplo afundo mostra o uso real e um exemplo detalhado demonstra uma funcionalidade incomum ou não óbvia.
Inclua a licença BSD::
-Inclua a licença BSD em novas páginas de manual. A licença preferencial está disponível no link:{committers-guide}[Guia dos Committer's].
+Inclua a licença BSD em novas páginas de manual. A licença preferencial está disponível no extref:{committers-guide}[Guia dos Committer's].
[[manual-pages-markup-tricks]]
=== Truques de Marcação
@@ -256,32 +278,32 @@ Algumas macros são usadas para definir blocos lógicos de uma página de manual
[.informaltable]
[cols="1,8", options="header"]
|===
-| Organizational Macro
-| Use
+| Macro Organizacional
+| Uso
|`.Sh`
-|Section header.
-Followed by the name of the section, traditionally all upper case.
-Think of these as chapter titles.
+|Cabeçalho da seção (Section header).
+Seguido do nome da seção, tradicionalmente toda em caixa alta.
+Pense nisso como títulos de capítulos.
|`.Ss`
-|Subsection header.
-Followed by the name of the subsection.
-Used to divide a `.Sh` section into subsections.
+|Cabeçalho da subseção (Subsection header).
+Seguido pelo nome da subseção.
+Usado para dividir uma seção `.Sh` em subseções.
|`.Bl`
-|Begin list. Start a list of items.
+|Comece a lista (Begin list). Inicie uma lista de itens.
|`.El`
-|End a list.
+|Terminar lista (End list).
|`.Bd`
-|Begin display.
-Begin a special area of text, like an indented area.
+|Comece a exibição (Begin display).
+Comece uma área especial do texto, como uma área recuada.
|`.Ed`
-|End display.
+|Fim da exibição (End display).
|===
[[manual-pages-markup-important-macros-inline]]
@@ -292,17 +314,17 @@ Muitas macros são usadas para marcar texto embutido.
[.informaltable]
[cols="1,8", options="header"]
|===
-| Inline Macro
-| Use
+| Macro inline
+| Uso
|`.Nm`
-|Name.
-Called with a name as a parameter on the first use, then used later without the parameter to display the name that has already been defined.
+|Nome.
+Chamado com um nome como parâmetro no primeiro uso, depois usado sem o parâmetro para exibir o nome que já foi definido.
|`.Pa`
-|Path to a file.
-Used to mark up filenames and directory paths.
+|Caminho para um arquivo (Path to a file).
+Usado para marcar nomes de arquivos e caminhos de diretório.
|===
[[manual-pages-sample-structures]]
@@ -440,6 +462,15 @@ Use o package:textproc/igor[] para revisar a página do manual:
% igor ./mynewmanpage.8
....
+Outra ferramenta útil é o package:textproc/vale[]. Ele não suporta a sintaxe man:mdoc[7], mas a página de manual renderizada pode ser lida e analisada a partir da entrada padrão:
+
+[source, shell]
+....
+% man ls | vale
+....
+
+package:textproc/vale[] é altamente configurável. É aconselhável ler sua documentação.
+
Use man:man[1] para verificar o resultado final de suas alterações:
[source, shell]
@@ -469,8 +500,8 @@ Algumas destas páginas de manual são adequadas para serem usadas como exemplos
[.informaltable]
[cols="1,4", options="header"]
|===
-| Manual Page
-| Path to Source Location
+| Página de Manual
+| Caminho para o arquivo de origem
|man:cp[1]