Git commit f03dd455e68f64fdd96a24ba13d3509d744ad3d7 by Scarlett Clark. Committed on 20/01/2014 at 16:56. Pushed by scarlettclark into branch 'master'.
Created missing manpage for desktoptojson binary. REVIEW:115063 M +1 -0 docs/CMakeLists.txt A +1 -0 docs/desktoptojson/CMakeLists.txt A +128 -0 docs/desktoptojson/man-desktoptojson.8.docbook http://commits.kde.org/kservice/f03dd455e68f64fdd96a24ba13d3509d744ad3d7 diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 86ed60b..59943b9 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -1,2 +1,3 @@ add_subdirectory(kbuildsycoca5) add_subdirectory(kdeinit5) +add_subdirectory(desktoptojson) diff --git a/docs/desktoptojson/CMakeLists.txt b/docs/desktoptojson/CMakeLists.txt new file mode 100644 index 0000000..6fecff6 --- /dev/null +++ b/docs/desktoptojson/CMakeLists.txt @@ -0,0 +1 @@ +kdoctools_create_manpage(man-desktoptojson.8.docbook 8 INSTALL_DESTINATION ${MAN_INSTALL_DIR}) diff --git a/docs/desktoptojson/man-desktoptojson.8.docbook b/docs/desktoptojson/man-desktoptojson.8.docbook new file mode 100644 index 0000000..5743cdf --- /dev/null +++ b/docs/desktoptojson/man-desktoptojson.8.docbook @@ -0,0 +1,128 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % English "INCLUDE"><!-- change language only here --> +]> + +<refentry> + +<refentryinfo> +<title>&kde; User's Manual</title> +<author> +<firstname>Scarlett</firstname> +<surname>Clark</surname> +<affiliation> +<address><email>scarlett at scarlettgatelyclark.com</email></address> +</affiliation> +</author> + +<date>2014-01-16</date> +<releaseinfo>(&kde; 4.13)</releaseinfo> + +</refentryinfo> + +<refmeta> +<refentrytitle><command>desktoptojson</command></refentrytitle> +<manvolnum>8</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>desktoptojson</command></refname> +<refpurpose>Small program which takes a <literal role="extension">.desktop</literal> file and converts it to json. This is useful to convert plugins which have their metadata in <literal role="extension">.desktop</literal> files (i.e. all KDE plugins) to Qt's new plugin system.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<title>Synopsis</title> + +<cmdsynopsis> +<command>desktoptojson</command> + +<group> +<arg choice="opt">--version</arg> +<arg choice="opt">--help</arg> +<arg choice="opt">--input</arg> +<arg choice="opt">--output</arg> +</group> +</cmdsynopsis> + +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para> +<command>desktoptojson</command>, Small program which takes a <literal role="extension">.desktop</literal> file and converts it to json. This is useful to convert plugins which have their metadata in <literal role="extension">.desktop</literal> files (i.e. all KDE plugins) to Qt's new plugin system. +</para> +<para>Use a <literal role="extension">.desktop</literal> file as the input file to generate json.</para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<varlistentry> +<term><option>--version</option></term> +<listitem> +<para>Displays version information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--help</option></term> +<listitem> +<para>Displays help</para> +</listitem> +</varlistentry> + +<varlistentry> + <term><option>--input <replaceable>name</replaceable></option></term> +<listitem> +<para>Read input from a file.</para> +</listitem> +</varlistentry> + +<varlistentry> + <term><option>--output <replaceable>name</replaceable></option></term> +<listitem> +<para>Write output to a file.</para> +</listitem> +</varlistentry> + +</variablelist> +</refsect1> + +<refsect1> +<title>Usage</title> +<para> +A standard way to run this program is by simply specifying the following +command at the prompt +<userinput><command>desktoptojson</command></userinput> --input <replaceable>filename.desktop</replaceable> --output <replaceable>filename.json</replaceable> +</para> + +</refsect1> + +<refsect1> +<title>Files</title> + +<variablelist> +<varlistentry> +<term><filename>/usr/bin/desktoptojson</filename></term> +<listitem> +<para>The default directory where the excecutable resides.</para> +</listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>Bugs</title> + +<para>If you find bugs use <ulink url="http://bugs.kde.org";>bugs.kde.org</ulink> to report them.</para> + +</refsect1> + +</refentry> + + +
