[kde-doc-english] [kdelibs/frameworks] doc: Remove kjs and kconfig_compiler manpages

Kevin Ottens ervin at kde.org
Thu Nov 7 16:44:06 UTC 2013


Git commit 7ed7d4e4338a6d22e66bbe19af51c3fc6e0106ae by Kevin Ottens.
Committed on 06/11/2013 at 21:32.
Pushed by ervin into branch 'frameworks'.

Remove kjs and kconfig_compiler manpages

Those pages add no value whatsoever compared to invoking the command
with --help. No need to keep them around then, especially as that'd push
those tier 1 frameworks to use kdoctools which is in tier 2.

M  +0    -4    doc/CMakeLists.txt
D  +0    -1    doc/kconfig_compiler/CMakeLists.txt
D  +0    -457  doc/kconfig_compiler/man-kconfig_compiler.1.docbook
D  +0    -1    doc/kjs/CMakeLists.txt
D  +0    -192  doc/kjs/man-kjs.1.docbook

http://commits.kde.org/kdelibs/7ed7d4e4338a6d22e66bbe19af51c3fc6e0106ae

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index adc6aa3..1e9c207 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -1,7 +1,3 @@
 
 add_subdirectory( common )
 
-if (NOT WIN32)
-    add_subdirectory( kjs )
-    add_subdirectory( kconfig_compiler )
-endif (NOT WIN32)
diff --git a/doc/kconfig_compiler/CMakeLists.txt b/doc/kconfig_compiler/CMakeLists.txt
deleted file mode 100644
index 83a87ad..0000000
--- a/doc/kconfig_compiler/CMakeLists.txt
+++ /dev/null
@@ -1 +0,0 @@
-kdoctools_create_manpage(man-kconfig_compiler.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
diff --git a/doc/kconfig_compiler/man-kconfig_compiler.1.docbook b/doc/kconfig_compiler/man-kconfig_compiler.1.docbook
deleted file mode 100644
index 664295c..0000000
--- a/doc/kconfig_compiler/man-kconfig_compiler.1.docbook
+++ /dev/null
@@ -1,457 +0,0 @@
-<?xml version="1.0" ?>
-<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
-"dtd/kdex.dtd" [
-<!ENTITY % English "INCLUDE">
-]>
-
-<refentry lang="&language;">
-<refentryinfo>
-<title>Programming Tool</title>
-
-<author>
-<firstname>Cornelius</firstname>
-<surname>Schumacher</surname>
-<affiliation>
-<address>
-<email>schumacher at kde.org</email>
-</address>
-</affiliation>
-</author>
-
-<author>
-<firstname>Waldo</firstname>
-<surname>Bastian</surname>
-<affiliation>
-<address>
-<email>bastian at kde.org</email>
-</address>
-</affiliation>
-</author>
-
-<author>
-<firstname>Zack</firstname>
-<surname>Rusin</surname>
-<affiliation>
-<address>
-<email>zack at kde.org</email>
-</address>
-</affiliation>
-</author>
-
-<date>2006-06-01</date>
-<productname>K Desktop Environment</productname>
-</refentryinfo>
-
-<refmeta>
-<refentrytitle>
-<command>kconfig_compiler</command>
-</refentrytitle>
-<manvolnum>1</manvolnum>
-</refmeta>
-
-<refnamediv>
-<refname>kconfig_compiler</refname>
-<refpurpose>KDE configuration compiler</refpurpose>
-</refnamediv>
-
-<refsynopsisdiv>
-<cmdsynopsis>
-<command>kconfig_compiler</command>
-<arg>Qt-options</arg>
-<arg>KDE-options</arg>
-<arg>options</arg>
-<arg choice="plain"><replaceable>file.kcfg</replaceable></arg>
-<arg choice="plain"><replaceable>file.kcfgc</replaceable></arg>
-</cmdsynopsis>
-</refsynopsisdiv>
-
-<refsect1>
-<title>Description</title>
-<para>
-<command>kconfig_compiler</command> generates C++ source code from two files. The first file (.kcfg) contains information about configuration options and the second file (.kcfgc) provides the code generation options.
-</para>
-
-<para>
-The generated source code contains a class based on <command>KConfigSkeleton</command> that provides an API to access the applications configuration data.
-</para>
-</refsect1>
-
-<refsect1>
-<title>Options</title>
-
-<para>
-<variablelist>
-<title><emphasis role="bold">Arguments:</emphasis></title>
-
-<varlistentry>
-<term>
-<replaceable>file.kcfg</replaceable>
-</term>
-<listitem>
-<para>Input kcfg XML file</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<replaceable>file.kcfgc</replaceable>
-</term>
-<listitem>
-<para>Code generation options file</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<para>
-<variablelist>
-<title><emphasis role="bold">Options:</emphasis></title>
-
-<varlistentry>
-<term>
-<option>-d, --directory <dir></option>
-</term>
-<listitem>
-<para>Directory to generate files in [.]</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<para>
-<variablelist>
-<title><emphasis role="bold">Generic options:</emphasis></title>
-
-<varlistentry>
-<term>
-<option>--help</option>
-</term>
-<listitem>
-<para>Show help about options</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--help-qt</option>
-</term>
-<listitem>
-<para>Show Qt specific options</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--help-kde</option>
-</term>
-<listitem>
-<para>Show KDE specific options</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--help-all</option>
-</term>
-<listitem>
-<para>Show all options</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--author</option>
-</term>
-<listitem>
-<para>Show author information</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>-v, --version</option>
-</term>
-<listitem>
-<para>Show version information</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--license</option>
-</term>
-<listitem>
-<para>Show license information</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<para>
-<variablelist>
-<title><emphasis role="bold">KDE Options:</emphasis></title>
-
-<varlistentry>
-<term>
-<option>--caption <caption></option>
-</term>
-<listitem>
-<para>Use 'caption' as name in the titlebar</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--icon <icon></option>
-</term>
-<listitem>
-<para>Use 'icon' as the application icon</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--miniicon <icon></option>
-</term>
-<listitem>
-<para>Use 'icon' as the application icon</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--config <filename></option>
-</term>
-<listitem>
-<para>Use alternative configuration file</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--dcopserver <server></option>
-</term>
-<listitem>
-<para>Use the DCOP server specified by 'server'</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--nocrashhandler</option>
-</term>
-<listitem>
-<para>Disable crash handler to get core dumps</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--waitforwm</option>
-</term>
-<listitem>
-<para>Waits for a WM_NET compatible windowmanager</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--style <style></option>
-</term>
-<listitem>
-<para>Sets the application GUI style</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--geometry <geometry></option>
-</term>
-<listitem>
-<para>Sets the client geometry of the main widget - see man X for the argument format</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<para>
-<variablelist>
-<title><emphasis role="bold">Qt options:</emphasis></title>
-
-<varlistentry>
-<term>
-<option>--display <displayname></option>
-</term>
-<listitem>
-<para>Use the X-server display 'displayname'</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--session <sessionId></option>
-</term>
-<listitem>
-<para>Restore the application for the given 'sessionId'</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--cmap</option>
-</term>
-<listitem>
-<para>Causes the application to install a private color map on an 8-bit display</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--ncols <count></option>
-</term>
-<listitem>
-<para>Limits the number of colors allocated in the color cube on an 8-bit display, if the application is using the QApplication::ManyColor color specification</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--nograb</option>
-</term>
-<listitem>
-<para>Tells Qt to never grab the mouse or the keyboard</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--sync</option>
-</term>
-<listitem>
-<para>Switches to synchronous mode for debugging</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--fn, --font <fontname></option>
-</term>
-<listitem>
-<para>Defines the application font</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--bg, --background <color></option>
-</term>
-<listitem>
-<para>Sets the default background color and an application palette (light and dark shades are calculated)</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--fg, --foreground <color></option>
-</term>
-<listitem>
-<para>Sets the default foreground color</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--btn, --button <color></option>
-</term>
-<listitem>
-<para>Sets the default button color</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--name <name></option>
-</term>
-<listitem>
-<para>Sets the application name</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--title <title></option>
-</term>
-<listitem>
-<para>Sets the application title (caption)</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--visual TrueColor</option>
-</term>
-<listitem>
-<para>Forces the application to use a TrueColor visual on an 8-bit display</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--inputstyle <inputstyle></option>
-</term>
-<listitem>
-<para>Sets XIM (X Input Method) input style. Possible values are onthespot, overthespot, offthespot, and root</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--im <XIM server></option>
-</term>
-<listitem>
-<para>Sets XIM server</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--noxim</option>
-</term>
-<listitem>
-<para>Disable XIM</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<option>--reverse</option>
-</term>
-<listitem>
-<para>Mirrors the whole layout of widgets</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-</refsect1>
-
-<refsect1>
-<title>See Also</title>
-<variablelist>
-<varlistentry>
-<term>
-<option>http://developer.kde.org</option>
-</term>
-<listitem>
-<para>KDE Developer's Corner website</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</refsect1>
-
-<refsect1>
-<title>Bugs</title>
-<para>Please use <ulink url="http://bugs.kde.org">bugs.kde.org</ulink> to report bugs, do not mail the authors directly.</para>
-</refsect1>
-
-</refentry>
diff --git a/doc/kjs/CMakeLists.txt b/doc/kjs/CMakeLists.txt
deleted file mode 100644
index 5b46c1c..0000000
--- a/doc/kjs/CMakeLists.txt
+++ /dev/null
@@ -1 +0,0 @@
-kdoctools_create_manpage(man-kjs.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
diff --git a/doc/kjs/man-kjs.1.docbook b/doc/kjs/man-kjs.1.docbook
deleted file mode 100644
index 14055da..0000000
--- a/doc/kjs/man-kjs.1.docbook
+++ /dev/null
@@ -1,192 +0,0 @@
-<?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>Harri</firstname>
-<surname>Porten</surname>
-<affiliation>
-<address><email>porten at kde.org</email></address>
-</affiliation>
-</author>
-
-<date>2008-10-15</date>
-<releaseinfo>0.01.01</releaseinfo>
-
-</refentryinfo>
-
-<refmeta>
-<refentrytitle><command>kjs</command></refentrytitle>
-<manvolnum>1</manvolnum>
-</refmeta>
-
-<refnamediv>
-<refname><command>kjs</command></refname>
-<refpurpose>&kde; ECMAScript compatible interpreter</refpurpose>
-</refnamediv>
-
-<refsynopsisdiv>
-<title>Synopsis</title>
-
-<cmdsynopsis>
-<command>kjs</command>
-
-<group>
-<arg choice="opt">--help</arg>
-<arg choice="opt">-help</arg>
-<arg choice="opt">-h</arg>
-</group>
-<!--
-<arg choice="opt">Generic-options</arg>
-<arg choice="opt">Qt-options</arg>
-<arg choice="opt">KDE-options</arg>
--->
-<group>
-<arg choice="opt">-e<replaceable> statement</replaceable></arg>
-</group>
-<group>
-<arg choice="plain"><replaceable>script</replaceable></arg>
-</group>
-</cmdsynopsis>
-</refsynopsisdiv>
-
-<refsect1>
-<title>Description</title>
-
-<para><command>kjs</command> is KDE ECMAScript/JavaScript engine.
-</para>
-</refsect1>
-<!--
-<refsect1>
-<title>Generic Options</title>
-<para>
-<variablelist>
-
-<varlistentry>
-<term><option>- -author</option></term>
-<listitem>
-<para>
-Show author information.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>- -help</option></term>
-<listitem>
-<para>
-Show help about options.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>- -help-all</option></term>
-<listitem>
-<para>
-Show all options.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>- -help-kde</option></term>
-<listitem>
-<para>
-Show KDE specific options.
-</para>
-
-
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>- -help-qt</option></term>
-<listitem>
-<para>
-Show Qt specific options.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>- -license</option></term>
-<listitem>
-<para>
-Show license information.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>-v</option><option>- -version</option></term>
-<listitem>
-<para>
-Show version information
-</para>
-</listitem>
-</varlistentry>
-
-</variablelist>
-</para>
-</refsect1>
--->
-<refsect1>
-<title>Application Options</title>
-<variablelist>
-
-<varlistentry>
-<term><option>--help</option>,<option>-help</option>,<option>-h</option></term>
-<listitem>
-<para>
-Show <command>kjscmd</command> usage.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>-e</option><parameter> statement</parameter></term>
-<listitem>
-<para>Executes the statement and exits. For example:</para>
-<screen><command>kjs</command> -e "print('hello world')"</screen>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><parameter>script</parameter></term>
-<listitem>
-<para>Executes the statements included in file <parameter>script</parameter>.</para>
-</listitem>
-</varlistentry>
-
-</variablelist>
-
-</refsect1>
-
-<refsect1>
-<title>Usage</title>
-<para>
-<command>kjs</command> <parameter>file</parameter>, as many other interpreters, when called without parameters
-uses a line editor to enter statements, showing the prompt 
-<literallayout>JS></literallayout>
-To exit the line editor type <command>quit()</command> or press <command>Ctrl+D</command>.
-</para>
-</refsect1>
-
-<refsect1>
-<title>See Also</title>
-<para><replaceable>kjs</replaceable>(1)</para>
-</refsect1>
-
-<refsect1>
-<title>Bugs</title>
-<para>There are probably tons of bugs. Use <ulink url="http://bugs.kde.org">bugs.kde.org</ulink> to report them.</para>
-</refsect1>
-
-</refentry>



More information about the kde-doc-english mailing list