Provided by: txt2tags_2.6-3build1_all bug

NOMBRE

       txt2tags - Herramienta de formateo y conversión de texto.

SINOPSIS

       txt2tags [opciones] [ARCHIVO...]

DESCRIPCIÓN

       txt2tags  lee  un  archivo  de  texto que ha sido mínimamente marcado y lo convierte a los
       siguientes formatos: ASCII Art, AsciiDoc, Creole, DocBook,  DokuWiki,  Google  Code  Wiki,
       HTML,  LaTeX,  Lout,  MagicPoint, Man page, MoinMoin, PageMaker, Plain Text (Texto Plano),
       PmWiki, SGML, Wikipedia and XHTML.

       Esta página de manual (Man page) fué creada con txt2tags a partir de un archivo  de  texto
       plano. El mismo archivo de texto fué también convertido en un archivo HTML para generar la
       versión online de este manual.

       UNA única fuente, MÚLTIPLES formatos de salida - http://txt2tags.org

MARCADO

       Encabezado             Las primeras tres líneas del archivo fuente.
       Título                 = texto =
       Título numerado        + texto +
       Comentario             % comentarios
       Línea de separación    -----------------------...
       Línea gruesa           =======================...
       Imagen                 [nombre.jpg]
       Enlace                 [etiqueta url]

       Negrita                **texto**
       Cursiva                //texto//
       Subrayado              __texto__
       Tachado                --texto--
       Monoespacio            ``texto``
       Raw                    ""texto""
       Etiquetado             ''texto''

       Párrafo                texto
       Cita                   <TAB>texto
       Lista                  - texto
       Lista numerada         + texto
       Lista de definición    : texto
       Tabla                  | celda1 | celda2 | celda3...

       Línea verbatim         ``` texto
       Línea Raw              """ texto
       Línea Etiquetada       ''' texto

       Bloque Verbatim        ```
                              líneas
                              ```
       Bloque Raw             """
                              líneas
                              """
       Bloque etiquetado      '''
                              líneas
                              '''

OPCIONES

       -C, --config-file=ARCHIVO
              Lee la  configuración  desde  el  archivo  externo  especificado  en   ARCHIVO.  La
              configuración  debe estar en formato  %!keyword:value . Para mas detalles, véase la
              sección AJUSTES.

           --css-sugar
              Mejora el código HTML/XHTML generado para poder usar archivos CSS. Se eliminan  los
              atributos  de  las  etiquetas,  se  ignoran  las  etiquetas  de  presentación,  los
              encabezados se generan con etiquetas H1, H2 y H3 y se crean nuevas DIVs :  #header,
              #body, .toc.

           --css-inside
              Inserta  el  contenido de un archivo CSS en el encabezado HTML/XHTML. Usar  --style
              para especificar el archivo CSS que debe leerse.

           --dump-config
              Muestra toda la configuración encontrada y sale.

           --dump-source
              Muestra el documento fuente, con todas sus inclusiones  (%!include) expandidas.

           --encoding=CÓDIGO
              Establece  la  configuración  de  caracteres  del  archivo  de  salida  usando   la
              establecida en  CÓDIGO. Ejemplos de  CÓDIGO: UTF-8 y iso-8859-1.

           --gui
              Llama la Interfaz Gráfica Tk.

       -h, --help
              Muestra la información de ayuda y sale.

       -H, --no-headers
              Elimina  los  encabezados  y  los  piés  de  página  del archivo de salida. Solo se
              mostrarán los contenidos (cuerpo del documento).

           --headers
              Muestra los encabezados y piés de página del archivo de salida. Por defecto: ON.

           --height=NUM
              Fija el número de líneas del archivo de salida al señalado  en   NUM.  Esta  opción
              solo  se  usa  en  formatos  de  salida  ASCII  Art,  cuando también se esté usando
              --slides.

       -i, --infile=ARCHIVO
              Toma  ARCHIVO  como archivo fuente. Usar '-' para leer la fuente desde STDIN.

           --mask-email
              Oculta los emails  a  los  robots  de  spam.  Elimina  @  y  puntos.  La  dirección
              foo@bar.com  se convierte en <foo (a) bar com>.

       -n, --enum-title
              Activa  la  numeración automática de los títulos. Está prefijada en: 1, 1.1, 1.1.1,
              ...

           --no-dump-config
              Cancela la acción  --dump-config.

           --no-dump-source
              Cancela la acción  --dump-source.

           --no-encoding
              Elimina la configuración de caracteres.

           --no-enum-title
              Desactiva la numeración automática de los títulos.

           --no-infile
              Elimina toda anterior declaración  --infile.

           --no-targets
              Elimina la acción  --targets.

           --no-mask-email
              Desactiva la ocultación de emails.

           --no-outfile
              Elimina toda anterior declaración  --outfile.

           --no-quiet
              Muestra los mensajes, desactiva la opción  --quiet.

           --no-rc
              No leer en el archivo de configuración del usuario   ~/.txt2tagsrc.

           --no-slides
              Desactiva  --slides.

           --no-style
              Elimina todos los ajustes de estilo.

           --no-toc
              Elimina la Tabla de Contenidos (TOC) en el archivo de salida.

           --no-toc-only
              Desactiva la acción --toc-only.

       -o, --outfile=ARCHIVO
              Toma  ARCHIVO  como nombre del archivo  de  salida.  Usar   '-'  para  dirigir  los
              resultados a STDOUT.

       -q, --quiet
              Modo silencioso. Suprime todos los mensajes del sistema, excepto los de error.

           --rc
              Lee  el archivo de configuración (ajustes) del usuario  ~/.txt2tagsrc. Por defecto:
              ON.

           --slides
              Formatea el archivo de salida como una presentación de diapositivas. Esta opción se
              usa solo en formatos de salida ASCII Art.

           --style=ARCHIVO
              Usa   ARCHIVO   como  el  archivo  que contiene el estilo del documento. Usado para
              definir archivos CSS en documentos HTML/XHTML y ´´módulos´´ para LaTeX. Esta opción
              puede usarse múltiples veces para incluir múltiples archivos de estilo.

       -t, --target=TIPO
              Fija  el  formato  de  documento de salida al establecido en  TIPO. Los formatos de
              documento mas corrientes son:  html,  xhtml,   tex,   man,   txt.  Usar  la  opción
              --targets para ver los formatos disponibles.

           --targets
              Muestra los formatos disponibles para los archivos de salida y sale.

           --toc
              Incluye,  automaticamente,  una  Tabla de Contenidos (TOC) en el archivo de salida,
              entre el encabezado (HEADER) y el cuerpo del documento  (BODY).  El  usuario  puede
              especificar la posición de la TOC  usando el macro %%TOC.

           --toc-level=NUM
              Fija  el  nivel  máximo  de  la Tabla de Contenidos (TOC) al número especificado en
              NUM. Los niveles inferiores a  NUM no serán incluidos en la tabla de contenidos.

           --toc-only
              Muestra la Tabla de Contenidos (TOC) y sale.

       -v, --verbose
              Muestra los mensajes del sistema durante la conversión. Esta  opción  puede  usarse
              múltiples veces para incrementar el número de mensajes a mostrar.

       -V, --version
              Muestra la versión del programa y sale.

           --width=NUM
              Fija  al  número  especificado  en   NUM  la anchura de las columnas del archivo de
              salida. Esta opción se usa solo con archivos de salida en formato ASCII Art.

ARCHIVO FUENTE

       Los  archivos  fuente  suelen  identificarse  por  la  extensión   .t2t    (por   ejemplo,
       miarchivo.t2t). En un archivo fuente podemos considerar tres áreas:

       Encabezado (opcional)
              Las  tres  primeras  líneas  del  archivo. Si no se necesitara encabezado, dejar la
              primera línea en blanco. Esta área suele utilizarse para  emplazar  el  título  del
              documento y la información sobre el autor, la versión y la fecha.

       Ajustes (opcional)
              Comienzan  justo  después del Encabezado (4ª línea, o 2ª línea en el caso de omitir
              el encabezado) y finalizan al comienzo del área de Cuerpo del  Documento..   Usados
              para para implementar ajustes (configuraciones) en formato  %!keyword:value.

       Cuerpo del Documento
              Comienza  con  la  primera  línea de texto válido (que no sea comentario o ajustes)
              después del Encabezado y se extiende hasta el final del documeno. En esta  área  es
              en la que se encuentra el contenido del documento.

AJUSTES

       Los  Ajustes  nos  permiten  personalizar   txt2tags; son similares a las opciones. Pueden
       emplazarse: en el área de Ajustes del documento fuente, en el archivo  ~/.txt2tagsrc o  en
       un archivo externo que se invoca mediante la opción  --config-file.

       %!target
              Define  el  formato  del  archivo de salida, tal como lo haria la opción  --target.
              Ejemplo:
              %!target: html

       %!options(tipo)
              Define las opciones por defecto para cada tipo de archivo de salida.  Deben  usarse
              las opciones de línea de comandos (las que empiezan por  -- ). Ejemplo:
              %!options(html): --toc --toc-level 3 --css-sugar

       %!includeconf
              Incluye, en el archivo en uso, las configuraciones definidas en un archivo externo,
              tal como lo haria la opción  --config-file. Ejemplo:
              %!includeconf: miconfig.t2t

       %!style
              Utiliza un archivo de estilo externo en el documento en uso, tal como lo  haria  la
              opción  --style. Puede utilizarse múltiples veces. Ejemplo:
              %!style: colores.css

       %!encoding
              Define  la  codificación de caracteres que se utilizará en el documento convertido,
              tal como lo haria la opción  --encoding. Ejemplo :
              %!encoding: UTF-8

       %!preproc
              Filtro input de buscar/reemplazar utilizado para realizar cambios en el cuerpo  del
              documento  fuente  ANTES  de  que  txt2tags  realice  cualquier acción. La búsqueda
              utiliza expresiones regulares de Python. Ejemplo:
              %!preproc:  "JJS"  "John J. Smith"

       %!postproc
              Filtro output de buscar/reemplazar utilizado para realizar cambios en el  documento
              generado  DESPUÉS  del  completo  procesamiento del archivo fuente por txt2tags. La
              búsqueda utiliza expresiones regulares de Python. Ejemplo:
              %!postproc(html):  "<B>"  "<STRONG>"

       Si la misma palabra clave aparece mas de  una  vez,  la  última  encontrada  será  que  se
       utilizará  (excepciones: opciones, preproc y postproc, que son acumulativas). Las palabras
       clave inválidas serán ignoradas. El orden de procesamiento  es:   ~/.txt2tagsrc,  area  de
       Ajustes del documento fuente, opción  --config-file.

COMANDOS

       Los  Comandos  ejecutan  tareas  durante  el proceso de conversión. Deben emplazarse en el
       cuerpo del documento fuente.

       %!csv: archivo.csv
              Incorpora un archivo CSV como una tabla.

       %!include: archivo.t2t
              Incorpora al documento un archivo txt2tags.

       %!include: ``archivo.txt``
              Incorpora en el documento un archivo de texto (verbatim).

       %!include: ''archivo.html''
              Incorpora al documento un archivo etiquetado.

MACROS

       Mediante las Macros podremos insertar, de una forma  fácil,  contenidos  dinámicos  en  el
       documento  convertido. Deben definirse en el cuerpo del documento fuente. Con la excepción
       de  %%toc,  todos las macros pueden ser personalizadas con  directivas  especiales,  tales
       como  %Y  y  %f. Para mas detalles, consultar la  Guia del Usuario de txt2tags.

       %%date Inserta  la  fecha  actual.  Su  formato  por  defecto es:  %%date(%Y%m%d), que nos
              mostrará la fecha como: AAAAMMDD.

       %%infile
              Inserta la ruta del archivo fuente. Su formato por defecto es:  %%infile(%f).  Útil
              para enlaces del tipo:  [Ver fuente %%infile].

       %%mtime
              Inserta  la  fecha  de  modificación del archivo fuente. Su formato por defecto es:
              %%date(%Y%m%d), que nos mostrará la fecha como AAAAMMDD.

       %%outfile
              Inserta la ruta del archivo final. Su formato por defecto es:  %%outfile(%f).  Útil
              en menciones del tipo: "Este es el archivo manpage-es.man".

       %%toc  Con ella el usuario puede especificar la ubicación de la Tabla de Contenidos (TOC).
              Puede utilizarse repetidas veces.  Debe  utilizarse  conjuntamente  con  la  opción
              --toc.

EJEMPLOS

       txt2tags -t html archivo.t2t

              Convierte a HTML, guardando el resultado como archivo.html.

       txt2tags -t html -o - archivo.t2t

              Convierte a HTML, mostrando el resultado en STDOUT.

       txt2tags -t html --toc archivo.t2t

              Convierte a HTML, generando una Tabla de Contenidos (TOC) de forma automática.

       txt2tags -t html --toc --toc-level 2 -n archivo.t2t

              Convierte  a  HTML,  con  una  Tabla  de  Contenidos  (TOC) a dos niveles y títulos
              numerados.

       txt2tags --toc-only archivo.t2t

              Solo nos muestra la Tabla de Contenidos (TOC), sin realizar conversión alguna en el
              documento fuente.

       txt2tags -t html --css-sugar --style base.css --style ui.css archivo.t2t

              Convierte  a   HTML,  preparando  el  código  resultante  para  poder utilizar CSS,
              incluyendo también una llamada a dos archivos CSS externos (base.css y ui.css).

       txt2tags -t art --slides --width 80 --height 25 -o - archivo.t2t | more

              Crea una presentación de diapositivas tipo ASCII Art, apta para ser visionada en un
              terminal pantalla/ventana 80x25.

       (echo ; echo "**bold**") | txt2tags -t html -H -

              Práctica forma de realizar comprobaciones rápidas usando STDIN.

       txt2tags -t html -o - archivo.t2t | tidy > archivo.html

              Envia  el  resultado  a  STDOUT,  desde  donde se le redirige a un programa externo
              (tidy) antes de ser guardado.

ARCHIVOS

       ~/.txt2tagsrc
              Archivo de configuración del usuario, por defecto.

ENTORNO

       T2TCONFIG
              Si no es nulo, define el pathname completo para el  archivo  de  configuración  del
              usuario por defecto.

AUTOR

       Aurelio Jargas <verde@aurelio.net>

       Traducción al español realizada por Antoni Serra Devecchi <antoni.serra@gmail.com>

BUGS

       http://bugs.txt2tags.org

COPYRIGHT

       Copyright (C) 2001-2010 Aurelio Jargas, GNU GPL v2

                                            Aug, 2010                                 TXT2TAGS(1)