plasma-sdk/kqml/man-kqml.1.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003 <!ENTITY % English "INCLUDE">
0004 ]>
0005 <!--
0006     SPDX-FileCopyrightText: 2023 ivan tkachenko <me@ratijas.tk>
0007
0008     SPDX-License-Identifier: GPL-2.0-or-later
0009 -->
0010
0011 <refentry lang="&language;">
0012 <refentryinfo>
0013 <title>kqml User's Manual</title>
0014 <date>2023-06-10</date>
0015 <releaseinfo>Plasma 6.0</releaseinfo>
0016 <productname>KDE Plasma</productname>
0017 </refentryinfo>
0018
0019 <refmeta>
0020 <refentrytitle><command>kqml</command></refentrytitle>
0021 <manvolnum>1</manvolnum>
0022 </refmeta>
0023
0024 <refnamediv>
0025 <refname><command>kqml</command></refname>
0026 <refpurpose>QML Runtime with KLocalizedContext</refpurpose>
0027 </refnamediv>
0028
0029 <refsynopsisdiv>
0030 <cmdsynopsis>
0031 <command>kqml</command>
0032
0033 <group choice="opt"><option>-v, --version</option></group>
0034 <group choice="opt"><option>-h, --help</option></group>
0035 <group choice="opt"><option>-d, --domain</option> <replaceable>domain</replaceable></group>
0036 <arg choice="opt"><replaceable>files</replaceable>...</arg>
0037 <arg choice="opt"><option>--</option> <replaceable>args</replaceable>...</arg>
0038 </cmdsynopsis>
0039 </refsynopsisdiv>
0040
0041 <refsect1>
0042 <title>Description</title>
0043 <para><command>kqml</command> is a QML runtime with initialized KLocalizedContext.</para>
0044
0045 <para>Unlike the qml tool that comes with qt-declarative package, kqml
0046 initializes KLocalizedContext that allows testing real-world applications and
0047 scratch files with i18n calls throughout their code and imported libraries.</para>
0048 </refsect1>
0049
0050 <refsect1>
0051 <title>Options</title>
0052
0053 <variablelist>
0054 <varlistentry>
0055 <term><option>-v</option>, <option>--version</option></term>
0056 <listitem><para>Displays version information.</para></listitem>
0057 </varlistentry>
0058 <varlistentry>
0059 <term><option>-d</option>, <option>--domain</option> <replaceable>domain</replaceable></term>
0060 <listitem><para>The main localization domain.</para></listitem>
0061 </varlistentry>
0062 <varlistentry>
0063 <term><option>-h</option>, <option>--help</option></term>
0064 <listitem><para>Displays this help.</para></listitem>
0065 </varlistentry>
0066 <varlistentry>
0067 <term><replaceable>files</replaceable>...</term>
0068 <listitem><para>Any number of QML files can be loaded.
0069 They will share the same engine.</para></listitem>
0070 </varlistentry>
0071 <varlistentry>
0072 <term><replaceable>args</replaceable>...</term>
0073 <listitem><para>Arguments after '<option>--</option>' are ignored, but passed through to the
0074 application.arguments variable in QML.</para></listitem>
0075 </varlistentry>
0076
0077 </variablelist>
0078
0079 </refsect1>
0080
0081 <refsect1>
0082 <title>See Also</title>
0083
0084 <para>More detailed user documentation is available from <ulink
0085 url="help:/plasma-desktop">help:/plasma-desktop</ulink>
0086 (either enter this <acronym>URL</acronym> into &konqueror;, or run
0087 <userinput><command>khelpcenter</command>
0088 <parameter>help:/plasma-desktop</parameter></userinput>).</para>
0089
0090 </refsect1>
0091
0092 <refsect1>
0093 <title>Authors</title>
0094 <para><command>kqml</command> was written by
0095 <personname><firstname>ivan</firstname><surname>tkachenko</surname></personname> <email>me@raitjas.tk</email>.</para>
0096 </refsect1>
0097
0098 </refentry>