updated readme

git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@2189 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
joostverburg 2003-02-19 21:46:08 +00:00
parent 8c0383dbbb
commit 52ba78180f
3 changed files with 51 additions and 35 deletions

View file

@ -4,17 +4,19 @@ DIALER PLUGIN
Written by Amir Szekely aka KiCHiK
Readme by Joost Verburg
The Dialer plugin for NSIS provides five functions related to internet connections.
To download files from the internet, use the NSISdl plugin.
USAGE
-----
The DialerDLL plugin for NSIS provides five functions related to internet connections.
Example of usage:
ClearErrors ;Clear the error flag
Dialer::FunctionName ;Call Dialer function
IfErrors "" +3 ;Check for errors
MessageBox "Function not available"
MessageBox MB_OK "Function not available"
Quit
Pop $R0 ;Get the return value from the stack
MessageBox MB_OK $R0 ;Display the return value

View file

@ -0,0 +1,18 @@
NSISdl 1.1 - HTTP downloading plugin for NSIS
Copyright (C) 2001-2002 Yaroslav Faybishenko & Justin Frankel
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.

View file

@ -1,50 +1,46 @@
NSIS-DL 1.1 - http downloading DLL for NSIS
Copyright (C) 2001-2002 Yaroslav Faybishenko & Justin Frankel
NSISdl 1.1 - HTTP downloading plugin for NSIS
---------------------------------------------
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Copyright (C) 2001-2002 Yaroslav Faybishenko & Justin Frankel
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
This plugin can be used from NSIS to download files via http.
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
To connect to the internet, use the Dialer pluin.
USAGE
-----
This dll can be used from NSIS to download files via http.
NSISdl::download http://www.domain.com/file localfile.exe
How to use (for another example, see waplugin.nsi in the nsis directory):
You can also pass /TIMEOUT to set the timeout in milliseconds:
You can also pass /TIMEOUT=### to set the timeout in milliseconds
Result is pushed to the stack
"cancel" if cancelled
"success" if success
otherwise, an error string describing the error
NSISdl::download /TIMEOUT=30000 http://www.domain.com/file localfile.exe
NSISdl::download http://www.nullsoft.com/free/nsis/nsis198.exe poo.exe
or
NSISdl::download /TIMEOUT=30000 http://www.nullsoft.com/free/nsis/nsis198.exe poo.exe
The return value is pushed to the stack:
"cancel" if cancelled
"success" if success
otherwise, an error string describing the error
then, pop a value from the stack and for errors:
Example of usage:
Pop $0
StrCmp $0 "success" yay
Abort "Error downloading file
yay:
NSISdl::download http://www.domain.com/file localfile.exe
Pop $R0 ;Get the return value
StrCmp $R0 "success" +3
MessageBox MB_OK "Download failed: $R0"
Quit
For another example, see waplugin.nsi in the nsis directory.
TRANSLATE
---------
To translate NSISdl add the following values to the call line:
To translate NSISdl add:
/TRANSLATE downloading connecting second minute hour plural progress remianing
to the call line.
Default values are:
downloading - "Downloading %s"
connecting - "Connecting ..."
second - "second"