Grutatxt  2.20
About: Grutatxt is a plain text to HTML converter (handles headings, lists, tables, ...).
  Fossies Dox: Grutatxt-2.20.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

Grutatxt Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies Grutatxt-2.20.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README
Grutatxt README
===============

 Grutatxt - Text to HTML converter
 Angel Ortega <angel@triptico.com>
 Home Page: http://triptico.com/software/grutatxt.html

This software is released into the public domain. See file LICENSE for details.

Intro
-----

Grutatxt is a plain text to HTML (and now other formats) converter. It
succesfully converts subtle text markup to lists, bold, italics, tables
and headings to their corresponding HTML, troff, man page or LaTeX markup
without having to write unreadable source text files.

To install Grutatxt, do it just like you would do to any Perl module, so

    $ perl Makefile.PL
    $ make
    $ su -c "make install"

This will install the perl module (`Grutatxt.pm') as well as the command
line utility (`grutatxt').

Grutatxt includes several command-line arguments; see them using

    $ grutatxt --help

The markup description document included with this package is in Grutatxt
format, so it also serves as a demo. To see how this file will look after
being converted by Grutatxt, you can just do

    $ grutatxt < doc/grutatxt_markup.txt > output.html

or

    $ grutatxt --mode=troff < doc/grutatxt_markup.txt | groff -t -me -Tps > output.ps

or
    $ grutatxt --mode=latex < doc/grutatxt_markup.txt > output.latex

----
Angel Ortega <angel@triptico.com>