Evan Giles > X11-Terminal-0.4 > X11::Terminal

Download:
X11-Terminal-0.4.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.4   Source   Latest Release: X11-Terminal-v1.0.0

NAME ^

X11::Terminal - Create customised X11 termnal windows

SYNOPSIS ^

This module provides a baseclass for launching terminal windows on your desktop. You would normally instantiate subclass rather than using this class directly.

For example:

        use X11::Terminal::XTerm;
        
        # Create an xterm window, logged in to a remote server
        my $term = X11::Terminal::XTerm->new(host => "remotehost");
        $term->launch();

ATTRIBUTES ^

Each of the following attributes provide an accessor method, but they can also be set in the constructor.

The following attribues define the shell command to be run within the terminal window.

host

If set, the terminal window will ssh to that host. Otherwise, it will just run a bash shell.

xforward

If set, the ssh command will enable X11 forwarding. Requires "host".

agentforward

If set, the ssh command will enable agent forwarding. Requires "host".

The following attributes are implemented in the various subclasses and depending on the subclass involved they may have no effect. For example, a GnomeTerminal subclass can't set the font as gnome-terminals utilise a profile setting for that bahaviour.

profile
geometry
font
foreground
background
scrollback

OTHER METHODS ^

launch($debug);

Calculates (and returns) the command that will launch your terminal program. The exact content of the command will depend on which subclass is calling the command, and the attributes that have been specified.

It also runs that command in a child process - unless $debug is specified.

shellCommand();

Returns the shell command that should be run within the terminal window. There should be no need to call this method directly.

terminalName();

Returns the name of the program that will be run to provide the terminal window. There should be no need to call this method directly.

COPYRIGHT ^

Copyright 2010-2011 Evan Giles.

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

syntax highlighting: