workspace/doc/plasma/tools/man-plasmaengineexplorer.1.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   3 <!ENTITY % English "INCLUDE">
   4 ]>
   5
   6 <refentry lang="&language;">
   7 <refentryinfo>
   8 <title>KDE User's Manual</title>
   9 <date>Jan 2, 2008</date>
  10 <productname>K Desktop Environment</productname>
  11 </refentryinfo>
  12
  13 <refmeta>
  14 <refentrytitle><command>plasmaengineexplorer</command></refentrytitle>
  15 <manvolnum>1</manvolnum>
  16 </refmeta>
  17
  18 <refnamediv>
  19 <refname><command>plasmaengineexplorer</command></refname>
  20 <refpurpose>Provides direct access to plasma data engines</refpurpose>
  21 </refnamediv>
  22
  23 <refsynopsisdiv>
  24 <cmdsynopsis>
  25 <command>plasmaengineexplorer</command>
  26
  27 <group choice="opt"><option>--height</option> <replaceable> pixels</replaceable></group>
  28 <group choice="opt"><option>--width</option> <replaceable> pixels</replaceable></group>
  29 <group choice="opt"><option>-x</option> <replaceable> pixels</replaceable></group>
  30 <group choice="opt"><option>-y</option> <replaceable> pixels</replaceable></group>
  31 <group choice="opt"><option>--engine</option> <replaceable> name</replaceable></group>
  32 <group choice="opt"><option>--source</option> <replaceable> name</replaceable></group>
  33 <group choice="opt"><option>--interval</option> <replaceable> ms</replaceable></group>
  34
  35 </cmdsynopsis>
  36 <cmdsynopsis>
  37 <command>plasmaengineexplorer</command>
  38 <arg choice="opt">KDE Generic Options</arg>
  39 <arg choice="opt">Qt Generic Options</arg>
  40 </cmdsynopsis>
  41 </refsynopsisdiv>
  42
  43 <refsect1>
  44 <title>Description</title>
  45 <para><command>plasmaengineexplorer</command> is a graphical tool allowing developers to
  46 test Plasma data engines without writing a Plasma applet.</para>
  47
  48 <para>If no options are given, it will start without any data engine
  49 selected.  The required data engine can be selected from a drop-down list.</para>
  50
  51 <para>Only installed data engines will be found.
  52 <command>kbuildsycoca4</command> may need to be run for newly-installed
  53 data engines to be found.</para>
  54 </refsect1>
  55
  56 <refsect1>
  57 <title>Options</title>
  58
  59 <variablelist>
  60 <varlistentry>
  61 <term><option>--height <replaceable>pixels</replaceable></option></term>
  62 <listitem><para>Sets the height of the window, in pixels.</para></listitem>
  63 </varlistentry>
  64 <varlistentry>
  65 <term><option>--width <replaceable>pixels</replaceable></option></term>
  66 <listitem><para>Sets the width of the window, in pixels.</para></listitem>
  67 </varlistentry>
  68 <varlistentry>
  69 <term><option>-x <replaceable>pixels</replaceable></option></term>
  70 <listitem><para>Sets the x (horizontal) co-ordinate of the top left corner of the window, in pixels.</para></listitem>
  71 </varlistentry>
  72 <varlistentry>
  73 <term><option>-y <replaceable>pixels</replaceable></option></term>
  74 <listitem><para>Sets the y (vertical) co-ordinate of the top left corner of the window, in pixels.</para></listitem>
  75 </varlistentry>
  76 <varlistentry>
  77 <term><option>--engine <replaceable>name</replaceable></option></term>
  78 <listitem><para>Start <command>plasmaengineexplorer</command> with the given data engine
  79 selected.  <parameter>name</parameter> is the internal name of the data engine given by
  80 the X-KDE-PluginInfo-Name key of the desktop file.</para></listitem>
  81 </varlistentry>
  82 <varlistentry>
  83 <term><option>--source <replaceable>name</replaceable></option></term>
  84 <listitem><para>Only valid in conjunction with <option>--engine</option>.
  85 Requests a specific source from the data engine when
  86 <command>plasmaengineexplorer</command> is started.</para></listitem>
  87 </varlistentry>
  88 <varlistentry>
  89 <term><option>--interval <replaceable>time</replaceable></option></term>
  90 <listitem><para>Sets the default update interval for requested sources
  91 to <parameter>time</parameter> milliseconds.  If not set, the source will update
  92 on demand (for some sources, this will be when new data is available).</para>
  93
  94 <para>If <option>--source</option> is specified, this is the update interval
  95 that will be used when requesting that source.</para></listitem>
  96 </varlistentry>
  97
  98 </variablelist>
  99
 100 </refsect1>
 101
 102 <refsect1>
 103 <title>See Also</title>
 104
 105 <para>More detailed user documentation is available from <ulink
 106 url="help:/plasma">help:/plasma</ulink>
 107 (either enter this <acronym>URL</acronym> into &konqueror;, or run
 108 <userinput><command>khelpcenter</command>
 109 <parameter>help:/plasma</parameter></userinput>).</para>
 110
 111 </refsect1>
 112
 113 <refsect1>
 114 <title>Examples</title>
 115 <para>Load the time data engine, showing the local time and updating every
 116 second:</para>
 117 <screen><userinput><command>plasmaengineexplorer</command> <option>--engine time</option> <option>--source Local</option> <option>--interval 1000</option></userinput></screen>
 118
 119 </refsect1>
 120
 121 <refsect1>
 122 <title>Authors</title>
 123 <para><command>plasmaengineexplorer</command> was written by
 124 <personname><firstname>Aaron</firstname><surname>Seigo</surname></personname> <email>aseigo@kde.org</email>.</para>
 125 </refsect1>
 126
 127 </refentry>