Warning, /plasma/plasma-sdk/plasmoidviewer/man-plasmoidviewer.1.docbook is written in an unsupported language. File is not indexed.
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>plasmoidviewer 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>plasmoidviewer</command></refentrytitle> 0016 <manvolnum>1</manvolnum> 0017 </refmeta> 0018 0019 <refnamediv> 0020 <refname><command>plasmoidviewer</command></refname> 0021 <refpurpose>Run Plasma widgets in their own window</refpurpose> 0022 </refnamediv> 0023 0024 <refsynopsisdiv> 0025 <cmdsynopsis> 0026 <command>plasmoidviewer</command> 0027 0028 <group choice="opt"><option>-v, --version</option></group> 0029 <group choice="opt"><option>-c, --containment</option> <replaceable>name</replaceable></group> 0030 <group choice="opt"><option>-a, --applet</option> <replaceable>name</replaceable></group> 0031 <group choice="opt"><option>-f, --formfactor</option> <replaceable>name</replaceable></group> 0032 <group choice="opt"><option>-l, --location</option> <replaceable>name</replaceable></group> 0033 <group choice="opt"><option>-x, --xPosition</option> <replaceable>xPosition</replaceable></group> 0034 <group choice="opt"><option>-y, --yPosition</option> <replaceable>yPosition</replaceable></group> 0035 <group choice="opt"><option>-s, --size</option> <replaceable>widthXheight</replaceable></group> 0036 <group choice="opt"><option>-p, --pixmapcache</option> <replaceable>size</replaceable></group> 0037 <group choice="opt"><option>-t, --theme</option> <replaceable>name</replaceable></group> 0038 <group choice="opt"><option>-h, --help</option></group> 0039 <arg choice="opt">args</arg> 0040 </cmdsynopsis> 0041 </refsynopsisdiv> 0042 0043 <refsect1> 0044 <title>Description</title> 0045 <para><command>plasmoidviewer</command> is a graphical tool allowing developers to 0046 test Plasma applets.</para> 0047 0048 <para>Only installed applets will be found. 0049 <command>kbuildsycoca5</command> may need to be run for newly-installed 0050 applets to be found.</para> 0051 </refsect1> 0052 0053 <refsect1> 0054 <title>Options</title> 0055 0056 <variablelist> 0057 <varlistentry> 0058 <term><option>-v, --version</option></term> 0059 <listitem><para>Displays version information.</para></listitem> 0060 </varlistentry> 0061 <varlistentry> 0062 <term><option>-c, --containment <replaceable>name</replaceable></option></term> 0063 <listitem><para>The name of the containment plugin.</para></listitem> 0064 </varlistentry> 0065 <varlistentry> 0066 <term><option>-a, --applet <replaceable>name</replaceable></option></term> 0067 <listitem><para>The name of the applet plugin.</para></listitem> 0068 </varlistentry> 0069 <varlistentry> 0070 <term><option>-f, --formfactor <replaceable>name</replaceable></option></term> 0071 <listitem><para>The formfactor to use (horizontal, vertical, mediacenter, planar or application).</para></listitem> 0072 </varlistentry> 0073 <varlistentry> 0074 <term><option>-l, --location <replaceable>name</replaceable></option></term> 0075 <listitem><para>The location constraint to start the Containment with (floating, 0076 desktop, fullscreen, topedge, bottomedge, leftedge, rightedge).</para></listitem> 0077 </varlistentry> 0078 <varlistentry> 0079 <term><option>-x, --xPosition <replaceable>xPosition</replaceable></option></term> 0080 <listitem><para>Set the x position of the plasmoidviewer on the Plasma desktop.</para></listitem> 0081 </varlistentry> 0082 <varlistentry> 0083 <term><option>-y, --yPosition <replaceable>yPosition</replaceable></option></term> 0084 <listitem><para>Set the y position of the plasmoidviewer on the Plasma desktop.</para></listitem> 0085 </varlistentry> 0086 <varlistentry> 0087 <term><option>-s, --size <replaceable>widthXheight</replaceable></option></term> 0088 <listitem><para>Set the window size of the plasmoidview.</para></listitem> 0089 </varlistentry> 0090 <varlistentry> 0091 <term><option>-p, --pixmapcache <replaceable>size</replaceable></option></term> 0092 <listitem><para>The size in KB to set the pixmap cache to.</para></listitem> 0093 </varlistentry> 0094 <varlistentry> 0095 <term><option>-t, --theme <replaceable>name</replaceable></option></term> 0096 <listitem><para>The name of the theme which the shell will use.</para></listitem> 0097 </varlistentry> 0098 <varlistentry> 0099 <term><option>-h, --help</option></term> 0100 <listitem><para>Displays this help.</para></listitem> 0101 </varlistentry> 0102 <varlistentry> 0103 <term><option><replaceable>args</replaceable></option></term> 0104 <listitem><para>Data that should be passed to the applet as 0105 'externalData' event.</para></listitem> 0106 </varlistentry> 0107 0108 </variablelist> 0109 0110 </refsect1> 0111 0112 <refsect1> 0113 <title>See Also</title> 0114 0115 <para>More detailed user documentation is available from <ulink 0116 url="help:/plasma-desktop">help:/plasma-desktop</ulink> 0117 (either enter this <acronym>URL</acronym> into &konqueror;, or run 0118 <userinput><command>khelpcenter</command> 0119 <parameter>help:/plasma-desktop</parameter></userinput>).</para> 0120 0121 </refsect1> 0122 0123 <refsect1> 0124 <title>Authors</title> 0125 <para><command>plasmoidviewer</command> was written by 0126 <personname><firstname>Aaron</firstname><surname>Seigo</surname></personname> <email>aseigo@kde.org</email>.</para> 0127 </refsect1> 0128 0129 </refentry>