← Back to branch summary

~ubuntu-branches/ubuntu/utopic/kde-workspace/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/plasma-desktop/tools/man-plasmaengineexplorer.1.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Michał Zając
  • Date: 2011-07-09 08:31:15 UTC
  • Revision ID: james.westby@ubuntu.com-20110709083115-ohyxn6z93mily9fc
Tags: upstream-4.6.90
Import upstream version 4.6.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/plasma-desktop/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>2010-10-06</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>--list</option></group>
 
28
<group choice="opt"><option>--height</option> <replaceable> pixels</replaceable></group>
 
29
<group choice="opt"><option>--width</option> <replaceable> pixels</replaceable></group>
 
30
<group choice="opt"><option>-x</option> <replaceable> pixels</replaceable></group>
 
31
<group choice="opt"><option>-y</option> <replaceable> pixels</replaceable></group>
 
32
<group choice="opt"><option>--engine</option> <replaceable> data engine</replaceable></group>
 
33
<group choice="opt"><option>--source</option> <replaceable> data engine</replaceable></group>
 
34
<group choice="opt"><option>--interval</option> <replaceable> ms</replaceable></group>
 
35
<group choice="opt"><option>--app</option> <replaceable> application</replaceable></group>
 
36
 
 
37
</cmdsynopsis>
 
38
<cmdsynopsis>
 
39
<command>plasmaengineexplorer</command>
 
40
<arg choice="opt">KDE Generic Options</arg>
 
41
<arg choice="opt">Qt Generic Options</arg>
 
42
</cmdsynopsis>
 
43
</refsynopsisdiv>
 
44
 
 
45
<refsect1>
 
46
<title>Description</title>
 
47
<para><command>plasmaengineexplorer</command> is a graphical tool allowing developers to
 
48
test Plasma data engines without writing a Plasma applet.</para>
 
49
 
 
50
<para>If no options are given, it will start without any data engine
 
51
selected.  The required data engine can be selected from a drop-down list.</para>
 
52
 
 
53
<para>Only installed data engines will be found.
 
54
<command>kbuildsycoca4</command> may need to be run for newly-installed
 
55
data engines to be found.</para>
 
56
</refsect1>
 
57
 
 
58
<refsect1>
 
59
<title>Options</title>
 
60
 
 
61
<variablelist>
 
62
<varlistentry>
 
63
<term><option>--list <replaceable>pixels</replaceable></option></term>
 
64
<listitem><para>Displays a list of known engines and their descriptions.</para></listitem>
 
65
</varlistentry>
 
66
<varlistentry>
 
67
<term><option>--height</option></term>
 
68
<listitem><para>Sets the height of the window, in pixels.</para></listitem>
 
69
</varlistentry>
 
70
<varlistentry>
 
71
<term><option>--width <replaceable>pixels</replaceable></option></term>
 
72
<listitem><para>Sets the width of the window, in pixels.</para></listitem>
 
73
</varlistentry>
 
74
<varlistentry>
 
75
<term><option>-x <replaceable>pixels</replaceable></option></term>
 
76
<listitem><para>Sets the x (horizontal) co-ordinate of the top left corner of the window, in pixels.</para></listitem>
 
77
</varlistentry>
 
78
<varlistentry>
 
79
<term><option>-y <replaceable>pixels</replaceable></option></term>
 
80
<listitem><para>Sets the y (vertical) co-ordinate of the top left corner of the window, in pixels.</para></listitem>
 
81
</varlistentry>
 
82
<varlistentry>
 
83
<term><option>--engine <replaceable>data engine</replaceable></option></term>
 
84
<listitem><para>Start <command>plasmaengineexplorer</command> with the given data engine
 
85
selected.  <parameter>data engine</parameter> is the internal name of the data engine given by
 
86
the X-KDE-PluginInfo-Name key of the desktop file.</para></listitem>
 
87
</varlistentry>
 
88
<varlistentry>
 
89
<term><option>--source <replaceable>data engine</replaceable></option></term>
 
90
<listitem><para>Only valid in conjunction with <option>--engine</option>.
 
91
Requests a specific source from the data engine when
 
92
<command>plasmaengineexplorer</command> is started.</para></listitem>
 
93
</varlistentry>
 
94
<varlistentry>
 
95
<term><option>--interval <replaceable>time</replaceable></option></term>
 
96
<listitem><para>Sets the default update interval for requested sources
 
97
to <parameter>time</parameter> milliseconds.  If not set, the source will update
 
98
on demand (for some sources, this will be when new data is available).</para>
 
99
 
 
100
<para>If <option>--source</option> is specified, this is the update interval
 
101
that will be used when requesting that source.</para></listitem>
 
102
</varlistentry>
 
103
<varlistentry>
 
104
<term><option>--app <replaceable>application</replaceable></option></term>
 
105
<listitem><para>Only show engines associated with the parent application; maps to the 
 
106
X-KDE-ParentApp entry in the DataEngine's .desktop file.</para></listitem>
 
107
</varlistentry>
 
108
 
 
109
</variablelist>
 
110
 
 
111
</refsect1>
 
112
 
 
113
<refsect1>
 
114
<title>See Also</title>
 
115
 
 
116
<para>More detailed user documentation is available from <ulink
 
117
url="help:/plasma-desktop">help:/plasma-desktop</ulink>
 
118
(either enter this <acronym>URL</acronym> into &konqueror;, or run
 
119
<userinput><command>khelpcenter</command>
 
120
<parameter>help:/plasma-desktop</parameter></userinput>).</para>
 
121
 
 
122
</refsect1>
 
123
 
 
124
<refsect1>
 
125
<title>Examples</title>
 
126
<para>Load the time data engine, showing the local time and updating every
 
127
second:</para>
 
128
<screen><userinput><command>plasmaengineexplorer</command> <option>--engine time</option> <option>--source Local</option> <option>--interval 1000</option></userinput></screen>
 
129
 
 
130
</refsect1>
 
131
 
 
132
<refsect1>
 
133
<title>Authors</title>
 
134
<para><command>plasmaengineexplorer</command> was written by
 
135
<personname><firstname>Aaron</firstname><surname>Seigo</surname></personname> <email>aseigo@kde.org</email>.</para>
 
136
</refsect1>
 
137
 
 
138
</refentry>