git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@3941 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
kichik 2005-03-29 20:57:16 +00:00
parent 99fd0223ab
commit 02c67b8a83
5 changed files with 14 additions and 13 deletions

View file

@ -3,7 +3,7 @@
\H{intro-about} About NSIS
An installer is the first experience of a user with your application.
Slow or unsuccesful software installations are the most irritating computer problems.
Slow or unsuccessful software installations are the most irritating computer problems.
A quick and user friendly installer is therefore an essential part of your software product.
NSIS (Nullsoft Scriptable Install System) is a tool that allows programmers to create such installers for Windows.
@ -11,7 +11,7 @@ It is released under an open source license and is \R{license}{completely free f
NSIS creates installers that are capable of installing, uninstalling, setting system settings, extracting files, etc.
Because it's based on script files, you can fully control every part of your installers.
The script language support variables, functions, string manipulation, just like a normal programming language - but designed for the creation of installers.
The script language supports variables, functions, string manipulation, just like a normal programming language - but designed for the creation of installers.
Even with all these features, NSIS is still the smallest installer system available. With the default options, it has an overhead of only 34 KB.
\H{intro-features} Main Features
@ -42,7 +42,7 @@ The script language provides commands you can use on the target system. From sim
\\<b\\>Custom dialogs and interfaces\\</b\\>
You can create custom wizard pages to get user input or integrate configuration options. NSIS includes a classic and modern wizard interface, but it is even possible to create a own custom interface.
You can create custom wizard pages to get user input or integrate configuration options. NSIS includes a classic and modern wizard interface, but it is even possible to create your own custom interface.
\\<b\\>Plug-in system\\</b\\>
@ -58,7 +58,7 @@ The NSIS compiler features a powerful preprocessor. This allows you to easily in
\\<b\\>Easy and human readable file formats\\</b\\>
The NSIS script format and the format used for interface dialogs are easy, documented and human readable, so you can edit your files with your favorite editor. This also makes automatic script generation possible.
The NSIS script format and the format used for interface dialogs are easy, documented and humanly readable, so you can edit your files with your favorite editor. This also makes automatic script generation possible.
\H{intro-featurelist} Feature List

View file

@ -24,7 +24,7 @@ Lines beginning with ; or # are comments. You can put comments after commands. Y
\c
\c File "myfile" ; Comment
If want a parameter to start with ; or # put it in quotes.
If you want a parameter to start with ; or # put it in quotes.
\\<b\\>Plug-ins\\</b\\>
@ -71,7 +71,7 @@ Variables start with $. User variables should be declared and are case-sensitive
\\<b\\>Long commands\\</b\\>
To extend a command over multiple lines, use a backslash (\\) at the end of the line, and the next line will effectively be concatenated the end of it. For example:
To extend a command over multiple lines, use a backslash (\\) at the end of the line. The next line will effectively be concatenated to the end of it. For example:
\c CreateShortCut "$SMPROGRAMS\NSIS\ZIP2EXE project workspace.lnk" \
\c "$INSTDIR\source\zip2exe\zip2exe.dsw"

View file

@ -148,6 +148,7 @@ Another common use is macros. Macros are used to insert code on compile time, de
\c ReadRegStr $0 HKLM Software\MyProgram key
\c DetailPrint $0
\c FunctionEnd
\c !macroend
\c
\c !insertmacro MyFunc ""
\c !insertmacro MyFunc "un."
@ -162,7 +163,7 @@ The second thing you need to do in order to create your installer after you have
To compile you have to right-click your .nsi file and select Compile NSIS Script. This will cause MakeNSISW, the NSIS Compiler Interface, to launch and call MakeNSIS to compile your script. MakeNSISW will get the output of MakeNSIS and present it to you in a window where you can see it, copy it, test the installer, browse for it and more. Using makensis.exe from the command prompt is also possible.
The compiler will check your script and give you warnings or an error. If an errors occurs (i.e. 2 parameters required but only 1 given) the compiler will abort and a short error message including the line number will be displayed. For non-critical error the compiler will give a warning (i.e. two DirText commands in one script). If your script has no errors the compiler will output an installer for you to distribute.
The compiler will check your script and give you warnings or an error. If an error occurs (i.e. 2 parameters required but only 1 given) the compiler will abort and a short error message including the line number will be displayed. For non-critical errors the compiler will give a warning (i.e. two DirText commands in one script). If your script has no errors the compiler will output an installer for you to distribute.
NSIS supports different compression methods, as explained \R{asetcompressor}{here}. ZLIB is the default compression method, which is fast and uses only a little bit of memory. LZMA is a good method for the creation of small installers for internet distribution. BZIP2 usually compresses better than ZLIB but not as good as LZMA, it is useful if you need lower memory usage or fast script compilation.
@ -192,7 +193,7 @@ The plug-ins that NSIS knows of are listed at the top of the output of the compi
The NSIS distribution already included many plug-ins. \L{../Contrib/InstallOptions/Readme.html}{InstallOptions} is a popular plug-in that allows you to create custom pages, in combination with the NSIS Page commands (See \R{pages}{Pages}). The \L{../Contrib/StartMenu/Readme.txt}{Startmenu plug-in} provides a page that allows the user to choose a Start Menu folder. There are a lot of plug-ins for different purposes, have a look at the \L{../Contrib/}{Contrib folder} for help files and examples. You can find additional plug-ins on-line: \W{http://nsis.sf.net/archive/}{NSIS Archive}.
You can also create a plug-in in yourself. C/C++ and Delphi header files are already available, see \L{../Contrib/ExDLL}{ExDLL} for a basic plug-in example. Source code of included plug-ins can also be found in the \L{../Contrib/}{Contrib folder}.
You can also create a plug-in yourself. C/C++ and Delphi header files are already available, see \L{../Contrib/ExDLL}{ExDLL} for a basic plug-in example. Source code of included plug-ins can also be found in the \L{../Contrib/}{Contrib folder}.
\H{tutmore} More

View file

@ -23,7 +23,7 @@ If you want to use MakeNSIS on the command line, the syntax of the makensis comm
\b /HDRINFO prints out information on what options were used to compile makensis was compiled with.
\b /NOCD disabled the current directory change to that of the .nsi file
\b /NOCD disables the current directory change to that of the .nsi file
\b Using the /D switch one or more times will add to symbols to the globally defined list (See !define).

View file

@ -64,7 +64,7 @@ The windows desktop directory (usually C:\\windows\\desktop but detected at runt
\e{$EXEDIR}
The location of the installer executable. (technically you can modify this variable, but it is probably not a good idea)
The location of the installer executable (technically you can modify this variable, but it is probably not a good idea).
\e{$\{NSISDIR\}}
@ -72,15 +72,15 @@ A symbol that contains the path where NSIS is installed. Detected at compile tim
\e{$WINDIR}
The windows directory (usually C:\\windows or C:\\winnt but detected at runtime)
The windows directory (usually C:\\windows or C:\\winnt but detected at runtime).
\e{$SYSDIR}
The windows system directory (usually C:\\windows\\system or C:\\winnt\\system32 but detected at runtime)
The windows system directory (usually C:\\windows\\system or C:\\winnt\\system32 but detected at runtime).
\e{$TEMP}
The system temporary directory (usually C:\\windows\\temp but detected at runtime)
The system temporary directory (usually C:\\windows\\temp but detected at runtime).
\e{$STARTMENU}