NAME

X11::Muralis::Backend - display backend for X11::Muralis

VERSION

This describes version 0.10 of X11::Muralis::Backend.

SYNOPSIS

    muralis --use I<backend>

DESCRIPTION

This is the base class for backend modules for X11::Muralis. Generally speaking, the only methods that backends need to override are "new" and "display".

METHODS

new

There are two parameters that need to be set in "new";

prog

The name of the program which is used as the backend.

can_do

A hash containing the features that the backend provides.

name

The name of the backend; this is basically the last component of the module name. This works as either a class function or a method.

$name = $self->name();

$name = X11::Muralis::Backend::name($class);

active

Returns true if the backend program is available to run. This is checked by searching the PATH environment variable and checking for the existence of $self->{prog}

provides

Returns a hash of the features the backend has enabled.

display

Display the file, with the given options. THis must be overridden by the specific backend class.

REQUIRES

    File::Spec

INSTALLATION

To install this module, run the following commands:

    perl Build.PL
    ./Build
    ./Build test
    ./Build install

Or, if you're on a platform (like DOS or Windows) that doesn't like the "./" notation, you can do this:

   perl Build.PL
   perl Build
   perl Build test
   perl Build install

In order to install somewhere other than the default, such as in a directory under your home directory, like "/home/fred/perl" go

   perl Build.PL --install_base /home/fred/perl

as the first step instead.

This will install the files underneath /home/fred/perl.

You will then need to make sure that you alter the PERL5LIB variable to find the modules, and the PATH variable to find the script.

Therefore you will need to change: your path, to include /home/fred/perl/script (where the script will be)

        PATH=/home/fred/perl/script:${PATH}

the PERL5LIB variable to add /home/fred/perl/lib

        PERL5LIB=/home/fred/perl/lib:${PERL5LIB}

SEE ALSO

perl(1).

BUGS

Please report any bugs or feature requests to the author.

AUTHOR

    Kathryn Andersen RUBYKAT
    perlkat AT katspace DOT org
    www.katspace.org

COPYRIGHT AND LICENCE

Copyright (c) 2008 by Kathryn Andersen

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