blob: 4924eb84175d102bb755ea805c6b7f588fa63a7d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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>TQTDIR</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>TQTDIR</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>
|
