dragonleo/NSIS
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Documentation fixes and clarifications

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@6728 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
anders_k 2016-03-27 23:24:43 +00:00
parent 2b5baa3639
commit e7ac6581e4
39 changed files with 315 additions and 429 deletions
Download patch file Download diff file Expand all files Collapse all files

38
Docs/src/var.but
View file

@ -1,12 +1,12 @@
\H{variables} Variables
All variables are global and can be used in Sections or Functions. Note that, by default, variables are limited to 1024 characters. To extend this limit, \R{build}{build NSIS} with a bigger value of the NSIS_MAX_STRLEN build setting or use the \W{http://nsis.sourceforge.net/download/specialbuilds/}{special build}.
All variables are global and can be used in Sections or Functions. Note that by default, variables are limited to 1024 characters. To extend this limit, \R{build}{build NSIS} with a bigger value of the NSIS_MAX_STRLEN build setting or use the \W{http://nsis.sourceforge.net/download/specialbuilds/}{special build}.
\S1{varuser} User Variables
\e{$VARNAME}
User variables can be declared with the \R{var}{Var} command. You can use these variables to store values, work with string manipulation etc.
User variables must be declared with the \R{var}{Var} command. You can use these variables to store values, work with string manipulation etc.
\S2{var} Var
@ -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 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.
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}
@ -51,7 +51,7 @@ The command line of the installer. The format of the command line can be one of
\e{$LANGUAGE}
The identifier of the language that is currently used. For example, English is 1033. You can change this variable in \R{oninit}{.onInit}.
The identifier of the language that is currently used. For example, English is 1033. You can only change this variable in \R{oninit}{.onInit}.
\S1{varconstant} Constants
@ -69,11 +69,11 @@ The common files directory. This is a directory for components that are shared a
\e{$DESKTOP}
The Windows desktop directory (usually \c{C:\\Windows\\Desktop} but detected at runtime). The context of this constant (All Users or Current user) depends on the \R{setshellvarcontext}{SetShellVarContext} setting. The default is the current user.
The Windows desktop directory. The context of this constant (All Users or Current user) depends on the \R{setshellvarcontext}{SetShellVarContext} setting. The default is the current user.
\e{$EXEDIR}
The directory containing the installer executable (technically you can modify this variable, but it is probably not a good idea).
The directory containing the installer executable (technically this is a variable and you can modify it, but it is probably not a good idea).
\e{$EXEFILE}
@ -85,7 +85,7 @@ The full path of the installer executable.
\e{$\{NSISDIR\}}
A symbol that contains the path where NSIS is installed. Useful if you want to call resources that are in NSIS directory e.g. Icons, UIs etc.
A symbol that contains the path where NSIS is installed. Useful if you want to reference resources that are in NSIS directory e.g. Icons, UIs etc.
When compiled with support for keeping makensis and the data in the same place (the default on Windows), it is in the same place as makensis, on other platforms it is set at compile time (See the INSTALL file for info). In both instances you can modify it at runtime by setting the NSISDIR environment variable. See \k{usageenvironment} for more info.
@ -99,11 +99,11 @@ The Windows system directory (usually \c{C:\\Windows\\System} or \c{C:\\WinNT\\S
\e{$TEMP}
The system temporary directory (usually \c{C:\\Windows\\Temp} but detected at runtime).
The temporary directory.
\e{$STARTMENU}
The start menu folder (useful in adding start menu items using \R{createshortcut}{CreateShortcut}). The context of this constant (All Users or Current user) depends on the \R{setshellvarcontext}{SetShellVarContext} setting. The default is the current user.
The start menu folder (useful for adding start menu items using \R{createshortcut}{CreateShortcut}). The context of this constant (All Users or Current user) depends on the \R{setshellvarcontext}{SetShellVarContext} setting. The default is the current user.
\e{$SMPROGRAMS}
@ -115,13 +115,13 @@ The start menu programs / startup folder. The context of this constant (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 quick launch folder for IE4 active desktop and above. If quick launch is not available it simply returns the same as $TEMP.
\e{$DOCUMENTS}
The documents directory. A typical path for the current user is \c{C:\\Documents and Settings\\Foo\\My Documents}. The context of this constant (All Users or Current user) depends on the \R{setshellvarcontext}{SetShellVarContext} setting. The default is the current user.
This constant is not available on Windows 95 with Internet Explorer 4 not installed.
This constant is not available on Windows 95 unless Internet Explorer 4 is installed.
\e{$SENDTO}
@ -135,7 +135,7 @@ The directory that contains shortcuts to the user's recently used documents.
The directory that contains shortcuts to the user's favorite websites, documents, etc. The context of this constant (All Users or Current user) depends on the \R{setshellvarcontext}{SetShellVarContext} setting. The default is the current user.
This constant is not available on Windows 95 with Internet Explorer 4 not installed.
This constant is not available on Windows 95 unless Internet Explorer 4 is installed.
\e{$MUSIC}
@ -159,7 +159,7 @@ This constant is available on Windows XP, ME and above.
The directory that contains link objects that may exist in the My Network Places/Network Neighborhood folder.
This constant is not available on Windows 95 with Internet Explorer 4 and Active Desktop not installed.
This constant is not available on Windows 95 unless Internet Explorer 4 with Active Desktop is installed.
\e{$FONTS}
@ -173,7 +173,7 @@ The document templates directory. The context of this constant (All Users or Cur
The application data directory. Detection of the current user path requires Internet Explorer 4 and above. Detection of the all users path requires Internet Explorer 5 and above. The context of this constant (All Users or Current user) depends on the \R{setshellvarcontext}{SetShellVarContext} setting. The default is the current user.
This constant is not available on Windows 95 with Internet Explorer 4 and Active Desktop not installed.
This constant is not available on Windows 95 unless Internet Explorer 4 with Active Desktop is installed.
\e{$LOCALAPPDATA}
@ -191,19 +191,19 @@ This constant is not available on Windows 95 and Windows 98.
Internet Explorer's temporary internet files directory.
This constant is not available on Windows 95 and Windows NT with Internet Explorer 4 and Active Desktop not installed.
This constant is not available on Windows 95 nor Windows NT 4 unless Internet Explorer 4 with Active Desktop is installed.
\e{$COOKIES}
Internet Explorer's cookies directory.
This constant is not available on Windows 95 and Windows NT with Internet Explorer 4 and Active Desktop not installed.
This constant is not available on Windows 95 nor Windows NT 4 unless Internet Explorer 4 with Active Desktop is installed.
\e{$HISTORY}
Internet Explorer's history directory.
This constant is not available on Windows 95 and Windows NT with Internet Explorer 4 and Active Desktop not installed.
This constant is not available on Windows 95 nor Windows NT 4 unless Internet Explorer 4 with Active Desktop is installed.
\e{$PROFILE}
@ -219,13 +219,13 @@ This constant is available on Windows 2000, ME and above.
\e{$RESOURCES}
The resources directory that stores themes and other Windows resources (usually \c{C:\\Windows\\Resources} but detected at runtime).
The resources directory that stores themes and other Windows resources (usually \c{$WINDIR\\Resources} but detected at runtime).
This constant is available on Windows XP and above.
\e{$RESOURCES_LOCALIZED}
The localized resources directory that stores themes and other Windows resources (usually \c{C:\\Windows\\Resources\\1033} but detected at runtime).
The localized resources directory that stores themes and other Windows resources (usually \c{$WINDIR\\Resources\\1033} but detected at runtime).
This constant is available on Windows XP and above.