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

Docs updates. More to come.

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1050 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
rainwater 2002-09-19 16:31:22 +00:00
parent d266b5b004
commit 306ef235aa
11 changed files with 30 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Docs/src/attributes.but
View file

@ -74,9 +74,9 @@ Specifies a string that is above the component list. This can be something that
\S{acrccheck} CRCCheck
CRCCheck \e{on|off}
CRCCheck \e{on|off|force}
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.
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, the CRC will not occur, and the user will be allowed to install a (potentially) corrupted installer.
\S{adetailsbuttontext} DetailsButtonText
@ -96,12 +96,6 @@ 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...").
\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).
\S{a} FileErrorText
FileErrorText \e{[/LANG=lang_id] [file error text]}
@ -184,7 +178,7 @@ Sets the name of the installer. The name is usually simply the product name such
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).
Sets the icon of the installer.
\S{aoutfile} OutFile
@ -256,7 +250,7 @@ Sets what the titlebars of the uninstaller will display. By default, it is 'Name
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).
Sets the icon of the uninstaller.
\S{auninstallsubcaption} UninstallSubCaption

16
Docs/src/compiler.but
View file

@ -17,3 +17,19 @@ This command will change the compiler to the new directory, new_path. new_path c
\e{!packhdr tempfile command}
This option makes the compiler an external EXE packer (such as Petite or UPX) to compress the executable header. Specify a temporary file name (such as "temp.dat") and a command line (such as "C:\\program files\\upx\\upx -9 temp.dat") to compress the header.
\e{!echo message}
This command will echo a message to the user compiling the script.
\e{!warning [message]}
This command will issue a warning to the script compiler. You can also add a message to this warning.
\e{!error [message]}
This commnd will issue an error to the script compiler and will stop execution of the script. You can also add a message to this error.
\e{!verbose level}
This command will set the level of verbosity. 4=all, 3=no script, 2=no info, 1=no warnings, 0=none

1
Docs/src/compilerflags.but
View file

@ -3,6 +3,7 @@
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).
\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).

16
Docs/src/defines.but
View file

@ -32,22 +32,6 @@ This command closes a block started with !ifdef or !ifndef.
This command is the logical lovemonkey to !ifdef and !endif. !ifdef/!else/!endif, !ifdef/!else ifdef/!endif, !ifdef/!else ifdef/!else ifndef/!endif, etc. If ifdef or ifndef is specified as the first parameter, it behaves as expected.
\e{!echo message}
This command will echo a message to the user compiling the script.
\e{!warning [message]}
This command will issue a warning to the script compiler. You can also add a message to this warning.
\e{!error [message]}
This commnd will issue an error to the script compiler and will stop execution of the script. You can also add a message to this error.
\e{!verbose level}
This command will set the level of verbosity. 4=all, 3=no script, 2=no info, 1=no warnings, 0=none
\e{!macro macro_name [parameter][...]}
Creates a macro named 'macro_name'. All lines between the !macro and the !macroend will be saved. To insert the macro later on, use !insertmacro. Note that macros cannot contain other macro definitions (though they can insert other macros), or !ifdef/!else/!endif. !macro definitions can have one or more parameters defined. The parameters may be accessed the same way a !define would (i.e. $\{PARMNAME\}) from inside the macro.

2
Docs/src/intro.but
View file

@ -4,8 +4,6 @@ NSIS is a free scriptable win32 installer/uninstaller system that doesn't suck a
\B{intro-about} About NSIS
NSIS tries to be a scriptable win32 installer/uninstaller system that doesn't suck and isn't huge.
NSIS exists largely because of the need to distribute Winamp.
In the beginning, Winamp was distributed as a simple .ZIP file (see Winamp 1.0).

2
Docs/src/misc.but
View file

@ -62,6 +62,6 @@ Sets the context of $SMPROGRAMS and other shell folders. If set to 'current' (th
\S{CreateFont} CreateFont
CreateFont \e{user_var(handle output) face_name [height weight /ITALIC /UNDERLINE /STRIKE]}
CreateFont \e{user_var(handle output) face_name [height] [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]}
Creates a font and puts its handle into user_var. For more information about the different parameters have a look at MSDN's page about the Win32 API function CreateFont().

1
Docs/src/registry.but
View file

@ -1,6 +1,7 @@
\H{registry} Registry, INI, File Instructions
\S{writeregstr} WriteRegStr
WriteRegStr \e{root_key subkey key_name value}
WriteRegExpandStr \e{root_key subkey key_name value}

2
Docs/src/sec.but
View file

@ -16,7 +16,7 @@ Retrieves the section's flags. See above for a description of the flag. The erro
SectionSetText \e{section_index section_text}
Sets the description for the section section_index. The error flag will be set if an out of range section is specified.
Sets the description for the section section_index. To set a subsection, you must use - at the beginning of the text. The error flag will be set if an out of range section is specified.
\S{SectionGetText} SectionGetText

2
Docs/src/string.but
View file

@ -2,7 +2,7 @@
\S{StrCpy} StrCpy
StrCpy \e{user_var(destination) str[maxlen] [start_offset]}
StrCpy \e{user_var(destination) str [maxlen] [start_offset]}
Sets the user variable $x with str. Note that str can contain other variables, or the user variable being set (concatenating strings this way is possible, etc). If maxlen is specified, the string will be a maximum of maxlen characters (if maxlen is negative, the string will be truncated abs(maxlen) characters from the end). If start_offset is specified, the source is offset by it (if start_offset is negative, it will start abs(start_offset) from the end of the string).

7
Docs/src/var.but
View file

@ -42,6 +42,10 @@ The windows desktop directory (usually C:\\windows\\desktop but detected at runt
The location of the installer executable. (technically you can modify this variable, but it is probably not a good idea)
\e{$\{NSISDIR\}}
A symbol that contains the path where NSIS is installed.
\e{$WINDIR}
The windows directory (usually C:\\windows or C:\\winnt but detected at runtime)
@ -92,6 +96,3 @@ Use to represent a newline (\\n).
Where SYMBOL is the name of something globally defined, this will be replaced with the value of that symbol. If the symbol is not defined, no replace occurs (i.e. if $\{POOP\} is encountered, and POOP is not defined, $\{POOP\} is output).
\e{$\{NSISDIR\}}
A symbol contains the path where NSIS is installed.

2
Docs/style.css
View file

@ -4,7 +4,7 @@ body {
}
pre {
font-family: Courier New;
background-color: #E9E9E9;
background-color: #F7F7F7;
padding: 1px;
}
a,a:visisted {