README

   1 Grutatxt README
   2 ===============
   3
   4  Grutatxt - Text to HTML converter
   5  Copyright (C) 2000/2011 Angel Ortega <angel@triptico.com>
   6  Home Page: http://triptico.com/software/grutatxt.html
   7
   8 This software is GPL. NO WARRANTY. See file 'COPYING' for details.
   9
  10 Intro
  11 -----
  12
  13 Grutatxt is a plain text to HTML (and now other formats) converter. It
  14 succesfully converts subtle text markup to lists, bold, italics, tables
  15 and headings to their corresponding HTML, troff, man page or LaTeX markup
  16 without having to write unreadable source text files.
  17
  18 To install Grutatxt, do it just like you would do to any Perl module, so
  19
  20         $ perl Makefile.PL
  21         $ make
  22         $ su -c "make install"
  23
  24 This will install the perl module (`Grutatxt.pm') as well as the command
  25 line utility (`grutatxt').
  26
  27 Grutatxt includes several command-line arguments; see them using
  28
  29         $ grutatxt --help
  30
  31 The markup description document included with this package is in Grutatxt
  32 format, so it also serves as a demo. To see how this file will look after
  33 being converted by Grutatxt, you can just do
  34
  35         $ grutatxt < doc/grutatxt_markup.txt > output.html
  36
  37 or
  38
  39         $ grutatxt --mode=troff < doc/grutatxt_markup.txt | groff -t -me -Tps > output.ps
  40
  41 or
  42         $ grutatxt --mode=latex < doc/grutatxt_markup.txt > output.latex
  43
  44 ----
  45 Angel Ortega <angel@triptico.com>