summaryrefslogtreecommitdiff
path: root/debian/ivycpy.3
blob: 47650e26756aff1d0fef0c620148cd58bec79a59 (plain)
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
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH IVYCPY 3 "Sept, 2004" "ivycpy" "Python library for accessing Ivy Bus, v0.5"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
ivycpy \- a Python library for accessing Ivy Bus
.SH SYNOPSIS
.B # importing ivycpy 

.B from ivycpy import *

.B # tbc 

.SH DESCRIPTION
This manual page documents briefly the
.B ivycpy library.

This Python library (actually C wrapper around ivy-c library) allow
to use Ivy bus using Python. This library is a wrapper above ivyc library (>=3.3)
and procures functions to plug a Python application onto the Ivy Bus.

This version is strictly compatible with ivy-c [3.2 .. 3.6] and can be
dynamically linked to a new version of ivy-c, if ivy-c api is unchanged which is
quite unlikely.

This current source version allows to link ivycpy with an dedicated version of
[Python/Tkinter] . ivycpy requires to share some internal data with _tkinter.c
and thus a dedicated version of tkinter is required to make ivycpy working.

.PP
Ivycpy is developped using SWIG (Simplified Wrapper and Interface Generator),
see http://www.swig.org for further inforation on SWIG.

.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
.SH EXAMPLES
Some examples of Python scripts are provided in
/usr/share/doc/ivycpy(version)/examples directory .
.SH SEE ALSO
Documentation is available at :
/usr/share/doc/ivycpy(version)/
For further information about Ivy, visit the Ivy web site : 
http://www.tls.cena.fr/products/ivy/
.SH AUTHOR
This manual page was written by Didier Pavet <pavet@cena.fr>,
for the Debian GNU/Linux system.