[plasma-sdk] /: update engineexplorer + plasmoidviewer manpages and include in build
Burkhard Lück
null at kde.org
Tue Jan 10 18:21:57 UTC 2017
Git commit 6e92f39fb9064c39d456fdca38e598d3dc8f88ad by Burkhard Lück.
Committed on 10/01/2017 at 18:21.
Pushed by lueck into branch 'master'.
update engineexplorer + plasmoidviewer manpages and include in build
Differential Revision: https://phabricator.kde.org/D4054
M +1 -1 CMakeLists.txt
M +1 -2 engineexplorer/CMakeLists.txt
M +22 -12 engineexplorer/man-plasmaengineexplorer.1.docbook
M +1 -2 plasmoidviewer/CMakeLists.txt
M +39 -54 plasmoidviewer/man-plasmoidviewer.1.docbook
https://commits.kde.org/plasma-sdk/6e92f39fb9064c39d456fdca38e598d3dc8f88ad
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 7f891ad..e68b47f 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -82,7 +82,7 @@ endif()
# Load CMake, Compiler and InstallDirs settings from KF5 and the following are already somewhat "done" tier1/tier2 libs from kdelibs:
find_package(KF5 REQUIRED COMPONENTS
Archive Completion Config ConfigWidgets CoreAddons DBusAddons Declarative I18n IconThemes ItemModels
- KIO Plasma PlasmaQuick Service TextEditor WidgetsAddons XmlGui WindowSystem)
+ KIO Plasma PlasmaQuick Service TextEditor WidgetsAddons XmlGui WindowSystem DocTools)
#########################################################################
diff --git a/engineexplorer/CMakeLists.txt b/engineexplorer/CMakeLists.txt
index a7055b0..bec5ce0 100644
--- a/engineexplorer/CMakeLists.txt
+++ b/engineexplorer/CMakeLists.txt
@@ -25,5 +25,4 @@ target_link_libraries(plasmaengineexplorer
install(TARGETS plasmaengineexplorer ${INSTALL_TARGETS_DEFAULT_ARGS})
-# FIXME: needs replacement
-#kde4_create_manpage(man-plasmaengineexplorer.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
+kdoctools_create_manpage (man-plasmaengineexplorer.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
diff --git a/engineexplorer/man-plasmaengineexplorer.1.docbook b/engineexplorer/man-plasmaengineexplorer.1.docbook
index 65369cf..3d79db4 100644
--- a/engineexplorer/man-plasmaengineexplorer.1.docbook
+++ b/engineexplorer/man-plasmaengineexplorer.1.docbook
@@ -5,9 +5,10 @@
<refentry lang="&language;">
<refentryinfo>
-<title>KDE User's Manual</title>
-<date>2010-10-06</date>
-<productname>K Desktop Environment</productname>
+<title>plasmaengineexplorer User's Manual</title>
+<date>2017-01-09</date>
+<releaseinfo>Plasma 5.8</releaseinfo>
+<productname>KDE Plasma</productname>
</refentryinfo>
<refmeta>
@@ -24,15 +25,17 @@
<cmdsynopsis>
<command>plasmaengineexplorer</command>
+<group choice="opt"><option>-v, --version</option></group>
+<group choice="opt"><option>-h, --help</option></group>
<group choice="opt"><option>--list</option></group>
-<group choice="opt"><option>--height</option> <replaceable> pixels</replaceable></group>
-<group choice="opt"><option>--width</option> <replaceable> pixels</replaceable></group>
-<group choice="opt"><option>-x</option> <replaceable> pixels</replaceable></group>
-<group choice="opt"><option>-y</option> <replaceable> pixels</replaceable></group>
-<group choice="opt"><option>--engine</option> <replaceable> data engine</replaceable></group>
-<group choice="opt"><option>--source</option> <replaceable> data engine</replaceable></group>
-<group choice="opt"><option>--interval</option> <replaceable> ms</replaceable></group>
-<group choice="opt"><option>--app</option> <replaceable> application</replaceable></group>
+<group choice="opt"><option>--height</option> <replaceable>pixels</replaceable></group>
+<group choice="opt"><option>--width</option> <replaceable>pixels</replaceable></group>
+<group choice="opt"><option>-x</option> <replaceable>pixels</replaceable></group>
+<group choice="opt"><option>-y</option> <replaceable>pixels</replaceable></group>
+<group choice="opt"><option>--engine</option> <replaceable>data engine</replaceable></group>
+<group choice="opt"><option>--source</option> <replaceable>data engine</replaceable></group>
+<group choice="opt"><option>--interval</option> <replaceable>ms</replaceable></group>
+<group choice="opt"><option>--app</option> <replaceable>application</replaceable></group>
</cmdsynopsis>
<cmdsynopsis>
@@ -60,6 +63,14 @@ data engines to be found.</para>
<variablelist>
<varlistentry>
+<term><option>-v, --version</option></term>
+<listitem><para>Displays version information.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>-h, --help</option></term>
+<listitem><para>Displays this help.</para></listitem>
+</varlistentry>
+<varlistentry>
<term><option>--list <replaceable>pixels</replaceable></option></term>
<listitem><para>Displays a list of known engines and their descriptions.</para></listitem>
</varlistentry>
@@ -96,7 +107,6 @@ Requests a specific source from the data engine when
<listitem><para>Sets the default update interval for requested sources
to <parameter>time</parameter> milliseconds. If not set, the source will update
on demand (for some sources, this will be when new data is available).</para>
-
<para>If <option>--source</option> is specified, this is the update interval
that will be used when requesting that source.</para></listitem>
</varlistentry>
diff --git a/plasmoidviewer/CMakeLists.txt b/plasmoidviewer/CMakeLists.txt
index 022b01d..1c0ff46 100644
--- a/plasmoidviewer/CMakeLists.txt
+++ b/plasmoidviewer/CMakeLists.txt
@@ -21,8 +21,7 @@ target_link_libraries(plasmoidviewer
install(TARGETS plasmoidviewer ${INSTALL_TARGETS_DEFAULT_ARGS})
-#FIXME
-#kde4_create_manpage(man-plasmoidviewer.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
+kdoctools_create_manpage (man-plasmoidviewer.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
#qml
plasma_install_package(qmlpackages/shell org.kde.plasma.plasmoidviewershell shells shell)
diff --git a/plasmoidviewer/man-plasmoidviewer.1.docbook b/plasmoidviewer/man-plasmoidviewer.1.docbook
index 2477183..f412b63 100644
--- a/plasmoidviewer/man-plasmoidviewer.1.docbook
+++ b/plasmoidviewer/man-plasmoidviewer.1.docbook
@@ -5,9 +5,10 @@
<refentry lang="&language;">
<refentryinfo>
-<title>KDE User's Manual</title>
-<date>2010-10-21</date>
-<productname>K Desktop Environment</productname>
+<title>plasmoidviewer User's Manual</title>
+<date>2017-01-09</date>
+<releaseinfo>Plasma 5.8</releaseinfo>
+<productname>KDE Plasma</productname>
</refentryinfo>
<refmeta>
@@ -24,22 +25,18 @@
<cmdsynopsis>
<command>plasmoidviewer</command>
-<group choice="opt"><option>-c, --containment</option> <replaceable> name</replaceable></group>
-<group choice="opt"><option>-f, --formfactor</option> <replaceable> name</replaceable></group>
-<group choice="opt"><option>--list</option></group>
-<group choice="opt"><option>--list-wallpapers</option></group>
-<group choice="opt"><option>--list-containments</option></group>
-<group choice="opt"><option>-l, --location</option> <replaceable> name</replaceable></group>
-<group choice="opt"><option>-p, --pixmapcache</option> <replaceable> size</replaceable></group>
-<group choice="opt"><option>-s, --screenshot</option></group>
-<group choice="opt"><option>--screenshot-all</option></group>
-<group choice="opt"><option>-t, --theme</option> <replaceable> name</replaceable></group>
-<group choice="opt"><option>-w, --wallpaper</option> <replaceable> name</replaceable></group>
-<arg choice="opt">applet</arg>
+<group choice="opt"><option>-v, --version</option></group>
+<group choice="opt"><option>-c, --containment</option> <replaceable>name</replaceable></group>
+<group choice="opt"><option>-a, --applet</option> <replaceable>name</replaceable></group>
+<group choice="opt"><option>-f, --formfactor</option> <replaceable>name</replaceable></group>
+<group choice="opt"><option>-l, --location</option> <replaceable>name</replaceable></group>
+<group choice="opt"><option>-x, --xPosition</option> <replaceable>xPosition</replaceable></group>
+<group choice="opt"><option>-y, --yPosition</option> <replaceable>yPosition</replaceable></group>
+<group choice="opt"><option>-s, --size</option> <replaceable>widthXheight</replaceable></group>
+<group choice="opt"><option>-p, --pixmapcache</option> <replaceable>size</replaceable></group>
+<group choice="opt"><option>-t, --theme</option> <replaceable>name</replaceable></group>
+<group choice="opt"><option>-h, --help</option></group>
<arg choice="opt">args</arg>
-<arg choice="opt">--list-remote</arg>
-<arg choice="opt">KDE Generic Options</arg>
-<arg choice="opt">Qt Generic Options</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -49,7 +46,7 @@
test Plasma applets.</para>
<para>Only installed applets will be found.
-<command>kbuildsycoca4</command> may need to be run for newly-installed
+<command>kbuildsycoca5</command> may need to be run for newly-installed
applets to be found.</para>
</refsect1>
@@ -58,66 +55,54 @@ applets to be found.</para>
<variablelist>
<varlistentry>
-<term><option>-c, --containment <replaceable>name</replaceable></option></term>
-<listitem><para>Name of the containment plugin [null].</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>-f, --formfactor <replaceable>name</replaceable></option></term>
-<listitem><para>The formfactor to use (horizontal, vertical, mediacenter or planar) [planar].</para></listitem>
+<term><option>-v, --version</option></term>
+<listitem><para>Displays version information.</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>--list</option></term>
-<listitem><para>Displays a list of known applets.</para></listitem>
+<term><option>-c, --containment <replaceable>name</replaceable></option></term>
+<listitem><para>The name of the containment plugin.</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>--list-wallpapers</option></term>
-<listitem><para>Displays a list of known wallpapers.</para></listitem>
+<term><option>-a, --applet <replaceable>name</replaceable></option></term>
+<listitem><para>The name of the applet plugin.</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>--list-containments</option></term>
-<listitem><para>Displays a list of known containments.</para></listitem>
+<term><option>-f, --formfactor <replaceable>name</replaceable></option></term>
+<listitem><para>The formfactor to use (horizontal, vertical, mediacenter, planar or application).</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-l, --location <replaceable>name</replaceable></option></term>
<listitem><para>The location constraint to start the Containment with (floating,
-desktop, fullscreen, topedge, bottomedge, leftedge, rightedge) [floating].</para></listitem>
+desktop, fullscreen, topedge, bottomedge, leftedge, rightedge).</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>-p, --pixmapcache <replaceable>size</replaceable></option></term>
-<listitem><para>The size in KB to set the pixmap cache to.</para></listitem>
+<term><option>-x, --xPosition <replaceable>xPosition</replaceable></option></term>
+<listitem><para>Set the x position of the plasmoidviewer on the plasma desktop.</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>-s, --screenshot</option></term>
-<listitem><para>Takes a screenshot of the widget and saves it the working directory as
-<pluginname>.png.</para></listitem>
+<term><option>-y, --yPosition <replaceable>yPosition</replaceable></option></term>
+<listitem><para>Set the y position of the plasmoidviewer on the plasma desktop.</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>-s, --screenshot-all</option></term>
-<listitem><para>Takes a screenshot of each widget and saves it the working directory as
-<pluginname>.png.</para></listitem>
+<term><option>-s, --size <replaceable>widthXheight</replaceable></option></term>
+<listitem><para>Set the window size of the plasmoidview.</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>-t, --theme <replaceable>name</replaceable></option></term>
-<listitem><para>Desktop SVG theme to use.</para></listitem>
+<term><option>-p, --pixmapcache <replaceable>size</replaceable></option></term>
+<listitem><para>The size in KB to set the pixmap cache to.</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>-w, --wallpaper <replaceable>name</replaceable></option></term>
-<listitem><para>Name of the wallpaper plugin. Requires a containment plugin
-to be specified.</para></listitem>
+<term><option>-t, --theme <replaceable>name</replaceable></option></term>
+<listitem><para>The name of the theme which the shell will use.</para></listitem>
</varlistentry>
<varlistentry>
-<term><option><replaceable>applet</replaceable></option></term>
-<listitem><para>Name of applet to view; may refer to the plugin name or be a path
-(absolute or relative) to a package. If not provided, then an attempt is made to
-load a package from the current directory.</para></listitem>
+<term><option>-h, --help</option></term>
+<listitem><para>Displays this help.</para></listitem>
</varlistentry>
<varlistentry>
<term><option><replaceable>args</replaceable></option></term>
-<listitem><para>Optional arguments of the applet to add.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option><replaceable>--list-remote</replaceable></option></term>
-<listitem><para>List zeroconf announced remote widgets.</para></listitem>
+<listitem><para>Data that should be passed to the applet as
+'externalData' event.</para></listitem>
</varlistentry>
</variablelist>
More information about the kde-doc-english
mailing list