summaryrefslogtreecommitdiff
path: root/Docs/src
diff options
context:
space:
mode:
authorDidier Raboud <odyx@debian.org>2018-03-31 20:38:06 +0200
committerDidier Raboud <odyx@debian.org>2018-03-31 20:38:06 +0200
commita14ad06a0ed01c11bce2b341003cbec56d94b114 (patch)
tree445c24f907309ee554d74c6547b99013be3c9958 /Docs/src
parent57ba1ad89a375b1a6748bf19df10cc12f6d4706a (diff)
Import Upstream version 2.09
Diffstat (limited to 'Docs/src')
-rwxr-xr-xDocs/src/compiler.but2
-rwxr-xr-xDocs/src/compilerflags.but2
-rwxr-xr-xDocs/src/credits.but2
-rwxr-xr-xDocs/src/history.but42
-rwxr-xr-xDocs/src/misc.but4
-rwxr-xr-xDocs/src/plugin.but14
-rwxr-xr-xDocs/src/script.but2
-rwxr-xr-xDocs/src/tutorial.but2
-rwxr-xr-xDocs/src/usefulfunc.but2
-rwxr-xr-xDocs/src/usefulinfos.but4
-rwxr-xr-xDocs/src/var.but9
11 files changed, 65 insertions, 20 deletions
diff --git a/Docs/src/compiler.but b/Docs/src/compiler.but
index 4ab1945..59d4266 100755
--- a/Docs/src/compiler.but
+++ b/Docs/src/compiler.but
@@ -28,7 +28,7 @@ Adds another include directory to the include directories list. This list is sea
\c directory
-Causes the NSIS compiler to scan the given directory for Plugin DLLs.
+Causes the NSIS compiler to scan the given directory for plug-in DLLs.
\c !addplugindir myplugin
\c MyPlugin::SomeFunction
diff --git a/Docs/src/compilerflags.but b/Docs/src/compilerflags.but
index 4407c2c..d74397c 100755
--- a/Docs/src/compilerflags.but
+++ b/Docs/src/compilerflags.but
@@ -72,7 +72,7 @@ This command sets the overwrite flag which is used by the File command to determ
\c \\<b\\>manual\\</b\\>|alwaysoff
-This command sets the unload plugin flag which is by CallInstDLL and plugin calls (dll::func). Setting this to always off will behave as if you have added the /NOUNLOAD to every CallInstDLL and plugin call. Setting this to manual will only not unload if you specifically use /NOUNLOAD.
+This command sets the unload plug-in flag which is by CallInstDLL and plug-in calls (dll::func). Setting this to always off will behave as if you have added the /NOUNLOAD to every CallInstDLL and plug-in call. Setting this to manual will only not unload if you specifically use /NOUNLOAD.
\S1{versioninfo} Version Information
diff --git a/Docs/src/credits.but b/Docs/src/credits.but
index 59ee5c6..44b5add 100755
--- a/Docs/src/credits.but
+++ b/Docs/src/credits.but
@@ -184,7 +184,7 @@ Spanish - \e{MoNKi, Lobo Lunar}
Swedish - \e{Peter Gustafsson, Magnus Bonnevier, Rickard Angbratt}
-Thai - \e{TuW@nNu (asdfuae)}
+Thai - \e{SoKoOLz, TuW@nNu (asdfuae)}
Traditional & Simplified Chinese - \e{Kii Ali}
diff --git a/Docs/src/history.but b/Docs/src/history.but
index b9add5e..b8b112b 100755
--- a/Docs/src/history.but
+++ b/Docs/src/history.but
@@ -1,5 +1,47 @@
\A{history} Changelog and Release Notes
+\H{v2.09} 2.09
+
+Released on August 26th, 2005
+
+\S1{v2.09-cl} Changelog
+
+\S2{} Major Changes
+
+\b Fixed a bug introduced in 2.08, that prevented uninstallers from deleting $INSTDIR
+
+\b Fixed a bug that caused "C:\\ " to be considered a valid installation directory, even without \R{aallowrootdirinstall}{AllowRootDirInstall}
+
+\S2{} New/Changed Commands
+
+\b \R{var}{Var} can now be used in sections and functions, but only with the /GLOBAL flag
+
+\S2{} Minor Changes
+
+\b Applied \W{http://sourceforge.net/tracker/index.php?func=detail&group_id=22049&atid=373087&aid=1248335}{patch #1248335} for greater portability of examples
+
+\b \R{filefunc}{FileFunc}: workaround for GetLongPathName which is not available on Windows 95 (Instructor)
+
+\b Fixed an unused label warning in \R{library}{Library}
+
+\b Fixed duplicate label errors in \L{../Examples/LogicLib.nsi}{LogicLib} and \R{library}{Library} when used in different files (\W{http://sourceforge.net/tracker/index.php?func=detail&group_id=22049&atid=373085&aid=1243865}{bug #1243865})
+
+\b \L{../Docs/Modern UI/Readme.html}{Modern UI 1.73}: fixed checkboxes on uninstaller finish page or multiple finish pages
+
+\b \R{wordfunc}{WordFunc}: fixed incorrect replacement of first word in WordReplace, under some conditions (Instructor)
+
+\S2{} Translations
+
+\b Renamed Malaysian to Malay
+
+\b Update Thai translation to the latest version
+
+\b Updated Kurdish MUI translation to the latest version
+
+\S2{} Build System
+
+\b Fixed a number of build problems on POSIX platforms which caused plug-ins to malfunction and installers to crash
+
\H{v2.08} 2.08
Released on July 23rd, 2005
diff --git a/Docs/src/misc.but b/Docs/src/misc.but
index 386d020..787b35b 100755
--- a/Docs/src/misc.but
+++ b/Docs/src/misc.but
@@ -47,7 +47,7 @@ Use in the leave function of a directory page. Reads the flag set if '\R{adirver
\S2{initpluginsdir} InitPluginsDir
-Initializes the plugins dir (\R{varconstant}{$PLUGINSDIR}) if not already initialized.
+Initializes the plug-ins dir (\R{varconstant}{$PLUGINSDIR}) if not already initialized.
\c InitPluginsDir
\c File /oname=$PLUGINSDIR\image.bmp image.bmp
@@ -65,7 +65,7 @@ Sets the error level of the installer or uninstaller to \e{error_level}. See \R{
\c \\<b\\>current\\</b\\>|all
-Sets the context of $SMPROGRAMS and other shell folders. If set to 'current' (the default), the current user's shell folders are used. If set to 'all', the 'all users' shell folder is used. The all users folder may not be supported on all OSes. If the all users folder is not found, the current user folder will be used. Please take into consideration that a "normal user" has no rights to write in the all users area. Only admins have full access rights to the all users area. You can check this by using the UserInfo Plugin. See Contrib\\UserInfo\\UserInfo.nsi for an example.
+Sets the context of $SMPROGRAMS and other shell folders. If set to 'current' (the default), the current user's shell folders are used. If set to 'all', the 'all users' shell folder is used. The all users folder may not be supported on all OSes. If the all users folder is not found, the current user folder will be used. Please take into consideration that a "normal user" has no rights to write in the all users area. Only admins have full access rights to the all users area. You can check this by using the UserInfo plug-in. See Contrib\\UserInfo\\UserInfo.nsi for an example.
\c SetShellVarContext current
\c StrCpy $0 $DESKTOP
diff --git a/Docs/src/plugin.but b/Docs/src/plugin.but
index 3b6271a..80c7e48 100755
--- a/Docs/src/plugin.but
+++ b/Docs/src/plugin.but
@@ -1,26 +1,26 @@
-\S0{plugindlls} Plugin DLLs
+\S0{plugindlls} Plug-in DLLs
The abilities of the NSIS scripting language can be extended by utilising functionality provided in a DLL file. Probably the best known example of this is the InstallOptions.dll bundled with every NSIS release.
-When the NSIS compiler starts it scans the plugins directory for DLLs and makes a list of the plugins found and their exported functions. During compilation if a sequence such as fred::flintstone is encountered where the compiler expected to find a language keyword the compiler will look through this list. If a list entry specifies that fred.dll exports function flintstone NSIS will pack the fred.dll file into the created installer binary.
+When the NSIS compiler starts it scans the plug-ins directory for DLLs and makes a list of the plug-ins found and their exported functions. During compilation if a sequence such as fred::flintstone is encountered where the compiler expected to find a language keyword the compiler will look through this list. If a list entry specifies that fred.dll exports function flintstone NSIS will pack the fred.dll file into the created installer binary.
-During execution of a plugin command NSIS will unpack the necessary DLL to a temporary folder ($PLUGINSDIR), push all of the arguments specified (right-to-left order), and then execute the DLL function. If the /NOUNLOAD option is specified the DLL will not be unloaded until the installer exits or the next time you use the DLL without /NOUNLOAD. Please note that the last call to the plugin must not have the /NOUNLOAD flag or the plugin will not be deleted from $PLUGINSDIR, thus garbage will be left on the user's machine.
+During execution of a plug-in command NSIS will unpack the necessary DLL to a temporary folder ($PLUGINSDIR), push all of the arguments specified (right-to-left order), and then execute the DLL function. If the /NOUNLOAD option is specified the DLL will not be unloaded until the installer exits or the next time you use the DLL without /NOUNLOAD. Please note that the last call to the plug-in must not have the /NOUNLOAD flag or the plug-in will not be deleted from $PLUGINSDIR, thus garbage will be left on the user's machine.
-\S1{usingplug} Using Plugin Commands
+\S1{usingplug} Using Plug-in Commands
A plug-in call looks like this:
\c InstallOptions::dialog "ini_file_location.ini"
-All parameters are pushed onto the stack (in this case, the plug-in function only needs one parameter). Some plugin commands may not need any parameters on the stack, others might require more of them. To use a plug-in command you will need to read the documentation for the plug-in so that you know what parameters its functions require.
+All parameters are pushed onto the stack (in this case, the plug-in function only needs one parameter). Some plug-in commands may not need any parameters on the stack, others might require more of them. To use a plug-in command you will need to read the documentation for the plug-in so that you know what parameters its functions require.
-\S1{disablingplug} Disabling Plugin Unloading
+\S1{disablingplug} Disabling Plug-in Unloading
If you don't want to unload the DLL after calling a function, use /NOUNLOAD as the first parameter. For example:
\c dll::function /NOUNLOAD "param"
-You can also use \R{setpluginunload}{SetPluginUnload} alwaysoff to avoid writing /NOUNLOAD each and every time you use the same plugin.
+You can also use \R{setpluginunload}{SetPluginUnload} alwaysoff to avoid writing /NOUNLOAD each and every time you use the same plug-in.
\S1{calldiskplug} Calling plug-ins manually
diff --git a/Docs/src/script.but b/Docs/src/script.but
index 7adf43e..1e9d304 100755
--- a/Docs/src/script.but
+++ b/Docs/src/script.but
@@ -28,7 +28,7 @@ If you want a parameter to start with ; or # put it in quotes.
\\<b\\>Plug-ins\\</b\\>
-To call a plugin, use 'plugin::command [parameters]'. For more info see \R{plugindlls}{Plugin DLLs}.
+To call a plug-in, use 'plugin::command [parameters]'. For more info see \R{plugindlls}{Plug-in DLLs}.
\c nsExec::Exec "myfile"
diff --git a/Docs/src/tutorial.but b/Docs/src/tutorial.but
index bc157a6..0061f1f 100755
--- a/Docs/src/tutorial.but
+++ b/Docs/src/tutorial.but
@@ -128,7 +128,7 @@ After calling the function, the variables contain the same value as before. Note
\S2{tutdebug} Debugging Scripts
-The more you work with NSIS the more complex the scripts will become. This will increase the potential of mistakes, especially when dealing with lots of variables. There are a few possibilities to help you debugging the code. To display the contents of variables you should use \R{messagebox}{MessageBoxes} or \R{detailprint}{DetailPrint}. To get a brief overview about all variables you should use the plugin \W{http://nsis.sourceforge.net/wiki/DumpState}{DumpState}. By default all actions of the Installer are printed out in the Log Window. You can access the log if you right-click in the Log Window and select "Copy Details To Clipboard". There is also a way to write it directly to a file, see \R{dumplogtofile}{here}.
+The more you work with NSIS the more complex the scripts will become. This will increase the potential of mistakes, especially when dealing with lots of variables. There are a few possibilities to help you debugging the code. To display the contents of variables you should use \R{messagebox}{MessageBoxes} or \R{detailprint}{DetailPrint}. To get a brief overview about all variables you should use the plug-in \W{http://nsis.sourceforge.net/wiki/DumpState}{DumpState}. By default all actions of the Installer are printed out in the Log Window. You can access the log if you right-click in the Log Window and select "Copy Details To Clipboard". There is also a way to write it directly to a file, see \R{dumplogtofile}{here}.
\S1{compilercommands} Compiler Commands
diff --git a/Docs/src/usefulfunc.but b/Docs/src/usefulfunc.but
index b74443d..617e986 100755
--- a/Docs/src/usefulfunc.but
+++ b/Docs/src/usefulfunc.but
@@ -389,7 +389,7 @@
\H{connectinternet} Connect to the Internet
-\c ; ConnectInternet (uses Dialer plugin)
+\c ; ConnectInternet (uses Dialer plug-in)
\c ; Written by Joost Verburg
\c ;
\c ; This function attempts to make a connection to the internet if there is no
diff --git a/Docs/src/usefulinfos.but b/Docs/src/usefulinfos.but
index 027600a..92c8e93 100755
--- a/Docs/src/usefulinfos.but
+++ b/Docs/src/usefulinfos.but
@@ -68,7 +68,7 @@ Some of the following values will not be used by older Windows versions.
If both NoModify and NoRepair are set to 1, the button displays "Remove" instead of "Modify/Remove".
-\H{useful_system_plugin} Calling an external DLL using the System.dll plugin
+\H{useful_system_plugin} Calling an external DLL using the System.dll plug-in
Some install processes are required to call functions contained inside third party DLLs. A prime example of this is when installing a Palm(TM) conduit.
@@ -183,7 +183,7 @@ Save this script
\c DetailPrint "Path length: $1"
\c DetailPrint "Return value: $2"
\c
-\c ; last plugin call must not have /NOUNLOAD so NSIS will be able to delete
+\c ; last plug-in call must not have /NOUNLOAD so NSIS will be able to delete
\c ; the temporary DLL
\c
\c SetPluginUnload manual
diff --git a/Docs/src/var.but b/Docs/src/var.but
index 3d54fa1..dae8f1c 100755
--- a/Docs/src/var.but
+++ b/Docs/src/var.but
@@ -10,14 +10,17 @@ User variables can be declared with the \R{var}{Var} command. You can use these
\S2{var} Var
-\c var_name
+\c [/GLOBAL] var_name
-Declare a user variable. Allowed characters for variables names: [a-z][A-Z][0-9] and '_'. Variables cannot be declared in sections or functions.
+Declare a user variable. Allowed characters for variables names: [a-z][A-Z][0-9] and '_'. All defined variables are global, even if defined in a section or a function. To make this clear, variables defined in a section or a function must use the /GLOBAL flag. The /GLOBAL flag is not required outside of sections and functions.
\c Var example
\c
\c Function testVar
+\c Var /GLOBAL example2
+\c
\c StrCpy $example "example value"
+\c StrCpy $example2 "another example value"
\c FunctionEnd
\S1{varother} Other Writable Variables
@@ -228,7 +231,7 @@ The decimal HWND of the parent window.
\e{$PLUGINSDIR}
-The path to a temporary folder created upon the first usage of a plugin or a call to \R{initpluginsdir}{InitPluginsDir}. This folder is automatically deleted when the installer exits. This makes this folder the ideal folder to hold INI files for \L{../Docs/InstallOptions/Readme.html}{InstallOptions}, bitmaps for the splash plugin, or any other file that a plugin needs to work.
+The path to a temporary folder created upon the first usage of a plug-in or a call to \R{initpluginsdir}{InitPluginsDir}. This folder is automatically deleted when the installer exits. This makes this folder the ideal folder to hold INI files for \L{../Docs/InstallOptions/Readme.html}{InstallOptions}, bitmaps for the splash plug-in, or any other file that a plug-in needs to work.
\S1{varstrings} Constants Used in Strings