source: kde/kf5-apps/khelpcenter.xml

trunk
Last change on this file was 660581e, checked in by Bruce Dubbs <bdubbs@…>, 8 days ago

Update to kf5-gear-22.04.1 (was kf5-apps).
This commit changes falkon to kf5-gear. Other packages updated:
ark5.xml
gwenview.xml
k3b.xml
kdenlive5.xml
khelpcenter.xml
kio-extras.xml
kmix5.xml
konsole5.xml
libkcddb.xml
libkdcraw.xml
libkexiv2.xml
okular5.xml
kwave.xml
kate5.xml

  • Property mode set to 100644
File size: 4.9 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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
7 <!ENTITY khelpcenter-download-http "&kf5apps-download-http;/khelpcenter-&kf5apps-version;.tar.xz">
8 <!ENTITY khelpcenter-download-ftp " ">
9 <!ENTITY khelpcenter-md5sum "0af1a87fe60e3bc339ac66ead167de7e">
10 <!ENTITY khelpcenter-size "4.1 MB">
11 <!ENTITY khelpcenter-buildsize "27 MB">
12 <!ENTITY khelpcenter-time "0.2 SBU (using parallelism=4)">
13]>
14
15<sect1 id="khelpcenter" xreflabel="khelpcenter-&kf5apps-version;">
16 <?dbhtml filename="khelpcenter.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Khelpcenter-&kf5apps-version;</title>
23
24 <indexterm zone="khelpcenter">
25 <primary sortas="a-khelpcenter">khelpcenter</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Khelpcenter</title>
30
31 <para>
32 <application>Khelpcenter</application> is an application
33 to show KDE Applications' documentation.
34 </para>
35
36 &lfs111_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&khelpcenter-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&khelpcenter-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &khelpcenter-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &khelpcenter-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &khelpcenter-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &khelpcenter-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71
72 <bridgehead renderas="sect3">Khelpcenter Dependencies</bridgehead>
73
74 <bridgehead renderas="sect4">Required</bridgehead>
75 <para role="required">
76 <xref linkend="grantlee"/>,
77 <xref linkend="kf5-frameworks"/>,
78 <xref linkend="libxml2"/>, and
79 <xref linkend="xapian"/>
80 </para>
81
82 <bridgehead renderas="sect4">Recommended</bridgehead>
83 <para role="recommended">
84 <xref linkend="kio-extras"/>
85 </para>
86<!--
87 <note>
88 <para>
89 Khelpcenter does not provide the plugin to display the manual pages.
90 It is found in kio-extras, another <ulink
91 url="&kf5apps-download-http;">KDE application</ulink>.
92 Depending on what is installed on your system, other dependencies
93 may be needed to build it.
94 </para>
95 </note>
96-->
97 <para condition="html" role="usernotes">
98 User Notes: <ulink url="&blfs-wiki;/khelpcenter"/>
99 </para>
100 </sect2>
101
102 <sect2 role="installation">
103 <title>Installation of Khelpcenter</title>
104
105 <para>
106 Install <application>khelpcenter</application> by running the following
107 commands:
108 </para>
109
110<screen><userinput>mkdir build &amp;&amp;
111cd build &amp;&amp;
112
113cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
114 -DCMAKE_BUILD_TYPE=Release \
115 -DBUILD_TESTING=OFF \
116 -Wno-dev .. &amp;&amp;
117make</userinput></screen>
118
119 <para>
120 This package does not come with a test suite.
121 </para>
122
123 <para>
124 Now, as the <systemitem class="username">root</systemitem> user:
125 </para>
126
127<screen role="root"><userinput>make install &amp;&amp;
128
129mv -v $KF5_PREFIX/share/kde4/services/khelpcenter.desktop /usr/share/applications/ &amp;&amp;
130rm -rv $KF5_PREFIX/share/kde4</userinput></screen>
131
132 </sect2>
133
134 <sect2 role="content">
135 <title>Contents</title>
136
137 <segmentedlist>
138 <segtitle>Installed Program</segtitle>
139 <segtitle>Installed Libraries</segtitle>
140 <segtitle>Installed Directories</segtitle>
141
142 <seglistitem>
143 <seg>
144 khelpcenter
145 </seg>
146 <seg>
147 libkdeinit5_khelpcenter.so
148 </seg>
149 <seg>
150 $KF5_PREFIX/share/khelpcenter,
151 $KF5_PREFIX/share/kxmlgui5/khelpcenter, and
152 $KF5_PREFIX/share/doc/HTML/*/{khelpcenter,fundamentals,onlinehelp}
153 </seg>
154 </seglistitem>
155 </segmentedlist>
156
157 <variablelist>
158 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
159 <?dbfo list-presentation="list"?>
160 <?dbhtml list-presentation="table"?>
161
162 <varlistentry id="khelpcenter-prog">
163 <term><command>khelpcenter</command></term>
164 <listitem>
165 <para>
166 is the help viewer for KDE applications
167 </para>
168 <indexterm zone="khelpcenter khelpcenter-prog">
169 <primary sortas="b-khelpcenter">khelpcenter</primary>
170 </indexterm>
171 </listitem>
172 </varlistentry>
173
174 </variablelist>
175
176 </sect2>
177
178</sect1>
Note: See TracBrowser for help on using the repository browser.