summaryrefslogtreecommitdiffstats
path: root/doc/scripting.qdoc
diff options
context:
space:
mode:
authorTim Jenssen <tim.jenssen@nokia.com>2011-09-08 12:08:30 +0200
committerTim Jenssen <tim.jenssen@nokia.com>2011-09-08 13:40:36 +0200
commitacd000cc4289e3afe9b47bf4c31dbfb2b7afd159 (patch)
tree5cbe7dde1012c05c8a1fbb09ff25244d61e54d92 /doc/scripting.qdoc
parent09853be0f364a7ff84647bc9a3585a50a375e36c (diff)
added possible operations to an extra page
- maybe this way it is easier to add more operation documenation Change-Id: I2555f855a9519fd2c02ca014b195bca79345e138 Reviewed-on: http://codereview.qt-project.org/4420 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Tim Jenssen <tim.jenssen@nokia.com>
Diffstat (limited to 'doc/scripting.qdoc')
-rw-r--r--doc/scripting.qdoc132
1 files changed, 1 insertions, 131 deletions
diff --git a/doc/scripting.qdoc b/doc/scripting.qdoc
index 5a94aba8c..47b14491b 100644
--- a/doc/scripting.qdoc
+++ b/doc/scripting.qdoc
@@ -79,137 +79,7 @@
QInstaller::Installer::setValue. See the list of
\l{Predefined variables}{predefined variables}.
- Following a list of all available operations, which
- can be added to a installation script.
-
- \section2 Copy
-
- \bold Syntax: "Copy" \a source \a target
-
- Copies a file from \a source to \a target.
-
-
- \section2 Move
-
- \bold Syntax: "Move" \a source \a target
-
- Moves a file from \a source to \a target.
-
-
- \section2 Delete
-
- \bold Syntax: "Delete" \a filename
-
- Deletes the file specified by \a filename.
-
-
- \section2 Mkdir
-
- \bold Syntax: "Mkdir" \a path
-
- Creates the directory path \a path.
-
-
- \section2 Rmdir
-
- \bold Syntax: "Rmdir" \a path
-
- Removes the directory path \a path.
-
-
- \section2 AppendFile
-
- \bold Syntax: "AppendFile" \a filename \a text
-
- Appends \a text to the file specified by \a filename. \a is threated as ASCII text.
-
-
- \section2 PrependFile
-
- \bold Syntax: "PrependFile" \a filename \a text
-
- Prepends \a text to the file specified by \a filename. \a is threated as ASCII text.
-
-
- \section2 Execute
-
- \bold Syntax: "Execute" [{\a exitcodes}] \a command [\a parameter1 [\a parameter2 [\a parameter3 [\a parameter4]]]]
-
- Executes the command specified by \a command. Up to four parameters can be passed.
-
- Optionally, you can pass a comma separated list of numbers in {} as first argument, which defines the "valid" exit codes
- of the process, i.e. the codes the execution is considered being successful. This defaults to "{0}".
-
- \section2 CreateShortcut
-
- \bold Syntax: "CreateShortcut" \a filename \a linkname [\a arguments]
-
- Creates a shortcut from the file specified by \a filename to \a linkname.
- On Windows, this will create a .lnk file which can have \a arguments, on Unix this will create a symobic link.
-
-
- \section2 CreateDesktopEntry
-
- \bold Syntax: "CreateDesktopEntry" \a filename \a "key=value[\nkey2=value2[\nkey3=value3]]]"
-
- Creates an INI-file like .desktop file as specified by freedesktop.org
- If \a filename is absolute, the desktop entry is stored there. Otherwise it's stored in locations defined in $XDG_DATA_DIRS/applications
- or $XDG_DATA_HOME/applications, including the default pathes for boths, as defined by freedesktop.org.
-
- The key/value pairs are written in the file.
-
- The file is set to a encoding of UTF-8.
-
- \section2 InstallIcons
-
- \bold Syntax: "InstallIcons" \a directory
-
- Installs the contents of \a directory into a location as specified by freedesktop.org, i.e. in any of $XDG_DATA_DIRS/icons or /usr/share/icons
- or $HOME/.icons. The files are removed from their initial location. Make sure to add this operation after the operation extracting them form the archive.
-
- \section2 Extract
-
- \bold Syntax: "Extract" \a archive \a targetdirectory
-
- Extracts \a archive to \a targetdirectory
-
-
- \section2 GlobalConfig
-
- \bold Syntax: "GlobalConfig" \a company \a application \a key \a value <br>
- \a or <br>
- \bold Syntax: "GlobalConfig" \a filename \a key \a value
-
- Stores \a value for \a key in a configuration file. The configuration file is either
- specified by \a filename (using QSettings::NativeFormat, which might be the Windows registry)
- or via the \a application and the \a company name.
-
-
- \section2 EnvironmentVariable
-
- \bold Syntax: "EnvironmentVariable" \a key \a value [[\a persistent] \a system]
-
- Sets the envirnoment variable \a key to a \a value. If \a persistent is set to true, the variable
- will be set persistently. This is currently only supported on Windows. If \a system is set to true, the
- persistent variable will be set system wide, not only for the current user.
-
-
- \section2 RegisterFileType
-
- \bold Syntax: "RegisterFileType" \a extension \a command [\a description [\a contentType [\a icon]]].
-
- Registers the file type with \a extension to be opened via \a command. Optionally, you can specify
- a \a description, a \a contentType and an \a icon. This is currently only supported on Windows.
-
-
- \section2 RegisterQtInCreatorV2
-
- \bold Syntax: "RegisterQtInCreatorV2", \a displayname, \a qt_or_qmake_path, [\a system_root, [\a sbs_path]].
-
- Registers the Qt version \a displayname to Qt Creator with \a qt_or_qmake_path (if the path does not end with the qmake binary, it will add bin/qmake to the path automatically). Optionally, you can specify a\ system_root which. For Symbian SDKs the instance root will be where Qt Creator will find the Symbian SDK root (EPOCROOT).  For Symbian SDKs supporting sbs, you add the \a sbs_path .
-
- \note The minimum Qt Creator version it supports is 2.2
-
+ A list of all available operations can be found \l{Operations}{here}
\section1 Custom Operations