summaryrefslogtreecommitdiff
path: root/Docs
diff options
context:
space:
mode:
authorDidier Raboud <odyx@debian.org>2018-03-31 20:38:07 +0200
committerDidier Raboud <odyx@debian.org>2018-03-31 20:38:07 +0200
commit18276390068d341f519528d38511ed79c4ef14ff (patch)
tree65cc1f530f5cb4570b5a5c2d4a8fe6d3bda441cf /Docs
parenta14ad06a0ed01c11bce2b341003cbec56d94b114 (diff)
Import Upstream version 2.10-1
Diffstat (limited to 'Docs')
-rwxr-xr-xDocs/src/attributes.but4
-rwxr-xr-xDocs/src/build.but2
-rwxr-xr-xDocs/src/compiler.but4
-rwxr-xr-xDocs/src/flowcontrol.but2
-rwxr-xr-xDocs/src/headers.but6
-rwxr-xr-xDocs/src/history.but52
-rwxr-xr-xDocs/src/langs.but20
-rwxr-xr-xDocs/src/pages.but26
-rwxr-xr-xDocs/src/sections.but2
-rwxr-xr-xDocs/src/silent.but2
-rwxr-xr-xDocs/src/tutorial.but2
-rwxr-xr-xDocs/src/ui.but6
-rwxr-xr-xDocs/src/var.but2
13 files changed, 99 insertions, 31 deletions
diff --git a/Docs/src/attributes.but b/Docs/src/attributes.but
index e2893af..743aad0 100755
--- a/Docs/src/attributes.but
+++ b/Docs/src/attributes.but
@@ -32,7 +32,7 @@ Sets whether or not the install window automatically closes when completed. This
\S2{abgfont} BGFont
-\c [font_face [height [wieght] [/ITALIC] [/UNDERLINE] [/STRIKE]]]
+\c [font_face [height [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]]]
Specifies the font used to show the text on the background gradient. To set the color use \R{abggradient}{BGGradient}. If no parameters are specified, the default font will be used. The default font is bold and italic Times New Roman.
@@ -64,7 +64,7 @@ Accepts variables. If variables are used, they must be initialized on \R{oninit}
\c dialog ui_file.exe
-Replaces dialog (\e{IDD_LICENSE}, \e{IDD_DIR}, \e{IDD_SELCOM}, \e{IDD_INST}, \e{IDD_INSTFILES}, \e{IDD_UNINST} or \e{IDD_VERIFY}) by a dialog with the same resource ID in ui_file.exe. You can also specify 'all' as the dialog if you wish to load replace all 7 of the dialogs at once from the same UI file. For some example UIs look at Contrib\\UIs under your NSIS directory.
+Replaces dialog (\e{IDD_LICENSE}, \e{IDD_DIR}, \e{IDD_SELCOM}, \e{IDD_INST}, \e{IDD_INSTFILES}, \e{IDD_UNINST} or \e{IDD_VERIFY}) by a dialog with the same resource ID in ui_file.exe. You can also specify 'all' as the dialog if you wish to replace all 7 of the dialogs at once from the same UI file. For some example UIs look at Contrib\\UIs under your NSIS directory.
\b \e{IDD_LICENSE} must contain \e{IDC_EDIT1} (RICHEDIT control).
diff --git a/Docs/src/build.but b/Docs/src/build.but
index bc8a590..2060332 100755
--- a/Docs/src/build.but
+++ b/Docs/src/build.but
@@ -6,7 +6,7 @@ NSIS version 2.07 introduced a new build system, based on \W{http://www.scons.or
Source code is available in \W{http://cvs.sourceforge.net/viewcvs.py/nsis}{CVS} and as a separate package with every \W{http://sourceforge.net/project/showfiles.php?group_id=22049}{NSIS distribution}.
-To build NSIS \W{http://www.python.org/}{Python} and \W{http://www.scons.org/}{SCons} must be installed. Currently, the supported version of SCons is version 0.96.90. Any version of Python above 1.5.2 is supported.
+To build NSIS \W{http://www.python.org/}{Python} and \W{http://www.scons.org/}{SCons} must be installed. Currently, the supported version of SCons is version 0.96.91. Any version of Python above 1.6 is supported.
To build, open a console, change the working directory to the root directory of NSIS and type \c{scons}. That's it. For example:
diff --git a/Docs/src/compiler.but b/Docs/src/compiler.but
index 59d4266..4f3a3ca 100755
--- a/Docs/src/compiler.but
+++ b/Docs/src/compiler.but
@@ -137,8 +137,8 @@ Time when the script started compiling according to the current locale.
Date & time of the last modification to the script file according to the current locale.
-\S0{compenvvarread} Read enviroment variables
+\S0{compenvvarread} Read environment variables
\S1{compenvvar} $%envVarName%
-$%envVarName% will be replaced on compile time by the enviroment variable envVarName.
+$%envVarName% will be replaced on compile time by the environment variable envVarName.
diff --git a/Docs/src/flowcontrol.but b/Docs/src/flowcontrol.but
index 73307c3..4dbd331 100755
--- a/Docs/src/flowcontrol.but
+++ b/Docs/src/flowcontrol.but
@@ -13,7 +13,7 @@ Cancels the install, stops execution of script, and displays user_message in the
\c function_name | :label_name | user_var(input)
-Calls the function named \e{function_name}, the label named \e{label_name}, or a variable that specifies an address. An address is returned by \R{getcurrentaddress}{GetCurrentAddress}, \R{getfunctionaddress}{GetFunctionAddress} or \R{getlabeladdress}{GetLabelAddress}. A call returns when it encouters a \R{return}{Return} instruction. Sections and functions are automatically ended with a \R{return}{Return} instruction. Uninstall functions cannot be called from installer functions and sections, and vice-versa.
+Calls the function named \e{function_name}, the label named \e{label_name}, or a variable that specifies an address. An address is returned by \R{getcurrentaddress}{GetCurrentAddress}, \R{getfunctionaddress}{GetFunctionAddress} or \R{getlabeladdress}{GetLabelAddress}. A call returns when it encounters a \R{return}{Return} instruction. Sections and functions are automatically ended with a \R{return}{Return} instruction. Uninstall functions cannot be called from installer functions and sections, and vice-versa.
\c Function func
\c Call :label
diff --git a/Docs/src/headers.but b/Docs/src/headers.but
index 09b56c0..18132dd 100755
--- a/Docs/src/headers.but
+++ b/Docs/src/headers.but
@@ -898,7 +898,7 @@ Call functions:
\S1{} RefreshShellIcons
-\b After changing file associations, you can call this function to refresh the shell immediatly.
+\b After changing file associations, you can call this function to refresh the shell immediately.
\\<b\\>Syntax:\\</b\\>
@@ -944,7 +944,7 @@ Call functions:
\S1{} LineFind
-\b Find specified lines in text file and edit or view this lines in callback function.
+\b Find specified lines in text file, and edit or view these lines in callback function.
\\<b\\>Syntax:\\</b\\>
@@ -1938,7 +1938,7 @@ Call functions:
\S1{} WordFind3X
-\b Find word, that contain string, between two delimiters.
+\b Find a word that contains a string, between two delimiters.
\\<b\\>Syntax:\\</b\\>
diff --git a/Docs/src/history.but b/Docs/src/history.but
index b8b112b..f02d42f 100755
--- a/Docs/src/history.but
+++ b/Docs/src/history.but
@@ -1,5 +1,57 @@
\A{history} Changelog and Release Notes
+\H{v2.10} 2.10
+
+Released on October 4th, 2005
+
+\S1{v2.10-cl} Changelog
+
+\S2{} Major Changes
+
+\b Added auto completion to the directory page
+
+\b Fixed a bug, introduced in 2.09, that caused \R{aallowrootdirinstall}{AllowRootDirInstall} to fail
+
+\b Fixed a thread leak in the POSIX implementation of LZMA
+
+\b \L{../Docs/VPatch/Readme.html}{VPatch 3.1}: MD5 checksums, better performance, and some bug fixes (including \W{http://sourceforge.net/tracker/index.php?func=detail&group_id=22049&atid=373085&aid=1219806}{bug #1219806})
+
+\S2{} Minor Changes
+
+\b Added rounding of required and available size on the directory page (1.59 => 1.6 instead of 1.5)
+
+\b Added WS_EX_LEFTSCROLLBAR style in RTL mode (\W{http://sourceforge.net/tracker/index.php?func=detail&group_id=22049&atid=373085&aid=1283528}{bug #1283528})
+
+\b Fixed alteration of the working directory by FileRequest in InstallOptions (\W{http://sourceforge.net/tracker/index.php?func=detail&group_id=22049&atid=373085&aid=1287731}{bug #1287731})
+
+\b Fixed bad mnemonic key in MakeNSISw menu (\W{http://sourceforge.net/tracker/index.php?func=detail&group_id=22049&atid=373085&aid=1288159}{bug #1288159})
+
+\b Minor documentation improvements and fixes
+
+\b \L{../Docs/Modern UI/Readme.html}{Modern UI 1.74}: Fixed compile error when checkboxes are used on multiple finish pages
+
+\S2{} Translations
+
+\b Fixed a bug in Slovenian translation that caused lots of missing language string warnings
+
+\b Fixed typos in Serbian translation
+
+\b Fixed typos in Thai translation
+
+\b Updated Simple Chinese translation
+
+\S2{} Build System
+
+\b Automatic fix for \W{http://forums.winamp.com/showthread.php?s=&threadid=179848}{VC6 SP6 compile error}
+
+\b Moved most of the configuration from config.h to the build system
+
+\b Removed all optimizations and symbol stripping in debug mode
+
+\b SCons requirement updated to 0.96.91
+
+\b VPatch can be built on POSIX as well
+
\H{v2.09} 2.09
Released on August 26th, 2005
diff --git a/Docs/src/langs.but b/Docs/src/langs.but
index a5b8313..5cb81f8 100755
--- a/Docs/src/langs.but
+++ b/Docs/src/langs.but
@@ -12,7 +12,7 @@ After you have inserted the language file $\{LANG_langfile\} will be defined as
\c name language_id string
-Defines a multilingual string. This means the its value will be different (or not, it's up to you) for every language. It allows you to easily make your installer multilingual without the need to add massive switches to the script.
+Defines a multilingual string. This means its value may be different (or not, it's up to you) for every language. It allows you to easily make your installer multilingual without the need to add massive switches to the script.
Each language string has a name that identifies it and a value for each language used by the installer. They can be used in any runtime string in the script. To use a language string all you need to add to the string is $(LangString_name_here) where you want the LangString to be inserted.
@@ -20,9 +20,9 @@ Each language string has a name that identifies it and a value for each language
\b Unlike defines that use curly braces - \{\}, language strings use parenthesis - ().
-\b If you change the langauge in the .onInit function, note that language strings in .onInit will still use the detected language based on the user's default Windows language, because the language is initialized after .onInit.
+\b If you change the language in the .onInit function, note that language strings in .onInit will still use the detected language based on the user's default Windows language, because the language is initialized after .onInit.
-\b Always set langauge strings for every language in your script.
+\b Always set language strings for every language in your script.
\b If you set the language ID to 0 the last used language by LangString or \R{loadlanguagefile}{LoadLanguageFile} will be used.
@@ -50,15 +50,15 @@ Does the same as \R{langstring}{LangString} only it loads the string from a text
As of version 2 NSIS fully supports multiple languages. The interface of one installer can support multiple languages.
-Use \R{loadlanguagefile}{LoadLanguageFile} for every langauge to load the default interface texts and language properties.
+Use \R{loadlanguagefile}{LoadLanguageFile} for every language to load the default interface texts and language properties.
The default interface texts can easily be changed using instructions like \R{acomponenttext}{ComponentText} etc.
-You can also use the contents of the standard language strings in your own strings (for example, $(^Name) contains the installer's name set using the \R{aname}{Name} instruction). The names of all standard langauges strings are listed as comments just above the strings in the language files. The language files are located in \L{../Contrib/Language files}{Contrib\\Language Files}.
+You can also use the contents of the standard language strings in your own strings (for example, $(^Name) contains the installer's name set using the \R{aname}{Name} instruction). The names of all standard language strings are listed as comments just above the strings in the language files. The language files are located in \L{../Contrib/Language files}{Contrib\\Language Files}.
-To create your own langauge strings, use \R{langstring}{LangString}.
+To create your own language strings, use \R{langstring}{LangString}.
-For an example of an installer with multiple langauges, see \L{../Examples/languages.nsi}{languages.nsi}.
+For an example of an installer with multiple languages, see \L{../Examples/languages.nsi}{languages.nsi}.
\S1{langselection} Language Selection
@@ -66,13 +66,13 @@ When the installer starts up it goes through these steps to select the interface
\n Get user's default Windows language
-\n Find a perfect match for the langauge
+\n Find a perfect match for the language
\n If there is no perfect match, find a primary language match
\n If there is no match, use the first language defined in the script (make sure your first language is a common one like English)
-\n If the langauge variable \R{varconstant}{$LANGUAGE} has changed during .onInit, NSIS goes through steps 2 to 4 again.
+\n If the language variable \R{varconstant}{$LANGUAGE} has changed during .onInit, NSIS goes through steps 2 to 4 again.
\S1{langdll} LangDLL Plug-in
@@ -82,4 +82,4 @@ For an example of usage see \L{../Examples/languages.nsi}{languages.nsi}.
\S1{rtl} RTL Languages
-RTL languages are languages that are written from the right to the left (like Arabic and Hebrew). NSIS fully supports RTL languages. In the language file there is a place to specify if the language is RTL or not. To find out on runtime if the the current langauge is RTL or not check the value of the $(^RTL) language string. It will be 1 if the language is RTL and 0 otherwise. This can be useful when using plug-ins that create dialogs, they usually have RTL settings too.
+RTL languages are languages that are written from right to left (e.g. Arabic and Hebrew). NSIS fully supports RTL languages. In the language file there is a place to specify if the language is RTL or not. To find out at runtime if the current language is RTL or not, check the value of the $(^RTL) language string. It will be 1 if the language is RTL and 0 otherwise. This can be useful when using plug-ins that create dialogs, they usually have RTL settings too.
diff --git a/Docs/src/pages.but b/Docs/src/pages.but
index 4fcb0e9..9235c72 100755
--- a/Docs/src/pages.but
+++ b/Docs/src/pages.but
@@ -65,7 +65,7 @@ To set the page caption use \R{acaption}{Caption}.
\S{pagecallbacks_explain} Callbacks
-Each built-in page has three callback functions. The pre-function, the show-creation function and the leave-function. The pre-function is called right before the page is created, the show-function is called right after it is created and before it is shown and the leave-function is called right after the user has pressed the next button and before the page is left.
+Each built-in page has three callback functions: the pre-function, the show-creation function and the leave-function. The pre-function is called right before the page is created, the show-function is called right after it is created and before it is shown and the leave-function is called right after the user has pressed the next button and before the page is left.
\b The pre-function allows you to skip the page using \R{abort}{Abort}.
@@ -107,20 +107,36 @@ Examples:
\S{page} Page
-\c custom [creator_function] [leave_function] [caption]
+\c custom [creator_function] [leave_function] [caption] [/ENABLECANCEL]
\c OR
-\c (license|components|directory|instfiles|uninstConfirm) [pre_function] [show_function] [leave_function]
+\c internal_page_type [pre_function] [show_function] [leave_function] [/ENABLECANCEL]
Adds an installer page. See the above sections for more information about built-in versus custom pages and about callback functions.
+\e{internal_page_type} can be:
+
+\b \e{license} - license page
+
+\b \e{components} - components selection page
+
+\b \e{directory} - installation directory selection page
+
+\b \e{instfiles} - installation page where the sections are executed
+
+\b \e{uninstConfirm} - uninstall confirmation page
+
+The last page of the installer has its cancel button disabled to prevent confusion. To enable it anyway, use \e{/ENABLECANCEL}.
+
\S{uninstpage} UninstPage
-\c custom [creator_function] [leave_function] [caption]
+\c custom [creator_function] [leave_function] [caption] [/ENABLECANCEL]
\c OR
-\c (license|components|directory|instfiles|uninstConfirm) [pre_function] [show_function] [leave_function]
+\c internal_page_type [pre_function] [show_function] [leave_function] [/ENABLECANCEL]
Adds an uninstaller page. See the above sections for more information about built-in versus custom pages and about callback functions.
+See \R{page}{Page} for possible values of \e{internal_page_type}.
+
\S{pageex} PageEx
\c [un.](custom|uninstConfirm|license|components|directory|instfiles)
diff --git a/Docs/src/sections.but b/Docs/src/sections.but
index 86efc32..34eb924 100755
--- a/Docs/src/sections.but
+++ b/Docs/src/sections.but
@@ -6,7 +6,7 @@ Each NSIS installer contains one or more sections. Each of these sections are cr
\b Sections are executed in order by the resulting installer, and if ComponentText is set, the user will have the option of disabling/enabling each visible section.
-\b If a section's name is 'Uninstall' or is prefixed with 'un.', then it is a an uninstaller section.
+\b If a section's name is 'Uninstall' or is prefixed with 'un.', it's an uninstaller section.
\S1{ssectioncommands} Section Commands
diff --git a/Docs/src/silent.but b/Docs/src/silent.but
index d24e36d..2056fbe 100755
--- a/Docs/src/silent.but
+++ b/Docs/src/silent.but
@@ -1,6 +1,6 @@
\S0{silent} Silent Installers/Uninstallers
-Silent installers are installers which require no user intervention and have no user interface. The user doesn't see any dialog and isn't ask any questions. This is useful for network administrators who wish to install or uninstall something without user intervention so they can preform the operation quickly over multiple number of computers. It is also useful for other developers who wish to embed another installer in their own and collect all of the required information on their installer instead of showing two installers.
+Silent installers are installers which require no user intervention and have no user interface. The user doesn't see any dialog and isn't asked any questions. This is useful for network administrators who wish to install or uninstall something without user intervention so they can perform the operation quickly over any number of computers. It is also useful for other developers who wish to embed another installer in their own and collect all of the required information on their installer instead of showing two installers.
NSIS installers and uninstallers can be both silent and not silent. When an installer or an uninstaller is silent, not all callback functions are called. \R{onguiinit}{.onGUIInit}, \R{onguiend}{.onGUIEnd}, their uninstaller equivalents and any callback related to a specific page or page type will not be called.
diff --git a/Docs/src/tutorial.but b/Docs/src/tutorial.but
index 0061f1f..98458a8 100755
--- a/Docs/src/tutorial.but
+++ b/Docs/src/tutorial.but
@@ -110,7 +110,7 @@ Declaring and using a user variable:
In addition there is a Stack, which can also be used for temporary storage. To access the stack use the commands \R{Push}{Push} and \R{Pop}{Pop}. Push adds a value to the stack, Pop removes one and sets the variable.
-For shared code, there are \R{varother}{20 registers avaibable} (like $0 and $R0). These static variables don't have to be declared and you won't get any name conflicts. If you want to use these variables in shared code, store the original values on the stack and restore the original values afterwards.
+For shared code, there are \R{varother}{20 registers available} (like $0 and $R0). These static variables don't have to be declared and you won't get any name conflicts. If you want to use these variables in shared code, store the original values on the stack and restore the original values afterwards.
After calling the function, the variables contain the same value as before. Note the order when using multiple variables (last-in first-out):
diff --git a/Docs/src/ui.but b/Docs/src/ui.but
index dc918a0..617cc99 100755
--- a/Docs/src/ui.but
+++ b/Docs/src/ui.but
@@ -4,7 +4,7 @@
Makes the installer window visible and brings it to the top of the window list. If an application was executed that shows itself in front of the installer, a BringToFront would bring the installer back in focus.
-Recent Windows versions restrict the setting of foreground windows. If the user is working with another application during installation, the user may be notifed using a different method.
+Recent Windows versions restrict the setting of foreground windows. If the user is working with another application during installation, the user may be notified using a different method.
\S2{createfont} CreateFont
@@ -75,7 +75,7 @@ If HWND is a window, Gotos jump_if_window, otherwise, Gotos jump_if_not_window (
\c on|off
-\e{LockWindow on} makes the main window not to redraw itself upon changes. When \e{LockWindow off} is used, all controls that weren't redrawn since \e{LockWindow on} will be redrawn. This makes the pages flickering look nicer because now it flickers a group of controls at the same time, instead of one control at a time. The individual control flickering is more noticiable on older computers.
+\e{LockWindow on} prevents the main window from redrawing itself upon changes. When \e{LockWindow off} is used, all controls that weren't redrawn since \e{LockWindow on} will be redrawn. This makes the pages flickering look nicer because now it flickers a group of controls at the same time, instead of one control at a time. The individual control flickering is more noticeable on old computers.
\S2{sendmessage} SendMessage
@@ -147,7 +147,7 @@ Sets the installer to silent mode or normal mode. See \R{asilentinstall}{SilentI
\c hwnd show_state
-Sets the visability of a window. Possible show_states are the same as \W{http://msdn.microsoft.com/library/en-us/winui/winui/windowsuserinterface/windowing/windows/windowreference/windowfunctions/showwindow.asp}{Windows ShowWindow} function. SW_* constants are defined in \L{../Include/WinMessages.nsh}{Include\\WinMessages.nsh}.
+Sets the visibility of a window. Possible show_states are the same as \W{http://msdn.microsoft.com/library/en-us/winui/winui/windowsuserinterface/windowing/windows/windowreference/windowfunctions/showwindow.asp}{Windows ShowWindow} function. SW_* constants are defined in \L{../Include/WinMessages.nsh}{Include\\WinMessages.nsh}.
\c !include WinMessages.nsh
\c GetDlgItem $0 $HWNDPARENT 1
diff --git a/Docs/src/var.but b/Docs/src/var.but
index dae8f1c..9c25c69 100755
--- a/Docs/src/var.but
+++ b/Docs/src/var.but
@@ -27,7 +27,7 @@ Declare a user variable. Allowed characters for variables names: [a-z][A-Z][0-9]
\e{$0, $1, $2, $3, $4, $5, $6, $7, $8, $9, $R0, $R1, $R2, $R3, $R4, $R5, $R6, $R7, $R8, $R9}
-Registers. These variables can be used just like user variables, but are usually used in shared functions or macro's. You don't have to declare these variables, so you won't get any name conflicts when using them in shared code. When using these variables in shared code, it's recommended that you use the stack to save and restore their original values. These variables can also be used for communication with plug-ins, because they can be read and written by the plug-in DLL's.
+Registers. These variables can be used just like user variables, but are usually used in shared functions or macros. You don't have to declare these variables, so you won't get any name conflicts when using them in shared code. When using these variables in shared code, it's recommended that you use the stack to save and restore their original values. These variables can also be used for communication with plug-ins, because they can be read and written by the plug-in DLLs.
\e{$INSTDIR}