mirror of
https://github.com/miurahr/aqtinstall.git
synced 2025-12-16 20:27:05 +03:00
Commercial docs (#886)
* First documentation draft for the commercial feature * Update commercial.rst * Update commercial.rst * Update docs/commercial.rst Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com> * Update docs/commercial.rst Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com> * Update and rename commercial.rst to official.rst * Update index.rst * Update official.rst --------- Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
This commit is contained in:
Alexandre Poumaroux
committed by
GitHub
GitHub
parent
3665552702
commit
d0ca508859
@@ -10,6 +10,7 @@ Contents:
|
||||
getting_started
|
||||
cli
|
||||
configuration
|
||||
official
|
||||
appendix
|
||||
CONTRIBUTE
|
||||
CODE_OF_CONDUCT
|
||||
@@ -24,4 +25,3 @@ Indices and tables
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
||||
157
docs/official.rst
Normal file
157
docs/official.rst
Normal file
@@ -0,0 +1,157 @@
|
||||
.. _official:
|
||||
|
||||
Official Qt Installer
|
||||
=====================
|
||||
|
||||
.. important::
|
||||
* **You can use this for commercial and open-source Qt versions**
|
||||
* **You can only install for the OS running the CLI**
|
||||
* **All commands require authentication, even for open-source.** The authentication process:
|
||||
|
||||
* It first looks into the folder of your OS where the file ``qtaccount.ini`` can be:
|
||||
|
||||
* Windows: ``C:\Users\<username>\AppData\Roaming\Qt\qtaccount.ini``
|
||||
* Linux: ``/home/<username>/.local/share/Qt/qtaccount.ini``
|
||||
* MacOS: ``/Users/<username>/Library/Application Support/Qt/qtaccount.ini``
|
||||
|
||||
This file is automatically created when you use the ``MaintenanceTool`` binary and log in using the GUI. It is also created the first time you use the CLI or any mean to authenticate. You can simply copy the file from your PC to the CI server, it will work across platforms. Just treat it as a password. Refer to `this page <https://doc.qt.io/qt-6/get-and-install-qt-cli.html#providing-login-information>`_ for more details.
|
||||
|
||||
* It will also check the value of the environment variable ``QT_INSTALLER_JWT_TOKEN`` and use the token if provided.
|
||||
* If neither are present, you will need to provide ``--email <email> --pw <password>``.
|
||||
Note that if ``--email`` and ``--pw`` are provided, they will supersede the ``qtaccount.ini`` and the JWT token account.
|
||||
|
||||
``install-qt-official``
|
||||
------------------------
|
||||
Install Qt packages using the official Qt installer.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
aqt install-qt-official <target> <arch> <version> [options]
|
||||
|
||||
Arguments
|
||||
~~~~~~~~~
|
||||
- ``target`` - Target platform (desktop, android, ios)
|
||||
- ``arch`` - Target architecture
|
||||
- ``version`` - Qt version to install
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
- ``--email <email>`` - Qt account email/username
|
||||
- ``--pw <password>`` - Qt account password
|
||||
- ``--modules <module1> <module2> ...`` - Additional Qt modules to install
|
||||
|
||||
* Very broad meaning, aka ``packages`` or ``components`` (`see here <https://doc.qt.io/qt-6/get-and-install-qt-cli.html#component-names-for-installation>`_). Extensions, wasm, src... are 'modules'
|
||||
* If none are inputed, the package ``qtX.Y.Z-essentials`` is downloaded (default Qt install, includes ``qtcreator``...)
|
||||
* If ``all`` is inputed, the package ``qtX.Y.Z-full`` is downloaded (includes everything)
|
||||
|
||||
.. dropdown:: Click to see all the special packages (for Linux Qt 6.8.1)
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
Name: qt6.8.1-essentials
|
||||
Display name: Qt 6.8.1 Linux x86_64 Essential Components
|
||||
Description: Qt 6.8.1 Linux x86_64 Essential Libraries, Headers, and Tools
|
||||
Version: 6.8.1
|
||||
Components: qt.qt6.681.linux_gcc_64
|
||||
|
||||
Name: qt6.8.1-essentials-dev
|
||||
Display name: Qt 6.8.1 Linux x86_64 Essential Components (dev)
|
||||
Description: Qt 6.8.1 Linux x86_64 Essential Libraries, Headers, and Tools (dev)
|
||||
Version: 6.8.1
|
||||
Required aliases: qt6.8.1-essentials
|
||||
|
||||
Name: qt6.8.1-full
|
||||
Display name: Qt 6.8.1 Linux x86_64 All Components with Sources
|
||||
Description: Qt 6.8.1 Linux x86_64 All Libraries, Headers, Tools, and Sources
|
||||
Version: 6.8.1
|
||||
Components: qt.qt6.681.src,extensions.qtwebengine.681.src
|
||||
Required aliases: qt6.8.1-essentials,qt6.8.1-addons,qt6.8.1-extensions
|
||||
Optional components: extensions.qtinsighttracker.681.src
|
||||
|
||||
Name: qt6.8.1-full-dbg
|
||||
Display name: Qt 6.8.1 Linux x86_64 All Components with Sources and Debug Information Files
|
||||
Description: Qt 6.8.1 Linux x86_64 All Libraries, Headers, Tools, Sources, and Debug Information Files (dev)
|
||||
Version: 6.8.1
|
||||
Components: qt.qt6.681.debug_info.linux_gcc_64,qt.qt6.681.debug_info,extensions.qtwebengine.681.debug_information
|
||||
Required aliases: qt6.8.1-full-dev
|
||||
|
||||
Name: qt6.8.1-full-dev
|
||||
Display name: Qt 6.8.1 Linux x86_64 All Components with Sources (dev)
|
||||
Description: Qt 6.8.1 Linux x86_64 All Libraries, Headers, Tools, and Sources (dev)
|
||||
Version: 6.8.1
|
||||
Required aliases: qt6.8.1-full
|
||||
|
||||
Name: qt6.8.1-sdk
|
||||
Display name: Qt 6.8.1 Linux x86_64 SDK
|
||||
Description: Qt 6.8.1 Linux x86_64 SDK Tools (Qt Creator, Ninja, and CMake)
|
||||
Version: 6.8.1
|
||||
Components: qt.tools.qtcreator_gui,qt.tools.cmake,qt.tools.ninja
|
||||
Required aliases: qt6.8.1-full-dev,qt6.8.1-full-dbg
|
||||
|
||||
- ``--outputdir <path>`` - Installation directory (default: current directory)
|
||||
- ``--override <args...>`` - Pass all remaining arguments directly to the Qt installer CLI
|
||||
|
||||
``list-qt-official``
|
||||
---------------------
|
||||
Search available Qt packages using the official Qt installer.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
aqt list-qt-official [search_terms] [options]
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
- ``--email <email>`` - Qt account email/username
|
||||
- ``--pw <password>`` - Qt account password
|
||||
- ``search_terms`` - Terms to search for in package names (grabs all that is not other options)
|
||||
|
||||
Override Mode
|
||||
------------
|
||||
``install-qt-official`` supports an override mode that passes all arguments after ``--override`` directly to the Qt installer CLI, and will ignore all the other params except ``--email`` and ``--pw`` if given prior to it
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
aqt install-qt-official --override [installer_args... --email email --pw password]
|
||||
aqt install-qt-official --email email --pw password --override [installer_args...]
|
||||
|
||||
When using override mode:
|
||||
|
||||
* All standard command options are ignored
|
||||
* Arguments are passed directly to the Qt installer
|
||||
* The ``--email``/``--pw`` flags are used for authentication
|
||||
* `More info here <https://doc.qt.io/qt-6/get-and-install-qt-cli.html>`_
|
||||
|
||||
Examples
|
||||
--------
|
||||
.. code-block:: bash
|
||||
|
||||
# Standard installation
|
||||
aqt install-qt-official desktop linux_gcc_64 6.8.0 --email user@example.com --pw pass
|
||||
|
||||
# Installation with modules
|
||||
aqt install-qt-official desktop linux_gcc_64 6.8.0 --email user@example.com --pw pass --modules qtcharts qtnetworkauth
|
||||
|
||||
# List packages containing 'wasm'
|
||||
aqt list-qt-official wasm --email user@example.com --pw pass
|
||||
|
||||
# Override mode
|
||||
aqt install-qt-official --override install qt.qt6.680.gcc_64 --email user@example.com --pw pass
|
||||
|
||||
Advanced configs
|
||||
--------------
|
||||
The file located in ``./aqt/settings.ini`` can be edited in the ``[qtofficial]`` part to fine tune the official installer (`more details here <https://doc.qt.io/qt-6/get-and-install-qt-cli.html#message-identifiers-for-auto-answer>`_):
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[qtofficial]
|
||||
unattended : True # Removes needs of user interaction, and simplifies the --override option as well by passing flags by default to remain unattended
|
||||
installer_timeout : 1800
|
||||
operation_does_not_exist_error : Ignore
|
||||
overwrite_target_directory : No
|
||||
stop_processes_for_updates : Ignore
|
||||
installation_error_with_cancel : Ignore
|
||||
installation_error_with_ignore : Ignore
|
||||
associate_common_filetypes : Yes
|
||||
telemetry : No
|
||||
cache_path : # When empty, will use ~/.local/share/aqt/cache or equivalent for your OS
|
||||
temp_dir : # When empty, will use ~/.local/share/aqt/tmp or equivalent for your OS
|
||||
Reference in New Issue
Block a user