source: trunk/third-party/miniupnp/README

Last change on this file was 13331, checked in by jordan, 10 years ago

(trunk) upgrade miniupnpc to version 1.7. Should fix bug #4891

File size: 2.1 KB
Line 
1Project: miniupnp
2Project web page: http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org/
3github: https://github.com/miniupnp/miniupnp
4freecode: http://freecode.com/projects/miniupnp
5Author: Thomas Bernard
6Copyright (c) 2005-2012 Thomas Bernard
7This software is subject to the conditions detailed in the
8LICENSE file provided within this distribution.
9
10
11For the comfort of Win32 users, bsdqueue.h is included in the distribution.
12Its licence is included in the header of the file.
13bsdqueue.h is a copy of the sys/queue.h of an OpenBSD system.
14
15
16* miniUPnP Client - miniUPnPc *
17
18To compile, simply run 'gmake' (could be 'make' on your system).
19Under win32, to compile with MinGW, type "mingw32make.bat".
20MS Visual C solution and project files are supplied in the msvc/ subdirectory.
21
22The compilation is known to work under linux, FreeBSD,
23OpenBSD, MacOS X, AmigaOS and cygwin.
24The official AmigaOS4.1 SDK was used for AmigaOS4 and GeekGadgets for AmigaOS3.
25upx (http://upx.sourceforge.net) is used to compress the win32 .exe files.
26
27To install the library and headers on the system use :
28> su
29> make install
30> exit
31
32alternatively, to install into a specific location, use :
33> INSTALLPREFIX=/usr/local make install
34
35upnpc.c is a sample client using the libminiupnpc.
36To use the libminiupnpc in your application, link it with
37libminiupnpc.a (or .so) and use the following functions found in miniupnpc.h,
38upnpcommands.h and miniwget.h :
39- upnpDiscover()
40- miniwget()
41- parserootdesc()
42- GetUPNPUrls()
43- UPNP_* (calling UPNP methods)
44
45Note : use #include <miniupnpc/miniupnpc.h> etc... for the includes
46and -lminiupnpc for the link
47
48Discovery process is speeded up when MiniSSDPd is running on the machine.
49
50
51* Python module *
52
53you can build a python module with 'make pythonmodule'
54and install it with 'make installpythonmodule'.
55setup.py (and setupmingw32.py) are included in the distribution.
56
57
58Feel free to contact me if you have any problem :
59e-mail : miniupnp@free.fr
60
61If you are using libminiupnpc in your application, please
62send me an email !
63
64For any question, you can use the web forum :
65http://miniupnp.tuxfamily.org/forum/
66
Note: See TracBrowser for help on using the repository browser.