PageRenderTime 136ms CodeModel.GetById 120ms RepoModel.GetById 0ms 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
Possible License(s): GPL-2.0, GPL-3.0, WTFPL
  1. .TH "TXT2TAGS" 1 "Ago, 2010" ""
  2. .SH NOME
  3. .P
  4. txt2tags \- ferramenta para formatar e converter textos
  5. .SH SINOPSE
  6. .P
  7. \fBtxt2tags\fR [\fIopções\fR] [\fIARQUIVO\fR...]
  8. .SH DESCRIÇÃO
  9. .P
  10. O \fBtxt2tags\fR um arquivo texto com poucas marcações e o converte para:
  11. \fIASCII Art\fR,
  12. \fIAsciiDoc\fR,
  13. \fICreole\fR,
  14. \fIDocBook\fR,
  15. \fIDokuWiki\fR,
  16. \fIGoogle Code Wiki\fR,
  17. \fIHTML\fR,
  18. \fILaTeX\fR,
  19. \fILout\fR,
  20. \fIMagicPoint\fR,
  21. \fIMan page\fR,
  22. \fIMoinMoin\fR,
  23. \fIPageMaker\fR,
  24. \fIPlain Text\fR,
  25. \fIPmWiki\fR,
  26. \fISGML\fR,
  27. \fIWikipedia\fR e
  28. \fIXHTML\fR.
  29. .P
  30. Esta 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.
  31. .P
  32. UM arquivo fonte, VÁRIOS destinos \- http://txt2tags.org
  33. .SH SINTAXE
  34. .nf
  35. Cabeçalhos As 3 primeiras linhas do arquivo fonte
  36. Título = palavras =
  37. Título numerado + palavras +
  38. Comentário % comentários
  39. Linha de separação -----------------------...
  40. Linha destacada =======================...
  41. Imagem [arquivo.jpg]
  42. Link [nome url]
  43. Negrito **palavras**
  44. Itálico //palavras//
  45. Sublinhado __palavras__
  46. Riscado --palavras--
  47. Monoespaçado ``palavras``
  48. Texto protegido ""palavras""
  49. Texto com tags ''palavras''
  50. Parágrafo palavras
  51. Citação <TAB>palavras
  52. Lista - palavras
  53. Lista numerada + palavras
  54. Lista de definição : palavras
  55. Tabela | cel1 | cel2 | cel3...
  56. Linha formatada ``` palavras
  57. Linha protegida """ palavras
  58. Linha com tags ''' palavras
  59. Área formatada ```
  60. linhas
  61. ```
  62. Área protegida """
  63. linhas
  64. """
  65. Área com tags '''
  66. linhas
  67. '''
  68. .fi
  69. .SH OPÇÕES
  70. .TP
  71. \fB\-\-art\-chars\fR=\fISTRING\fR
  72. Define \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.
  73. .TP
  74. \fB\-C\fR, \fB\-\-config\-file\fR=\fIARQUIVO\fR
  75. Lê 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.
  76. .TP
  77. \fB\-\-css\-sugar\fR
  78. Prepara 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.
  79. .TP
  80. \fB\-\-css\-inside\fR
  81. Insere o conteúdo do arquivo CSS no cabeçalho do documento HTML/XHTML. Use \-\-style para indicar o arquivo CSS a ser lido.
  82. .TP
  83. \fB\-\-dump\-config\fR
  84. Exibe todas as configurações encontradas e sai.
  85. .TP
  86. \fB\-\-dump\-source\fR
  87. Exibe os fontes do documento, com os arquivos incluídos (%!include) expandidos.
  88. .TP
  89. \fB\-\-encoding\fR=\fICÓDIGO\fR
  90. Informa 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.
  91. .TP
  92. \fB\-\-gui\fR
  93. Carrega a interface gráfica (Tk).
  94. .TP
  95. \fB\-h\fR, \fB\-\-help\fR
  96. Exibe o texto de ajuda e sai.
  97. .TP
  98. \fB\-H\fR, \fB\-\-no\-headers\fR
  99. Suprime os cabeçalhos e o rodapé do documento. Apenas o Corpo do documento será mostrado.
  100. .TP
  101. \fB\-\-headers\fR
  102. Exibe os cabeçalhos e o rodapé no documento. Esta opção é usada por padrão.
  103. .TP
  104. \fB\-\-height\fR=\fIN\fR
  105. Define 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.
  106. .TP
  107. \fB\-i\fR, \fB\-\-infile\fR=\fIARQUIVO\fR
  108. Define \fIARQUIVO\fR como arquivo fonte. Use '\-' para ler os dados de STDIN.
  109. .TP
  110. \fB\-\-mask\-email\fR
  111. Esconde 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>.
  112. .TP
  113. \fB\-n\fR, \fB\-\-enum\-title\fR
  114. Enumera todos os títulos automaticamente, nos formatos 1, 1.1, 1.1.1, ...
  115. .TP
  116. \fB\-\-no\-dump\-config\fR
  117. Cancela a ação \-\-dump\-config.
  118. .TP
  119. \fB\-\-no\-dump\-source\fR
  120. Cancela a ação \-\-dump\-source.
  121. .TP
  122. \fB\-\-no\-encoding\fR
  123. Remove a configuração de codificação.
  124. .TP
  125. \fB\-\-no\-enum\-title\fR
  126. Desativa a numeração automática de títulos.
  127. .TP
  128. \fB\-\-no\-infile\fR
  129. Remove as definições anteriores do arquivo fonte.
  130. .TP
  131. \fB\-\-no\-targets\fR
  132. Cancela a ação \-\-targets.
  133. .TP
  134. \fB\-\-no\-mask\-email\fR
  135. Desativa o disfarce de emails.
  136. .TP
  137. \fB\-\-no\-outfile\fR
  138. Remove as definições anteriores sobre o arquivo de destino.
  139. .TP
  140. \fB\-\-no\-quiet\fR
  141. Mostras as mensagens, desativando a opção \-\-quiet.
  142. .TP
  143. \fB\-\-no\-rc\fR
  144. Não lê o arquivo configuração do usuário em ~/.txt2tagsrc.
  145. .TP
  146. \fB\-\-no\-slides\fR
  147. Desliga os slides.
  148. .TP
  149. \fB\-\-no\-style\fR
  150. Remove todas as configurações de estilo.
  151. .TP
  152. \fB\-\-no\-toc\fR
  153. Remove o Sumário automático.
  154. .TP
  155. \fB\-\-no\-toc\-only\fR
  156. Desativa a opção \-\-toc\-only.
  157. .TP
  158. \fB\-o\fR, \fB\-\-outfile\fR=\fIARQUIVO\fR
  159. Define \fIARQUIVO\fR como arquivo de destino. Use '\-' para mandar o resultado para STDOUT.
  160. .TP
  161. \fB\-q\fR, \fB\-\-quiet\fR
  162. Modo silencioso, não mostra nada na saída, exceto os erros.
  163. .TP
  164. \fB\-\-rc\fR
  165. Lê a configuração do usuário em ~/.txt2tagsrc. Esta opção é usada por padrão.
  166. .TP
  167. \fB\-\-slides\fR
  168. Formata a saída como uma apresentação de slides. Esta opção é utilizada somente pelo formato ASCII Art.
  169. .TP
  170. \fB\-\-style\fR=\fIARQUIVO\fR
  171. Utiliza \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.
  172. .TP
  173. \fB\-t\fR, \fB\-\-target\fR=\fIFORMATO\fR
  174. Define 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.
  175. .TP
  176. \fB\-\-targets\fR
  177. Mostra a lista completa de todos os formatos disponíveis e sai.
  178. .TP
  179. \fB\-\-toc\fR
  180. Inclui 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.
  181. .TP
  182. \fB\-\-toc\-level\fR=\fIN\fR
  183. Define 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.
  184. .TP
  185. \fB\-\-toc\-only\fR
  186. Exibe o Sumário do documento e sai.
  187. .TP
  188. \fB\-v\fR, \fB\-\-verbose\fR
  189. Exibe 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.
  190. .TP
  191. \fB\-V\fR, \fB\-\-version\fR
  192. Exibe a versão do programa e sai.
  193. .TP
  194. \fB\-\-width\fR=\fIN\fR
  195. Define a largura da saída para \fIN\fR colunas. Esta opção é utilizada somente pelo formato ASCII Art.
  196. .SH ARQUIVO FONTE
  197. .P
  198. Um 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:
  199. .TP
  200. \fBCabeçalho\fR
  201. As 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.
  202. .TP
  203. \fBConfiguração\fR
  204. Inicia 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.
  205. .TP
  206. \fBCorpo\fR
  207. Começ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.
  208. .SH CONFIGURAÇÕES
  209. .P
  210. Você 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.
  211. .TP
  212. \fB%!target\fR
  213. Define o formato de saída, igual faz a opção \-\-target. Exemplo:
  214. .nf
  215. %!target: html
  216. .fi
  217. .TP
  218. \fB%!options(target)\fR
  219. Define as opções de cada formato. No valor você deve colocar as opções de linha de comando. Exemplo:
  220. .nf
  221. %!options(html): --toc --toc-level 3 --css-sugar
  222. .fi
  223. .TP
  224. \fB%!includeconf\fR
  225. Lê as configurações a partir de um arquivo externo, igual faz a opção \-\-config\-file. Exemplo:
  226. .nf
  227. %!includeconf: minhaconfig.t2t
  228. .fi
  229. .TP
  230. \fB%!style\fR
  231. Define 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:
  232. .nf
  233. %!style: cores.css
  234. .fi
  235. .TP
  236. \fB%!encoding\fR
  237. Define a codificação do texto, igual faz a opção \-\-encoding. Exemplo:
  238. .nf
  239. %!encoding: UTF-8
  240. .fi
  241. .TP
  242. \fB%!preproc\fR
  243. Filtro 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:
  244. .nf
  245. %!preproc: "FSS" "Fulano da Silva Sauro"
  246. .fi
  247. .TP
  248. \fB%!postproc\fR
  249. Filtro 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:
  250. .nf
  251. %!postproc(html): "<B>" "<STRONG>"
  252. .fi
  253. .P
  254. Se 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.
  255. .SH COMANDOS
  256. .P
  257. Os comandos são executados durante a conversão do documento. Eles devem ser colocados dentro do Corpo do arquivo fonte.
  258. .TP
  259. \fB%!csv: arquivo.csv\fR
  260. Gera uma tabela a partir de um arquivo externo CSV.
  261. .TP
  262. \fB%!include: arquivo.t2t\fR
  263. Inclui um arquivo fonte txt2tags no documento.
  264. .TP
  265. \fB%!include: ``arquivo.txt``\fR
  266. Inclui um arquivo texto no documento.
  267. .TP
  268. \fB%!include: \&''arquivo.html''\fR
  269. Inclui um arquivo pronto no documento, ele não é modificado.
  270. .SH MACROS
  271. .P
  272. As 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.
  273. .TP
  274. \fB%%date\fR
  275. Insere a data atual. O formato padrão é %%date(%Y%m%d), que fica AAAAMMDD.
  276. .TP
  277. \fB%%infile\fR
  278. Insere o nome do arquivo fonte. O formato padrão é %%infile(%f). Útil para links de rodapé, como [Veja os fontes %%infile].
  279. .TP
  280. \fB%%mtime\fR
  281. Insere a data de modificação do arquivo fonte. O formato padrão é %%date(%Y%m%d), que fica AAAAMMDD.
  282. .TP
  283. \fB%%outfile\fR
  284. Insere 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".
  285. .TP
  286. \fB%%toc\fR
  287. Especifica 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.
  288. .SH EXEMPLOS
  289. .TP
  290. txt2tags \-t html arquivo.t2t
  291. Converte para HTML, gravando o resultado em arquivo.html.
  292. .TP
  293. txt2tags \-t html \-o \- arquivo.t2t
  294. Converte para HTML, mandando o resultado para STDOUT.
  295. .TP
  296. txt2tags \-t html \-\-toc arquivo.t2t
  297. Converte para HTML, com Sumário automático (Table Of Contents).
  298. .TP
  299. txt2tags \-t html \-\-toc \-\-toc\-level 2 \-n arquivo.t2t
  300. Converte para HTML, com Sumário de dois níveis e títulos numerados.
  301. .TP
  302. txt2tags \-\-toc\-only arquivo.t2t
  303. Apenas mostra o Sumário, nenhuma conversão é feita.
  304. .TP
  305. txt2tags \-t html \-\-css\-sugar \-\-style base.css \-\-style ui.css arquivo.t2t
  306. Converte para HTML, com código preparado para usar CSS e também inclui dois arquivos CSS externos.
  307. .TP
  308. txt2tags \-t art \-\-slides \-\-width 80 \-\-height 25 \-o \- arquivo.t2t | more
  309. Cria uma apresentação de slides em ASCII Art, pronta para ser mostrada em um terminal de tamanho 80x25 (colunas e linhas).
  310. .TP
  311. (echo ; echo "**bold**") | txt2tags \-t html \-H \-
  312. Mostra como testar o programa rapidamente usando a STDIN como fonte.
  313. .TP
  314. txt2tags \-t html \-o \- arquivo.t2t | tidy > arquivo.html
  315. Manda os resultados para STDOUT e refina o código gerado usando um programa externo (tidy) antes de salvar o arquivo HTML final.
  316. .SH ARQUIVOS
  317. .TP
  318. ~/.txt2tagsrc
  319. A localização padrão para o arquivo com as configurações do usuário.
  320. .SH AMBIENTE
  321. .TP
  322. T2TCONFIG
  323. Se definida, esta variável guarda o caminho completo para o arquivo de configuração do usuário.
  324. .SH AUTOR
  325. .P
  326. Aurélio Marinho Jargas <verde@aurelio.net>
  327. .P
  328. Já trabalharam neste manual José Inácio Coelho <jic@technologist.com> e Mauricio Teixeira <mteixeira@webset.net>.
  329. .SH BUGS
  330. .P
  331. http://bugs.txt2tags.org
  332. .SH COPYRIGHT
  333. .P
  334. Copyright (C) 2001\-2010 Aurelio Jargas, GNU GPL v2
  335. .\" man code generated by txt2tags 2.6 (http://txt2tags.org)
  336. .\" cmdline: txt2tags -t man doc/Portuguese/manpage-pt.t2t