Return to README CVS log

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

Annotation of embedaddon/miniupnpc/README, revision 1.1.1.2

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