summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTim Jenssen <tim.jenssen@digia.com>2014-01-17 14:34:57 +0100
committerTim Jenssen <tim.jenssen@digia.com>2014-01-17 14:36:23 +0100
commitfe92a09482c5abf7f2c56901f2d60e287282f939 (patch)
treefbfcefcc6f86dd2980b6b5816dece03664c57a76 /doc
parent0b5241a696cf05612dae2c8810022f5e205d42df (diff)
parentfaa8f39bdd8c13b21c19bec1592f18e710c56206 (diff)
Merge remote-tracking branch 'origin/1.5'
Diffstat (limited to 'doc')
-rw-r--r--doc/installerfw-getting-started.qdoc4
-rw-r--r--doc/installerfw.qdoc38
-rw-r--r--doc/operations.qdoc1
-rw-r--r--doc/scripting.qdoc7
4 files changed, 31 insertions, 19 deletions
diff --git a/doc/installerfw-getting-started.qdoc b/doc/installerfw-getting-started.qdoc
index 1b21ac664..67dd4de14 100644
--- a/doc/installerfw-getting-started.qdoc
+++ b/doc/installerfw-getting-started.qdoc
@@ -81,7 +81,7 @@
Windows:
\code
- configure.exe -opensource -release -static -no-multimedia -no-declarative -no-phonon -no-dbus -no-opengl -no-qt3support -no-webkit -no-xmlpatterns -nomake examples -nomake demos
+ configure.exe -opensource -release -static -accessibility -no-multimedia -no-declarative -no-phonon -no-dbus -no-opengl -no-qt3support -no-webkit -no-xmlpatterns -nomake examples -nomake demos
\endcode
\section2 Configuring Qt for Linux and Mac OS X
@@ -90,7 +90,7 @@
Mac OS X:
\code
- configure -opensource -release -static -qt-zlib -qt-libtiff -qt-libpng -qt-libmng -qt-libjpeg -no-phonon -no-dbus -no-opengl -no-qt3support -no-webkit -no-xmlpatterns -no-svg -nomake examples -nomake demos
+ configure -opensource -release -static -accessibility -qt-zlib -qt-libtiff -qt-libpng -qt-libmng -qt-libjpeg -no-phonon -no-dbus -no-opengl -no-qt3support -no-webkit -no-xmlpatterns -no-svg -nomake examples -nomake demos
\endcode
\section1 Setting up Qt Installer Framework
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 5a88813a4..cd2cbefd4 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -199,10 +199,10 @@
\o Filename for a watermark used as \a QWizard::WatermarkPixmap.
\row
\o Banner
- \o Filename for a banner used as \a QWizard::BannerPixmap.
+ \o Filename for a banner used as \a QWizard::BannerPixmap (only used by ModernStyle).
\row
\o Background
- \o Filename for an image used as \a QWizard::BackgroundPixmap.
+ \o Filename for an image used as \a QWizard::BackgroundPixmap (only used by MacStyle).
\row
\o WizardStyle
\o Set the wizard style to be used ("Modern", "Mac", "Aero" or "Classic").
@@ -272,6 +272,10 @@
\o List of language codes to be used for translating the user interface. To add several language
variants, specify several Translation sections that each specify the name of a language
variant. Optional. For more information, see \l{Translating Pages}.
+ \row
+ \o UrlQueryString
+ \o This string needs to be in the form "key=value" and will be appended to archive download
+ requests. This can be used to transmit information to the webserver hosting the repository.
\endtable
@@ -452,6 +456,7 @@
\row
\o Virtual
\o Set to \c true to hide the component from the installer.
+ Note that setting this on a root component does not work.
\row
\o SortingPriority
\o Priority of the component in the tree. The tree is sorted from
@@ -1014,34 +1019,35 @@
Updates.xml file in the current repository. You can add, replace, or remove
repositories.
+ \code
+ <RepositoryUpdate>
+ <Repository action="..." OPTIONS />
+ <Repository action="..." OPTIONS />
+ </RepositoryUpdate>
+ \endcode
+
\section2 Adding Repositories
- To update a repository, add the following code to Updates.xml:
+ To update a repository, add the following code to the RepositoryUpdate section:
\code
- <RepositoryUpdate>
- <Repository action="add" url="http://www.example.com/repository" name="user" password="password"
+ <Repository action="add" url="http://www.example.com/repository" name="user" password="password"
displayname="Example Repository" />
- </RepositoryUpdate>
\endcode
\section2 Removing Repositories
- To remove a repository, add the following code to Updates.xml:
+ To remove a repository, add the following code to the RepositoryUpdate section:
\code
- <RepositoryUpdate>
- <Repository action="remove" url="http://www.example.com/repository" />
- </RepositoryUpdate>
+ <Repository action="remove" url="http://www.example.com/repository" />
\endcode
\section2 Replacing repositories
- To replace one repository with another, add the following code to Updates.xml:
+ To replace one repository with another, add the following code to the RepositoryUpdate section:
\code
- <RepositoryUpdate>
- <Repository action="replace" oldurl="http://www.example.com/repository"
- newurl="http://www.example.com/newrepository" name="user" password="password"
- displayname="New Example Repository" />
- </RepositoryUpdate>
+ <Repository action="replace" oldurl="http://www.example.com/repository"
+ newurl="http://www.example.com/newrepository" name="user" password="password"
+ displayname="New Example Repository" />
\endcode
*/
diff --git a/doc/operations.qdoc b/doc/operations.qdoc
index 2a29a519d..5f959002e 100644
--- a/doc/operations.qdoc
+++ b/doc/operations.qdoc
@@ -35,6 +35,7 @@
The operations are prepared by component scripts and performed by the
installer.
+ \note Operations are performed threaded.
Internally, each operation has a \e DO step that contains instructions for
the installer and an \e UNDO step that contains instructions for the
diff --git a/doc/scripting.qdoc b/doc/scripting.qdoc
index 38fced90e..fe256458d 100644
--- a/doc/scripting.qdoc
+++ b/doc/scripting.qdoc
@@ -118,6 +118,8 @@
copying files or patching file content, for example. You can create and add
update operations to the installation from within
a script using \a QInstaller::Component::addOperation.
+ If you need to run an operation that requires administrative rights, use
+ \a QInstaller::Component::addElevatedOperation instead.
Each operation has a unique key used for identification and can take up to
five parameters. In the parameter values, you can use variables as set in
@@ -252,6 +254,10 @@
\row
\o HomeDir
\o Home directory of the current user.
+ \row
+ \o ApplicationsDir
+ \o Applications directory. For example, \c {C:\Program Files} on Windows,
+ \c {/opt} on Linux and \c {/Applications} on Mac OS X.
\endtable
The variables can be resolved by calls to \c installer.value(). If embedded
@@ -263,5 +269,4 @@
component.addOperation("CreateShortcut", "@TargetDir@/MyApp.exe", "@StartMenuDir@/MyApp.lnk");
}
\endcode
-
*/