pebsconsulting / grutatxt Goto Github PK

Grutatxt README
===============

 Grutatxt - Text to HTML converter
 Copyright (C) 2000/2013 Angel Ortega <[email protected]>
 Home Page: http://triptico.com/software/grutatxt.html

This software is GPL. NO WARRANTY. See file 'COPYING' 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 <[email protected]>