[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[5e96852] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[be4bba9d] | 7 | <!ENTITY khelpcenter-download-http "&kf6apps-download-http;/khelpcenter-&kf6apps-version;.tar.xz">
|
---|
[5e96852] | 8 | <!ENTITY khelpcenter-download-ftp " ">
|
---|
[bbedebd] | 9 | <!ENTITY khelpcenter-md5sum "db5ffba114392ca66db1c2733f2668ed">
|
---|
[0005499] | 10 | <!ENTITY khelpcenter-size "4.0 MB">
|
---|
[bbedebd] | 11 | <!ENTITY khelpcenter-buildsize "22 MB">
|
---|
[14e7e0b] | 12 | <!ENTITY khelpcenter-time "0.2 SBU (using parallelism=4)">
|
---|
[5e96852] | 13 | ]>
|
---|
| 14 |
|
---|
[be4bba9d] | 15 | <sect1 id="khelpcenter" xreflabel="khelpcenter-&kf6apps-version;">
|
---|
[5e96852] | 16 | <?dbhtml filename="khelpcenter.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[0005499] | 19 | <title>khelpcenter-&kf6apps-version;</title>
|
---|
[5e96852] | 20 |
|
---|
| 21 | <indexterm zone="khelpcenter">
|
---|
| 22 | <primary sortas="a-khelpcenter">khelpcenter</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Khelpcenter</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
[8558044] | 29 | <application>Khelpcenter</application> is an application
|
---|
[5e96852] | 30 | to show KDE Applications' documentation.
|
---|
| 31 | </para>
|
---|
| 32 |
|
---|
[bbedebd] | 33 | &lfs122_checked;
|
---|
[5e96852] | 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&khelpcenter-download-http;"/>
|
---|
| 40 | </para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&khelpcenter-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download MD5 sum: &khelpcenter-md5sum;
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download size: &khelpcenter-size;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Estimated disk space required: &khelpcenter-buildsize;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated build time: &khelpcenter-time;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect3">Khelpcenter Dependencies</bridgehead>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 72 | <para role="required">
|
---|
[5bfcd23e] | 73 | <xref linkend="kf6-frameworks"/>,
|
---|
[ed74a9a] | 74 | <xref linkend="libxml2"/>, and
|
---|
| 75 | <xref linkend="xapian"/>
|
---|
[5e96852] | 76 | </para>
|
---|
| 77 |
|
---|
[6b25d09d] | 78 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[2c87187] | 79 | <para role="recommended">
|
---|
[f806bbf2] | 80 | <xref linkend="qtwebengine"/>
|
---|
[6b25d09d] | 81 | </para>
|
---|
[f806bbf2] | 82 |
|
---|
| 83 | <!-- Is this true any more ???
|
---|
[f91e5a91] | 84 | <note>
|
---|
| 85 | <para>
|
---|
| 86 | Khelpcenter does not provide the plugin to display the manual pages.
|
---|
| 87 | It is found in kio-extras, another <ulink
|
---|
[be4bba9d] | 88 | url="&kf6apps-download-http;">KDE application</ulink>.
|
---|
[f91e5a91] | 89 | Depending on what is installed on your system, other dependencies
|
---|
| 90 | may be needed to build it.
|
---|
| 91 | </para>
|
---|
| 92 | </note>
|
---|
[6b25d09d] | 93 | -->
|
---|
[5e96852] | 94 | </sect2>
|
---|
| 95 |
|
---|
| 96 | <sect2 role="installation">
|
---|
| 97 | <title>Installation of Khelpcenter</title>
|
---|
| 98 |
|
---|
| 99 | <para>
|
---|
| 100 | Install <application>khelpcenter</application> by running the following
|
---|
| 101 | commands:
|
---|
| 102 | </para>
|
---|
| 103 |
|
---|
| 104 | <screen><userinput>mkdir build &&
|
---|
| 105 | cd build &&
|
---|
| 106 |
|
---|
[0005499] | 107 | cmake -D CMAKE_INSTALL_PREFIX=$KF6_PREFIX \
|
---|
| 108 | -D CMAKE_BUILD_TYPE=Release \
|
---|
| 109 | -D BUILD_TESTING=OFF \
|
---|
| 110 | -W no-dev .. &&
|
---|
[5e96852] | 111 | make</userinput></screen>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | This package does not come with a test suite.
|
---|
| 115 | </para>
|
---|
| 116 |
|
---|
| 117 | <para>
|
---|
| 118 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 119 | </para>
|
---|
| 120 |
|
---|
[f806bbf2] | 121 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[5e96852] | 122 |
|
---|
| 123 | </sect2>
|
---|
| 124 |
|
---|
| 125 | <sect2 role="content">
|
---|
| 126 | <title>Contents</title>
|
---|
| 127 |
|
---|
| 128 | <segmentedlist>
|
---|
| 129 | <segtitle>Installed Program</segtitle>
|
---|
| 130 | <segtitle>Installed Libraries</segtitle>
|
---|
| 131 | <segtitle>Installed Directories</segtitle>
|
---|
| 132 |
|
---|
| 133 | <seglistitem>
|
---|
| 134 | <seg>
|
---|
| 135 | khelpcenter
|
---|
| 136 | </seg>
|
---|
| 137 | <seg>
|
---|
[f806bbf2] | 138 | None
|
---|
[5e96852] | 139 | </seg>
|
---|
| 140 | <seg>
|
---|
[f806bbf2] | 141 | $KF6_PREFIX/share/khelpcenter,
|
---|
| 142 | $KF6_PREFIX/share/doc/HTML/*/{khelpcenter,fundamentals,onlinehelp}
|
---|
[5e96852] | 143 | </seg>
|
---|
| 144 | </seglistitem>
|
---|
| 145 | </segmentedlist>
|
---|
| 146 |
|
---|
| 147 | <variablelist>
|
---|
| 148 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 149 | <?dbfo list-presentation="list"?>
|
---|
| 150 | <?dbhtml list-presentation="table"?>
|
---|
| 151 |
|
---|
| 152 | <varlistentry id="khelpcenter-prog">
|
---|
| 153 | <term><command>khelpcenter</command></term>
|
---|
| 154 | <listitem>
|
---|
| 155 | <para>
|
---|
[4c24eb0a] | 156 | is the help viewer for KDE applications
|
---|
[5e96852] | 157 | </para>
|
---|
| 158 | <indexterm zone="khelpcenter khelpcenter-prog">
|
---|
| 159 | <primary sortas="b-khelpcenter">khelpcenter</primary>
|
---|
| 160 | </indexterm>
|
---|
| 161 | </listitem>
|
---|
| 162 | </varlistentry>
|
---|
| 163 |
|
---|
| 164 | </variablelist>
|
---|
| 165 |
|
---|
| 166 | </sect2>
|
---|
| 167 |
|
---|
| 168 | </sect1>
|
---|