Back to Contents Page
INI Customization for Setup Package: XGI User's Guide
Introduction
Outlook and Initialization for Setup
The Maintenance of the Setup - [Start]
2D Customization
INF Customization
The following is the exposition for Setup customization with setup.ini. Three sections in setup.ini: [StartUp], [Start] and [INFCustom] record all information about the definition of setup outlook, the property of the installing components, INF customization.
Outlook for Setup Initialization I - [Startup]
[Startup] section display a custom startup graphic during setup initialization.
- INI Description
[Startup]
AppName=XGI VGA Package
#ProductName="Volari Z7"
#BKColor="BLACK"
#ResDir="340"
SmallProgress=N
;CMDLINE=
[Constant]
Dev_XG20 = VEN_18CA&DEV_0020
- How to customize
AppName =the package name.
ProductName=the product name.
BKColor = Background Color for InstallShield installation. Six colors can be chosen from, which are GREEN, RED, BLUE, GREEN, YELLOW, MAGENTA.
ResDir = The name of the folder under package, which contains bitmaps for InstallShield installation.
SmallProgress = Y means to display the small initialization dialog of the setup program; N is opposite.
The symbol "#" uses when different command lines use the same keyword, ex. ProductName, the setup will follow the command line matched the flag condition, ex. "%Dev_340%" .
Note that "^" and "|" are Boolean operator. "^" means AND; "|" means OR.
Outlook for Setup Initialization II- [Languages]
[Languages] section displays a custom language before setup.
- INI Description
[Languages]
Default=0x0009
count=19
key0=0x0804
key1=0x0404
key2=0x0006
key3=0x0013
key4=0x0009
key5=0x000b
key6=0x0c0c
key7=0x040c
key8=0x0007
key9=0x0010
key10=0x0011
key11=0x0012
key12=0x0014
key13=0x0416
key14=0x0816
key15=0x0019
key16=0x000a
key17=0x001d
key18=0x001e
RequireExactLangMatch=0x0804,0x0404
- How to customize
- Keyword defined in [Languages]
Default = the default language ID.
Key NO.= the supported language ID by InstallShield.
At the beginning of the installation, InstallShield engine detects the target
system's language. If you selected more than one supported language when you
built your setup in this section and one of those languages matches the target
system's language, InstallShield engine sets the language during the
installation is the target system's language.
If the target system's language is not present in your setup, i.e. it is not
listed in the setup.ini, InstallShield engine launches the setup with the
default language. Note that that you can choose any language as the default
before launching the setup program by modifying setup.ini.
We support totally 19 different languages and usually set English to be the
default language. You can customize the supported languages in this section.
The following list is the IDs corresponding with its language.
Language |
ID |
Language |
ID |
CHINESE_PRC |
0x0804 |
JAPANESE |
0x0011 |
CHINESE_TAIWAN |
0x0404 |
KOREAN |
0x0012 |
DANISH
|
0x0006 |
NORWEGIAN |
0x0014 |
DUTCH |
0x0013 |
PORTUGUESE_BRAZILIAN |
0x0416 |
ENGLISH |
0x0009 |
PORTUGUESE_STANDARD |
0x0816 |
FINNISH |
0x000b |
RUSSIAN |
0x0019 |
FRENCH_CANADIAN |
0x0c0c |
SPANISH |
0x000a |
FRENCH_STANDARD |
0x040c |
SWEDISH |
0x001d |
GERMAN |
0x0007 |
THAI |
0x001e |
ITALIAN
|
0x0010 |
|
|
Outlook for Setup Initialization III- [Package]
[Package] section displays a custom graphic during setup.
- INI Description
[Package]
TitleColor=ORANGE
Version=1.00.01
INFNAME=xg20gr.inf
DisplayName="XGI Volair Z7"
Provider=XGI Technology Inc.
- How to customize
- Keyword defined in [Package]
TitleColor =The title color on the background during installation. Six colors are chosen from, which are GREEN, RED, BLUE, GREEN, YELLOW, MAGENTA.
Version= Package version.
Provider = The company name.
INFNAME = Specify the INF name.
DisplayName = Specify the display name on the Add/Remove program of control panel.
Dialog Customization during Setup- [Dialog]
[Dialog] section displays a custom dialog during installation.
- INI Description
[Dialog]
WelcomeDlg=1
PreVersioinDlg=0
SetupTypeDlg=0
SelectFolderDlg=0
StartCopyDlg=0
ReadMeFileDlg=0
FinishDlg=1
- How to customize
During setup, seven dialogs can be customized, which are WelcomeDlg,
PreVersioinDlg, SetupTypeDlg, SelectFolderDlg, StartCopyDlg, ReadMeFileDlg, FinishDlg. The following is the format.
WelcomeDlg = 1 : show the dialog during setup.
WelcomeDlg = 0 : do not show the dialog during setup.
Others are the same.
Device ID List - [DeviceID]
List all device ID and the setup will determine in the list which is(are) the current device(s).
- INI Description
[DeviceID]
; for XG20
"(VEN_18CA&DEV_0020)"
- How to customize
If there is a new device, follow the format to add the device ID.
[Start] section display the maintenance of setup. Except sections [Startup],
[Languages], [Package], [DeviceID], [INFCustom] and [Constant], other sections are branches of [Start] in SETUP.INI.
- INI Description
[Start]
AddComponent="[Driver]",,,, %InstallMode% ^ %SetupMode%
"[DrvGeneral]",,,, %InstallMode%
"[UtiGeneral]",,,, %InstallMode%
"[Customer]",,,, %InstallMode%
"[DefaultMode]",,,, %InstallMode% ^ %SetDefaultMode%
[Constant]
OS_NT = XGI_Win2000|XGI_WinXP|XGI_WinNET
; About INF customization
InstallMode = @Install_Mode
SetupMode = @Setup_Mode
; Others
SetDefaultMode = 0
How to customize
- Keyword defined in [Start]
AddComponent =Specify the component section name .If the flagged condition is obeyed, the setup will execute by the director of the section. As for the detail
format of the component section, see The Format of Component Section.
- Flags defined in [Constant]
SetupMode="SetupMode" means where the "Setup" is triggered from and @Setup_Mode will be replaced in constant (0 or 1) during installation.
0 mean that "Setup" is triggered from INF.
1 mean that "Setup" is triggered from "Setup.exe".
InstallMode="InstallMode" means the current install mode and @Install_Mode will be replaced in constant (0 or 1) during installation.
0 mean that the current install is in INF.
1 mean that the current install is in "Setup", i.e. InstallShield.
OS_NT:
Require the platform of the target operating system to consist with the flag.
Others like "InstallWallpaper" or "InstallDirectX" and so forth are set to 0 or 1.
1 means to execute the section or install the component by the director of the section.
0 otherwise.
Note that "^ ", "!" and "|" are Boolean operator. "^" means AND; "|" means OR; "!" means NOT.
Component Section
- The Format of Component Section
The assigned section adds for the keyword "AddComponent" and it has the format to customize. By using the following example makes a
description for the format.
- INI Description
[Start]
AddComponent=[Group]
AddComponent =[Component2]
[Group]
ID= Group
Name= Group
Description="This component contains all utilities. "
Display=1
Select=7
AddComponent ="[Group.Component1]"
[Group.Component1]
ID= Group. Component1
Name= Component1
Description="This utility changes the resolution, frame rate, color, and etc."
Display=1
Select=5
File="%Des5%\xgiapp.dll"
PageEnable=1
CopyFile="[FileCopy. Component1]"
WriteReg="[RegWrite. Component1]", "%OS_9X%"
DeleteReg="[DeleteReg. Component1]"
- How to customize
ID = Specify ID which should be consistent with InstallShield.
Name = Specify the name which can be displayed on the icon.
Description = String that displays in the StartCopyDlg when installing the component.
Display=Set 0 or1 to determine whether the component displays in the component dialog. 1 means display and 0 means otherwise.
Select=Default selection type value. You can change selection status (Typical, Compact or Custom) in constant (0~7) for displaying components in component dialogs.
0 : Select nothing
1 : Typical
2 : Compact
3 : Typical, Compact
4 : Custom
5 : Typical, Custom
6 : Compact, Custom
7 : Typical, Compact, Custom
File=
Add file which need to display in VGA-Utility Information page.
PageEnable= Set a constant to determine whether the component displays in the VGA-Utility “UtilityManager?and “XGItray?
AddComponent: See [Start] section for illustration.
As implied by the name, keyword CopyFile, WriteReg and DeleteReg, do copying, registry-written and registry-deleted when setup execute
the assigned section, [FileCopy.Wallpaper] or [RegWrite.Wallpaper].
- Component Section - [Driver]
[Driver] section customizes the title, description and display on the dialog when installing the component "VGA Driver"
- INI Description
[Driver]
ID=Driver
Name=VGA Driver
Display=0
Select=7
Inf="[Inf.Driver]"
[Inf.Driver]
"(Win64\xg20gr.inf)", "%OS_XP64%"
"(WinXP&2K\xg20gr.inf)", "%OS_NT%"
[Constant]
OS_NT = XGI_Win2000|XGI_WinXP|XGI_WinNET
OS_XP64 = XGI_WinXP64
- How to customize
- Keyword defined in [Driver]
Inf= The assigned section, [Inf.Driver] , stores the information of the relative directory of the INF file which
is used to install VGA driver.
Other keywords like ID, Name, Display and Select, see The Format of Component Section. The keyword "Display" is set
to 0 by default, which means the component "VGA Driver" is not displayed on the selected component dialog, and the
keyword "Select" is set to 7 by default, which means no matter what setup type(Typical, Compact, Custom) the end user
chooses, the setup always installs "VGA Driver" Without the VGA driver, all utilities component installed can’t work.
- Flags defined in [Constant]
The flags, OS_9X, OS_2K and OS_NT ,see section [Start].
Execute Section
- Execute Section - [UtiGeneral]
[UtiGeneral] section customizes registry keys written and files copied for VGA utilities.
- INI Description
[UtiGeneral]
CopyFile="[FileCopy.UtiGeneral]"
WriteReg="[RegWrite.UtiGeneral.Win9X]", "%OS_9X%"
WriteReg="[RegWrite.UtiGeneral.WinNT]", "%OS_NT%"
- How to customize
- Keyword defined in [UtiGeneral]
WriteReg and CopyFile here is for VGA driver use.
- Flags defined in [Constant]
The format of flags, see [Start] section.
- Execute Section - [DrvGeneral]
[DrvGeneral] section customizes registry keys written and files copied for VGA driver.
- INI Description
[DrvGeneral]
WriteReg=[RegWrite.EscVersion]
WriteReg="[RegWrite.2DInf.WinNT]", "%OS_NT%"
WriteReg="[RegWrite.2D.WinNT]", "%OS_NT%"
WriteReg="[RegWrite.Common.WinNT]", "%OS_NT%"
WriteReg="[RegWrite.VideoCapture.WinNT]", "%OS_NT%"
- How to customize
- Keyword defined in [DrvGeneral]
WriteReg and CopyFile here is for VGA driver use.
- Execute Section - [DefaultMode]
[DefaultMode] section customizes registry keys written to set the default pixels and resolutions of the screen.
- INI Description
[DefaultMode]
WriteReg="[RegWrite.DefaultMode.Win2K]", "%OS_2K%"
WriteReg="[RegWrite.DefaultMode.WinXP]", "%OS_XP%|%OS_SRV03%"
- How to customize
- Keyword defined in [DefaultMode]
WriteReg and CopyFile here is for screen setting.
- Flags defined in [Constant]
The format of flags, see [Start] section.
- Execute Section - [Customer]
[Customer] section does registry keys written and files copied for customers to customize.
- INI Description
[Customer]
WriteReg="[RegWrite.Customer.WinNT]", "%OS_NT%"
- How to customize
- Keyword defined in [Customer]
WriteReg and CopyFile here is for customers to customize.
- Flags defined in [Constant]
The format of flags, see [Start] section.
Execute Section - [DrvGeneral]
[DrvGeneral] section customizes 2D settings.
Execute Section - [INFCustom]
[INFCustom] section customizes registry keys written for VGA driver and whether to install utility when the current install is in INF.
- INI Description
"[INFCustom]",,,, !%InstallMode%
[INFCustom]
Execute="[Execute.INFUtility]",,,, %InstallUtility%
[Execute.INFUtility]
"setup.exe -s",,,,,"RunOnce"
[Constant]
SupportMode = 0
Performance = 1
InstallUtility = 0
- How to customize
- Keyword defined in [INFCustom]
WriteReg and CopyFile here is for VGA driver use.
- Flags defined in [Constant]
RunOnce:
The flag in [Execute.INFUtility] section means INF will launch the application "Setup.exe" only once. Note that "-s" means it is silent install.
SupportMode, Performance and InstallUtility can be set in constant (0 or 1).
Please read all restrictions and disclaimers.
Back to Contents Page