/ 
Meta-0.08
River stage zero No dependents
/ Meta::Tool::Groff

NAME

Meta::Tool::Groff - run groff for you.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

MANIFEST: Groff.pm
PROJECT: meta
VERSION: 0.07

SYNOPSIS

package foo;
use Meta::Tool::Groff qw();
my($object)=Meta::Tool::Groff->new();
my($result)=$object->method();

DESCRIPTION

This module eases the job of running groff for you.

FUNCTIONS

BEGIN()
process($$)
get_oneliner($)
TEST($)

FUNCTION DOCUMENTATION

BEGIN()

Bootstrap method for finding your groff executable.

process($$)

This method will run groff on a piece of data and will return the result. The other input is the device to render to.

get_oneliner($)

This method will get the one line description from the content of a manual page. If this method is unable to extract the one line description (problem with the content of the troff manual page) then it will return "undef".

TEST($)

Test suite for this module.

SUPER CLASSES

None.

BUGS

None.

AUTHOR

Name: Mark Veltzer
Email: mailto:veltzer@cpan.org
WWW: http://www.veltzer.org
CPAN id: VELTZER

HISTORY

0.00 MV import tests
0.01 MV dbman package creation
0.02 MV more thumbnail issues
0.03 MV website construction
0.04 MV web site automation
0.05 MV SEE ALSO section fix
0.06 MV download scripts
0.07 MV md5 issues

SEE ALSO

Compress::Zlib(3), Meta::Error::Simple(3), Meta::Utils::File::File(3), Meta::Utils::File::Patho(3), Meta::Utils::File::Remove(3), Meta::Utils::System(3), Meta::Utils::Utils(3), strict(3)

TODO

-is there a way (using a CPAN module?) to feed the string into Groff without writing it first into a file ?

-the oneliner method doesn't work right - get it to work right.

-grohtml (the underlying tool doing the html conversion) is leaving junk if it crashes. Take care of it.