'\" t
.\"     Title: \fBplasmaengineexplorer\fR
.\"    Author: [see the "Authors" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2017-01-09
.\"    Manual: plasmaengineexplorer User's Manual
.\"    Source: KDE Plasma Plasma 5.8
.\"  Language: English
.\"
.TH "\FBPLASMAENGINEEXPLO" "1" "2017\-01\-09" "KDE Plasma Plasma 5.8" "plasmaengineexplorer User's Ma"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
plasmaengineexplorer \- Provides direct access to plasma data engines
.SH "SYNOPSIS"
.HP \w'\fBplasmaengineexplorer\fR\ 'u
\fBplasmaengineexplorer\fR [\fB\-v, \-\-version\fR] [\fB\-h, \-\-help\fR] [\fB\-\-list\fR] [\fB\-\-height\fR\fIpixels\fR] [\fB\-\-width\fR\fIpixels\fR] [\fB\-x\fR\fIpixels\fR] [\fB\-y\fR\fIpixels\fR] [\fB\-\-engine\fR\fIdata engine\fR] [\fB\-\-source\fR\fIdata engine\fR] [\fB\-\-interval\fR\fIms\fR] [\fB\-\-app\fR\fIapplication\fR]
.HP \w'\fBplasmaengineexplorer\fR\ 'u
\fBplasmaengineexplorer\fR [KDE\ Generic\ Options] [Qt\ Generic\ Options]
.SH "DESCRIPTION"
.PP
\fBplasmaengineexplorer\fR
is a graphical tool allowing developers to test Plasma data engines without writing a Plasma applet\&.
.PP
If no options are given, it will start without any data engine selected\&. The required data engine can be selected from a drop\-down list\&.
.PP
Only installed data engines will be found\&.
\fBkbuildsycoca4\fR
may need to be run for newly\-installed data engines to be found\&.
.SH "OPTIONS"
.PP
\fB\-v, \-\-version\fR
.RS 4
Displays version information\&.
.RE
.PP
\fB\-h, \-\-help\fR
.RS 4
Displays this help\&.
.RE
.PP
\fB\-\-list \fR\fB\fIpixels\fR\fR
.RS 4
Displays a list of known engines and their descriptions\&.
.RE
.PP
\fB\-\-height\fR
.RS 4
Sets the height of the window, in pixels\&.
.RE
.PP
\fB\-\-width \fR\fB\fIpixels\fR\fR
.RS 4
Sets the width of the window, in pixels\&.
.RE
.PP
\fB\-x \fR\fB\fIpixels\fR\fR
.RS 4
Sets the x (horizontal) co\-ordinate of the top left corner of the window, in pixels\&.
.RE
.PP
\fB\-y \fR\fB\fIpixels\fR\fR
.RS 4
Sets the y (vertical) co\-ordinate of the top left corner of the window, in pixels\&.
.RE
.PP
\fB\-\-engine \fR\fB\fIdata engine\fR\fR
.RS 4
Start
\fBplasmaengineexplorer\fR
with the given data engine selected\&.
\fIdata engine\fR
is the internal name of the data engine given by the X\-KDE\-PluginInfo\-Name key of the desktop file\&.
.RE
.PP
\fB\-\-source \fR\fB\fIdata engine\fR\fR
.RS 4
Only valid in conjunction with
\fB\-\-engine\fR\&. Requests a specific source from the data engine when
\fBplasmaengineexplorer\fR
is started\&.
.RE
.PP
\fB\-\-interval \fR\fB\fItime\fR\fR
.RS 4
Sets the default update interval for requested sources to
\fItime\fR
milliseconds\&. If not set, the source will update on demand (for some sources, this will be when new data is available)\&.
.sp
If
\fB\-\-source\fR
is specified, this is the update interval that will be used when requesting that source\&.
.RE
.PP
\fB\-\-app \fR\fB\fIapplication\fR\fR
.RS 4
Only show engines associated with the parent application; maps to the X\-KDE\-ParentApp entry in the DataEngine\*(Aqs \&.desktop file\&.
.RE
.SH "SEE ALSO"
.PP
More detailed user documentation is available from
\m[blue]\fBhelp:/plasma\-desktop\fR\m[]
(either enter this
URL
into
Konqueror, or run
\fB\fBkhelpcenter\fR\fR\fB \fR\fB\fIhelp:/plasma\-desktop\fR\fR)\&.
.SH "EXAMPLES"
.PP
Load the time data engine, showing the local time and updating every second:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB\fBplasmaengineexplorer\fR\fR\fB \fR\fB\fB\-\-engine time\fR\fR\fB \fR\fB\fB\-\-source Local\fR\fR\fB \fR\fB\fB\-\-interval 1000\fR\fR
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBplasmaengineexplorer\fR
was written by
Aaron Seigo
<aseigo@kde\&.org>\&.