PageRenderTime 25ms CodeModel.GetById 15ms app.highlight 6ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/Portuguese/manpage-pt.man

http://txt2tags.googlecode.com/
Unknown | 468 lines | 336 code | 132 blank | 0 comment | 0 complexity | eb3b529868fb02c89b5e23d8b75043bd MD5 | raw file
  1.TH "TXT2TAGS" 1 "Ago, 2010" ""
  2
  3
  4.SH NOME
  5
  6.P
  7txt2tags \- ferramenta para formatar e converter textos
  8
  9.SH SINOPSE
 10
 11.P
 12\fBtxt2tags\fR [\fIopções\fR] [\fIARQUIVO\fR...]
 13
 14.SH DESCRIÇÃO
 15
 16.P
 17O \fBtxt2tags\fR lê um arquivo texto com poucas marcações e o converte para:
 18\fIASCII Art\fR,
 19\fIAsciiDoc\fR,
 20\fICreole\fR,
 21\fIDocBook\fR,
 22\fIDokuWiki\fR,
 23\fIGoogle Code Wiki\fR,
 24\fIHTML\fR,
 25\fILaTeX\fR,
 26\fILout\fR,
 27\fIMagicPoint\fR,
 28\fIMan page\fR,
 29\fIMoinMoin\fR,
 30\fIPageMaker\fR,
 31\fIPlain Text\fR,
 32\fIPmWiki\fR,
 33\fISGML\fR,
 34\fIWikipedia\fR e
 35\fIXHTML\fR.
 36
 37.P
 38Esta página de manual foi criada pelo \fBtxt2tags\fR a partir de um arquivo de texto. Este mesmo arquivo de texto também é convertido para HTML e colocado no site do programa para consulta.
 39
 40.P
 41UM arquivo fonte, VÁRIOS destinos \- http://txt2tags.org
 42
 43.SH SINTAXE
 44
 45.nf
 46Cabeçalhos          As 3 primeiras linhas do arquivo fonte
 47Título              = palavras =
 48Título numerado     + palavras +
 49Comentário          % comentários
 50Linha de separação  -----------------------...
 51Linha destacada     =======================...
 52Imagem              [arquivo.jpg]
 53Link                [nome url]
 54
 55Negrito             **palavras**
 56Itálico             //palavras//
 57Sublinhado          __palavras__
 58Riscado             --palavras--
 59Monoespaçado        ``palavras``
 60Texto protegido     ""palavras""
 61Texto com tags      ''palavras''
 62
 63Parágrafo           palavras
 64Citação             <TAB>palavras
 65Lista               - palavras
 66Lista numerada      + palavras
 67Lista de definição  : palavras
 68Tabela              | cel1 | cel2 | cel3...
 69
 70Linha formatada     ``` palavras
 71Linha protegida     """ palavras
 72Linha com tags      ''' palavras
 73
 74Área formatada      ```
 75                    linhas
 76                    ```
 77Área protegida      """
 78                    linhas
 79                    """
 80Área com tags       '''
 81                    linhas
 82                    '''
 83.fi
 84
 85
 86.SH OPÇÕES
 87
 88.TP
 89    \fB\-\-art\-chars\fR=\fISTRING\fR
 90Define \fISTRING\fR como a lista de caracteres usados para fazer os enfeites do ASCII Art, nesta ordem: canto, borda, lado, linha1, linha2, nível2, nível3, nível4, nível5. O valor padrão da string é +\-|\-==\-^". Esta opção é utilizada somente pelo formato ASCII Art.
 91
 92.TP
 93\fB\-C\fR, \fB\-\-config\-file\fR=\fIARQUIVO\fR
 94Lê a configuração a partir do arquivo externo \fIARQUIVO\fR. A configuração deve estar no formato \fI%!nome:valor\fR. Veja o tópico CONFIGURAÇÕES para mais detalhes.
 95
 96.TP
 97    \fB\-\-css\-sugar\fR
 98Prepara o código HTML/XHTML para ser usado com arquivos CSS. Os atributos das tags são removidos, tags de formatação são evitadas, o cabeçalho é composto pelas tags H1, H2 e H3, novos DIVs são criados: \fI#header\fR, \fI#body\fR, \fI.toc\fR.
 99
100.TP
101    \fB\-\-css\-inside\fR
102Insere o conteúdo do arquivo CSS no cabeçalho do documento HTML/XHTML. Use \-\-style para indicar o arquivo CSS a ser lido.
103
104.TP
105    \fB\-\-dump\-config\fR
106Exibe todas as configurações encontradas e sai.
107
108.TP
109    \fB\-\-dump\-source\fR
110Exibe os fontes do documento, com os arquivos incluídos (%!include) expandidos.
111
112.TP
113    \fB\-\-encoding\fR=\fICÓDIGO\fR
114Informa a codificação usada no arquivo fonte. Alguns exemplos são UTF\-8 e iso\-8859\-1. A codificação não é alterada durante a conversão, então o arquivo de destino terá a mesma codificação do arquivo fonte.
115
116.TP
117    \fB\-\-gui\fR
118Carrega a interface gráfica (Tk).
119
120.TP
121\fB\-h\fR, \fB\-\-help\fR
122Exibe o texto de ajuda e sai.
123
124.TP
125\fB\-H\fR, \fB\-\-no\-headers\fR
126Suprime os cabeçalhos e o rodapé do documento. Apenas o Corpo do documento será mostrado.
127
128.TP
129    \fB\-\-headers\fR
130Exibe os cabeçalhos e o rodapé no documento. Esta opção é usada por padrão.
131
132.TP
133    \fB\-\-height\fR=\fIN\fR
134Define a altura da saída para \fIN\fR linhas. Esta opção é utilizada somente pelo formato ASCII Art, quando também utilizada a opção \-\-slides.
135
136.TP
137\fB\-i\fR, \fB\-\-infile\fR=\fIARQUIVO\fR
138Define \fIARQUIVO\fR como arquivo fonte. Use '\-' para ler os dados de STDIN.
139
140.TP
141    \fB\-\-mask\-email\fR
142Esconde os e\-mails dos robôs de SPAM. Os pontos e o @ são removidos. O endereço foo@bar.com vira <foo (a) bar com>.
143
144.TP
145\fB\-n\fR, \fB\-\-enum\-title\fR
146Enumera todos os títulos automaticamente, nos formatos 1, 1.1, 1.1.1, ...
147
148.TP
149    \fB\-\-no\-dump\-config\fR
150Cancela a ação \-\-dump\-config.
151
152.TP
153    \fB\-\-no\-dump\-source\fR
154Cancela a ação \-\-dump\-source.
155
156.TP
157    \fB\-\-no\-encoding\fR
158Remove a configuração de codificação.
159
160.TP
161    \fB\-\-no\-enum\-title\fR
162Desativa a numeração automática de títulos.
163
164.TP
165    \fB\-\-no\-infile\fR
166Remove as definições anteriores do arquivo fonte.
167
168.TP
169    \fB\-\-no\-targets\fR
170Cancela a ação \-\-targets.
171
172.TP
173    \fB\-\-no\-mask\-email\fR
174Desativa o disfarce de emails.
175
176.TP
177    \fB\-\-no\-outfile\fR
178Remove as definições anteriores sobre o arquivo de destino.
179
180.TP
181    \fB\-\-no\-quiet\fR
182Mostras as mensagens, desativando a opção \-\-quiet.
183
184.TP
185    \fB\-\-no\-rc\fR
186Não lê o arquivo configuração do usuário em ~/.txt2tagsrc.
187
188.TP
189    \fB\-\-no\-slides\fR
190Desliga os slides.
191
192.TP
193    \fB\-\-no\-style\fR
194Remove todas as configurações de estilo.
195
196.TP
197    \fB\-\-no\-toc\fR
198Remove o Sumário automático.
199
200.TP
201    \fB\-\-no\-toc\-only\fR
202Desativa a opção \-\-toc\-only.
203
204.TP
205\fB\-o\fR, \fB\-\-outfile\fR=\fIARQUIVO\fR
206Define \fIARQUIVO\fR como arquivo de destino. Use '\-' para mandar o resultado para STDOUT.
207
208.TP
209\fB\-q\fR, \fB\-\-quiet\fR
210Modo silencioso, não mostra nada na saída, exceto os erros.
211
212.TP
213    \fB\-\-rc\fR
214Lê a configuração do usuário em ~/.txt2tagsrc. Esta opção é usada por padrão.
215
216.TP
217    \fB\-\-slides\fR
218Formata a saída como uma apresentação de slides. Esta opção é utilizada somente pelo formato ASCII Art.
219
220.TP
221    \fB\-\-style\fR=\fIARQUIVO\fR
222Utiliza \fIARQUIVO\fR como estilo do documento. É usado para incluir arquivos CSS em documentos HTML, e pacotes para o LaTeX. Esta opção pode ser usada mais de uma vez caso você precise incluir dois ou mais arquivos.
223
224.TP
225\fB\-t\fR, \fB\-\-target\fR=\fIFORMATO\fR
226Define o formato do documento de destino. Alguns formatos populares são: \fIhtml\fR, \fIxhtml\fR, \fItex\fR, \fIman\fR, \fItxt\fR. Use a opção \-\-targets para ver a lista completa com todos os formatos disponíveis.
227
228.TP
229    \fB\-\-targets\fR
230Mostra a lista completa de todos os formatos disponíveis e sai.
231
232.TP
233    \fB\-\-toc\fR
234Inclui um Sumário automático (Table of Contents) no documento de destino, entre o cabeçalho e o corpo. Você também pode indicar onde o Sumário deve ser colocado, usando a macro %%TOC.
235
236.TP
237    \fB\-\-toc\-level\fR=\fIN\fR
238Define o nível máximo (profundidade) do Sumário para \fIN\fR. Os títulos abaixo do nível \fIN\fR não serão incluídos no Sumário.
239
240.TP
241    \fB\-\-toc\-only\fR
242Exibe o Sumário do documento e sai.
243
244.TP
245\fB\-v\fR, \fB\-\-verbose\fR
246Exibe mensagens informativas durante a conversão. Utilize\-a duas ou mais vezes na linha de comando para aumentar o número de mensagens a serem mostradas.
247
248.TP
249\fB\-V\fR, \fB\-\-version\fR
250Exibe a versão do programa e sai.
251
252.TP
253    \fB\-\-width\fR=\fIN\fR
254Define a largura da saída para \fIN\fR colunas. Esta opção é utilizada somente pelo formato ASCII Art.
255
256.SH ARQUIVO FONTE
257
258.P
259Um arquivo fonte do \fBtxt2tags\fR geralmente usa a extensão \fI.t2t\fR, como por exemplo: trabalho.t2t. Você pode ter três áreas distintas em seus fontes:
260
261.TP
262\fBCabeçalho\fR
263As primeiras três linhas. São usadas para identificação do documento, como título, autor, versão e data. Se você não quiser usar cabeçalhos, deixe a primeira linha em branco.
264
265.TP
266\fBConfiguração\fR
267Inicia logo após o cabeçalho (4ª ou 2ª linha) e termina quando o Corpo se inicia. Esta área é usada para configurações no formato %!nome:valor.
268
269.TP
270\fBCorpo\fR
271Começa na primeira linha de texto (que não seja um comentário ou uma configuração) logo após o cabeçalho e vai até o fim do documento. É usada para guardar o conteúdo do documento.
272
273.SH CONFIGURAÇÕES
274
275.P
276Você pode personalizar o txt2tags usando configurações. Elas são parecidas com as opções de linha de comando e podem ser usadas nos seguintes locais: na área Configuração do seu arquivo fonte, no arquivo ~/.txt2tagsrc ou ainda em um arquivo externo chamado com a opção \-\-config\-file.
277
278.TP
279\fB%!target\fR
280Define o formato de saída, igual faz a opção \-\-target. Exemplo:
281.nf
282%!target: html
283.fi
284
285
286
287.TP
288\fB%!options(target)\fR
289Define as opções de cada formato. No valor você deve colocar as opções de linha de comando. Exemplo:
290.nf
291%!options(html): --toc --toc-level 3 --css-sugar
292.fi
293
294
295
296.TP
297\fB%!includeconf\fR
298Lê as configurações a partir de um arquivo externo, igual faz a opção \-\-config\-file. Exemplo:
299.nf
300%!includeconf: minhaconfig.t2t
301.fi
302
303
304
305.TP
306\fB%!style\fR
307Define um arquivo de estilos para o documento, igual faz a opção \-\-style. Pode ser usada várias vezes para definir mais de um arquivo. Exemplo:
308.nf
309%!style: cores.css
310.fi
311
312
313
314.TP
315\fB%!encoding\fR
316Define a codificação do texto, igual faz a opção \-\-encoding. Exemplo:
317.nf
318%!encoding: UTF-8
319.fi
320
321
322
323.TP
324\fB%!preproc\fR
325Filtro de entrada (estilo troque "isso" por "aquilo") usado para alterar o Corpo do documento ANTES do txt2tags processá\-lo. Você pode usar as expressões regulares do Python. Exemplo:
326.nf
327%!preproc:  "FSS"  "Fulano da Silva Sauro"
328.fi
329
330
331
332.TP
333\fB%!postproc\fR
334Filtro de saída (estilo troque "isso" por "aquilo") usado para alterar o documento de saída DEPOIS da conversão feita pelo txt2tags. Você pode usar as expressões regulares do Python. Exemplo:
335.nf
336%!postproc(html):  "<B>"  "<STRONG>"
337.fi
338
339
340
341.P
342Se a mesma configuração for usada mais de uma vez, somente a última será utilizada. As exceções são: options, preproc e postproc, que são cumulativas. Configurações com nomes inválidos serão ignoradas. A ordem de processamento é: ~/.txt2tagsrc, área Configuração do arquivo fonte, opção \-\-config\-file.
343
344.SH COMANDOS
345
346.P
347Os comandos são executados durante a conversão do documento. Eles devem ser colocados dentro do Corpo do arquivo fonte.
348
349.TP
350\fB%!csv: arquivo.csv\fR
351Gera uma tabela a partir de um arquivo externo CSV.
352
353.TP
354\fB%!include: arquivo.t2t\fR
355Inclui um arquivo fonte txt2tags no documento.
356
357.TP
358\fB%!include: ``arquivo.txt``\fR
359Inclui um arquivo texto no documento.
360
361.TP
362\fB%!include: \&''arquivo.html''\fR
363Inclui um arquivo pronto no documento, ele não é modificado.
364
365.SH MACROS
366
367.P
368As macros são úteis para inserir conteúdos dinâmicos em seu documento, como a data atual, por exemplo. Exceto a %%toc, todas as macros podem ser personalizadas com curingas tipo %Y e %f. Veja o Guia do Usuário para saber mais detalhes.
369
370.TP
371\fB%%date\fR
372Insere a data atual. O formato padrão é %%date(%Y%m%d), que fica AAAAMMDD.
373
374.TP
375\fB%%infile\fR
376Insere o nome do arquivo fonte. O formato padrão é %%infile(%f). Útil para links de rodapé, como [Veja os fontes %%infile].
377
378.TP
379\fB%%mtime\fR
380Insere a data de modificação do arquivo fonte. O formato padrão é %%date(%Y%m%d), que fica AAAAMMDD.
381
382.TP
383\fB%%outfile\fR
384Insere o nome do arquivo de saída. O formato padrão é %%outfile(%f). Útil para mencionar o próprio documento, como em "Este é o arquivo manpage\-pt.man".
385
386.TP
387\fB%%toc\fR
388Especifica o lugar onde será colocado o Sumário (Table Of Contents). Você pode utilizá\-la em qualquer parte do documento, inclusive mais de uma vez. A opção \-\-toc também deve ser usada para esta que esta macro funcione.
389
390.SH EXEMPLOS
391
392.TP
393txt2tags \-t html arquivo.t2t
394
395Converte para HTML, gravando o resultado em arquivo.html.
396
397.TP
398txt2tags \-t html \-o \- arquivo.t2t
399
400Converte para HTML, mandando o resultado para STDOUT.
401
402.TP
403txt2tags \-t html \-\-toc arquivo.t2t
404
405Converte para HTML, com Sumário automático (Table Of Contents).
406
407.TP
408txt2tags \-t html \-\-toc \-\-toc\-level 2 \-n arquivo.t2t
409
410Converte para HTML, com Sumário de dois níveis e títulos numerados.
411
412.TP
413txt2tags \-\-toc\-only arquivo.t2t
414
415Apenas mostra o Sumário, nenhuma conversão é feita.
416
417.TP
418txt2tags \-t html \-\-css\-sugar \-\-style base.css \-\-style ui.css arquivo.t2t
419
420Converte para HTML, com código preparado para usar CSS e também inclui dois arquivos CSS externos.
421
422.TP
423txt2tags \-t art \-\-slides \-\-width 80 \-\-height 25 \-o \- arquivo.t2t | more
424
425Cria uma apresentação de slides em ASCII Art, pronta para ser mostrada em um terminal de tamanho 80x25 (colunas e linhas).
426
427.TP
428(echo ; echo "**bold**") | txt2tags \-t html \-H \-
429
430Mostra como testar o programa rapidamente usando a STDIN como fonte.
431
432.TP
433txt2tags \-t html \-o \- arquivo.t2t | tidy > arquivo.html
434
435Manda os resultados para STDOUT e refina o código gerado usando um programa externo (tidy) antes de salvar o arquivo HTML final.
436
437.SH ARQUIVOS
438
439.TP
440~/.txt2tagsrc
441A localização padrão para o arquivo com as configurações do usuário.
442
443.SH AMBIENTE
444
445.TP
446T2TCONFIG
447Se definida, esta variável guarda o caminho completo para o arquivo de configuração do usuário.
448
449.SH AUTOR
450
451.P
452Aurélio Marinho Jargas <verde@aurelio.net>
453
454.P
455Já trabalharam neste manual José Inácio Coelho <jic@technologist.com> e Mauricio Teixeira <mteixeira@webset.net>.
456
457.SH BUGS
458
459.P
460http://bugs.txt2tags.org
461
462.SH COPYRIGHT
463
464.P
465Copyright (C) 2001\-2010 Aurelio Jargas, GNU GPL v2
466
467.\" man code generated by txt2tags 2.6 (http://txt2tags.org)
468.\" cmdline: txt2tags -t man doc/Portuguese/manpage-pt.t2t