basic addtions to the docs
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@2134 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
flizebogen
parent
54580c8e54
commit
b685eff548
6 changed files with 35 additions and 12 deletions
|
|
@ -190,7 +190,7 @@ Sets the name of the installer. The name is usually simply the product name such
|
|||
|
||||
\c path_to_icon.ico
|
||||
|
||||
Sets the icon of the installer. Every icon in the icon file will be included in the installer.
|
||||
Sets the icon of the installer. Every icon in the icon file will be included in the installer. Note that if you use different icons for installer and uninstaller the file size and structure of the icons has to match otherwise the built of the installer will fail.
|
||||
|
||||
\S2{aoutfile} OutFile
|
||||
|
||||
|
|
@ -286,4 +286,4 @@ Sets whether or not the installer's icon is being displayed.
|
|||
|
||||
\c on|\\<b\\>off\\</b\\>
|
||||
|
||||
Sets whether or not an XP manifest will be added to the installer. This affects the uninstaller too.
|
||||
Sets whether or not an XP manifest will be added to the installer. This affects the uninstaller too.
|
||||
|
|
@ -40,7 +40,12 @@ Writes a string to a file opened with FileOpen. If an error occurs writing, the
|
|||
|
||||
\c handle string
|
||||
|
||||
Writes the integer interpretation of 'string' to a file opened with FileOpen. If an error occurs writing, the error flag will be set. Note that the low byte of the integer is used, i.e. writing 256 is the same as writing 0, etc.
|
||||
Writes the integer interpretation of 'string' to a file opened with FileOpen. Of course you can enter the integer value directly. The following code writes an "Carriage Return / Line Feed" - Enter to the file.
|
||||
|
||||
\c FileWriteByte file_handle "13"
|
||||
\c FileWriteByte file_handle "10"
|
||||
|
||||
You can If an error occurs writing, the error flag will be set. Note that the low byte of the integer is used, i.e. writing 256 is the same as writing 0, etc.
|
||||
|
||||
\S2{FindClose} FindClose
|
||||
|
||||
|
|
@ -58,4 +63,4 @@ Performs a search for 'filespec', placing the first file found in filename_outpu
|
|||
|
||||
\c handle user_var(filename_output)
|
||||
|
||||
Continues a search began with FindFirst. handle should be the handle_output_variable returned by FindFirst. If the search is completed (there are no more files), filename_output is set to empty, and the error flag is set. Note that the filename output is without path.
|
||||
Continues a search began with FindFirst. handle should be the handle_output_variable returned by FindFirst. If the search is completed (there are no more files), filename_output is set to empty, and the error flag is set. Note that the filename output is without path.
|
||||
|
|
@ -42,7 +42,7 @@ If label is specified, goto the label 'label_to_jump_to:'.
|
|||
|
||||
If +offset or -offset is specified, jump is relative by offset instructions. Goto +1 goes to the next instruction, Goto -1 goes to the previous instruction, etc.
|
||||
|
||||
If a user variable is specified, jumps to absolute address (generally you will want to get this value from a function like GetLabelAddress. I Compiler flag commands and SectionIn aren't instructions so jumping over them has no effect.
|
||||
If a user variable is specified, jumps to absolute address (generally you will want to get this value from a function like GetLabelAddress. Compiler flag commands and SectionIn aren't instructions so jumping over them has no effect.
|
||||
|
||||
\S2{iferrors} IfErrors
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ Copies files from the source to the destination on the installing system. Useful
|
|||
|
||||
\c path_to_create
|
||||
|
||||
Creates (recursively if necessary) the specified directory.
|
||||
Creates (recursively if necessary) the specified directory. The error flag is \\<b\\>not\\</b\\> set if the directory couldn't be created.
|
||||
|
||||
\S2{createshortcut} CreateShortCut
|
||||
|
||||
|
|
@ -33,7 +33,14 @@ The error flag is set if the shortcut cannot be created (i.e. the path does not
|
|||
|
||||
\c filename user_var(high dword output) user_var(low dword output)
|
||||
|
||||
Gets the version information from the DLL in "filename". Sets the user output variables with the high and low dwords of version information on success; on failure the outputs are empty and the error flag is set.
|
||||
Gets the version information from the DLL in "filename". Sets the user output variables with the high and low dwords of version information on success; on failure the outputs are empty and the error flag is set. The following example reads the DLLVersion and makes it readable.
|
||||
|
||||
\c GetDllVersion "$EXEDIR\ScummVM.exe" $R0 $R1
|
||||
\c IntOp $R2 $R0 / 0x00010000
|
||||
\c IntOp $R3 $R0 & 0x0000FFFF
|
||||
\c IntOp $R4 $R1 / 0x00010000
|
||||
\c IntOp $R5 $R1 & 0x0000FFFF
|
||||
\c StrCpy $0 "$R2.$R3.$R4.$R5"
|
||||
|
||||
\S2{getdllversionlocal} GetDLLVersionLocal
|
||||
|
||||
|
|
@ -103,4 +110,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)).
|
||||
|
|
@ -8,7 +8,7 @@ Initializes the plugins dir ($PLUGINSDIR, see \k{var2}) if not initialized alrea
|
|||
|
||||
\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.
|
||||
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 isadmin.dll Plugin. You can download it in the \W{http://nsis.sourceforge.net/archive/}{NSIS Archiv}.
|
||||
|
||||
\S2{sleep} Sleep
|
||||
|
||||
|
|
|
|||
|
|
@ -24,6 +24,8 @@ The command line of the installer. The format of the command line can be one of
|
|||
|
||||
\b For parsing out the PARAMETER portion, see GetParameters on the utility functions page. It's worth noting that if /D= is specified on the command line (to override the install directory), it won't be in $CMDLINE.
|
||||
|
||||
If you want to deal with parameters you should take a look at the GetParameters Function (See \k{getparameters}).
|
||||
|
||||
\e{$LANGUAGE}
|
||||
|
||||
The identifier of the language that is currently used. For example, English is 1033. You can change this variable in .onInit.
|
||||
|
|
@ -44,7 +46,7 @@ The location of the installer executable. (technically you can modify this varia
|
|||
|
||||
\e{$\{NSISDIR\}}
|
||||
|
||||
A symbol that contains the path where NSIS is installed.
|
||||
A symbol that contains the path where NSIS is installed. Detected at compile time. Useful if you want to call resources that are in NSIS directory e.g. Icons, UI's...
|
||||
|
||||
\e{$WINDIR}
|
||||
|
||||
|
|
@ -72,7 +74,7 @@ The start menu programs / startup folder. The context of this variable (All User
|
|||
|
||||
\e{$QUICKLAUNCH}
|
||||
|
||||
The quick launch folder for IE4 active desktop and above. If quick launch is not available, simply returns the same as $TEMP. The context of this variable (All Users or Current user) depends on the SetShellVarContext setting. The default is the current user.
|
||||
The quick launch folder for IE4 active desktop and above. If quick launch is not available, simply returns the same as $TEMP. It seems that there is no Quicklaunch for all users. Therefore current user is always used.
|
||||
|
||||
\e{$HWNDPARENT}
|
||||
|
||||
|
|
@ -98,5 +100,14 @@ Use to represent a newline (\\n).
|
|||
|
||||
\e{$\{SYMBOL\}}
|
||||
|
||||
Where SYMBOL is the name of something globally defined, this will be replaced with the value of that symbol. If the symbol is not defined, no replace occurs (i.e. if $\{POOP\} is encountered, and POOP is not defined, $\{POOP\} is output).
|
||||
Where SYMBOL is the name of something globally defined, this will be replaced with the value of that symbol. The order of calling Symbols in the script is important.
|
||||
|
||||
\c Name "Test Program ${VERSION}"
|
||||
\c !define VERSION "V.1.0"
|
||||
|
||||
This code will set the name of the installer to "Test Program ${VERSION}". The Same happens if the Symbol has not been defined.
|
||||
|
||||
\c !define VERSION "V.1.0"
|
||||
\c Name "Test Program ${VERSION}"
|
||||
|
||||
This code sets the name of the installer to "Test Program V.1.0"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue