Typos and spelling mistakes etc.

git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@2992 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
eccles 2003-10-05 11:00:47 +00:00
parent 47bc1eb92d
commit 3e659f4568
12 changed files with 40 additions and 34 deletions

View file

@ -10,7 +10,7 @@ The commands below all adjust attributes of the installer. These attributes cont
\c (left|right|top|bottom) (width|height) [padding]
Adds a branding image on the top, bottom, left, or right of the installer. Its size will be set according to the width/height specified, the installer width/height and the installer font. The final size will not always be the same as the what you have requsted. Have a look at the output of the command for the final size. Because this depends on the installer font, you should use SetFont before AddBrandingImage. The default padding value is 2.
Adds a branding image on the top, bottom, left, or right of the installer. Its size will be set according to the width/height specified, the installer width/height and the installer font. The final size will not always be what you requested; have a look at the output of the command for the actual size. Because this depends on the installer font, you should use SetFont before AddBrandingImage. The default padding value is 2.
\S2{aallowrootdirinstall} AllowRootDirInstall

View file

@ -1,5 +1,11 @@
bin\halibut.exe config.but intro.but tutorial.but usage.but script.but var.but labels.but jumps.but pages.but sections.but usection.but functions.but callback.but attributes.but compilerflags.but basic.but registry.but generalpurpose.but flowcontrol.but file.but uninstall.but misc.but string.but stack.but int.but reboot.but log.but sec.but ui.but langs.but plugin.but compiler.but defines.but modernui.but usefulfunc.but usefulinfos.but history.but credits.but license.but
@copy Contents.html index.html
@copy index.html IndexPage.html
@copy *.html ..
@del *.html
@echo off
copy Contents.html index.html > nul
copy index.html IndexPage.html > nul
if "x%OS%x" == "xWindows_NTx" goto nt
copy *.html .. > nul
goto done
:nt
for %%A in (*.html) do (fc "%%A" "..\%%~nxA" || copy "%%A" ..) > nul
:done
del *.html > nul

View file

