~ubuntu-branches/ubuntu/utopic/python-omniorb/utopic

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Bazaar Package Importer
  • Author(s): Floris Bruynooghe
  • Date: 2008-03-26 22:17:38 UTC
  • Revision ID: james.westby@ubuntu.com-20080326221738-r20t9hmikbvcg2vh
Tags: upstream-3.2
ImportĀ upstreamĀ versionĀ 3.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
omniORBpy 3
 
2
===========
 
3
 
 
4
This is omniORBpy 3.2.
 
5
 
 
6
omniORBpy is a robust high-performance CORBA ORB for Python.
 
7
 
 
8
The bindings adhere to the standard IDL to Python mapping which you
 
9
may find at
 
10
 
 
11
  http://www.omg.org/technology/documents/formal/python_language_mapping.htm
 
12
 
 
13
 
 
14
omniORBpy makes use of the C++ omniORB library. omniORBpy version 3.x
 
15
can only be used with omniORB 4.1.x.
 
16
 
 
17
omniORBpy is currently available for many Unix platforms and Windows.
 
18
It has been ported to a number of other operating systems by outside
 
19
contributors.
 
20
 
 
21
It is a good idea to subscribe to the omniORB mailing list. See
 
22
 
 
23
    http://omniorb.sourceforge.net/list.html
 
24
 
 
25
 
 
26
Please report any bugs you find to the mailing list.
 
27
 
 
28
 
 
29
Building
 
30
--------
 
31
 
 
32
If you are using a Unix platform, the Autoconf configure script will
 
33
probably work for you. Simply create a directory for the build and run
 
34
the configure script, followed by make:
 
35
 
 
36
  $ cd [omniORBpy directory]
 
37
  $ mkdir build
 
38
  $ cd build
 
39
  $ ../configure [configure options]
 
40
  $ make
 
41
  $ make install
 
42
 
 
43
Run configure --help to get a list of configuration options. Most
 
44
options are standard Autoconf ones. The most commonly required is
 
45
--prefix, used to select the install location. The default is
 
46
/usr/local. To change it, use, for example
 
47
 
 
48
  ../configure --prefix=/home/fred/omni_inst
 
49
 
 
50
If you use a different prefix to the omniORB install, you must give
 
51
the location to omniORB with the --with-omniorb= option.
 
52
 
 
53
The configure script tries to figure out the location of the C and C++
 
54
compilers and Python. It will always choose gcc over the platform's
 
55
native compiler if it is available. To change the choices it makes,
 
56
use variables CC, CXX and PYTHON, e.g.:
 
57
 
 
58
  ../configure CXX=/usr/bin/platform_c++ PYTHON=/usr/local/bin/python2.3
 
59
 
 
60
 
 
61
If you do not have Autoconf support on your platform (e.g. on
 
62
Windows), you must install the omniORBpy source in the $TOP/src/lib
 
63
directory of a working omniORB 4.1 tree. Make sure the directory is
 
64
called omniORBpy -- if you downloaded a release archive you must
 
65
rename the directory to remove the version from the directory name.
 
66
 
 
67
Once you have the source in the right place, simply do a make export
 
68
in the $TOP/src/lib/omniORBpy directory.
 
69
 
 
70
 
 
71
 
 
72
 
 
73
Using omniORBpy
 
74
---------------
 
75
 
 
76
To use omniORBpy, you need to add the directories containing omniORB
 
77
to your PYTHONPATH. With an Autoconf build, if you specified the same
 
78
installation prefix as was used for Python, you do not need to add
 
79
anything to PYTHONPATH; if you used a different installation prefix,
 
80
add this path:
 
81
 
 
82
  export PYTHONPATH=$PYTHONPATH:$PREFIX/lib/pythonX.Y/site-packages
 
83
 
 
84
replacing pythonX.Y with the version of Python you are using,
 
85
e.g. python2.4
 
86
 
 
87
With the non Autoconf build, you must add two directories to
 
88
PYTHONPATH:
 
89
 
 
90
  export PYTHONPATH=$PYTHONPATH:$TOP/lib/python:$TOP/lib/$FARCH
 
91
 
 
92
where $TOP is the root of your omniORB tree and $FARCH is the platform
 
93
name you selected in config.mk. Windows uses semicolons instead of
 
94
colons to separate path components:
 
95
 
 
96
  set PYTHONPATH=%PYTHONPATH%;%TOP%\lib\python;%TOP%\lib\x86_win32
 
97
 
 
98
 
 
99
You should also have the correct bin directory on your path so you can
 
100
run the IDL compiler, omniidl. With Autoconf builds, it is in
 
101
$PREFIX/bin ; otherwise it is in $TOP/bin/$FARCH.
 
102
 
 
103
 
 
104
Full documentation, in a variety of formats, can be found in the doc
 
105
directory.