source: trunk/third-party/miniupnp/README @ 10285

Last change on this file since 10285 was 10285, checked in by livings124, 12 years ago

update miniupnp to 1.4

File size: 1.7 KB
Line 
1Project: miniupnp
2Project web page: http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org/
3Author: Thomas Bernard
4Copyright (c) 2005-2009 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.
19
20To install the library and headers on the system use :
21> su
22> make install
23> exit
24
25alternatively, to install in a specific location, use :
26> INSTALLPREFIX=/usr/local make install
27
28upnpc.c is a sample client using the libminiupnpc.
29To use the libminiupnpc in your application, link it with
30libminiupnpc.a (or .so) and use the following functions found in miniupnpc.h,
31upnpcommands.h and miniwget.h :
32- upnpDiscover()
33- miniwget()
34- parserootdesc()
35- GetUPNPUrls()
36- UPNP_* (calling UPNP methods)
37
38Note : use #include <miniupnpc/miniupnpc.h> etc... for the includes
39and -lminiupnpc for the link
40
41Discovery process is speeded up when MiniSSDPd is running on the machine.
42
43* Python module *
44
45you can build a python module with 'make pythonmodule'
46and install it with 'make installpythonmodule'.
47setup.py (and setupmingw32.py) are included in the distribution.
48
49
50Feel free to contact me if you have any problem :
51e-mail : miniupnp@free.fr
52
53If you are using libminiupnpc in your application, please
54send me an email !
55
56
Note: See TracBrowser for help on using the repository browser.