@ -71,7 +71,7 @@ Assign to the user variable $x, the full path of the file specified. If the path
\c user_var(output) base_dir
Assign to the user variable $x, the name of a temporary file. The file will have been created, so you can then overwrite it with what you please. The name of the temporary file is guaranteed to be unique. If to want the temporary file to be created in another directory than the Windows temp direcory, specify a base_dir. Delete the file when done with it.
Assign to the user variable $x, the name of a temporary file. The file will have been created, so you can then overwrite it with what you please. The name of the temporary file is guaranteed to be unique. If to want the temporary file to be created in another directory than the Windows temp directory, specify a base_dir. Delete the file when done with it.
\S2{searchpath} SearchPath
@ -111,4 +111,4 @@ Loads the specified DLL and calls DllRegisterServer (or entrypoint_name if speci
\c dllfile
Loads the specified DLL and calls DllUnregisterServer. The error flag is set if an error occurs (i.e. it can't load the DLL, initialize OLE, find the entry point, or the function returned anything other than ERROR_SUCCESS (=0)).
Loads the specified DLL and calls DllUnregisterServer. The error flag is set if an error occurs (i.e. it can't load the DLL, initialize OLE, find the entry point, or the function returned anything other than ERROR_SUCCESS (=0)).

View file

@ -69,7 +69,7 @@
\b \R{ainsttype}{InstType} /NOCUSTOM and /COMPONENTSONLYONCUSTOM work together
\b Improved \R{aaddbrandingimage}{AddBrandingImage}: Doesn't depend on the UI, can set image on the bottom and on the right, support for custom padding value
\b Improved \R{aaddbrandingimage}{AddBrandingImage}: Doesn't depend on the UI, can set image on the bottom and on the right, support for custom padding value
\b Added base_dir for \R{gettempfilename}{GetTempFileName}
@ -85,7 +85,7 @@
\\<b\\>Notes:\\</b\\>
\W{../Contrib/Modern UI/Readme.html}{Modern UI 1.66}: Because of the new syntax for pages, settings etc., changed names names of settings and variable names, you have to make some changes to your scripts, see the \W{../Contrib/Modern UI/Readme.html}{Modern UI Readme} for details. \\<br\\>
\W{../Contrib/Modern UI/Readme.html}{Modern UI 1.66}: Because of the new syntax for pages, settings etc., changed names of settings and variable names, you have to make some changes to your scripts, see the \W{../Contrib/Modern UI/Readme.html}{Modern UI Readme} for details. \\<br\\>
\R{page}{Custom Pages} now have a leave function. As this parameter is placed before the caption you have to add another "" empty string for the title to work. \\<br\\>
\R{onselchange}{.onSelChange} is no longer called when the components page is created
@ -100,7 +100,7 @@
\b Added SectionSetInstTypes and SectionGetInstTypes
\b Reboot commmand does not force a reboot anymore (allows the user to save work)
\b Reboot command does not force a reboot anymore (allows the user to save work)
\b !if[n]def/!else fixes
@ -338,7 +338,7 @@
\b Fixed a bug that caused RTF not to show on Windows 9x
\b Added a dialog that shows up if compress whole is used and initial uncompressing lasts longer than a second
\b Added a dialog that shows up if compress whole is used and initial decompressing lasts longer than a second
\b Updated to InstallOptions 1.3
@ -469,7 +469,7 @@
\b Added expand node option to Section and SubSection
\b Added preserv file attribute option to File command
\b Added preserve file attribute option to File command
\b Copy-All bug fix in Makensisw
@ -492,4 +492,4 @@
\b Made config.h have hacks for easier building for me. :)
\e{For the NSIS 1.x version history, see \W{http://www.nullsoft.com/free/nsis/version-history.html}{http://www.nullsoft.com/free/nsis/version-history.html}}
\e{For the NSIS 1.x version history, see \W{http://www.nullsoft.com/free/nsis/version-history.html}{http://www.nullsoft.com/free/nsis/version-history.html}}

View file

@ -12,7 +12,7 @@ For ease of use LoadLanguageFile defines $\{LANG_language_file\} as the language
\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 swithces to the script.
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.
Each LangString has a name that identifies it and a value for each language used by the installer. To use a LangString you must know its name. LangStrings can be used in any runtime string in the script. To use a LangString all you need to add to the string is $(LangString_name_here) where you want the LangString to be inserted.
@ -59,7 +59,7 @@ When the installer starts up it goes through these steps to select the interface
\n If there is no perfect match, find a primary language match
\n If there is no no match, use the first language defined in the script
\n If there is no match, use the first language defined in the script
\n If \R{varconstant}{$LANGUAGE} has changed during .onInit, go through steps 2 to 4 again
@ -71,4 +71,4 @@ For an example of usage see \W{../Examples/languages.nsi}{languages.nsi}.
\S1{rtl} RTL Languages
RTL languages are languages that are written from right to left. NSIS fully supports RTL languages. In the language file there is a place to specify if the language is RTL or not. If it is, NSIS will create another set of dialogs for the language that will be RTL. To find out on runtime if the language you're currently using is RTL or not check the value of the $(^RTL) language string. It will be 1 if the language is RTL and 0 otherwise.
RTL languages are languages that are written from right to left. NSIS fully supports RTL languages. In the language file there is a place to specify if the language is RTL or not. If it is, NSIS will create another set of dialogs for the language that will be RTL. To find out on runtime if the language you're currently using is RTL or not check the value of the $(^RTL) language string. It will be 1 if the language is RTL and 0 otherwise.

View file

@ -15,7 +15,7 @@ The page order is set simply by the order \R{page}{Page}, \R{uninstpage}{UninstP
\c Page directory
\c Page instfiles
\c UninstPage uninstConfirm
\c UninstPage isntfiles
\c UninstPage instfiles
This code will tell NSIS to first show the license page, then the components selection page, then the directory selection page and finally the install log where sections are executed, just like in old installers. The uninstaller will first show the uninstall confirmation page and then the uninstallation log.
@ -129,7 +129,7 @@ Example usage:
\c LicenseText "Readme"
\c LicenseData readme.rtf
\c PageExEnd
\c
\c
\c PageEx license
\c LicenseData license.txt
\c LicenseForceSelection checkbox
@ -143,4 +143,4 @@ Ends a PageEx block.
\c ([creator_function] [leave_function]) | ([pre_function] [show_function] [leave_function])
Sets the callback functions for a page defined using \R{pageex}{PageEx}. Can only be used inside a \R{pageex}{PageEx} block. See the above sections for more information about callback functions.
Sets the callback functions for a page defined using \R{pageex}{PageEx}. Can only be used inside a \R{pageex}{PageEx} block. See the above sections for more information about callback functions.

View file

@ -1,6 +1,6 @@
\S1{registry} Registry, INI, File Instructions
In all of the below registry instructions use an empty string (just two quotes with nothing between them - "") as the kye name to specify the default key which is shown as (Default) in regedit.exe.
In all of the below registry instructions use an empty string (just two quotes with nothing between them - "") as the key name to specify the default key which is shown as (Default) in regedit.exe.
\S2{deleteinisec} DeleteINISec

View file

@ -30,7 +30,7 @@ Stores the text description of the section section_index into the output. If the
\c section_index inst_types
Sets the install types the section section specified by section_index defaults to the enabled state in. Note that the section index starts with zero. Every bit of inst_types is a flag that tells if the section is in that install type or not. For example, if you have 3 install types and you want the first section to be included in install types 1 and 3, then the command should look like this:
Sets the install types the section specified by section_index defaults to the enabled state in. Note that the section index starts with zero. Every bit of inst_types is a flag that tells if the section is in that install type or not. For example, if you have 3 install types and you want the first section to be included in install types 1 and 3, then the command should look like this:
\c SectionSetInstTypes 0 5

View file

@ -17,7 +17,7 @@ In a NSIS script every line is treated as a command. If your command is too long
\c Messagebox MB_OK|MB_ICONINFORMATION \
\c "This is a sample that shows how to use line breaks for larger commands in NSIS scripts"
If you want to use a double-quote in a string you can either use \\$" to esapce the quote or quote the string with a different type of quote such as ` or '.
If you want to use a double-quote in a string you can either use \\$" to escape the quote or quote the string with a different type of quote such as ` or '.
For more details about the script format, see \R{fileformat}{Script File Format}.
@ -46,7 +46,7 @@ An non-silent installer has a set of wizard pages to let the user configure the
\c Page directory
\c Page instfiles
\c UninstPage uninstConfirm
\c UninstPage isntfiles
\c UninstPage instfiles
\S1{tut-sections} Sections
@ -72,7 +72,7 @@ Functions, just like sections, can contain code. The difference between sections
User functions are called by the user from within sections or other functions using the \R{call}{Call} instruction. User functions will not execute unless you call them. After the code of the function will be executed the installer will continue executing the instructions that came after the Call instruction, unless you have aborted the installation inside the function. User functions are very useful if you have a set of instructions that need to be executed at several locations in the installers. If you put the code into a function you can save the copying time and you can maintain the code more easily.
Callback functions are called by the installer upon certain defined events such as when the installer starts. Callbacks are optional. If for example you want to welcome the user to your installer you will define a function called .onInit. The NSIS compiler will recongnize this function as a callback function by the name and will call it when the installer starts.
Callback functions are called by the installer upon certain defined events such as when the installer starts. Callbacks are optional. If for example you want to welcome the user to your installer you will define a function called .onInit. The NSIS compiler will recognize this function as a callback function by the name and will call it when the installer starts.
\c Function .onInit
\c MessageBox MB_YESNO "This will install My Program. Do you wish to continue?" IDYES gogogo
@ -88,7 +88,7 @@ For more information about functions see \R{functions}{Functions}.
\S2{tutVariables} Variables
You can decalare your own variables ($VARNAME) with the \R{var}{Var} command. Variables are global and can be used in any Section or Function. For shared code, there are also \R{varother}{20 registers avaibable} (like $0). These static variables don't have to be declared and you won't get any name conflics.
You can declare your own variables ($VARNAME) with the \R{var}{Var} command. Variables are global and can be used in any Section or Function. For shared code, there are also \R{varother}{20 registers avaibable} (like $0). These static variables don't have to be declared and you won't get any name conflicts.
Declaring and using a user variable:
@ -130,7 +130,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 debuging 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/archive/viewpage.php?pageid=140}{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 plugin \W{http://nsis.sourceforge.net/archive/viewpage.php?pageid=140}{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
@ -193,4 +193,4 @@ You can also customize the dialog resources without modifying or recompiling the
A popular user interface for NSIS is the Modern User Interface, with an interface like the wizards of recent Windows versions. The Modern UI is not only a customized resource file, it has a lots of new interface elements. It features a white header to describe the current step, a description area on the component page, a Finish page that allows you to run the application or reboot the system and more. The Modern UI language files make it easy to create a multilingual installer, because they contain translations for every label in the installer.
The Modern UI has a macro system that inserts the code to handle all the new UI elements, so you only have to insert a few lines of code to use it. For more information, check the \W{../Contrib/Modern UI/Readme.html}{Modern UI Readme} and the \W{../Examples/Modern UI/}{Modern UI Examples}.
The Modern UI has a macro system that inserts the code to handle all the new UI elements, so you only have to insert a few lines of code to use it. For more information, check the \W{../Contrib/Modern UI/Readme.html}{Modern UI Readme} and the \W{../Examples/Modern UI/}{Modern UI Examples}.

View file

@ -104,4 +104,4 @@ Sets the installer
\c hwnd show_state
Sets the visibilty 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 \W{../Include/WinMessages.nsh}{Include\\WinMessages.nsh}.
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 \W{../Include/WinMessages.nsh}{Include\\WinMessages.nsh}.

View file

@ -4,7 +4,7 @@
The NSIS source files are shipped with every official \W{http://sourceforge.net/project/showfiles.php?group_id=22049}{NSIS distribution} as well with the \W{http://nsis.sourceforge.net/nightly/nsis.zip}{development snapshots}. The binary files distributed with the NSIS releases are compiled with the Microsoft Visual C++ 6.0 compiler. The source has also been tested to be compatible with the Microsoft Visual C++ .NET 2002/2003 compiler. The NSIS distribution includes Microsoft Visual C++ 6.0 project files, Microsoft Visual C++ .NET 2002/2003 automatically convert these files to a new format.
If you don't have Microsoft Visual C++, you can download the free \W{http://msdn.microsoft.com/downloads/list/netdevframework.asp}{.NET Framework SDK} (requires Windows 2000/XP/Server 2003), which includes the latest Microsoft compiler. This SDK does not include the Win32 API headers/libraries, so you should also download the latest \W{http://www.microsoft.com/msdownload/platformsdk/sdkupdate/}{Platform SDK}. See the Microsoft documenation for information about using the command line compiler and linker tools.
If you don't have Microsoft Visual C++, you can download the free \W{http://msdn.microsoft.com/downloads/list/netdevframework.asp}{.NET Framework SDK} (requires Windows 2000/XP/Server 2003), which includes the latest Microsoft compiler. This SDK does not include the Win32 API headers/libraries, so you should also download the latest \W{http://www.microsoft.com/msdownload/platformsdk/sdkupdate/}{Platform SDK}. See the Microsoft documentation for information about using the command line compiler and linker tools.
Previous versions of NSIS have been reported to work with the MinGW compiler, however we don't have an up-to-date makefile. If you are working with MinGW or another compiler like Borland C++ Builder or Open Watcom C/C++ and want to provide makefiles or project files please drop a line on the \W{http://forums.winamp.com/forumdisplay.php?forumid=65}{NSIS Forum}.
@ -51,7 +51,7 @@ Write a value using the WriteRegStr command (for strings) or WriteRegDWORD comma
Some of the following values will not be used by older Windows versions.
\e{InstallLocation} (string) - Installation directory ($INSTDIR) \\<br\\>
\e{DisplayIcon} (string) - Path, filename and index of of the icon that will be displayed next to your application name
\e{DisplayIcon} (string) - Path, filename and index of the icon that will be displayed next to your application name
\e{Publisher} (string) - (Company) name of the publisher
@ -467,4 +467,4 @@ I wrote this script to help rpetges in \W{http://forums.winamp.com/showthread.ph
\c System::Free $0
\c SectionEnd
written by KiCHiK
written by KiCHiK

View file

@ -12,13 +12,13 @@ User variables can be declared with the \R{var}{Var} command. You can use these
\c var_name
Declare a user variable. Allowed charaters for variables names: [a-z][A-Z][0-9] and '_'.
Declare a user variable. Allowed characters for variables names: [a-z][A-Z][0-9] and '_'.
\S1{varother} Other Writable Variables
\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 conflics 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 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.
\e{$INSTDIR}
@ -130,4 +130,4 @@ This code will set the name of the installer to "Test Program $\{VERSION\}". The
This code sets the name of the installer to "Test Program V.1.0"
For more info, see \R{compdefines}{Conditional Compilation}.
For more info, see \R{compdefines}{Conditional Compilation}.