← 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-plasmoidviewer.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-plasmoidviewer.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-21</date>
 
10
<productname>K Desktop Environment</productname>
 
11
</refentryinfo>
 
12
 
 
13
<refmeta>
 
14
<refentrytitle><command>plasmoidviewer</command></refentrytitle>
 
15
<manvolnum>1</manvolnum>
 
16
</refmeta>
 
17
 
 
18
<refnamediv>
 
19
<refname><command>plasmoidviewer</command></refname>
 
20
<refpurpose>Run Plasma widgets in their own window</refpurpose>
 
21
</refnamediv>
 
22
 
 
23
<refsynopsisdiv>
 
24
<cmdsynopsis>
 
25
<command>plasmoidviewer</command>
 
26
 
 
27
<group choice="opt"><option>-c, --containment</option> <replaceable> name</replaceable></group>
 
28
<group choice="opt"><option>-f, --formfactor</option> <replaceable> name</replaceable></group>
 
29
<group choice="opt"><option>--list</option></group>
 
30
<group choice="opt"><option>--list-wallpapers</option></group>
 
31
<group choice="opt"><option>--list-containments</option></group>
 
32
<group choice="opt"><option>-l, --location</option> <replaceable> name</replaceable></group>
 
33
<group choice="opt"><option>-p, --pixmapcache</option> <replaceable> size</replaceable></group>
 
34
<group choice="opt"><option>-s, --screenshot</option></group>
 
35
<group choice="opt"><option>--screenshot-all</option></group>
 
36
<group choice="opt"><option>-t, --theme</option> <replaceable> name</replaceable></group>
 
37
<group choice="opt"><option>-w, --wallpaper</option> <replaceable> name</replaceable></group>
 
38
<arg choice="opt">applet</arg>
 
39
<arg choice="opt">args</arg>
 
40
<arg choice="opt">--list-remote</arg>
 
41
<arg choice="opt">KDE Generic Options</arg>
 
42
<arg choice="opt">Qt Generic Options</arg>
 
43
</cmdsynopsis>
 
44
</refsynopsisdiv>
 
45
 
 
46
<refsect1>
 
47
<title>Description</title>
 
48
<para><command>plasmoidviewer</command> is a graphical tool allowing developers to
 
49
test Plasma applets.</para>
 
50
 
 
51
<para>Only installed applets will be found.
 
52
<command>kbuildsycoca4</command> may need to be run for newly-installed
 
53
applets to be found.</para>
 
54
</refsect1>
 
55
 
 
56
<refsect1>
 
57
<title>Options</title>
 
58
 
 
59
<variablelist>
 
60
<varlistentry>
 
61
<term><option>-c, --containment <replaceable>name</replaceable></option></term>
 
62
<listitem><para>Name of the containment plugin [null].</para></listitem>
 
63
</varlistentry>
 
64
<varlistentry>
 
65
<term><option>-f, --formfactor <replaceable>name</replaceable></option></term>
 
66
<listitem><para>The formfactor to use (horizontal, vertical, mediacenter or planar) [planar].</para></listitem>
 
67
</varlistentry>
 
68
<varlistentry>
 
69
<term><option>--list</option></term>
 
70
<listitem><para>Displays a list of known applets.</para></listitem>
 
71
</varlistentry>
 
72
<varlistentry>
 
73
<term><option>--list-wallpapers</option></term>
 
74
<listitem><para>Displays a list of known wallpapers.</para></listitem>
 
75
</varlistentry>
 
76
<varlistentry>
 
77
<term><option>--list-containments</option></term>
 
78
<listitem><para>Displays a list of known containments.</para></listitem>
 
79
</varlistentry>
 
80
<varlistentry>
 
81
<term><option>-l, --location <replaceable>name</replaceable></option></term>
 
82
<listitem><para>The location constraint to start the Containment with (floating, 
 
83
desktop, fullscreen, top, bottom, left, right) [floating].</para></listitem>
 
84
</varlistentry>
 
85
<varlistentry>
 
86
<term><option>-p, --pixmapcache <replaceable>size</replaceable></option></term>
 
87
<listitem><para>The size in KB to set the pixmap cache to.</para></listitem>
 
88
</varlistentry>
 
89
<varlistentry>
 
90
<term><option>-s, --screenshot</option></term>
 
91
<listitem><para>Takes a screenshot of the widget and saves it the working directory as 
 
92
&lt;pluginname&gt;.png.</para></listitem>
 
93
</varlistentry>
 
94
<varlistentry>
 
95
<term><option>-s, --screenshot-all</option></term>
 
96
<listitem><para>Takes a screenshot of each widget and saves it the working directory as 
 
97
&lt;pluginname&gt;.png.</para></listitem>
 
98
</varlistentry>
 
99
<varlistentry>
 
100
<term><option>-t, --theme <replaceable>name</replaceable></option></term>
 
101
<listitem><para>Desktop SVG theme to use.</para></listitem>
 
102
</varlistentry>
 
103
<varlistentry>
 
104
<term><option>-w, --wallpaper <replaceable>name</replaceable></option></term>
 
105
<listitem><para>Name of the wallpaper plugin. Requires a containment plugin 
 
106
to be specified.</para></listitem>
 
107
</varlistentry>
 
108
<varlistentry>
 
109
<term><option><replaceable>applet</replaceable></option></term>
 
110
<listitem><para>Name of applet to view; may refer to the plugin name or be a path 
 
111
(absolute or relative) to a package. If not provided, then an attempt is made to 
 
112
load a package from the current directory.</para></listitem>
 
113
</varlistentry>
 
114
<varlistentry>
 
115
<term><option><replaceable>args</replaceable></option></term>
 
116
<listitem><para>Optional arguments of the applet to add.</para></listitem>
 
117
</varlistentry>
 
118
<varlistentry>
 
119
<term><option><replaceable>--list-remote</replaceable></option></term>
 
120
<listitem><para>List zeroconf announced remote widgets.</para></listitem>
 
121
</varlistentry>
 
122
 
 
123
</variablelist>
 
124
 
 
125
</refsect1>
 
126
 
 
127
<refsect1>
 
128
<title>See Also</title>
 
129
 
 
130
<para>More detailed user documentation is available from <ulink
 
131
url="help:/plasma-desktop">help:/plasma-desktop</ulink>
 
132
(either enter this <acronym>URL</acronym> into &konqueror;, or run
 
133
<userinput><command>khelpcenter</command>
 
134
<parameter>help:/plasma-desktop</parameter></userinput>).</para>
 
135
 
 
136
</refsect1>
 
137
 
 
138
<refsect1>
 
139
<title>Authors</title>
 
140
<para><command>plasmoidviewer</command> was written by
 
141
<personname><firstname>Aaron</firstname><surname>Seigo</surname></personname> <email>aseigo@kde.org</email>.</para>
 
142
</refsect1>
 
143
 
 
144
</refentry>