Return to README CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / miniupnpc

miniupnpc

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