[kde-doc-english] [kjs] /: add missing man page docbook

Albert Astals Cid aacid at kde.org
Fri Feb 13 13:29:43 UTC 2015


Git commit a4139852a3b4f61912c2e1cae9d0798f3708c612 by Albert Astals Cid, on behalf of Burkhard Lück.
Committed on 13/02/2015 at 13:28.
Pushed by aacid into branch 'master'.

add missing man page docbook

Commited by aacid after reading the review and understanding it had a ship it even if not really ship'ed it

REVIEW: 117985

M  +3    -0    CMakeLists.txt
A  +1    -0    docs/CMakeLists.txt
A  +1    -0    docs/kjs/CMakeLists.txt
A  +127  -0    docs/kjs/man-kjs5.1.docbook
M  +1    -1    metainfo.yaml

http://commits.kde.org/kjs/a4139852a3b4f61912c2e1cae9d0798f3708c612

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 7610111..472bf38 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -45,9 +45,12 @@ option(KJS_FORCE_DISABLE_PCRE "Force building of KJS without PCRE. Doing this wi
 # TODO: Remove these
 remove_definitions(-DQT_NO_CAST_FROM_ASCII)
 
+find_package(KF5DocTools ${KF5_DEP_VERSION} REQUIRED)
+
 add_subdirectory(src)
 add_subdirectory(autotests)
 add_subdirectory(tests)
+add_subdirectory(docs)
 
 # create a Config.cmake and a ConfigVersion.cmake file and install them
 set(CMAKECONFIG_INSTALL_DIR "${KDE_INSTALL_CMAKEPACKAGEDIR}/KF5JS")
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
new file mode 100644
index 0000000..0fa6c95
--- /dev/null
+++ b/docs/CMakeLists.txt
@@ -0,0 +1 @@
+add_subdirectory(kjs)
diff --git a/docs/kjs/CMakeLists.txt b/docs/kjs/CMakeLists.txt
new file mode 100644
index 0000000..14ed344
--- /dev/null
+++ b/docs/kjs/CMakeLists.txt
@@ -0,0 +1 @@
+kdoctools_create_manpage(man-kjs5.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
diff --git a/docs/kjs/man-kjs5.1.docbook b/docs/kjs/man-kjs5.1.docbook
new file mode 100644
index 0000000..84a3eea
--- /dev/null
+++ b/docs/kjs/man-kjs5.1.docbook
@@ -0,0 +1,127 @@
+<?xml version="1.0" ?>
+<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
+  <!ENTITY % English "INCLUDE"><!-- change language only here -->
+]>
+
+<refentry>
+
+<refentryinfo>
+<title>Programming Tool</title>
+
+<author>
+<firstname>Harri</firstname>
+<surname>Porten</surname>
+<affiliation>
+<address><email>porten at kde.org</email></address>
+</affiliation>
+</author>
+
+<date>2014-05-04</date>
+<releaseinfo>5.0</releaseinfo>
+
+</refentryinfo>
+
+<refmeta>
+<refentrytitle><command>kjs5</command></refentrytitle>
+<manvolnum>1</manvolnum>
+</refmeta>
+
+<refnamediv>
+<refname><command>kjs5</command></refname>
+<refpurpose>&kde; ECMAScript compatible interpreter</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<title>Synopsis</title>
+
+<cmdsynopsis>
+<command>kjs5</command>
+
+<group>
+<arg choice="opt">--help</arg>
+<arg choice="opt">-help</arg>
+<arg choice="opt">-h</arg>
+</group>
+<group>
+<arg choice="opt">--version</arg>
+<arg choice="opt">-version</arg>
+<arg choice="opt">-v</arg>
+</group>
+<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>Application Options</title>
+<variablelist>
+
+<varlistentry>
+<term><option>--help</option>,<option>-help</option>,<option>-h</option></term>
+<listitem>
+<para>
+Show <command>kjs5</command> usage.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--version</option>,<option>-version</option>,<option>-v</option></term>
+<listitem>
+<para>
+Show <command>kjs5</command> version.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>-e</option><parameter> statement</parameter></term>
+<listitem>
+<para>Executes the statement and exits. For example:</para>
+<screen><command>kjs5</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>kjs5</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>kjscmd5</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>
diff --git a/metainfo.yaml b/metainfo.yaml
index 924f2a2..ea7ba0f 100644
--- a/metainfo.yaml
+++ b/metainfo.yaml
@@ -1,6 +1,6 @@
 maintainer: buschinski
 description: Support for JS scripting in applications
-tier: 1
+tier: 3
 type: functional
 platforms:
     - name: All


More information about the kde-doc-english mailing list