README
1Project: miniupnp
2Project web page: http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org/
3Author: Thomas Bernard
4Copyright (c) 2005-2008 Thomas Bernard
5This software is subject to the conditions detailed in the
6LICENCE file provided within this distribution.
7
8For the comfort of Win32 users, bsdqueue.h is included in the distribution.
9Its licence is included in the header of the file.
10bsdqueue.h is a copy of the sys/queue.h of an OpenBSD system.
11
12* miniupnp Client *
13
14To compile, simply run 'gmake' (could be 'make').
15Under win32, to compile with MinGW, type "mingw32make.bat".
16The compilation is known to work under linux, FreeBSD,
17OpenBSD, MacOS X and cygwin.
18To install the library and headers on the system use :
19> su
20> make install
21> exit
22
23alternatively, to install in a specific location, use :
24> INSTALLPREFIX=/usr/local make install
25
26upnpc.c is a sample client using the libminiupnpc.
27To use the libminiupnpc in your application, link it with
28libminiupnpc.a and use the following functions found in miniupnpc.h,
29upnpcommands.h and miniwget.h :
30- upnpDiscover()
31- miniwget()
32- parserootdesc()
33- GetUPNPUrls()
34- UPNP_* (calling UPNP methods)
35
36Note : use #include <miniupnpc/miniupnpc.h> etc... for the includes
37and -lminiupnpc for the link
38
39Discovery process is speeded up when MiniSSDPd is running on the machine.
40
41* Python module *
42
43you can build a python module with 'make pythonmodule'
44and install it with 'make installpythonmodule'.
45setup.py (and setupmingw32.py) are included in the distribution.
46
47
48Feel free to contact me if you have any problem :
49e-mail : miniupnp@free.fr
50
51If you are using libminiupnpc in your application, please
52send me an email !
53
54
55