diff options
author | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
---|---|---|
committer | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
commit | bd9e6617827818fd043452c08c606f07b78014a0 (patch) | |
tree | 425bb4c3168f9c02f10150f235d2cb998dcc6108 /doc/scripts/man-qtdoc.1.docbook | |
download | tdesdk-bd9e6617827818fd043452c08c606f07b78014a0.tar.gz tdesdk-bd9e6617827818fd043452c08c606f07b78014a0.zip |
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdesdk@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'doc/scripts/man-qtdoc.1.docbook')
-rw-r--r-- | doc/scripts/man-qtdoc.1.docbook | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/scripts/man-qtdoc.1.docbook b/doc/scripts/man-qtdoc.1.docbook new file mode 100644 index 00000000..7491089e --- /dev/null +++ b/doc/scripts/man-qtdoc.1.docbook @@ -0,0 +1,75 @@ +<?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> +<author><personname><firstname>Ben</firstname><surname>Burton</surname></personname><email>bab@debian.org</email></author> +<date>April 8, 2003</date> +</refentryinfo> + +<refmeta> +<refentrytitle><command>qtdoc</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>qtdoc</command></refname> +<refpurpose>Open a &Qt; help page in &konqueror;</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>qtdoc</command> + +<group><option><replaceable>classname</replaceable></option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para><command>qtdoc</command> opens a &Qt; help page in &konqueror;. +If <replaceable>classname</replaceable> is given, it opens the help +page for that class. Otherwise the main &Qt; help page is opened. +<replaceable>classname</replaceable> is case insensitive.</para> + +<para>This utility is part of the &kde; Software Development Kit</para> + +</refsect1> + +<refsect1> +<title>Environment</title> + +<variablelist> +<varlistentry> +<term><envar>QTDIR</envar></term> +<listitem><para>The directory beneath which &Qt; is installed. The main &Qt; help page is expected to be in <filename class="directory">$<envar>QTDIR</envar>/doc/html/</filename>.</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>Examples</title> + +<para>To display the help on the class <classname>QString</classname>:</para> +<screen><userinput><command>qtdoc</command> <option>QString</option></userinput></screen> +</refsect1> + +<refsect1> +<title>See Also</title> + +<para>kdedoc(1), assistant(1)</para> + +</refsect1> + + +<refsect1> +<title>Authors</title> + +<para>This manual page was prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname><email>bab@debian.org</email></para> +</refsect1> + +</refentry> |