/thirdparty/libportfwd/third-party/miniupnpc-1.6/README

 1Project: miniupnp
 2Project web page: http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org/
 3Author: Thomas Bernard
 4Copyright (c) 2005-2011 Thomas Bernard
 5This software is subject to the conditions detailed in the
 6LICENSE 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' on your system).
15Under win32, to compile with MinGW, type "mingw32make.bat".
16The compilation is known to work under linux, FreeBSD,
17OpenBSD, MacOS X, AmigaOS and cygwin.
18The official AmigaOS4.1 SDK was used for AmigaOS4 and GeekGadgets for AmigaOS3.
19upx (http://upx.sourceforge.net) is used to compress the win32 .exe files.
20
21To install the library and headers on the system use :
22> su
23> make install
24> exit
25
26alternatively, to install in a specific location, use :
27> INSTALLPREFIX=/usr/local make install
28
29upnpc.c is a sample client using the libminiupnpc.
30To use the libminiupnpc in your application, link it with
31libminiupnpc.a (or .so) and use the following functions found in miniupnpc.h,
32upnpcommands.h and miniwget.h :
33- upnpDiscover()
34- miniwget()
35- parserootdesc()
36- GetUPNPUrls()
37- UPNP_* (calling UPNP methods)
38
39Note : use #include <miniupnpc/miniupnpc.h> etc... for the includes
40and -lminiupnpc for the link
41
42Discovery process is speeded up when MiniSSDPd is running on the machine.
43
44* Python module *
45
46you can build a python module with 'make pythonmodule' 
47and install it with 'make installpythonmodule'.
48setup.py (and setupmingw32.py) are included in the distribution.
49
50
51Feel free to contact me if you have any problem :
52e-mail : miniupnp@free.fr
53
54If you are using libminiupnpc in your application, please
55send me an email !
56
57For any question, you can use the web forum :
58http://miniupnp.tuxfamily.org/forum/
59