plasma-sdk/engineexplorer/man-plasmaengineexplorer.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 <refentry lang="&language;">
0007 <refentryinfo>
0008 <title>plasmaengineexplorer User's Manual</title>
0009 <date>2017-01-09</date>
0010 <releaseinfo>Plasma 5.8</releaseinfo>
0011 <productname>KDE Plasma</productname>
0012 </refentryinfo>
0013
0014 <refmeta>
0015 <refentrytitle><command>plasmaengineexplorer</command></refentrytitle>
0016 <manvolnum>1</manvolnum>
0017 </refmeta>
0018
0019 <refnamediv>
0020 <refname><command>plasmaengineexplorer</command></refname>
0021 <refpurpose>Provides direct access to plasma data engines</refpurpose>
0022 </refnamediv>
0023
0024 <refsynopsisdiv>
0025 <cmdsynopsis>
0026 <command>plasmaengineexplorer</command>
0027
0028 <group choice="opt"><option>-v, --version</option></group>
0029 <group choice="opt"><option>-h, --help</option></group>
0030 <group choice="opt"><option>--list</option></group>
0031 <group choice="opt"><option>--height</option> <replaceable>pixels</replaceable></group>
0032 <group choice="opt"><option>--width</option> <replaceable>pixels</replaceable></group>
0033 <group choice="opt"><option>-x</option> <replaceable>pixels</replaceable></group>
0034 <group choice="opt"><option>-y</option> <replaceable>pixels</replaceable></group>
0035 <group choice="opt"><option>--engine</option> <replaceable>data engine</replaceable></group>
0036 <group choice="opt"><option>--source</option> <replaceable>data engine</replaceable></group>
0037 <group choice="opt"><option>--interval</option> <replaceable>ms</replaceable></group>
0038 <group choice="opt"><option>--app</option> <replaceable>application</replaceable></group>
0039
0040 </cmdsynopsis>
0041 <cmdsynopsis>
0042 <command>plasmaengineexplorer</command>
0043 <arg choice="opt">KDE Generic Options</arg>
0044 <arg choice="opt">Qt Generic Options</arg>
0045 </cmdsynopsis>
0046 </refsynopsisdiv>
0047
0048 <refsect1>
0049 <title>Description</title>
0050 <para><command>plasmaengineexplorer</command> is a graphical tool allowing developers to
0051 test Plasma data engines without writing a Plasma applet.</para>
0052
0053 <para>If no options are given, it will start without any data engine
0054 selected.  The required data engine can be selected from a drop-down list.</para>
0055
0056 <para>Only installed data engines will be found.
0057 <command>kbuildsycoca4</command> may need to be run for newly-installed
0058 data engines to be found.</para>
0059 </refsect1>
0060
0061 <refsect1>
0062 <title>Options</title>
0063
0064 <variablelist>
0065 <varlistentry>
0066 <term><option>-v, --version</option></term>
0067 <listitem><para>Displays version information.</para></listitem>
0068 </varlistentry>
0069 <varlistentry>
0070 <term><option>-h, --help</option></term>
0071 <listitem><para>Displays this help.</para></listitem>
0072 </varlistentry>
0073 <varlistentry>
0074 <term><option>--list <replaceable>pixels</replaceable></option></term>
0075 <listitem><para>Displays a list of known engines and their descriptions.</para></listitem>
0076 </varlistentry>
0077 <varlistentry>
0078 <term><option>--height</option></term>
0079 <listitem><para>Sets the height of the window, in pixels.</para></listitem>
0080 </varlistentry>
0081 <varlistentry>
0082 <term><option>--width <replaceable>pixels</replaceable></option></term>
0083 <listitem><para>Sets the width of the window, in pixels.</para></listitem>
0084 </varlistentry>
0085 <varlistentry>
0086 <term><option>-x <replaceable>pixels</replaceable></option></term>
0087 <listitem><para>Sets the x (horizontal) co-ordinate of the top left corner of the window, in pixels.</para></listitem>
0088 </varlistentry>
0089 <varlistentry>
0090 <term><option>-y <replaceable>pixels</replaceable></option></term>
0091 <listitem><para>Sets the y (vertical) co-ordinate of the top left corner of the window, in pixels.</para></listitem>
0092 </varlistentry>
0093 <varlistentry>
0094 <term><option>--engine <replaceable>data engine</replaceable></option></term>
0095 <listitem><para>Start <command>plasmaengineexplorer</command> with the given data engine
0096 selected.  <parameter>data engine</parameter> is the internal name of the data engine given by
0097 the X-KDE-PluginInfo-Name key of the desktop file.</para></listitem>
0098 </varlistentry>
0099 <varlistentry>
0100 <term><option>--source <replaceable>data engine</replaceable></option></term>
0101 <listitem><para>Only valid in conjunction with <option>--engine</option>.
0102 Requests a specific source from the data engine when
0103 <command>plasmaengineexplorer</command> is started.</para></listitem>
0104 </varlistentry>
0105 <varlistentry>
0106 <term><option>--interval <replaceable>time</replaceable></option></term>
0107 <listitem><para>Sets the default update interval for requested sources
0108 to <parameter>time</parameter> milliseconds.  If not set, the source will update
0109 on demand (for some sources, this will be when new data is available).</para>
0110 <para>If <option>--source</option> is specified, this is the update interval
0111 that will be used when requesting that source.</para></listitem>
0112 </varlistentry>
0113 <varlistentry>
0114 <term><option>--app <replaceable>application</replaceable></option></term>
0115 <listitem><para>Only show engines associated with the parent application; maps to the
0116 X-KDE-ParentApp entry in the DataEngine's .desktop file.</para></listitem>
0117 </varlistentry>
0118
0119 </variablelist>
0120
0121 </refsect1>
0122
0123 <refsect1>
0124 <title>See Also</title>
0125
0126 <para>More detailed user documentation is available from <ulink
0127 url="help:/plasma-desktop">help:/plasma-desktop</ulink>
0128 (either enter this <acronym>URL</acronym> into &konqueror;, or run
0129 <userinput><command>khelpcenter</command>
0130 <parameter>help:/plasma-desktop</parameter></userinput>).</para>
0131
0132 </refsect1>
0133
0134 <refsect1>
0135 <title>Examples</title>
0136 <para>Load the time data engine, showing the local time and updating every
0137 second:</para>
0138 <screen><userinput><command>plasmaengineexplorer</command> <option>--engine time</option> <option>--source Local</option> <option>--interval 1000</option></userinput></screen>
0139
0140 </refsect1>
0141
0142 <refsect1>
0143 <title>Authors</title>
0144 <para><command>plasmaengineexplorer</command> was written by
0145 <personname><firstname>Aaron</firstname><surname>Seigo</surname></personname> <email>aseigo@kde.org</email>.</para>
0146 </refsect1>
0147
0148 </refentry>