README 3.36 KB
Newer Older
1
2
                 Net::DBus
                 =========
Daniel P. Berrange's avatar
Daniel P. Berrange committed
3

Daniel P. Berrange's avatar
Daniel P. Berrange committed
4
Net::DBus provides a Perl XS API to the dbus inter-application
5
messaging system. The Perl API covers the core base level
6
of the dbus APIs, not concerning itself yet with the GLib
7
or QT wrappers. For more information on dbus visit the
8
project website at:
Daniel P. Berrange's avatar
Daniel P. Berrange committed
9

10
  http://www.freedesktop.org/software/dbus/
Daniel P. Berrange's avatar
Daniel P. Berrange committed
11

12
13
The homepage for Net::DBus is

14
  https://metacpan.org/pod/Net::DBus
15
16
17

Please report bugs at

18
  https://gitlab.com/berrange/perl-net-dbus/issues
19
20
21

The primary GIT repository for Net::DBus is

22
  https://gitlab.com/berrange/perl-net-dbus
23

24
This version operates against DBus 1.00, and later
Daniel P. Berrange's avatar
Daniel P. Berrange committed
25

Daniel P. Berrange's avatar
Daniel P. Berrange committed
26
INSTALLATION
27
------------
Daniel P. Berrange's avatar
Daniel P. Berrange committed
28
29
30
31
32
33

To install this module type the following:

   perl Makefile.PL
   make
   make test
34
35
   sudo make install

Daniel P. Berrange's avatar
Daniel P. Berrange committed
36
37
38
39
The makefile calls the C<pkg-config> script to determine the
correct flags to pass to the compiler & linkers when building
the XS part of the module. Thus, ensure pkg-config is in
a directory listed by the $PATH environment. 
40

Daniel P. Berrange's avatar
Daniel P. Berrange committed
41
42
43
44
45
46
47
48
49
The pkg-config program will likely find the DBus install in /usr
provided by the base OS distribution, so if testing against an 
alternate  install of DBus, set the C$PKG_CONFIG_PATH env 
variable before generating the Makefile. For example, if your 
dbus installation is in C<$HOME/usr/dbus-cvs-tip> , then to build
and install against this version of DBus do

   export PKG_CONFIG_PATH=$HOME/usr/dbus-cvs-tip/lib/pkg-config
   perl Makefile.PL PREFIX=$HOME/usr/dbus-cvs-tip
50
51
   make
   make test
Daniel P. Berrange's avatar
Daniel P. Berrange committed
52
53
   make install

54

Daniel P. Berrange's avatar
Daniel P. Berrange committed
55
DEPENDENCIES
56
------------
Daniel P. Berrange's avatar
Daniel P. Berrange committed
57

58
59
In keeping with the C API, the Perl DBus implementation
has minimal external dependancies:
Daniel P. Berrange's avatar
Daniel P. Berrange committed
60

61
  Time::HiRes
62
  XML::Twig
Daniel P. Berrange's avatar
Daniel P. Berrange committed
63
  XML::Parser
Daniel P. Berrange's avatar
Daniel P. Berrange committed
64

Daniel P. Berrange's avatar
Daniel P. Berrange committed
65
66
67
And to run the test suite:

  Test::More
68
69
  Test::Pod (optional, but recommended)
  Test::Pod::Coverage (optional, but recommended)
Daniel P. Berrange's avatar
Daniel P. Berrange committed
70
71
72
73
74

Although they are not part of the base Perl distribution, most 
OS distributor will already provide addon packages containing
these modules. Failing this, they are all available from CPAN
http://search.cpan.org/
75
76
77
78

EXAMPLES
--------

Daniel P. Berrange's avatar
Daniel P. Berrange committed
79
80
81
There are a number of example programs in the examples/
subdirectory demonstrating use of the high level application
developer APIs.
82

Daniel P. Berrange's avatar
Daniel P. Berrange committed
83
84
85
86
87
  example-service.pl         - Providing a simple service
  example-client.pl          - Talking to a remote service
  example-signal-emitter.pl  - How to broadcast signals
  example-signal-receiver.pl - How to receive signals
  dump-object.pl             - Dump info about dbus objects
Daniel P. Berrange's avatar
Daniel P. Berrange committed
88
  lshal.pl                   - Dump names of all HAL devices
Daniel P. Berrange's avatar
Daniel P. Berrange committed
89

90
91
92
93
CONTRIBUTIONS
-------------

Contributions both simple bug fixes & new features are
94
95
96
97
always welcome. Please send patches for bugs / features
to the DBus mailing list, or file a bug against Net::DBus
in the Perl bug tracker, or failing that send them directly
to the author
98
99

  Daniel Berrange <dan at berrange dot com>
100

101
102
103
104
105
The preferred format for patches is that produced by the
"git format-patch" command. Please use GIT if at all
possible to ensure correct author attribution of your
proposed change.

106
107
COPYRIGHT AND LICENCE
---------------------
Daniel P. Berrange's avatar
Daniel P. Berrange committed
108

109
Copyright (C) 2004-2015 Daniel Berrange
Daniel P. Berrange's avatar
Daniel P. Berrange committed
110

Daniel P. Berrangé's avatar
Daniel P. Berrangé committed
111
112
113
114
Net-DBus may be redistributed and/or modified under the terms of Perl itself.
Either:

a) the GNU General Public License as published by the Free
115
   Software Foundation; either version 2, or (at your option) any
Daniel P. Berrangé's avatar
Daniel P. Berrangé committed
116
117
118
119
120
121
122
   later version

or

b) the "Artistic License"


123
See the file "LICENSE" for the full text of each license
Daniel P. Berrange's avatar
Daniel P. Berrange committed
124

125
-- End
126