~ubuntu-branches/ubuntu/precise/libnet-vnc-perl/precise

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
NAME
    Net::VNC - A simple VNC client

SYNOPSIS
      use Net::VNC;

      my $vnc = Net::VNC->new({hostname => $hostname, password => $password});
      $vnc->login;

      print $vnc->name . ": " . $vnc->width . ' x ' . $vnc->height . "\n";

      my $image = $vnc->capture;
      $image->save("out.png");

DESCRIPTION
    Virtual Network Computing (VNC) is a desktop sharing system which uses
    the RFB (Remote FrameBuffer) protocol to remotely control another
    computer. This module acts as a VNC client and communicates to a VNC
    server using the RFB protocol, allowing you to capture the screen of the
    remote computer.

    This module dies upon connection errors (with a timeout of 15 seconds)
    and protocol errors.

METHODS
  new
    The constructor. Given a hostname and a password returns a Net::VNC
    object:

      my $vnc = Net::VNC->new({hostname => $hostname, password => $password});

  login
    Logs into the remote computer:

      $vnc->login;

  name
    Returns the name of the remote computer:

      print $vnc->name . ": " . $vnc->width . ' x ' . $vnc->height . "\n";

  width
    Returns the width of the remote screen:

      print $vnc->name . ": " . $vnc->width . ' x ' . $vnc->height . "\n";

  height
    Returns the height of the remote screen:

      print $vnc->name . ": " . $vnc->width . ' x ' . $vnc->height . "\n";

  capture
    Captures the screen of the remote computer, returning an Image::Imlib2
    object:

      my $image = $vnc->capture;
      $image->save("out.png");

AUTHOR
    Leon Brocard acme@astray.com

    Many thanks for Foxtons Ltd for giving me the opportunity to write this
    module.

COPYRIGHT
    Copyright (C) 2006, Leon Brocard

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