kde-dev-scripts/doc/man-qtdoc.1.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003 <!ENTITY % English "INCLUDE">
0004 ]>
0005
0006 <refentry lang="&language;">
0007 <refentryinfo>
0008 <author><personname><firstname>Ben</firstname><surname>Burton</surname></personname><email>bab@debian.org</email></author>
0009 <date>2003-04-08</date>
0010 </refentryinfo>
0011
0012 <refmeta>
0013 <refentrytitle><command>qtdoc</command></refentrytitle>
0014 <manvolnum>1</manvolnum>
0015 </refmeta>
0016
0017 <refnamediv>
0018 <refname><command>qtdoc</command></refname>
0019 <refpurpose>Open a &Qt; help page in &konqueror;</refpurpose>
0020 </refnamediv>
0021
0022 <refsynopsisdiv>
0023 <cmdsynopsis>
0024 <command>qtdoc</command>
0025
0026 <group><option><replaceable>classname</replaceable></option></group>
0027 </cmdsynopsis>
0028 </refsynopsisdiv>
0029
0030 <refsect1>
0031 <title>Description</title>
0032
0033 <para><command>qtdoc</command> opens a &Qt; help page in &konqueror;.
0034 If <replaceable>classname</replaceable> is given, it opens the help
0035 page for that class.  Otherwise the main &Qt; help page is opened.
0036 <replaceable>classname</replaceable> is case insensitive.</para>
0037
0038 <para>This utility is part of the &kde; Software Development Kit</para>
0039
0040 </refsect1>
0041
0042 <refsect1>
0043 <title>Environment</title>
0044
0045 <variablelist>
0046 <varlistentry>
0047 <term><envar>QTDIR</envar></term>
0048 <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>
0049 </varlistentry>
0050 </variablelist>
0051
0052 </refsect1>
0053
0054 <refsect1>
0055 <title>Examples</title>
0056
0057 <para>To display the help on the class <classname>QString</classname>:</para>
0058 <screen><userinput><command>qtdoc</command> <option>QString</option></userinput></screen>
0059 </refsect1>
0060
0061 <refsect1>
0062 <title>See Also</title>
0063
0064 <para>kdedoc(1), assistant(1)</para>
0065
0066 </refsect1>
0067
0068
0069 <refsect1>
0070 <title>Authors</title>
0071
0072 <para>This manual page was prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname><email>bab@debian.org</email></para>
0073 </refsect1>
0074
0075 </refentry>