NAME

RTF::VimColor - generate colorized RTF using Vim's syntax highlighting

VERSION

version 0.002

SYNOPSIS

Achtung! You probably want to just use the synrtf command included with this distribution. If not, though...

  my $rtf_textref = RTF::VimColor->new->rtf_for_file(
    $filename,
    { filetype => 'forth' },
  );

  print $$rtf_textref;

PERL VERSION

This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years.

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

METHODS

rtf_for_file

  my $rtf_textref = RTF::VimColor->new->rtf_for_file($filename, \%arg);

Given the name of a file, this method will return a reference to a string of RTF.

Valid arguments for %arg are:

  colorscheme - a path to a Vim colorscheme file (default is manxome.vim)
  filetype    - the Vim filetype to use for syntax highlighting (default: guess)
  font_face   - the font face to use; defaults to Courier New
  font_size   - the font size, in points, to use; defaults to 14
  default_bg  - default background color ("#ab01ef" or a name)
  default_fg  - default foreground color (same format)

AUTHOR

Ricardo Signes <cpan@semiotic.systems>

CONTRIBUTOR

Ricardo Signes <rjbs@semiotic.systems>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Ricardo Signes.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.