Home · All Classes · Grouped Classes · Annotated · Functions

File System Standards

Introduction

Qtopia software is installed in the /opt/Qtopia directory of the target system. Within this directory, applications must follow the file placement standards described in this document.

Definitions

TermDefinition
<appname>this is the application's executable file name. It should be globally unique. Since this name is not intended to be seen or entered by the end-user, long and complex names such as "abc-textedit-3" can be used.
languagethis is the ISO639 language code (e.g. "de" for German).

File Name Standards

File TypeLocation
Executable/opt/Qtopia/bin/<appname>/...
Description: This is the executable program. Note: It is not appropriate to use the same executable with arguments to modify it's behavior, since only one instance of each application will be run (additional attempts to run the application will merely raise the previous instance).
Library/opt/Qtopia/lib/<appname>/...
Description: Applications may put libraries here as required
Image/opt/Qtopia/pics/<appname>/*.{png,jpg,svg}
Description: Any image files the application needs to use should either be standard built-in images, or be files in this application-specific directory. The files can be referred to using QPixmap(":image/<name>") for pictures belonging to the current application or the global context, and using QPixmap(":image/<appname>/<name>") for pictures belonging to another application context.
Icon/opt/Qtopia/pics/<appname>/icons/<IconSize>x<IconSize>/*.{png,svg}
Description: Any icon files the application needs to use should either be standard built-in icons, or be files in this application-specific directory. The files can be referred to using QIcon(":icon/name") for icons belonging to the current application or the global context, and using or QIcon(":icon/<appname>/<name>") for icons belonging to another application context.
Sound/opt/Qtopia/sounds/<appname>/...
Description: Any sound files the application needs to use should either be standard built-in sounds, or be files in this application-specific directory.
Internationalization/opt/Qtopia/i18n/language/<appname>.qm
Description: These files are translations of the software (see Internationalization).
English Online Documentation/opt/Qtopia/help/html/<appname>-suffixes.html
Description: These files provide the English online documentation of the software (the -suffixes is optional). Note that on-line documentation can refer to images under the /opt/Qtopia/pics directory, so you can refer to icons and other images explicitly without duplicating the files.
Online Documentation/opt/Qtopia/help/language/html/<appname>-suffixes.html
Description: These files are the online documentation of the software (the -suffixes is optional), in the language specified. The suffixes are the choice of the application developer, but Qtopia will automatically connect the Help button in the window decorations to <appname>-widgetname.html if such a file exists, thereby allowing different application windows to have different associated help pages.
Qt plug-ins/opt/Qtopia/qt_plugins/...
Description: These directory contains Qt plug-ins such as the gfx drivers, icon engines or file format plugins.
Mediaplayer Codecs/opt/Qtopia/plugins/codecs/...
Description: Mediaplayer codecs are placed in this directory.
Font/opt/Qtopia/lib/fonts/...
Description: Font files are placed in this directory.
Input Method Plug-ins/opt/Qtopia/plugins/inputmethods/...
Description: Input Method plug-ins are placed in this directory.
Network Setup/opt/Qtopia/plugins/network/...
Description: Network setup modules are placed in this directory.
Configuration/opt/Qtopia/etc/default/..., $HOME/Settings/...
Description: Configuration files are stored automatically in $HOME/Settings by using QSettings. If default configuration files are required, they should created and installed in /opt/Qtopia/etc/default/... as read only.
Service declarations/opt/Qtopia/services/...
Description: These service files are used to lookup service details and their providers.
Application Data$HOME/Application/<appname>/...
Description: Application specific data will be stored here, for example cache data.
Temporary Data/tmp/..., /tmp/qtopia-<QWS ID>/..., /tmp/qt-embedded-<QWS ID>/...
Description: All temporary files are expected to be stored under /tmp; typically /tmp is a RAM hosted partition on a device. In particular a directory such as /tmp/qtopia-0/ will be used by Qtopia application for their temporary files.

Note: The ramfs file system should not be used for the /tmp partition as it often incorrectly reports the amount of free space. Instead of using ramfs use tempfs for a RAM hosted /tmp partition.


Copyright © 2008 Nokia Trademarks
Qtopia 4.3.3