Features list updated, some links added and command parameters are now shown alone with a light background behind them.
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1476 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
kichik
parent
2bb6c55b0f
commit
41a03f754c
24 changed files with 497 additions and 464 deletions
|
|
@ -4,43 +4,43 @@ The commands below all adjust attributes of the installer. These attributes cont
|
|||
|
||||
\H{aaddbrandingimage} AddBrandingImage
|
||||
|
||||
AddBrandingImage \e{(left|top) (width|height)}
|
||||
\c (left|top) (width|height)
|
||||
|
||||
Adds a branding image on the top of the installer or on the left. Its size will be set according to the width/height sepcified, the installer width/height and the installer font. Because this depends on the installer font, you should put SetFont before AddBrandingImage.
|
||||
|
||||
\H{aallowrootdirinstall} AllowRootDirInstall
|
||||
|
||||
AllowRootDirInstall \e{true|false}
|
||||
\c true|false
|
||||
|
||||
Controls whether or not installs are enabled to the root directory of a drive, or directly into a network share. Set to 'true' to change the default (safe) behavior, which prevents users from selecting C:\\ or \\\\Herver\\Hhare as an install (and lataer on, uninstall) directory. For additional directory selection page customizability, see .onVerifyInstDir
|
||||
|
||||
\H{aautoclosewindow} AutoCloseWindow
|
||||
|
||||
AutoCloseWindow \e{true|false}
|
||||
\c true|false
|
||||
|
||||
Sets whether or not the install window automatically closes when completed. Can be 'false' or 'true'. This is overrideable from a section using SetAutoClose.
|
||||
|
||||
\H{abggradient} BGGradient
|
||||
|
||||
BGGradient \e{[off]|[topc botc [textcolor|notext]]}
|
||||
\c [off]|[topc botc [textcolor|notext]]
|
||||
|
||||
Specifies whether or not to use a gradient background window. If 'off', the installer will not show a background window, if no parameters are specified, the default black to blue gradient is used, and otherwise the top_color or bottom_color are used to make a gradient. Top_color and bottom_color are specified using the form RRGGBB (in hexadecimal, as in HTML, only minus the leading '#', since # can be used for comments). 'textcolor' can be specified as well, or 'notext' can be specified to turn the big background text off.
|
||||
|
||||
\H{abrandingtext} BrandingText
|
||||
|
||||
BrandingText \e{[/LANG=lang_id] /TRIM(LEFT|RIGHT|CENTER) text}
|
||||
\c [/LANG=lang_id] /TRIM(LEFT|RIGHT|CENTER) text
|
||||
|
||||
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.
|
||||
|
||||
\H{acaption} Caption
|
||||
|
||||
Caption \e{[/LANG=lang_id] caption}
|
||||
\c [/LANG=lang_id] caption
|
||||
|
||||
Sets what the titlebars of the installer will display. By default, it is 'Name Setup', where Name is specified with the Name command (See \k{aname}). You can, however, override it with 'MyApp Installer' or whatever. If you specify an empty string (""), the default will be used (you can however specify " " to achieve a blank string)
|
||||
|
||||
\H{achangeui} ChangeUI
|
||||
|
||||
ChangeUI \e{dialog ui_file.exe}
|
||||
\c dialog ui_file.exe
|
||||
|
||||
Replaces dialog (\e{IDD_LICENSE}, \e{IDD_DIR}, \e{IDD_SELCOM}, \e{IDD_INST}, \e{IDD_INSTFILES} or \e{IDD_UNINST}) by a dialog with the same resource ID in ui_file.exe. You can also specifiy 'all' as the dialog if you wish to load replace all 6 of the dialogs at once from the same UI file. For some example UIs look at Contrib\\UIs under your NSIS directory.
|
||||
|
||||
|
|
@ -56,221 +56,221 @@ Replaces dialog (\e{IDD_LICENSE}, \e{IDD_DIR}, \e{IDD_SELCOM}, \e{IDD_INST}, \e{
|
|||
|
||||
\b \e{IDD_UNINST} must contain \e{IDC_EDIT1} (edit box).
|
||||
|
||||
\b \e{IDD_VERIFY} must contain \e{IDC_STR} (static).
|
||||
\b \e{IDD_VERIFY} must contain \e{IDC_STR} (static).
|
||||
|
||||
\H{acompletedtext} CompletedText
|
||||
|
||||
CompletedText \e{[/LANG=lang_id] [Completed text]}
|
||||
\c [/LANG=lang_id] [Completed text]
|
||||
|
||||
Replaces the default text ("Completed") that is printed at the end of the install if parameter is specified. Otherwise, the default is used.
|
||||
Replaces the default text ("Completed") that is printed at the end of the install if parameter is specified. Otherwise, the default is used.
|
||||
|
||||
\H{acomponenttext} ComponentText
|
||||
|
||||
ComponentText \e{[/LANG=lang_id] [text] [subtext] [subtext2]}
|
||||
\c [/LANG=lang_id] [text] [subtext] [subtext2]
|
||||
|
||||
Specifies a string that is above the component list. This can be something that notifies the user what it is they are actually installing. Note that if no parameter is specified, or if the ComponentText command is omitted, then the component page will not be visible, and all of the sections will be installed. Note: if text is specified and non-empty and you leave subtext or subtext2 empty, the defaults will be used (to set one to blank, use a string like " "). empty strings mean default on subtext and subtext2. Likewise, if you wish to enable the component page, but don't want any text on the top line, set text to " ".
|
||||
Specifies a string that is above the component list. This can be something that notifies the user what it is they are actually installing. Note that if no parameter is specified, or if the ComponentText command is omitted, then the component page will not be visible, and all of the sections will be installed. Note: if text is specified and non-empty and you leave subtext or subtext2 empty, the defaults will be used (to set one to blank, use a string like " "). empty strings mean default on subtext and subtext2. Likewise, if you wish to enable the component page, but don't want any text on the top line, set text to " ".
|
||||
|
||||
\H{acrccheck} CRCCheck
|
||||
|
||||
CRCCheck \e{on|off|force}
|
||||
\c on|off|force
|
||||
|
||||
Specifies whether or not the installer will perform a CRC on itself before allowing an install. Valid options are 'on','off', and 'force'. Note that if the user uses /NCRC on the command line when executing the installer, and you didn't specify 'force', the CRC will not occur, and the user will be allowed to install a (potentially) corrupted installer.
|
||||
|
||||
\H{adetailsbuttontext} DetailsButtonText
|
||||
|
||||
DetailsButtonText \e{[/LANG=lang_id] [show details text]}
|
||||
\c [/LANG=lang_id] [show details text]
|
||||
|
||||
Replaces the default details button text of "Show details", if parameter is specified (otherwise the default is used).
|
||||
Replaces the default details button text of "Show details", if parameter is specified (otherwise the default is used).
|
||||
|
||||
\H{adirshow} DirShow
|
||||
|
||||
DirShow \e{show|hide}
|
||||
\c show|hide
|
||||
|
||||
Specifies whether or not the user will see the directory selection page. Note that if 'hide' is specified, the installer will still check the validity of the installation path (using internal logic and .onVerifyInstDir if it is declared). If the path is deemed invalid, the directory page will be shown. To completely disable the Directory page (and install without prompting, even if a valid installation path is not available), specify DirText with no parameter (this might be useful if the installer installs everything into $SYSDIR or something like that).
|
||||
|
||||
\H{adirtext} DirText
|
||||
|
||||
DirText \e{[/LANG=lang_id] [text] [subtext] [browse text]}
|
||||
\c [/LANG=lang_id] [text] [subtext] [browse text]
|
||||
|
||||
Specifies a string that is above the directory selection area. If this command is not specified, or no parameter is specified, then the directory page is never visible to the user (even if DirShow show is specified). If subtext is specified and not empty, it overrides the default text above the path entry box ("Select the directory to install MyApp in:"). If browse button text is specified but not empty, it overrides the default browse button text ("Browse...").
|
||||
Specifies a string that is above the directory selection area. If this command is not specified, or no parameter is specified, then the directory page is never visible to the user (even if DirShow show is specified). If subtext is specified and not empty, it overrides the default text above the path entry box ("Select the directory to install MyApp in:"). If browse button text is specified but not empty, it overrides the default browse button text ("Browse...").
|
||||
|
||||
\H{a} FileErrorText
|
||||
|
||||
FileErrorText \e{[/LANG=lang_id] [file error text]}
|
||||
\c [/LANG=lang_id] [file error text]
|
||||
|
||||
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.".
|
||||
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.".
|
||||
|
||||
\H{ainstallbuttontext} InstallButtonText
|
||||
|
||||
InstallButtonText \e{[/LANG=lang_id] [install button text]}
|
||||
\c [/LANG=lang_id] [install button text]
|
||||
|
||||
If parameter is specified, overrides the default install button text (of "Install") with the specified text.
|
||||
If parameter is specified, overrides the default install button text (of "Install") with the specified text.
|
||||
|
||||
\H{ainstallcolors} InstallColors
|
||||
|
||||
InstallColors \e{/windows | foreground background}
|
||||
\c /windows | foreground background
|
||||
|
||||
Sets the colors to use for the install info screen (the default is 00FF00 000000. Use the form RRGGBB (in hexadecimal, as in HTML, only minus the leading '#', since # can be used for comments). Note that if "/windows" is specified as the only parameter, the default windows colors will be used.
|
||||
Sets the colors to use for the install info screen (the default is 00FF00 000000. Use the form RRGGBB (in hexadecimal, as in HTML, only minus the leading '#', since # can be used for comments). Note that if "/windows" is specified as the only parameter, the default windows colors will be used.
|
||||
|
||||
\H{ainstalldir} InstallDir
|
||||
|
||||
InstallDir \e{definstdir}
|
||||
\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 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.
|
||||
|
||||
\H{ainstalldirregkey} InstallDirRegKey
|
||||
|
||||
InstallDirRegKey \e{root_key subkey key_name}
|
||||
\c root_key subkey key_name
|
||||
|
||||
This attribute tells the installer to check a string in the registry, and use it for the install dir if that string is valid. If this attribute is present, it will override the InstallDir attribute if the registry key is valid, otherwise it will fall back to the InstallDir default. When querying the registry, this command will automatically remove any quotes. If the string ends in ".exe", it will automatically remove the filename component of the string (i.e. if the string is "C:\\program files\\poop\\poop.exe", it will know to use "C:\\program files\\poop"). For more advanced install directory configuration, set $INSTDIR in .onInit.
|
||||
This attribute tells the installer to check a string in the registry, and use it for the install dir if that string is valid. If this attribute is present, it will override the InstallDir attribute if the registry key is valid, otherwise it will fall back to the InstallDir default. When querying the registry, this command will automatically remove any quotes. If the string ends in ".exe", it will automatically remove the filename component of the string (i.e. if the string is "C:\\program files\\poop\\poop.exe", it will know to use "C:\\program files\\poop"). For more advanced install directory configuration, set $INSTDIR in .onInit.
|
||||
|
||||
\H{ainstprogressflags} InstProgressFlags
|
||||
|
||||
InstProgressFlags \e{[flag [...]]}
|
||||
\c [flag [...]]
|
||||
|
||||
Valid values for flag are "smooth" (smooth the progress bar) or "colored" (color the progress bar with the colors set by InstallColors. Examples: "InstProgressFlags" (default old-school windows look), "InstProgressFlags smooth" (new smooth look), "InstProgressFlags smooth colored" (colored smooth look whee).
|
||||
Valid values for flag are "smooth" (smooth the progress bar) or "colored" (color the progress bar with the colors set by InstallColors. Examples: "InstProgressFlags" (default old-school windows look), "InstProgressFlags smooth" (new smooth look), "InstProgressFlags smooth colored" (colored smooth look whee).
|
||||
|
||||
\H{ainsttype} InstType
|
||||
|
||||
InstType \e{install_type_name | /NOCUSTOM | ([/LANG=lang_id] /CUSTOMSTRING=str)| /COMPONENTS.. ..ONLYONCUSTOM}
|
||||
\c install_type_name | /NOCUSTOM | ([/LANG=lang_id] /CUSTOMSTRING=str)| /COMPONENTS.. ..ONLYONCUSTOM
|
||||
|
||||
Adds an install type to the install type list, or disables the custom install type. There can be as many as 8 types, each one specifying the name of the install. The first type is the default (generally 'Typical'). Each type is numbered, starting at 1. See SectionIn for information on how those numbers are used. 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 shown if the "Custom" install type is selected.
|
||||
Adds an install type to the install type list, or disables the custom install type. There can be as many as 8 types, each one specifying the name of the install. The first type is the default (generally 'Typical'). Each type is numbered, starting at 1. See SectionIn for information on how those numbers are used. 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 shown if the "Custom" install type is selected.
|
||||
|
||||
\H{alicensebkcolor} LicenseBkColor
|
||||
|
||||
LicenseBkColor \e{color}
|
||||
\c color
|
||||
|
||||
Sets the background color of the license data.
|
||||
|
||||
\H{alicensedata} LicenseData
|
||||
|
||||
LicenseData \e{[/LANG=lang_id] licdata.txt}
|
||||
\c [/LANG=lang_id] licdata.txt
|
||||
|
||||
Specifies a text file to use for the license that the user can read. Omit this to not have a license displayed. Note that the file must be in the evil DOS text format (\\r\\n, yeah!)
|
||||
Specifies a text file to use for the license that the user can read. Omit this to not have a license displayed. Note that the file must be in the evil DOS text format (\\r\\n, yeah!)
|
||||
|
||||
\H{alicensetext} LicenseText
|
||||
|
||||
LicenseText \e{[/LANG=lang_id] text [button_text]}
|
||||
\c [/LANG=lang_id] text [button_text]
|
||||
|
||||
Specifies a string that is above the license text. Omit this to not have a license displayed. If button_text is specified, it will override the default button text of "I Agree".
|
||||
Specifies a string that is above the license text. Omit this to not have a license displayed. If button_text is specified, it will override the default button text of "I Agree".
|
||||
|
||||
\H{aloadlanguagefile} LoadLanguageFile
|
||||
|
||||
LoadLanguageFile \e{lang_file.nlf}
|
||||
\c lang_file.nlf
|
||||
|
||||
Loads a NLF (NSIS Language File) that will be used to create a string table for the specific language in that NLF.
|
||||
|
||||
\H{amiscbuttontext} MiscButtonText
|
||||
|
||||
MiscButtonText \e{[/LANG=lang_id] [back button text] [next button text] [cancel button text] [close button text]}
|
||||
\c [/LANG=lang_id] [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.
|
||||
|
||||
\H{aname} Name
|
||||
|
||||
Name \e{[/LANG=lang_id] name}
|
||||
\c [/LANG=lang_id] name
|
||||
|
||||
Sets the name of the installer. The name is usually simply the product name such as 'MyApp' or 'CrapSoft MyApp'.
|
||||
|
||||
\H{aicon} Icon
|
||||
|
||||
Icon \e{path_to_icon.ico}
|
||||
\c path_to_icon.ico
|
||||
|
||||
Sets the icon of the installer.
|
||||
Sets the icon of the installer.
|
||||
|
||||
\H{aoutfile} OutFile
|
||||
|
||||
OutFile \e{install.exe}
|
||||
\c install.exe
|
||||
|
||||
Specifies the output file that the MakeNSIS should write the installer to. This is just the file that MakeNSIS writes, it doesn't effect the contents of the installer.
|
||||
|
||||
\H{aplugindir} PluginDir
|
||||
|
||||
PluginDir \e{directory}
|
||||
\c directory
|
||||
|
||||
Causes the NSIS compiler to scan the given directory for Plugin DLLs.
|
||||
Causes the NSIS compiler to scan the given directory for Plugin DLLs.
|
||||
|
||||
\H{asetfont} SetFont
|
||||
|
||||
SetFont \e{font_face_name font_size}
|
||||
\c font_face_name font_size
|
||||
|
||||
Sets the installer font. Please remember that the font you choose must be present on the user's machine as well. Don't use rare fonts that only you have.
|
||||
|
||||
\H{ashowinstdetails} ShowInstDetails
|
||||
|
||||
ShowInstDetails \e{hide|show|nevershow}
|
||||
\c hide|show|nevershow
|
||||
|
||||
Sets whether or not the details of the install are shown. Can be 'hide' (the default) to hide the details by default, allowing the user to view them, or 'show' to show them by default, or 'nevershow', to prevent the user from ever seeing them. Note that sections can override this using SetDetailsView.
|
||||
Sets whether or not the details of the install are shown. Can be 'hide' (the default) to hide the details by default, allowing the user to view them, or 'show' to show them by default, or 'nevershow', to prevent the user from ever seeing them. Note that sections can override this using SetDetailsView.
|
||||
|
||||
\H{ashowuninstdetails} ShowUninstDetails
|
||||
|
||||
ShowUninstDetails \e{hide|show|nevershow}
|
||||
\c hide|show|nevershow
|
||||
|
||||
Sets whether or not the details of the uninstall are shown. Can be 'hide' (the default) to hide the details by default, allowing the user to view them, or 'show' to show them by default, or 'nevershow', to prevent the user from ever seeing them. Note that sections can override this using SetDetailsView.
|
||||
Sets whether or not the details of the uninstall are shown. Can be 'hide' (the default) to hide the details by default, allowing the user to view them, or 'show' to show them by default, or 'nevershow', to prevent the user from ever seeing them. Note that sections can override this using SetDetailsView.
|
||||
|
||||
\H{asilentinstall} SilentInstall
|
||||
|
||||
SilentInstall \e{normal|silent|silentlog}
|
||||
\c normal|silent|silentlog
|
||||
|
||||
Specifies whether or not the installer should be silent. If it is 'silent' or 'silentlog', all sections are installed quietly, with no screen output from the installer itself (MessageBoxes are still displayed on error, and the script can still display whatever it wants). Note that if this is set to 'normal' and the user runs the installer with /S on the command line, it will behave as if SilentInstall 'silent' was used. Note: see also LogSet.
|
||||
|
||||
\H{asilentuninstall} SilentUnInstall
|
||||
|
||||
SilentUnInstall \e{normal|silent}
|
||||
\c normal|silent
|
||||
|
||||
Specifies whether or not the uninstaller should be silent.
|
||||
|
||||
\H{aspacetexts} SpaceTexts
|
||||
|
||||
SpaceTexts \e{[/LANG=lang_id] [req text] [avail text]}
|
||||
\c [/LANG=lang_id] [req text] [avail text]
|
||||
|
||||
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.
|
||||
|
||||
\H{asubcaption} SubCaption
|
||||
|
||||
SubCaption \e{[/LANG=lang_id] page_number subcaption}
|
||||
\c [/LANG=lang_id] page_number subcaption
|
||||
|
||||
Overrides the subcaptions for each of the installer pages (0=": License Agreement",1=": Installation Options",2=": Installation Directory", 3=": Installing Files", 4=": Completed"). If you specify an empty string (""), the default will be used (you can however specify " " to achieve a blank string)
|
||||
|
||||
\H{auninstallbuttontext} UninstallButtonText
|
||||
|
||||
UninstallButtonText \e{[/LANG=lang_id] [button text]}
|
||||
\c [/LANG=lang_id] [button 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 WriteUninstaller (replaces UninstallEXEName).
|
||||
|
||||
\H{auninstallcaption} UninstallCaption
|
||||
|
||||
UninstallCaption \e{[/LANG=lang_id] caption}
|
||||
\c [/LANG=lang_id] 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)
|
||||
|
||||
\H{auninstallicon} UninstallIcon
|
||||
|
||||
UninstallIcon \e{path_to_icon.ico}
|
||||
\c path_to_icon.ico
|
||||
|
||||
Sets the icon of the uninstaller.
|
||||
Sets the icon of the uninstaller.
|
||||
|
||||
\H{auninstallsubcaption} UninstallSubCaption
|
||||
|
||||
UninstallSubCaption \e{[/LANG=lang_id] page_number subcaption}
|
||||
\c [/LANG=lang_id] page_number subcaption
|
||||
|
||||
Overrides the subcaptions for each of the uninstaller pages (0=": Confirmation",1=": Uninstalling Files",2=": Completed"). If you specify an empty string (""), the default will be used (you can however specify " " to achieve a blank string)
|
||||
Overrides the subcaptions for each of the uninstaller pages (0=": Confirmation",1=": Uninstalling Files",2=": Completed"). If you specify an empty string (""), the default will be used (you can however specify " " to achieve a blank string)
|
||||
|
||||
\H{auninstalltext} UninstallText
|
||||
|
||||
UninstallText text \e{[/LANG=lang_id] [subtext]}
|
||||
\c t \e{[/LANG=lang_id] [subtext]
|
||||
|
||||
Specifies the text on the first page of the uninstaller. If subtext is specified and not empty, it will replace the default secondary text on that page, "Uninstall from:".
|
||||
|
||||
\H{awindowicon} WindowIcon
|
||||
|
||||
WindowIcon \e{on|off}
|
||||
\c on|off
|
||||
|
||||
Sets whether or not the installer's icon is in the upper left corner of the installer.
|
||||
|
||||
\H{axpstyle} XPStyle
|
||||
|
||||
XPStyle \e{on|off}
|
||||
\c on|off
|
||||
|
||||
Sets whether or not an XP manifest will be added to the installer. Default value is off. This affects the uninstaller too.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue