NSIS Docs - Table of Contents

Index

Chapter 1 - Introduction to NSIS
Chapter 2 - Tutorial: The Basics
- 2.1 - Introduction
- 2.2 - Script Files
- 2.3 - Scripting structure
  - 2.3.1 - Installer Attributes
  - 2.3.2 - Pages
  - 2.3.3 - Sections
  - 2.3.4 - Functions
  - 2.3.5 - Working with Scripts
    - 2.3.5.1 - Variables
    - 2.3.5.2 - Debugging Scripts
  - 2.3.6 - Compiler Commands
- 2.4 - Compiler
- 2.5 - Modern UI
- 2.6 - Plug-ins
- 2.7 - More
Chapter 3 - MakeNSIS Usage
Chapter 4 - Scripting Reference
- 4.1 - Script File Format
- 4.2 - Variables
  - 4.2.1 - User Variables
    - 4.2.1.1 - Var
  - 4.2.2 - Other Writable Variables
  - 4.2.3 - Constant Variables
  - 4.2.4 - Variables Used in Strings
- 4.3 - Labels
- 4.4 - Relative Jumps
- 4.5 - Pages
  - 4.5.1 - Ordering
  - 4.5.2 - Page Options
  - 4.5.3 - Callbacks
  - 4.5.4 - Page
  - 4.5.5 - UninstPage
  - 4.5.6 - PageEx
  - 4.5.7 - PageExEnd
  - 4.5.8 - PageCallbacks
- 4.6 - Sections
  - 4.6.1 - Section Commands
    - 4.6.1.1 - AddSize
    - 4.6.1.2 - Section
    - 4.6.1.3 - SectionEnd
    - 4.6.1.4 - SectionIn
    - 4.6.1.5 - SubSection
    - 4.6.1.6 - SubSectionEnd
  - 4.6.2 - Uninstall Section
- 4.7 - Functions
  - 4.7.1 - Function Commands
    - 4.7.1.1 - Function
    - 4.7.1.2 - FunctionEnd
  - 4.7.2 - Callback Functions
    - 4.7.2.1 - Install Callbacks
      - 4.7.2.1.1 - .onGUIInit
      - 4.7.2.1.2 - .onInit
      - 4.7.2.1.3 - .onInstFailed
      - 4.7.2.1.4 - .onInstSuccess
      - 4.7.2.1.5 - .onGUIEnd
      - 4.7.2.1.6 - .onMouseOverSection
      - 4.7.2.1.7 - .onSelChange
      - 4.7.2.1.8 - .onUserAbort
      - 4.7.2.1.9 - .onVerifyInstDir
    - 4.7.2.2 - Uninstall Callbacks
      - 4.7.2.2.1 - un.onGUIInit
      - 4.7.2.2.2 - un.onInit
      - 4.7.2.2.3 - un.onUninstFailed
      - 4.7.2.2.4 - un.onUninstSuccess
      - 4.7.2.2.5 - un.onGUIEnd
      - 4.7.2.2.6 - un.onUserAbort
- 4.8 - Installer Attributes
  - 4.8.1 - General Attributes
    - 4.8.1.1 - AddBrandingImage
    - 4.8.1.2 - AllowRootDirInstall
    - 4.8.1.3 - AutoCloseWindow
    - 4.8.1.4 - BGGradient
    - 4.8.1.5 - BrandingText
    - 4.8.1.6 - Caption
    - 4.8.1.7 - ChangeUI
    - 4.8.1.8 - CheckBitmap
    - 4.8.1.9 - CompletedText
    - 4.8.1.10 - ComponentText
    - 4.8.1.11 - CRCCheck
    - 4.8.1.12 - DetailsButtonText
    - 4.8.1.13 - DirShow
    - 4.8.1.14 - DirText
    - 4.8.1.15 - DirVar
    - 4.8.1.16 - FileErrorText
    - 4.8.1.17 - Icon
    - 4.8.1.18 - InstallButtonText
    - 4.8.1.19 - InstallColors
    - 4.8.1.20 - InstallDir
    - 4.8.1.21 - InstallDirRegKey
    - 4.8.1.22 - InstProgressFlags
    - 4.8.1.23 - InstType
    - 4.8.1.24 - LicenseBkColor
    - 4.8.1.25 - LicenseData
    - 4.8.1.26 - LicenseForceSelection
    - 4.8.1.27 - LicenseText
    - 4.8.1.28 - MiscButtonText
    - 4.8.1.29 - Name
    - 4.8.1.30 - OutFile
    - 4.8.1.31 - SetFont
    - 4.8.1.32 - ShowInstDetails
    - 4.8.1.33 - ShowUninstDetails
    - 4.8.1.34 - SilentInstall
    - 4.8.1.35 - SilentUnInstall
    - 4.8.1.36 - SpaceTexts
    - 4.8.1.37 - SubCaption
    - 4.8.1.38 - UninstallButtonText
    - 4.8.1.39 - UninstallCaption
    - 4.8.1.40 - UninstallIcon
    - 4.8.1.41 - UninstallSubCaption
    - 4.8.1.42 - UninstallText
    - 4.8.1.43 - WindowIcon
    - 4.8.1.44 - XPStyle
  - 4.8.2 - Compiler Flags
    - 4.8.2.1 - AllowSkipFiles
    - 4.8.2.2 - FileBufSize
    - 4.8.2.3 - SetCompress
    - 4.8.2.4 - SetCompressor
    - 4.8.2.5 - SetDatablockOptimize
    - 4.8.2.6 - SetDateSave
    - 4.8.2.7 - SetOverwrite
    - 4.8.2.8 - SetPluginUnload
  - 4.8.3 - Version Information
    - 4.8.3.1 - VIAddVersionKey
    - 4.8.3.2 - VIProductVersion
- 4.9 - Instructions
  - 4.9.1 - Basic Instructions
    - 4.9.1.1 - Delete
    - 4.9.1.2 - Exec
    - 4.9.1.3 - ExecShell
    - 4.9.1.4 - ExecWait
    - 4.9.1.5 - File
    - 4.9.1.6 - Rename
    - 4.9.1.7 - ReserveFile
    - 4.9.1.8 - RMDir
    - 4.9.1.9 - SetOutPath
  - 4.9.2 - Registry, INI, File Instructions
    - 4.9.2.1 - DeleteINISec
    - 4.9.2.2 - DeleteINIStr
    - 4.9.2.3 - DeleteRegKey
    - 4.9.2.4 - DeleteRegValue
    - 4.9.2.5 - EnumRegKey
    - 4.9.2.6 - EnumRegValue
    - 4.9.2.7 - ExpandEnvStrings
    - 4.9.2.8 - FlushINI
    - 4.9.2.9 - ReadEnvStr
    - 4.9.2.10 - ReadINIStr
    - 4.9.2.11 - ReadRegDWORD
    - 4.9.2.12 - ReadRegStr
    - 4.9.2.13 - WriteINIStr
    - 4.9.2.14 - WriteRegBin
    - 4.9.2.15 - WriteRegDWORD
    - 4.9.2.16 - WriteRegStr
  - 4.9.3 - General Purpose Instructions
    - 4.9.3.1 - CallInstDLL
    - 4.9.3.2 - CopyFiles
    - 4.9.3.3 - CreateDirectory
    - 4.9.3.4 - CreateShortCut
    - 4.9.3.5 - GetDLLVersion
    - 4.9.3.6 - GetDLLVersionLocal
    - 4.9.3.7 - GetFileTime
    - 4.9.3.8 - GetFileTimeLocal
    - 4.9.3.9 - GetFullPathName
    - 4.9.3.10 - GetTempFileName
    - 4.9.3.11 - SearchPath
    - 4.9.3.12 - SetFileAttributes
    - 4.9.3.13 - RegDLL
    - 4.9.3.14 - UnRegDLL
  - 4.9.4 - Flow Control Instructions
    - 4.9.4.1 - Abort
    - 4.9.4.2 - Call
    - 4.9.4.3 - ClearErrors
    - 4.9.4.4 - GetCurrentAddress
    - 4.9.4.5 - GetFunctionAddress
    - 4.9.4.6 - GetLabelAddress
    - 4.9.4.7 - Goto
    - 4.9.4.8 - IfAbort
    - 4.9.4.9 - IfErrors
    - 4.9.4.10 - IfFileExists
    - 4.9.4.11 - IfRebootFlag
    - 4.9.4.12 - IfSilent
    - 4.9.4.13 - IntCmp
    - 4.9.4.14 - IntCmpU
    - 4.9.4.15 - MessageBox
    - 4.9.4.16 - Return
    - 4.9.4.17 - Quit
    - 4.9.4.18 - SetErrors
    - 4.9.4.19 - StrCmp
  - 4.9.5 - File Instructions
    - 4.9.5.1 - FileClose
    - 4.9.5.2 - FileOpen
    - 4.9.5.3 - FileRead
    - 4.9.5.4 - FileReadByte
    - 4.9.5.5 - FileSeek
    - 4.9.5.6 - FileWrite
    - 4.9.5.7 - FileWriteByte
    - 4.9.5.8 - FindClose
    - 4.9.5.9 - FindFirst
    - 4.9.5.10 - FindNext
  - 4.9.6 - Uninstaller Instructions
    - 4.9.6.1 - WriteUninstaller
  - 4.9.7 - Miscellaneous Instructions
    - 4.9.7.1 - InitPluginsDir
    - 4.9.7.2 - SetShellVarContext
    - 4.9.7.3 - Sleep
  - 4.9.8 - String Manipulation Instructions
    - 4.9.8.1 - StrCpy
    - 4.9.8.2 - StrLen
  - 4.9.9 - Stack Support
    - 4.9.9.1 - Exch
    - 4.9.9.2 - Pop
    - 4.9.9.3 - Push
  - 4.9.10 - Integer Support
    - 4.9.10.1 - IntFmt
    - 4.9.10.2 - IntOp
  - 4.9.11 - Reboot Instructions
    - 4.9.11.1 - Reboot
    - 4.9.11.2 - SetRebootFlag
  - 4.9.12 - Install Logging Instructions
    - 4.9.12.1 - LogSet
    - 4.9.12.2 - LogText
  - 4.9.13 - Section Management
    - 4.9.13.1 - SectionSetFlags
    - 4.9.13.2 - SectionGetFlags
    - 4.9.13.3 - SectionSetText
    - 4.9.13.4 - SectionGetText
    - 4.9.13.5 - SectionSetInstTypes
    - 4.9.13.6 - SectionGetInstTypes
    - 4.9.13.7 - SectionSetSize
    - 4.9.13.8 - SectionGetSize
    - 4.9.13.9 - SetCurInstType
    - 4.9.13.10 - GetCurInstType
    - 4.9.13.11 - InstTypeSetText
    - 4.9.13.12 - InstTypeGetText
  - 4.9.14 - User Interface Instructions
    - 4.9.14.1 - BringToFront
    - 4.9.14.2 - CreateFont
    - 4.9.14.3 - DetailPrint
    - 4.9.14.4 - EnableWindow
    - 4.9.14.5 - FindWindow
    - 4.9.14.6 - GetDlgItem
    - 4.9.14.7 - HideWindow
    - 4.9.14.8 - IsWindow
    - 4.9.14.9 - SendMessage
    - 4.9.14.10 - SetAutoClose
    - 4.9.14.11 - SetBrandingImage
    - 4.9.14.12 - SetDetailsView
    - 4.9.14.13 - SetDetailsPrint
    - 4.9.14.14 - SetCtlColors
    - 4.9.14.15 - SetSilent
    - 4.9.14.16 - ShowWindow
  - 4.9.15 - Multiple Languages Instructions
    - 4.9.15.1 - LoadLanguageFile
    - 4.9.15.2 - LangString
    - 4.9.15.3 - LicenseLangString
- 4.10 - Multiple Languages
  - 4.10.1 - Language Selection
  - 4.10.2 - LangDLL Plug-in
  - 4.10.3 - RTL Languages
- 4.11 - Plugin DLLs
  - 4.11.1 - Using Plugin Commands
  - 4.11.2 - Disabling Plugin Unloading
Chapter 5 - Compile Time Commands
- 5.1 - Compiler Utility Commands
  - 5.1.1 - !include
  - 5.1.2 - !addincludedir
  - 5.1.3 - !addplugindir
  - 5.1.4 - !cd
  - 5.1.5 - !echo
  - 5.1.6 - !error
  - 5.1.7 - !packhdr
  - 5.1.8 - !system
  - 5.1.9 - !warning
  - 5.1.10 - !verbose
- 5.2 - Predefines
  - 5.2.1 - ${__FILE__}
  - 5.2.2 - ${__LINE__}
  - 5.2.3 - ${__DATE__}
  - 5.2.4 - ${__TIME__}
  - 5.2.5 - ${__TIMESTAMP__}
- 5.3 - Conditional Compilation
  - 5.3.1 - !define
  - 5.3.2 - !ifdef
  - 5.3.3 - !ifndef
  - 5.3.4 - !else
  - 5.3.5 - !endif
  - 5.3.6 - !insertmacro
  - 5.3.7 - !macro
  - 5.3.8 - !macroend
  - 5.3.9 - !undef
Appendix A - Modern User Interface
Appendix B - Useful Functions
- B.1 - Get parent directory
- B.2 - Trim newlines
- B.3 - Get command line parameters
- B.4 - Search in a string
- B.5 - Get Windows version
- B.6 - Get Internet Explorer version
- B.7 - Is .NET Framework installed?
- B.8 - Is Macromedia Flash Player installed?
- B.9 - Add a shared DLL
- B.10 - Remove a shared DLL
- B.11 - Upgrade a DLL (macro)
- B.12 - Connect to the internet
- B.13 - More
Appendix C - Useful Information
- C.1 - Compiling NSIS Sources
- C.2 - Error Levels
- C.3 - Add uninstall information to Add/Remove Programs
- C.4 - How to install the VB6 runtimes
- C.5 - Calling an external DLL using the System.dll plugin
- C.6 - Dump Content of Log Window to File
- C.7 - How to Read REG_MULTI_SZ Values
Appendix D - Changelog and Release Notes
Appendix E - Credits
- E.1 - Programmers
- E.2 - Designers
- E.3 - Translators
- E.4 - Writers
Appendix F - NSIS License

^ Top