implemented RFE #1240601 - documentation of command line switches

git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@4187 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
kichik 2005-07-23 10:29:14 +00:00
parent f59e845e56
commit 4a6fb3bfad

View file

@ -1,4 +1,6 @@
\C{usage} MakeNSIS Usage
\C{cmdlineusage} Command Line Usage
\H{usage} MakeNSIS Usage
NSIS installers are generated by using the 'MakeNSIS' program to compile a NSIS script (.NSI) into an installer executable.
The NSIS development kit installer sets up your computer so that you can compile a .nsi file by simply right-clicking on it in explorer, and selecting 'compile'.
@ -7,7 +9,7 @@ If you want to use MakeNSIS on the command line, the syntax of the makensis comm
\c makensis [option | script.nsi | - [...]]
\H{usagereference} Options
\S1{usagereference} Options
\b /LICENSE displays a keen license page.
@ -31,13 +33,13 @@ If you want to use MakeNSIS on the command line, the syntax of the makensis comm
\b Specifying a dash (-) for the script name will tell makensis to use the standard input as a source.
\H{usagenotes} Notes
\S1{usagenotes} Notes
\b Parameters are processed by order. \c{makensis /Ddef script.nsi} is not the same as \c{makensis script.nsi /Ddef}.
\b If multiple scripts are specified, they are treated as one concatenated script.
\H{usageexamples} Examples
\S1{usageexamples} Examples
Basic usage:
@ -58,3 +60,34 @@ Change script behavior:
Parameters order:
\c makensis /XSection sectioncontents.nsi /XSectionEnd
\H{installerusage} Installer Usage
Generated installers and uninstallers accept a few options on the command line. These options give the user a bit more control over the installation process.
\S1{} Common Options
\b /NCRC disables the CRC check, unless \c{\R{acrccheck}{CRCCheck} force} was used in the script.
\b /S runs the installer or uninstaller silently. See \k{silent} for more information.
\b /D sets the default installation directory (\R{varother}{$INSTDIR}), overriding \R{ainstalldir}{InstallDir} and \R{ainstalldirregkey}{InstallDirRegKey}. It must be the last parameter used in the command line and must not contain any quotes, even if the path contains spaces.
\S1{} Uninstaller Specific Options
\b _?= sets $INSTDIR. It also stops the uninstaller from copying itself to the temporary directory and running from there. It can be used along with \R{execwait}{ExecWait} to wait for the uninstaller to finish. It must be the last parameter used in the command line and must not contain any quotes, even if the path contains spaces.
\S1{} Examples
\c installer.exe /NCRC
\c installer.exe /S
\c installer.exe /D=C:\Program Files\NSIS
\c installer.exe /NCRC /S /D=C:\Program Files\NSIS
\c uninstaller.exe /S _?=C:\Program Files\NSIS
\c # uninstall old version
\c ExecWait '"$INSTDIR\uninstaller.exe" /S _?=$INSTDIR'