NAME

Filter::Heredoc::App - The module behind the filter-heredoc command

VERSION

Version 0.02

SYNOPSIS

    use 5.010;
    use Filter::Heredoc::App qw( run_filter_heredoc );
    run_filter_heredoc();
  

DESCRIPTION

This module implements the logic and functions to search and filter here documents in scripts. Support for shell script is more mature than other near compatible languages like Perl. Don't rely on current version code for Perl since it's still in an early development.

SUBROUTINES

Filter::Heredoc::App exports following subroutine only on request.

    run_filter_heredoc   # runs the filter-heredoc application code
        

run_filter_heredoc

    run_filter_heredoc();
    

This function is called by filter-heredoc and implements the logic and functions to search and filter here documents from the command line.

ERRORS

On user errors dies with exit(1). Exceptions for hd_getstate are trapped and after writing an error file, dies with exit code 2.

BUGS AND LIMITATIONS

Filter::Heredoc::App understands here documents syntax in *nix shells scripts. Running other script languages will result in an unpredictable output. This is not regarded as a bug.

Please report any bugs or feature requests to http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Filter-Heredoc or at <bug-filter-heredoc at rt.cpan.org>.

AUTHOR

Bertil Kronlund, <bkron at cpan.org>

SEE ALSO

Filter::Heredoc, filter-heredoc

LICENSE AND COPYRIGHT

Copyright 2011-12, Bertil Kronlund

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.