home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 March / CMCD0304.ISO / Software / Freeware / Programare / nullsoft / nsis20.exe / Contrib / NSISdl / ReadMe.txt < prev    next >
Text File  |  2004-02-02  |  2KB  |  64 lines
  1. NSISdl 1.3 - HTTP downloading plugin for NSIS
  2. ---------------------------------------------
  3.  
  4. Copyright (C) 2001-2002 Yaroslav Faybishenko & Justin Frankel
  5.  
  6. This plugin can be used from NSIS to download files via http.
  7.  
  8. To connect to the internet, use the Dialer pluin.
  9.  
  10. USAGE
  11. -----
  12.  
  13. NSISdl::download http://www.domain.com/file localfile.exe
  14.  
  15. You can also pass /TIMEOUT to set the timeout in milliseconds:
  16.  
  17. NSISdl::download /TIMEOUT=30000 http://www.domain.com/file localfile.exe
  18.  
  19. The return value is pushed to the stack:
  20.  
  21.   "cancel" if cancelled
  22.   "success" if success
  23.   otherwise, an error string describing the error
  24.  
  25. If you don't want the progess window to appear use NSISdl::download_quiet.
  26.  
  27. Example of usage:
  28.  
  29. NSISdl::download http://www.domain.com/file localfile.exe
  30. Pop $R0 ;Get the return value
  31.   StrCmp $R0 "success" +3
  32.     MessageBox MB_OK "Download failed: $R0"
  33.     Quit
  34.  
  35. For another example, see waplugin.nsi in the examples directory.
  36.  
  37. PROXIES
  38. -------
  39.  
  40. NSISdl supports only basic configurations of proxies. It doesn't support
  41. proxies which require authentication, automatic configuration script, etc.
  42. NSISdl reads the proxy configuration from Internet Explorer's registry key
  43. under HKLM\Software\Microsoft\Windows\CurrentVersion\Internet Settings. It
  44. reads and parses ProxyEnable and ProxyServer.
  45.  
  46. TRANSLATE
  47. ---------
  48.  
  49. To translate NSISdl add the following values to the call line:
  50.  
  51. /TRANSLATE downloading connecting second minute hour plural progress remianing
  52.  
  53. Default values are:
  54.  
  55.   downloading - "Downloading %s"
  56.   connecting - "Connecting ..."
  57.   second - "second"
  58.   minute - "minute"
  59.   hour - "hour"
  60.   plural - "s"
  61.   progress - "%dkB (%d%%) of %dkB @ %d.%01dkB/s"
  62.   remaining -  "(%d %s%s remaining)"
  63.  
  64. /TRANSLATE must come before /TIMEOUT.