Index     Next     
Setup Util Programmer's Guide



Contents


About This Guide
Who Should Read This Guide
What's New in This Release
What's In This Guide
Documentation Conventions
About the Sample Code
Part 1 Getting Started with Setup Util

Chapter 1 Overview of the Setup Util

What the Setup Util Is
Getting and Installing the Setup Util
To Get the Setup Util
To Install the Setup Util
Working with the Source Code
What the Setup Util Contains
Key Concepts
Common Install Shell and Information Files
Installation Modes and Types
Archives
The Installation Source Repository
Pre- and Post-Installation Programs
Installation Cache
Log Files
Chapter 2 Quick Start
Overview of Installations
Performing a Basic Installation
Archiving Product Files
Modifying Information Files
Extending Your Installation
Requesting Input and Configuring Your Product
Registering Information in the Directory Server
A Simple Installation
Background Information
Creating the Archive
Creating the Information Files
Part 2 Writing an Installer

  Chapter 3 Information Files

Understanding Information Files
Customizing Information Files
Working with the Master Information File
Working with Package Information Files
Information File Directives
Chapter 4 Writing Pre-Installation Programs
What Pre-Installation Programs Do
Writing UNIX Pre-Installation Programs
Including Header Files
Finding Out Information about Components
Writing Code to Handle Dialogs and Input
Storing User Input
Compiling and Packaging the Program
Updating Information Files
Writing Windows NT Pre-Installation Programs
Finding Out Information about Components
Creating Dialog Boxes
Managing Dialogs and Processing Input
Storing User Input
Compiling and Packaging the DLL
Modifying your Package Information File
Chapter 5 Creating Dialogs
Understanding Setup Util Dialog Boxes
Working with a Dialog Manager
Creating a Dialog Manager
Using a Dialog Manager
Creating Dialog Boxes on UNIX
Dialog Box Arguments
Standard Dialog Boxes
Custom Dialog Boxes
Creating Dialog Boxes on Windows NT
Designing and Integrating Dialogs
Gathering and Processing Input
Collecting User Input on UNIX
Collecting User Input on Windows NT
Customizing Common UI Text
Customizing UNIX Text
Customizing Windows NT Text
Chapter 6 Writing Post-Installation Programs
Overview of Post-Installation Programs
Requirements for Post-Installation Programs
Writing a UNIX Post-Installation Program
Sample Post-Installation Program
Writing a Windows NT Post-Installation Program
Chapter 7 Silent Installation
Understanding Silent Installation
Requirements for Silent Installation
Using Installation Scripts
Sample Installation Script
Performing a Silent Installation
Running a Standard Installation
Saving the Installation Cache
Modifying the Installation Cache
Performing a Silent Installation
Chapter 8 Interacting with the Directory Server
`Overview: Setup Util and the Directory Server
Directory Organization
Installed Software Instance Entries
Server Instance Entries
Preferences
Access Control
Importing Schema and LDIF Files
Using Information File Directives
Using API Functions
Chapter 9 Compiling and Linking
Overview of Compilation and Linking
Compiling and Linking on UNIX
Required Libraries
Link Flags
Compiling on Windows NT
Part 3 Additional Topics

Chapter 10 Dependencies and Patches

Selecting Interdependent Components
Searching for Components
Checking Dependencies
Presenting a Selection List
Determining Installation Order
Invisible Components
Installing Patches
Performing a Patch
Chapter 11 Uninstalling
How the Setup Util Uninstalls Products
Writing Pre- and Post-Uninstallation Programs
Performing an Uninstallation
To Invoke the Uninstallation Shell
Chapter 12 Using Log Files
How the Setup Util uses Log Files
Working with Installation Logs
Logging and Uninstallation
Part 4 Reference of Setup Util Libraries

Chapter 13 Setupapi.h Library Reference

Conversion and Encoding AP
Memory Allocation and Freein
Directory Server Acces
Logging and Inf File Acces
Local File Syste
Networ
Platfor
Install Log Error Level
InstallLog Clas
Public API
Chapter 14 Setupdefs.h Library Reference
Setup Install Mode
Setup Wizard Page Definition
Setup Common File
Setup SIE Definition
Setup Security Definition
Setup INF definition
Setup INF Keyword
setup.inf General Section Keyword
UNIX only
Setup Global INF Keyword
Setup Message
Setup Error Message
Chapter 15 Setupinst.h Library Reference
UNIX and Windows N
Windows NT onl
Chapter 16 Setupldap.h Library Reference
General Routine
Setting Attribute
SIE/ISIE Creation Routine
Miscellaneous Routine
Chapter 17 Setupnvpair.h Library Reference
Overvie
Handl
NVPairHandle
Method
Constructors
Destructor
Other
Chapter 18 Dialog.h Library Reference
Forward Declarations and Typedef
Dialog Class
DialogAction
Function
DialogManager Class
Dialog Class
Display
Dialog Creation Function
DialogYesNo
DialogInput
DialogAlert
DialogProgress
Chapter 19 Global.h Library Reference
Global Setup Util Definition
Buffer Size
Bounds for Port Numbers
Installation Modes and Types
Default Installation Values
Templates for Default ACIs
Common Package Information File Variables
Silent Installation Variables
Installation Related Directories and File Naming
Chapter 20 Uninstall.h Library Reference
Method
logUninstallInfo
Chapter 21 Uxres.h Library Reference
Method
setResource
getResource
Definition
Initialized in Information Files
For Use in Dialogs
Chapter 22 Ux-util.h Library Reference
Definition
General
C Function
Common Functions
Utilities
Silent Installation Log
C++ Function
Utilities
Part 5 Reference of Supporting Libraries

Chapter 23 Code.h Library Reference

Definition
SHA1_LENGTH
BASE64_LEN
Function
SHA1_Hash
SHA1_HashBuf
base64_decode
base64_encode
sha1_pw_enc
sha1_pw_cmp
Chapter 24 Ldap.h Library Reference
Genera
Definitions
C LDAP API Feature
Standard Options
Private and Experimental Extensions
Result Types a Server can Return
Built-in SASL Methods
Search Scopes
Alias Dereferencing
Predefined Size and Time Limits
Allowed Values for ldap_result() Parameters
Returned Error Codes
Unsolicited LDAPv3 Notification Messages
LDAPv3 Server Controls
Password Information Returned to Client
Client Controls
LDAP API Macro
LDAPv3 Extended Operation Calls
LDAPv3 Extended Parsing and Result Handling Calls
Extension
Server Side Sorting
Virtual List View
LDAP URL Functions and Definitions
SSL Option
Referral Hop Limit
Preferred Language and get_lang_values
Rebind Callback Function
Thread Callback Functions
I/O Function Callbacks
Client Side Sorting of Entries
Filter Functions and Definitions
Friendly Mapping Structure and Routines
In Memory Cache
DNS Resolver Callbacks
Experimental Function
Memory Allocation Callback Functions
Server Reconnect
Extra Thread Callback Functions
Asynchronous I/O
Debugging Level
Unsupported Function
Authentication Methods
Experimental DN Format Support
User Friendly Naming/Searching Routines
Utility Routines
UTF-8 Routines
Obsolete Functions and Definition
LDAP_VERSION
LDAP_BUILD_FILTER
Server Returned Result Types
Error Messages
Generalized Cache Callback Interface
Cache Strategies
Chapter 25 Ldapu.h Library Reference
Error Code
General Definition
Error Codes Used by ldapu.h
Setup Util Error Codes
Routine
General Information on Working in C
Ldap Objects
SIE/ISIE Creation Routines
Miscellaneous Routines
LdapError Clas
Public API
Protected API
Ldap Clas
General
Public API
ldap_modify_s
Private API
LdapEntry Clas
General
Public API
LdifEntry Clas
General
Public API
LdapSchema Clas
General
Public API
Chapter 26 Nsdefs.h Library Reference
NSString Clas
General
Public API
Protected API
NVPair Clas
General
Public API
NVPair Get and Set Functions
List Functions
Internationalization Conversion Functions
Chapter 27 Utf8.h Library Reference
Method
UTF8ToLocal
localToUTF8
isAsciiBuffer
Part 6 Appendixes 

Appendix A Common Questions and Answers

General
What is the Messaging Installation Framework?
What is the Installation Database?
Is the Setup Util Localizable?
Why Does Setup Skip Product Selection?
Directory-Related
Where Does Setup Capture LDAP Information?
Information Files, Upgrades, and Archives
Which Compression Algorithm Does Setup Use?
How Do Programs Recognize ReInstallations?
Can I Use Self-Extracting Archives?
Where Should I Package Text Files?
What's a Build Number?
Can I Use More than Two Levels in an Inf File?
Silent Installation and Uninstallation
Why Doesn't Silent Installation Work For Me?
What is an Uninstallation Log?
Why Doesn't Silent Uninstallation Work For Me?
Why Doesn't Uninstallation Remove Everything?
UNIX-Specific
Are There Known Curses Problems on UNIX?
Windows-Specific
Why Doesn't The Back Button Work?
Can I Enable Asian Characters in an NT Dialog?
How Does the Setup Util Call My Plug-In?
How Do I Assign a Domain Name on Win2K?
Appendix B Sample Pre- and Post-Installation Programs
Sample UNIX Code
Sample Windows NT Code
Index


Index     Next     
Copyright (C) 2005 Red Hat, Inc. All rights reserved.
This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/

Last Updated September 21, 2001