Updated docs

git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1248 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
rainwater 2002-10-01 13:53:23 +00:00
parent c7a681751a
commit a3676511e6
24 changed files with 673 additions and 676 deletions

View file

@ -1,4 +1,4 @@
\H{sections} Sections
\C{sections} Sections
Each NSIS installer contains one or more Sections. Each These sections are created, modified, and ended with the following commands.
@ -8,42 +8,39 @@ Each NSIS installer contains one or more Sections. Each These sections are creat
\b If a section's name is 'Uninstall', then it is a special Uninstall Section.
\S{ssection} Section
Section \e{([/e] [section_name] [section index output]}
Begins annd opens a new section. If section_name is empty, omitted, or begins with a -, then it is a required section and the user will not see it, nor have the option of disabling it. If the section name is 'Uninstall', then it is a special Uninstall Section. If section index output is specified, the parameter will be !defined with the section index (that can be used for SectionSetText etc. If the section name begins with a !, the section will be displayed as bold. If /e is present, the sub sections of the section will be expanded by default.
\S{ssectionin} SectionIn
SectionIn \e{insttype_index [insttype_index] [RO]}
This command specifies which Install Types (see InstType) the current section defaults to the enabled state in. Multiple SectionIn commands can be specified (they are combined). If you specify RO as a parameter, then the section will be Read-Only, meaning it will always be set to install.
\S{ssectionend} SectionEnd
SectionEnd
This command closes the current open section.
\S{ssubsection} SubSection
SubSection \e{[/e] Caption}
This command inserts a subsection. The subsection must be close with SubSectionEnd, and should contain 1 or more Sections. If the subsection name begins with a !, the subsection will be displayed as bold. If /e is present, the sub sections of the sub section will be expanded by default.
\S{ssubsectionend} SubSectionEnd
SubSectionEnd
Closes a subsection opened with SubSection.
\S{saddsize} AddSize
\H{saddsize} AddSize
AddSize \e{size_kb}
Tells the installer that the current section needs an additional "size_kb" kilobytes of disk space. Only valid within a section (will have no effect outside of a section or in a function).
\H{ssection} Section
Section \e{([/e] [section_name] [section index output]}
Begins annd opens a new section. If section_name is empty, omitted, or begins with a -, then it is a required section and the user will not see it, nor have the option of disabling it. If the section name is 'Uninstall', then it is a special Uninstall Section. If section index output is specified, the parameter will be !defined with the section index (that can be used for SectionSetText etc. If the section name begins with a !, the section will be displayed as bold. If /e is present, the sub sections of the section will be expanded by default.
\H{ssectionend} SectionEnd
SectionEnd
This command closes the current open section.
\H{ssectionin} SectionIn
SectionIn \e{insttype_index [insttype_index] [RO]}
This command specifies which Install Types (see InstType) the current section defaults to the enabled state in. Multiple SectionIn commands can be specified (they are combined). If you specify RO as a parameter, then the section will be Read-Only, meaning it will always be set to install.
\H{ssubsection} SubSection
SubSection \e{[/e] Caption}
This command inserts a subsection. The subsection must be close with SubSectionEnd, and should contain 1 or more Sections. If the subsection name begins with a !, the subsection will be displayed as bold. If /e is present, the sub sections of the sub section will be expanded by default.
\H{ssubsectionend} SubSectionEnd
SubSectionEnd
Closes a subsection opened with SubSection.