- added AddBrandingImage examples
- added information about usage of variables git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@3939 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
kichik
parent
31f957efda
commit
c9c8811194
1 changed files with 47 additions and 3 deletions
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
\S1{attribgen} General Attributes
|
||||
|
||||
The commands below all adjust attributes of the installer. These attributes control how the installer looks and functions, including which pages are present in the installer, as what text is displayed in each part of each page, how the installer is named, what icon the installer uses, the default installation directory, what file it writes out, and more. Note that these attributes can be set anywhere in the file except in a Section or Function. With the exception of InstallDir, none of these attributes allow use of Variables other than $\\r and $\\n in their strings.
|
||||
The commands below all adjust attributes of the installer. These attributes control how the installer looks and functions, including which pages are present in the installer, as what text is displayed in each part of each page, how the installer is named, what icon the installer uses, the default installation directory, what file it writes out, and more. Note that these attributes can be set anywhere in the file except in a Section or Function.
|
||||
|
||||
\\<b\\>\\<u\\>Defaults are bold and underlined\\</u\\>\\</b\\>
|
||||
|
||||
|
|
@ -12,6 +12,12 @@ The commands below all adjust attributes of the installer. These attributes cont
|
|||
|
||||
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.
|
||||
|
||||
\c AddBrandingImage left 100
|
||||
\c AddBrandingImage right 50
|
||||
\c AddBrandingImage top 20
|
||||
\c AddBrandingImage bottom 35
|
||||
\c AddBrandingImage left 100 5
|
||||
|
||||
\S2{aallowrootdirinstall} AllowRootDirInstall
|
||||
|
||||
\c true|\\<b\\>false\\</b\\>
|
||||
|
|
@ -42,6 +48,8 @@ Specifies whether or not to use a gradient background window. If 'off', the inst
|
|||
|
||||
Sets the text that is shown (by default it is 'Nullsoft Install System vX.XX') in the bottom of the install window. Setting this to an empty string ("") uses the default; to set the string to blank, use " " (a space). If it doesn't matter to you, leave it the default so that everybody can know why the installer didn't suck. heh. Use /TRIMLEFT, /TRIMRIGHT or /TRIMCENTER to trim down the size of the control to the size of the string.
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized on \R{oninit}{.onInit}.
|
||||
|
||||
\S2{acaption} Caption
|
||||
|
||||
\c caption
|
||||
|
|
@ -50,6 +58,8 @@ When used outside a \R{pageex}{PageEx} block: Sets the text for the titlebar of
|
|||
|
||||
When used inside a \R{pageex}{PageEx} block: Sets the subcaption of the current page.
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized on \R{oninit}{.onInit}.
|
||||
|
||||
\S2{achangeui} ChangeUI
|
||||
|
||||
\c dialog ui_file.exe
|
||||
|
|
@ -86,6 +96,8 @@ This bitmap should have a size of 96x16 pixels, no more than 8bpp (256 colors) a
|
|||
|
||||
Replaces the default text ("Completed") that is printed at the end of the install if parameter is specified. Otherwise, the default is used.
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the message is printed.
|
||||
|
||||
\S2{acomponenttext} ComponentText
|
||||
|
||||
\c [text [subtext] [subtext2]]
|
||||
|
|
@ -100,6 +112,8 @@ subtext2: Text to the left of the components list and below the installation typ
|
|||
|
||||
The default string will be used if a string is empty ("").
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the components page is created.
|
||||
|
||||
\S2{acrccheck} CRCCheck
|
||||
|
||||
\c \\<b\\>on\\</b\\>|off|force
|
||||
|
|
@ -112,6 +126,8 @@ Specifies whether or not the installer will perform a CRC on itself before allow
|
|||
|
||||
Replaces the default details button text of "Show details", if parameter is specified (otherwise the default is used).
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the install log (instfiles) page is created.
|
||||
|
||||
\S2{adirtext} DirText
|
||||
|
||||
\c [text] [subtext] [browse_button_text] [browse_dlg_text]
|
||||
|
|
@ -128,6 +144,8 @@ browse_dlg_text: Text on the "Browse For Folder" dialog, appears after clicking
|
|||
|
||||
The default string will be used if a string is empty ("").
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the directory page is created.
|
||||
|
||||
\S2{adirvar} DirVar
|
||||
|
||||
\c user_var(dir input/output)
|
||||
|
|
@ -163,6 +181,8 @@ If `DirVerify leave' is used, the Next button will not be disabled if the instal
|
|||
|
||||
Replaces the default text that comes up when a file cannot be written to. This string can contain a reference to $0, which is the filename ($0 is temporarily changed to this value). Example: "Can not write to file $\\r$\\n$0$\\r$\\ngood luck, bitch.".
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before \R{file}{File} is used.
|
||||
|
||||
\S2{aicon} Icon
|
||||
|
||||
\c [path\]icon.ico
|
||||
|
|
@ -175,6 +195,8 @@ Sets the icon of the installer. Every icon in the icon file will be included in
|
|||
|
||||
If parameter is specified, overrides the default install button text (of "Install") with the specified text.
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the install button shows.
|
||||
|
||||
\S2{ainstallcolors} InstallColors
|
||||
|
||||
\c /windows | (foreground_color background_color)
|
||||
|
|
@ -185,7 +207,7 @@ Sets the colors to use for the install info screen (the default is 00FF00 000000
|
|||
|
||||
\c definstdir
|
||||
|
||||
Sets the default installation directory is. See the variables section for variables that can be used to make this string (especially $PROGRAMFILES). Note that the part of this string following the last \\ will be used if the user selects 'browse', and may be appended back on to the string at install time (to disable this, end the directory with a \\ (which will require the entire parameter to be enclosed with quotes). If this doesn't make any sense, play around with the browse button a bit.
|
||||
Sets the default installation directory is. See the \R{variables}{variables section} for variables that can be used to make this string (especially $PROGRAMFILES). Note that the part of this string following the last \\ will be used if the user selects 'browse', and may be appended back on to the string at install time (to disable this, end the directory with a \\ (which will require the entire parameter to be enclosed with quotes). If this doesn't make any sense, play around with the browse button a bit.
|
||||
|
||||
\S2{ainstalldirregkey} InstallDirRegKey
|
||||
|
||||
|
|
@ -206,6 +228,8 @@ Valid values for flag are "smooth" (smooth the progress bar) or "colored" (color
|
|||
Adds an install type to the install type list, or disables the custom install type. There can be as many as 32 types, each one specifying the name of the install type. If the name is prefixed with 'un.' it is an uninstaller install type. Instead of an "hard-coded" name you can use user variables which are processed at runtime. This allows you to change InstType name dynamically. Another way of changing the InstType name during runtime is the \R{sinsttypesettext}{InstTypeSetText} command. The difference is that with \R{sinsttypesettext}{InstTypeSetText} you are saving your precious user variables. The first type is the default (generally 'Typical'). If the /NOCUSTOM switch is specified, then the "custom" install type is disabled, and the user has to choose one of the pre-defined install types. Alternatively, if the /CUSTOMSTRING switch is specified, the parameter will override the "Custom" install type text. Alternatively, if the /COMPONENTSONLYONCUSTOM flag is specified, the component list will only be show
|
||||
n if the "Custom" install type is selected.
|
||||
|
||||
Accepts variables for type names. If variables are used, they must be initialized before the components page is created.
|
||||
|
||||
\S2{alicensebkcolor} LicenseBkColor
|
||||
|
||||
\c color | \\<b\\>/gray\\</b\\> | /windows
|
||||
|
|
@ -220,6 +244,8 @@ Specifies a text file or a RTF file to use for the license that the user can rea
|
|||
|
||||
If you make your license file a RTF file it is recommended you edit it with WordPad and not MS Word. Using WordPad will result in a much smaller file.
|
||||
|
||||
Use \R{licenselangstring}{LicenseLangString} to show a different license for every language.
|
||||
|
||||
\S2{alicenseforceselection} LicenseForceSelection
|
||||
|
||||
\c (checkbox [accept_text] | radiobuttons [accept_text] [decline_text] | \\<b\\>off\\</b\\>)
|
||||
|
|
@ -246,12 +272,16 @@ button_text: Text on the "I Agree" button.
|
|||
|
||||
The default string will be used if a string is empty ("").
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the license page is created.
|
||||
|
||||
\S2{amiscbuttontext} MiscButtonText
|
||||
|
||||
\c [back button text [next button text] [cancel button text] [close button text]]
|
||||
|
||||
Replaces the default text strings for the four buttons (< Back, Next >, Cancel and Close). If parameters are omitted, the defaults are used.
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized in \R{oninit}{.onInit}.
|
||||
|
||||
\S2{aname} Name
|
||||
|
||||
\c name [name_doubled_ampersands]
|
||||
|
|
@ -262,6 +292,8 @@ Sets the name of the installer. The name is usually simply the product name such
|
|||
|
||||
If you have ampersands in the name and use a \R{langstring}{LangString} for the name, you will have to create another one with doubled ampersands to use as the second parameter.
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized in \R{oninit}{.onInit}.
|
||||
|
||||
\S2{aoutfile} OutFile
|
||||
|
||||
\c [path\]install.exe
|
||||
|
|
@ -315,6 +347,8 @@ See \k{silent} for more information.
|
|||
|
||||
If parameters are specified, overrides the space required and space available text ("Space required: " and "Space available: " by default). If 'none' is specified as the required text no space texts will be shown.
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the components page is created.
|
||||
|
||||
\S2{asubcaption} SubCaption
|
||||
|
||||
\c [page_number subcaption]
|
||||
|
|
@ -323,17 +357,23 @@ Overrides the subcaptions for each of the installer pages (0=": License Agreemen
|
|||
|
||||
You can also set a subcaption (or override the default) using \R{acaption}{Caption} inside a \R{pageex}{PageEx} block.
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the relevant page is created.
|
||||
|
||||
\S2{auninstallbuttontext} UninstallButtonText
|
||||
|
||||
\c text
|
||||
|
||||
Changes the text of the button that by default says "Uninstall" in the uninstaller. If no parameter is specified, the default text is used. See also \R{writeuninstaller}{WriteUninstaller} (replaces UninstallEXEName).
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the uninstall button shows.
|
||||
|
||||
\S2{auninstallcaption} UninstallCaption
|
||||
|
||||
\c caption
|
||||
|
||||
Sets what the titlebars of the uninstaller will display. By default, it is 'Name Uninstall', where Name is specified with the Name command. You can, however, override it with 'MyApp uninstaller' or whatever. If you specify an empty string (""), the default will be used (you can however specify " " to achieve a blank string)
|
||||
Sets what the titlebars of the uninstaller will display. By default, it is 'Name Uninstall', where Name is specified with the Name command. You can, however, override it with 'MyApp uninstaller' or whatever. If you specify an empty string (""), the default will be used (you can however specify " " to achieve a blank string).
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized in \R{unonInit}{un.onInit}.
|
||||
|
||||
\S2{auninstallicon} UninstallIcon
|
||||
|
||||
|
|
@ -349,6 +389,8 @@ Sets the default subcaptions for the uninstaller pages (0=": Confirmation",1=":
|
|||
|
||||
You can also set a subcaption (or override the default) using \R{acaption}{Caption} inside a \R{pageex}{PageEx} block.
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the relevant page is created.
|
||||
|
||||
\S2{auninstalltext} UninstallText
|
||||
|
||||
\c text [subtext]
|
||||
|
|
@ -359,6 +401,8 @@ text: Text above the controls
|
|||
|
||||
subtext: Text next to the uninstall location
|
||||
|
||||
Accepts variables. If variables are used, they must be initialized before the uninstaller confirm page is created.
|
||||
|
||||
\S2{awindowicon} WindowIcon
|
||||
|
||||
\c \\<b\\>on\\</b\\>|off
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue