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

format updates

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@874 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
rainwater 2002-09-02 18:53:49 +00:00
parent 3ead7e15ef
commit adeca96bb7
5 changed files with 56 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

90
Docs/src/attributes.but
View file

@ -1,44 +1,46 @@
\A{attrib} Installer Attributes
\C{attrib} Script Reference
\H{instattribs} Installer 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.
\H{aaddbrandingimage} AddBrandingImage
\S{aaddbrandingimage} AddBrandingImage
AddBrandingImage \e{(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
\S{aallowrootdirinstall} AllowRootDirInstall
AllowRootDirInstall \e{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 \\\\server\\share as an install (and lataer on, uninstall) directory. For additional directory selection page customizability, see .onVerifyInstDir
\H{aautoclosewindow} AutoCloseWindow
\S{aautoclosewindow} AutoCloseWindow
AutoCloseWindow \e{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
\S{abggradient} BGGradient
BGGradient \e{[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
\S{abrandingtext} BrandingText
BrandingText \e{[/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
\S{acaption} Caption
Caption \e{[/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
\S{achangeui} ChangeUI
ChangeUI \e{dialog ui_file.exe}
@ -58,217 +60,217 @@ Replaces dialog (IDD_LICENSE, IDD_DIR, IDD_SELCOM, IDD_INST, IDD_INSTFILES or ID
\b IDD_VERIFY must contain IDC_STR (static).
\H{acompletedtext} CompletedText
\S{acompletedtext} CompletedText
CompletedText \e{[/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.
\H{acomponenttext} ComponentText
\S{acomponenttext} ComponentText
ComponentText \e{[/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 " ".
\H{acrccheck} CRCCheck
\S{acrccheck} CRCCheck
CRCCheck \e{on|off}
Specifies whether or not the installer will perform a CRC on itself before allowing an install. Valid options are 'on' and 'off'. Note that if the user uses /NCRC on the command line when executing the installer, the CRC will not occur, and the user will be allowed to install a (potentially) corrupted installer.
\H{adetailsbuttontext} DetailsButtonText
\S{adetailsbuttontext} DetailsButtonText
DetailsButtonText \e{[/LANG=lang_id] [show details text]}
Replaces the default details button text of "Show details", if parameter is specified (otherwise the default is used).
\H{adirshow} DirShow
\S{adirshow} DirShow
DirShow \e{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
\S{adirtext} DirText
DirText \e{[/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...").
\H{aenabledbitmap} EnabledBitmap
\S{aenabledbitmap} EnabledBitmap
EnabledBitmap \e{bitmap.bmp}
Sets the enabled state of the listbox for the component page. It MUST be a 16 color bitmap (it can be any size, but 20x20 is preferred -- all others will be resized down... poorly). DisabledBitmap bitmap.bmp Sets the disabled state of the listbox for the component page. It MUST be a 16 color bitmap (it can be any size, but 20x20 is preferred -- all others will be resized down... poorly).
\H{a} FileErrorText
\S{a} FileErrorText
FileErrorText \e{[/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.".
\H{ainstallbuttontext} InstallButtonText
\S{ainstallbuttontext} InstallButtonText
InstallButtonText \e{[/LANG=lang_id] [install button text]}
If parameter is specified, overrides the default install button text (of "Install") with the specified text.
\H{ainstallcolors} InstallColors
\S{ainstallcolors} InstallColors
InstallColors \e{/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.
\H{ainstalldir} InstallDir
\S{ainstalldir} InstallDir
InstallDir \e{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.
\H{ainstalldirregkey} InstallDirRegKey
\S{ainstalldirregkey} InstallDirRegKey
InstallDirRegKey \e{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.
\H{ainstprogressflags} InstProgressFlags
\S{ainstprogressflags} InstProgressFlags
InstProgressFlags \e{[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).
\H{ainsttype} InstType
\S{ainsttype} InstType
InstType \e{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.
\H{alicensebkcolor} LicenseBkColor
\S{alicensebkcolor} LicenseBkColor
LicenseBkColor \e{color}
Sets the background color of the license data.
\H{alicensedata} LicenseData
\S{alicensedata} LicenseData
LicenseData \e{[/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!)
\H{alicensetext} LicenseText
\S{alicensetext} LicenseText
LicenseText text \e{[/LANG=lang_id] [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".
\H{aloadlanguagefile} LoadLanguageFile
\S{aloadlanguagefile} LoadLanguageFile
LoadLanguageFile \e{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
\S{amiscbuttontext} MiscButtonText
MiscButtonText \e{[/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
\S{aname} Name
Name \e{[/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
\S{aicon} Icon
Icon \e{path_to_icon.ico}
Sets the icon of the installer. The icon MUST contain a 32x32 color icon resource (it can also contain other icons, but they will be discarded).
\H{aoutfile} OutFile
\S{aoutfile} OutFile
OutFile \e{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{asetfont} SetFont
\S{asetfont} SetFont
SetFont \e{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
\S{ashowinstdetails} ShowInstDetails
ShowInstDetails \e{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.
\H{ashowuninstdetails} ShowUninstDetails
\S{ashowuninstdetails} ShowUninstDetails
ShowUninstDetails \e{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.
\H{asilentinstall} SilentInstall
\S{asilentinstall} SilentInstall
SilentInstall \e{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
\S{asilentuninstall} SilentUnInstall
SilentUnInstall \e{normal|silent}
Specifies whether or not the uninstaller should be silent.
\H{aspacetexts} SpaceTexts
\S{aspacetexts} SpaceTexts
SpaceTexts \e{[/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).
\H{asubcaption} SubCaption
\S{asubcaption} SubCaption
SubCaption \e{[/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
\S{auninstallbuttontext} UninstallButtonText
UninstallButtonText \e{[/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
\S{auninstallcaption} UninstallCaption
UninstallCaption \e{[/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)
\H{auninstallicon} UninstallIcon
\S{auninstallicon} UninstallIcon
UninstallIcon \e{path_to_icon.ico}
Sets the icon of the uninstaller. Again, the icon MUST contain a 32x32x16 color icon resource (it can also contain other icons, but they will be discarded).
\H{auninstallsubcaption} UninstallSubCaption
\S{auninstallsubcaption} UninstallSubCaption
UninstallSubCaption \e{[/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)
\H{auninstalltext} UninstallText
\S{auninstalltext} UninstallText
UninstallText text \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
\S{awindowicon} WindowIcon
WindowIcon \e{on|off}
Sets whether or not the installer's icon is in the upper left corner of the installer.
\H{axpstyle} XPStyle
\S{axpstyle} XPStyle
XPStyle on|off

12
Docs/src/compilerflags.but
View file

@ -1,31 +1,31 @@
\A{compilerflags} Compiler Flags
\H{flags} Compiler Flags
The following commands change how the compiler generates code and compresses data. These commands are valid anywhere in the script, and effect every line below where each one is placed (until overriden by another command).
\H{asetoverwrite} SetOverwrite
\S{asetoverwrite} SetOverwrite
SetOverwrite \e{on|off|try|ifnewer}
This command sets the overwrite flag which is used by the File command to determine whether or not the file should overwrite any existing files that are present. If overwriteflag is 'on', files are overwritten (this is the default). If overwriteflag is 'off', files that are already present are not overwritten. If overwriteflag is 'try', files are overwritten if possible (meaning that if the file is not able to be written to, it is skipped without any user interaction). If overwriteflag is 'ifnewer', then files are only overwritten if the existing file is older than the new file (note that when in 'ifnewer' mode, the destination file's date is set, regardless of what SetDateSave is set to).
\H{asetcompress} SetCompress
\S{asetcompress} SetCompress
SetCompress \e{auto|force|off}
This command sets the compress flag which is used by the installer to determine whether or not data should be compressed. Typically the SetCompress flag will effect the commands after it, and the last SetCompress command in the file also determines whether or not the install info section and uninstall data of the installer is compressed. If compressflag is 'auto', then files are compressed if the compressed size is smaller than the uncompressed size. If compressflag is set to 'force', then the compressed version is always used. If compressflag is 'off' then compression is not used (which can be faster).
\H{asetcompressor} SetCompressor
\S{asetcompressor} SetCompressor
SetCompressor \e{zlib|bzip2}
This command sets the compression algorithm used to compress files/data in the installer. Options are ZLib or BZip2. ZLib uses deflate compression, which is very good. this mode uses the least amount of overhead on the runtime side, in terms of memory usage, disk footprint, and speed. BZip2 compression can be better than deflate, especially when using NSIS_COMPRESS_WHOLE. bzip2 is much slower to decompress, and uses a LOT more memory at runtime. The disk footprint using bzip2 is also approximately 1kb more than ZLib.
\H{asetdatablockoptimize} SetDatablockOptimize
\S{asetdatablockoptimize} SetDatablockOptimize
SetDatablockOptimize \e{on|off}
This command tells the compiler whether or not to do datablock optimizations. Datablock optimizations have the compiler check to see if any data being added to the data block is already in the data block, and if so, it is simply referenced as opposed to added (can save a little bit of size).
\H{asetdatesave} SetDateSave
\S{asetdatesave} SetDateSave
SetDateSave \e{on|off}

4
Docs/src/intro.but
View file

@ -2,7 +2,7 @@
NSIS is a free scriptable win32 installer/uninstaller system that doesn't suck and isn't huge.
\H{intro-about} About NSIS
\B{intro-about} About NSIS
NSIS tries to be a scriptable win32 installer/uninstaller system that doesn't suck and isn't huge.
@ -21,7 +21,7 @@ In order to make NSIS even more powerful than it already is, we have released it
The result of all of this is an installation system for win32 that lets you compile nice little scripts (which are text files, no wizards to slow you down) into tiny installers. Many features are supported, and the whole thing just works pretty damn well (at least, we think).
\H{intro-features} Main Features
\B{intro-features} Main Features
Here's a short list of some of NSIS' features.

2
Docs/src/script.but
View file

@ -1,4 +1,4 @@
\C{script} Script File Format
\U Script File Format
A NSIS Script File (.nsi) is just a text file with a series of commands.

2
Docs/src/usage.but
View file

@ -1,4 +1,4 @@
\C{usage} MakeNSIS Usage
\U MakeNSIS Usage
NSIS installers are generated by using the 'MakeNSIS' program to compile a NSIS script (.NSI) into an installer executable. The syntax of the makensis command is: