README 1.9 KB

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