1// Copyright (C) 2023 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
5\page qtqml-tooling-qml.html
7\brief Overview of the qml command line utility.
10\section1 The qml utility
11\c The qml utility tool loads QML documents and creates a window to show the scene
12if your QML document includes a visual item. You can also evaluate non-visual QML
14It is mainly meant for testing your QML applications or components quickly
15as described in \l {Prototyping with the QML Runtime Tool}{here}.
21 \li qml [\l{options}] files... [-- args...]
32 \li Displays help on commandline options.
35 \li Displays help, including generic Qt options.
38 \li Displays version information.
40 \li -a, --apptype <core|gui|widget>
41 \li Select which application class to use. Default is gui.
44 \li Prepend the given path to the import paths.
47 \li Load the given file as a QML file.
49 \li -c, --config <file>
50 \li Load the given built-in configuration or configuration file.
53 \li List the built-in configurations.
55 \li --translation <file>
56 \li Load the given file as the translations file.
58 \li --dummy-data <file>
59 \li Load QML files from the given directory as context properties. (deprecated)
62 \li Force use of desktop OpenGL (AA_UseDesktopOpenGL).
65 \li Force use of GLES (AA_UseOpenGLES).
68 \li Force use of software rendering (AA_UseSoftwareOpenGL).
71 \li Force use of OpenGL Core Profile.
73 \li --disable-context-sharing
74 \li Disable the use of a shared GL context for QtQuick Windows
76 \li --enable-shader-cache
77 \li Enable persistent caching of generated shaders
80 \li Requests an alpha channel in order to enable semi-transparent windows.
83 \li Requests 4x multisample antialiasing.
86 \li Suppress all output.
89 \li Print information about what qml is doing, like specific file URLs being loaded.
92 \li Run all animations in slow motion.
94 \li --fixed-animations
95 \li Run animations off animation tick rather than wall time.
97 \li -r, --rhi <backend>
98 \li Set the backend for the Qt graphics abstraction (RHI). Backend is one of:
99 default, vulkan, metal, d3d11, gl
102 \li Add selector to the list of QQmlFileSelectors.