diff options
author | Tobias Kortkamp <tobik@FreeBSD.org> | 2019-03-17 10:22:32 +0000 |
---|---|---|
committer | Tobias Kortkamp <tobik@FreeBSD.org> | 2019-03-17 10:22:32 +0000 |
commit | d1d4e45427d989851fe7e43bc2e3634928ab9fff (patch) | |
tree | 09c739f9601ab0ec5c2b53f046f98d0ae12dfd9a /en_US.ISO8859-1/books/porters-handbook/special | |
parent | 737069e4df8efec8686ccff5a8e7db22e31dff5e (diff) | |
download | doc-d1d4e45427d989851fe7e43bc2e3634928ab9fff.tar.gz doc-d1d4e45427d989851fe7e43bc2e3634928ab9fff.zip |
Porter's Handbook: Update KDE and Qt sections
- Remove mention of KDE/Qt 4
- Update examples to use KDE/Qt 5
- Update USE_KDE, USE_QT component lists
Approved by: mat, tcberner
Differential Revision: https://reviews.freebsd.org/D19605
Notes
Notes:
svn path=/head/; revision=52873
Diffstat (limited to 'en_US.ISO8859-1/books/porters-handbook/special')
-rw-r--r-- | en_US.ISO8859-1/books/porters-handbook/special/chapter.xml | 1399 |
1 files changed, 1248 insertions, 151 deletions
diff --git a/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml b/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml index 2160c1c2ae..b3d459cc45 100644 --- a/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml +++ b/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml @@ -2593,15 +2593,10 @@ GLIB_SCHEMAS= org.regexxer.gschema.xml <sect2 xml:id="qt-common"> <title>Ports That Require Qt</title> - <para>The Ports Collection provides support for Qt 4 and Qt 5 - frameworks with - <varname>USES+=qt:<replaceable>x</replaceable></varname>, - where <replaceable>x</replaceable> is - <literal>4</literal> or <literal>5</literal>. - Set <varname>USE_QT</varname> to the list of required - Qt components (libraries, tools, plugins). The Qt 4 - and Qt 5 frameworks are quite similar. The main - difference is the set of supported components.</para> + <para>The Ports Collection provides support for Qt 5 with + <varname>USES+=qt:5</varname>. Set <varname>USE_QT</varname> + to the list of required Qt components (libraries, tools, + plugins).</para> <para>The Qt framework exports a number of variables which can be used by ports, some of them listed below:</para> @@ -2673,8 +2668,7 @@ GLIB_SCHEMAS= org.regexxer.gschema.xml and plugin components are specified with the <literal>_run</literal> suffix. The most commonly used components are listed below (all available components are - listed in <varname>_USE_QT_ALL</varname>, - <varname>_USE_QT4_ONLY</varname>, and + listed in <varname>_USE_QT_ALL</varname>, and <varname>_USE_QT5_ONLY</varname> in <filename>/usr/ports/Mk/Uses/qt.mk</filename>):</para> @@ -2691,58 +2685,367 @@ GLIB_SCHEMAS= org.regexxer.gschema.xml <tbody> <row> + <entry><literal>3d</literal></entry> + <entry>Qt3D module</entry> + </row> + + <row> + <entry><literal>assistant</literal></entry> + <entry>Qt 5 documentation browser</entry> + </row> + + <row> + <entry><literal>canvas3d</literal></entry> + <entry>Qt canvas3d module</entry> + </row> + + <row> + <entry><literal>charts</literal></entry> + <entry>Qt 5 charts module</entry> + </row> + + <row> + <entry><literal>concurrent</literal></entry> + <entry>Qt multi-threading module</entry> + </row> + + <row> + <entry><literal>connectivity</literal></entry> + <entry>Qt connectivity (Bluetooth/NFC) module</entry> + </row> + + <row> <entry><literal>core</literal></entry> - <entry>core library (Qt 5 only)</entry> + <entry>Qt core non-graphical module</entry> </row> <row> - <entry><literal>corelib</literal></entry> - <entry>core library (Qt 4 only)</entry> + <entry><literal>datavis3d</literal></entry> + <entry>Qt 5 3D data visualization module</entry> </row> <row> <entry><literal>dbus</literal></entry> - <entry>Qt DBus library</entry> + <entry>Qt D-Bus inter-process communication + module</entry> + </row> + + <row> + <entry><literal>declarative</literal></entry> + <entry>Qt declarative framework for dynamic user + interfaces</entry> + </row> + + <row> + <entry><literal>designer</literal></entry> + <entry>Qt 5 graphical user interface designer</entry> + </row> + + <row> + <entry><literal>diag</literal></entry> + <entry>Tool for reporting diagnostic information about + Qt and its environment</entry> + </row> + + <row> + <entry><literal>doc</literal></entry> + <entry>Qt 5 documentation</entry> + </row> + + <row> + <entry><literal>examples</literal></entry> + <entry>Qt 5 examples sourcecode</entry> + </row> + + <row> + <entry><literal>gamepad</literal></entry> + <entry>Qt 5 Gamepad Module</entry> + </row> + + <row> + <entry><literal>graphicaleffects</literal></entry> + <entry>Qt Quick graphical effects</entry> </row> <row> <entry><literal>gui</literal></entry> - <entry>graphical user interface library</entry> + <entry>Qt graphical user interface module</entry> + </row> + + <row> + <entry><literal>help</literal></entry> + <entry>Qt online help integration module</entry> + </row> + + <row> + <entry><literal>l10n</literal></entry> + <entry>Qt localized messages</entry> + </row> + + <row> + <entry><literal>linguist</literal></entry> + <entry>Qt 5 translation tool</entry> + </row> + + <row> + <entry><literal>location</literal></entry> + <entry>Qt location module</entry> + </row> + + <row> + <entry><literal>multimedia</literal></entry> + <entry>Qt audio, video, radio and camera support + module</entry> </row> <row> <entry><literal>network</literal></entry> - <entry>network library</entry> + <entry>Qt network module</entry> + </row> + + <row> + <entry><literal>networkauth</literal></entry> + <entry>Qt network auth module</entry> </row> <row> <entry><literal>opengl</literal></entry> - <entry>Qt OpenGL library</entry> + <entry>Qt 5-compatible OpenGL support module</entry> + </row> + + <row> + <entry><literal>paths</literal></entry> + <entry>Command line client to QStandardPaths</entry> + </row> + + <row> + <entry><literal>phonon4</literal></entry> + <entry>KDE multimedia framework</entry> + </row> + + <row> + <entry><literal>pixeltool</literal></entry> + <entry>Qt 5 screen magnifier</entry> + </row> + + <row> + <entry><literal>plugininfo</literal></entry> + <entry>Qt5 plugin metadata dumper</entry> + </row> + + <row> + <entry><literal>printsupport</literal></entry> + <entry>Qt print support module</entry> + </row> + + <row> + <entry><literal>qdbus</literal></entry> + <entry>Qt command-line interface to D-Bus</entry> + </row> + + <row> + <entry><literal>qdbusviewer</literal></entry> + <entry>Qt 5 graphical interface to D-Bus</entry> + </row> + + <row> + <entry><literal>qdoc</literal></entry> + <entry>Qt documentation generator</entry> + </row> + + <row> + <entry><literal>qdoc-data</literal></entry> + <entry>QDoc configuration files</entry> + </row> + + <row> + <entry><literal>qev</literal></entry> + <entry>Qt QWidget events introspection tool</entry> + </row> + + <row> + <entry><literal>qmake</literal></entry> + <entry>Qt Makefile generator</entry> + </row> + + <row> + <entry><literal>quickcontrols</literal></entry> + <entry>Set of controls for building complete interfaces + in Qt Quick</entry> + </row> + + <row> + <entry><literal>quickcontrols2</literal></entry> + <entry>Set of controls for building complete interfaces + in Qt Quick</entry> + </row> + + <row> + <entry><literal>remoteobjects</literal></entry> + <entry>Qt5 SXCML module</entry> </row> <row> <entry><literal>script</literal></entry> - <entry>script library</entry> + <entry>Qt 4-compatible scripting module</entry> + </row> + + <row> + <entry><literal>scripttools</literal></entry> + <entry>Qt Script additional components</entry> + </row> + + <row> + <entry><literal>scxml</literal></entry> + <entry>Qt5 SXCML module</entry> + </row> + + <row> + <entry><literal>sensors</literal></entry> + <entry>Qt sensors module</entry> + </row> + + <row> + <entry><literal>serialbus</literal></entry> + <entry>Qt functions to access industrial bus + systems</entry> + </row> + + <row> + <entry><literal>serialport</literal></entry> + <entry>Qt functions to access serial ports</entry> + </row> + + <row> + <entry><literal>speech</literal></entry> + <entry>Accessibilty features for Qt5</entry> </row> <row> <entry><literal>sql</literal></entry> - <entry>SQL library</entry> + <entry>Qt SQL database integration module</entry> + </row> + + <row> + <entry><literal>sql-ibase</literal></entry> + <entry>Qt InterBase/Firebird database plugin</entry> + </row> + + <row> + <entry><literal>sql-mysql</literal></entry> + <entry>Qt MySQL database plugin</entry> + </row> + + <row> + <entry><literal>sql-odbc</literal></entry> + <entry>Qt Open Database Connectivity plugin</entry> + </row> + + <row> + <entry><literal>sql-pgsql</literal></entry> + <entry>Qt PostgreSQL database plugin</entry> + </row> + + <row> + <entry><literal>sql-sqlite2</literal></entry> + <entry>Qt SQLite 2 database plugin</entry> + </row> + + <row> + <entry><literal>sql-sqlite3</literal></entry> + <entry>Qt SQLite 3 database plugin</entry> + </row> + + <row> + <entry><literal>sql-tds</literal></entry> + <entry>Qt TDS Database Connectivity database + plugin</entry> + </row> + + <row> + <entry><literal>svg</literal></entry> + <entry>Qt SVG support module</entry> </row> <row> <entry><literal>testlib</literal></entry> - <entry>unit testing library</entry> + <entry>Qt unit testing module</entry> + </row> + + <row> + <entry><literal>uiplugin</literal></entry> + <entry>Custom Qt widget plugin interface for Qt + Designer</entry> + </row> + + <row> + <entry><literal>uitools</literal></entry> + <entry>Qt Designer UI forms support module</entry> + </row> + + <row> + <entry><literal>virtualkeyboard</literal></entry> + <entry>Qt 5 Virtual Keyboard Module</entry> + </row> + + <row> + <entry><literal>wayland</literal></entry> + <entry>Qt5 wrapper for Wayland</entry> + </row> + + <row> + <entry><literal>webchannel</literal></entry> + <entry>Qt 5 library for integration of C++/QML with + HTML/js clients</entry> + </row> + + <row> + <entry><literal>webengine</literal></entry> + <entry>Qt 5 library to render web content</entry> </row> <row> <entry><literal>webkit</literal></entry> - <entry>Qt WebKit library</entry> + <entry>QtWebKit with a more modern WebKit code + base</entry> + </row> + + <row> + <entry><literal>websockets</literal></entry> + <entry>Qt implementation of WebSocket protocol</entry> + </row> + + <row> + <entry><literal>websockets-qml</literal></entry> + <entry>Qt implementation of WebSocket protocol (QML + bindings)</entry> + </row> + + <row> + <entry><literal>webview</literal></entry> + <entry>Qt component for displaying web content</entry> + </row> + + <row> + <entry><literal>widgets</literal></entry> + <entry>Qt C++ widgets module</entry> + </row> + + <row> + <entry><literal>x11extras</literal></entry> + <entry>Qt platform-specific features for X11-based + systems</entry> </row> <row> <entry><literal>xml</literal></entry> - <entry>Qt XML library</entry> + <entry>Qt SAX and DOM implementations</entry> + </row> + + <row> + <entry><literal>xmlpatterns</literal></entry> + <entry>Qt support for XPath, XQuery, XSLT and XML + Schema</entry> </row> </tbody> </tgroup> @@ -2765,48 +3068,21 @@ GLIB_SCHEMAS= org.regexxer.gschema.xml <tbody> <row> - <entry><literal>qmake</literal></entry> - <entry>Makefile generator/build utility</entry> - </row> - - <row> <entry><literal>buildtools</literal></entry> <entry>build tools (<command>moc</command>, - <command>rcc</command>), needed for almost - every Qt application (Qt 5 only)</entry> + <command>rcc</command>), needed for almost every + Qt application.</entry> </row> <row> <entry><literal>linguisttools</literal></entry> <entry>localization tools: <command>lrelease</command>, - <command>lupdate</command> (Qt 5 only)</entry> + <command>lupdate</command></entry> </row> <row> - <entry><literal>linguist</literal></entry> - <entry>localization tools: <command>lrelease</command>, - <command>lupdate</command> (Qt 4 only)</entry> - </row> - - <row> - <entry><literal>moc</literal></entry> - <entry>meta object compiler, needed for almost - every Qt application at buildtime (Qt 4 only)</entry> - </row> - - <row> - <entry><literal>rcc</literal></entry> - <entry>resource compiler, needed if the application - comes with <filename>*.rc</filename> or - <filename>*.qrc</filename> files (Qt 4 only)</entry> - </row> - - <row> - <entry><literal>uic</literal></entry> - <entry>user interface compiler, needed if the - application comes with <filename>*.ui</filename> - files, in practice, every Qt - application with a GUI (Qt 4 only)</entry> + <entry><literal>qmake</literal></entry> + <entry>Makefile generator/build utility</entry> </row> </tbody> </tgroup> @@ -2825,12 +3101,6 @@ GLIB_SCHEMAS= org.regexxer.gschema.xml <tbody> <row> - <entry><literal>iconengines</literal></entry> - <entry>SVG icon engine plugin, needed if the application - ships SVG icons (Qt 4 only)</entry> - </row> - - <row> <entry><literal>imageformats</literal></entry> <entry>plugins for TGA, TIFF, and MNG image formats</entry> @@ -2839,23 +3109,23 @@ GLIB_SCHEMAS= org.regexxer.gschema.xml </tgroup> </table> - <example xml:id="qt4-components-example"> - <title>Selecting Qt 4 Components</title> + <example xml:id="qt5-components-example"> + <title>Selecting Qt 5 Components</title> - <para>In this example, the ported application uses the Qt 4 - graphical user interface library, the Qt 4 core library, - all of the Qt 4 code generation tools and Qt 4's Makefile + <para>In this example, the ported application uses the Qt 5 + graphical user interface library, the Qt 5 core library, + all of the Qt 5 code generation tools and Qt 5's Makefile generator. Since the <literal>gui</literal> library implies a dependency on the core library, - <literal>corelib</literal> does not need to be specified. - The Qt 4 code generation tools <literal>moc</literal>, - <literal>uic</literal> and <literal>rcc</literal>, as well - as the Makefile generator <literal>qmake</literal> are + <literal>core</literal> does not need to be specified. + The Qt 5 code generation tools <command>moc</command>, + <command>uic</command> and <command>rcc</command>, as well + as the Makefile generator <command>qmake</command> are only needed at buildtime, thus they are specified with the <literal>_build</literal> suffix:</para> - <programlisting>USES= qt:4 -USE_QT= gui moc_build qmake_build rcc_build uic_build</programlisting> + <programlisting>USES= qt:5 +USE_QT= gui buildtools_build qmake_build</programlisting> </example> </sect2> @@ -2992,12 +3262,8 @@ PLIST_SUB+= QT_INCDIR=${QT_INCDIR_REL} \ <title><literal>USES= qmake</literal> Example</title> <para>This snippet demonstrates the use of - <application>qmake</application> for a Qt 4 port:</para> - - <programlisting>USES= qmake:outsource qt:4 -USE_QT= moc_build</programlisting> + <application>qmake</application> for a Qt 5 port:</para> - <para>For a Qt 5 port:</para> <programlisting>USES= qmake:outsource qt:5 USE_QT= buildtools_build</programlisting> </example> @@ -3040,11 +3306,11 @@ USE_QT= buildtools_build</programlisting> <sect1 xml:id="using-kde"> <title>Using KDE</title> - <sect2 xml:id="kde4-variables"> - <title>KDE 4 Variable Definitions</title> + <sect2 xml:id="kde5-variables"> + <title>KDE Variable Definitions</title> - <para>If the application depends on KDE 4, set - <literal>USES+=kde:4</literal> and + <para>If the application depends on KDE, set + <literal>USES+=kde:5</literal> and <varname>USE_KDE</varname> to the list of required components. <literal>_build</literal> and <literal>_run</literal> suffixes can be used to force @@ -3052,13 +3318,12 @@ USE_QT= buildtools_build</programlisting> <literal>baseapps_run</literal>). If no suffix is set, a default dependency type will be used. To force both types, add the component twice with both suffixes (for example, - <literal>automoc4_build automoc4_run</literal>). The most - commonly used components are listed below (up-to-date - components are documented at the top of - <filename>/usr/ports/Mk/bsd.kde4.mk</filename>):</para> + <literal>ecm_build ecm_run</literal>). Available components + are listed below (up-to-date components are also listed in + <filename>/usr/ports/Mk/Uses/kde.mk</filename>):</para> <table frame="none" xml:id="using-kde-components"> - <title>Available KDE 4 Components</title> + <title>Available KDE Components</title> <tgroup cols="2"> <thead> @@ -3070,46 +3335,615 @@ USE_QT= buildtools_build</programlisting> <tbody> <row> - <entry><literal>kdehier</literal></entry> - <entry>Hierarchy of common KDE directories</entry> + <entry><literal>activities</literal></entry> + <entry>KF5 runtime and library to organize work in + separate activities</entry> + </row> + + <row> + <entry><literal>activities-stats</literal></entry> + <entry>KF5 statistics for activities</entry> + </row> + + <row> + <entry><literal>activitymanagerd</literal></entry> + <entry>System service to manage user's activities, track + the usage patterns</entry> + </row> + + <row> + <entry><literal>akonadi</literal></entry> + <entry>Storage server for KDE-Pim</entry> + </row> + + <row> + <entry><literal>akonadicalendar</literal></entry> + <entry>Akonadi Calendar Integration</entry> + </row> + + <row> + <entry><literal>akonadiconsole</literal></entry> + <entry>Akonadi management and debugging console</entry> + </row> + + <row> + <entry><literal>akonadicontacts</literal></entry> + <entry>Libraries and daemons to implement Contact + Management in Akonadi</entry> + </row> + + <row> + <entry><literal>akonadiimportwizard</literal></entry> + <entry>Import data from other mail clients to + KMail</entry> + </row> + + <row> + <entry><literal>akonadimime</literal></entry> + <entry>Libraries and daemons to implement basic email + handling</entry> + </row> + + <row> + <entry><literal>akonadinotes</literal></entry> + <entry>KDE library for accessing mail storages in MBox + format</entry> + </row> + + <row> + <entry><literal>akonadisearch</literal></entry> + <entry>Libraries and daemons to implement searching in + Akonadi</entry> + </row> + + <row> + <entry><literal>akregator</literal></entry> + <entry>A Feed Reader by KDE</entry> + </row> + + <row> + <entry><literal>alarmcalendar</literal></entry> + <entry>KDE API for KAlarm alarms</entry> + </row> + + <row> + <entry><literal>apidox</literal></entry> + <entry>KF5 API Documentation Tools</entry> + </row> + + <row> + <entry><literal>archive</literal></entry> + <entry>KF5 library that provides classes for handling + archive formats</entry> + </row> + + <row> + <entry><literal>attica</literal></entry> + <entry>Open Collaboration Services API library KDE5 + version</entry> + </row> + + <row> + <entry><literal>attica5</literal></entry> + <entry>Open Collaboration Services API library KDE5 + version</entry> + </row> + + <row> + <entry><literal>auth</literal></entry> + <entry>KF5 abstraction to system policy and + authentication features</entry> + </row> + + <row> + <entry><literal>baloo</literal></entry> + <entry>KF5 Framework for searching and managing user + metadata</entry> + </row> + + <row> + <entry><literal>baloo-widgets</literal></entry> + <entry>BalooWidgets library</entry> + </row> + + <row> + <entry><literal>baloo5</literal></entry> + <entry>KF5 Framework for searching and managing user + metadata</entry> + </row> + + <row> + <entry><literal>blog</literal></entry> + <entry>KDE API for weblogging access</entry> + </row> + + <row> + <entry><literal>bookmarks</literal></entry> + <entry>KF5 library for bookmarks and the XBEL + format</entry> + </row> + + <row> + <entry><literal>breeze</literal></entry> + <entry>Plasma5 artwork, styles and assets for the Breeze + visual style</entry> + </row> + + <row> + <entry><literal>breeze-gtk</literal></entry> + <entry>Plasma5 Breeze visual style for Gtk</entry> + </row> + + <row> + <entry><literal>breeze-icons</literal></entry> + <entry>Breeze icon theme for KDE</entry> + </row> + + <row> + <entry><literal>calendarcore</literal></entry> + <entry>KDE calendar access library</entry> + </row> + + <row> + <entry><literal>calendarsupport</literal></entry> + <entry>Calendar support libraries for KDEPim</entry> + </row> + + <row> + <entry><literal>calendarutils</literal></entry> + <entry>KDE utility and user interface functions for + accessing calendar</entry> + </row> + + <row> + <entry><literal>codecs</literal></entry> + <entry>KF5 library for string manipulation</entry> + </row> + + <row> + <entry><literal>completion</literal></entry> + <entry>KF5 text completion helpers and widgets</entry> + </row> + + <row> + <entry><literal>config</literal></entry> + <entry>KF5 widgets for configuration dialogs</entry> + </row> + + <row> + <entry><literal>configwidgets</literal></entry> + <entry>KF5 widgets for configuration dialogs</entry> + </row> + + <row> + <entry><literal>contacts</literal></entry> + <entry>KDE api to manage contact information</entry> + </row> + + <row> + <entry><literal>coreaddons</literal></entry> + <entry>KF5 addons to QtCore</entry> + </row> + + <row> + <entry><literal>crash</literal></entry> + <entry>KF5 library to handle crash analysis and bug + report from apps</entry> + </row> + + <row> + <entry><literal>dbusaddons</literal></entry> + <entry>KF5 addons to QtDBus</entry> + </row> + + <row> + <entry><literal>decoration</literal></entry> + <entry>Plasma5 library to create window + decorations</entry> + </row> + + <row> + <entry><literal>designerplugin</literal></entry> + <entry>KF5 integration of Frameworks widgets in Qt + Designer/Creator</entry> + </row> + + <row> + <entry><literal>discover</literal></entry> + <entry>Plasma5 package management tools</entry> + </row> + + <row> + <entry><literal>dnssd</literal></entry> + <entry>KF5 abstraction to system DNSSD features</entry> + </row> + + <row> + <entry><literal>doctools</literal></entry> + <entry>KF5 documentation generation from docbook</entry> + </row> + + <row> + <entry><literal>drkonqi</literal></entry> + <entry>Plasma5 crash handler</entry> + </row> + + <row> + <entry><literal>ecm</literal></entry> + <entry>Extra modules and scripts for CMake</entry> + </row> + + <row> + <entry><literal>emoticons</literal></entry> + <entry>KF5 library to convert emoticons</entry> + </row> + + <row> + <entry><literal>eventviews</literal></entry> + <entry>Event view libriares for KDEPim</entry> + </row> + + <row> + <entry><literal>filemetadata</literal></entry> + <entry>KF5 library for extracting file metadata</entry> + </row> + + <row> + <entry><literal>frameworkintegration</literal></entry> + <entry>KF5 workspace and cross-framework integration + plugins</entry> </row> <row> - <entry><literal>kdelibs</literal></entry> - <entry>KDE core libraries</entry> + <entry><literal>gapi</literal></entry> + <entry>KDE based library to access google + services</entry> </row> <row> - <entry><literal>kdeprefix</literal></entry> - <entry>If set, port will be installed into - <literal>${KDE_PREFIX}</literal></entry> + <entry><literal>globalaccel</literal></entry> + <entry>KF5 library to add support for global workspace + shortcuts</entry> </row> <row> - <entry><literal>automoc4</literal></entry> - <entry>Build tool to automatically generate moc + <entry><literal>grantlee-editor</literal></entry> + <entry>Editor for Grantlee themes</entry> + </row> + + <row> + <entry><literal>grantleetheme</literal></entry> + <entry>KDE PIM grantleetheme</entry> + </row> + + <row> + <entry><literal>gravatar</literal></entry> + <entry>Library for gravatar support</entry> + </row> + + <row> + <entry><literal>guiaddons</literal></entry> + <entry>KF5 addons to QtGui</entry> + </row> + + <row> + <entry><literal>holidays</literal></entry> + <entry>KDE library for calendar holidays</entry> + </row> + + <row> + <entry><literal>hotkeys</literal></entry> + <entry>Plasma5 library for hotkeys</entry> + </row> + + <row> + <entry><literal>i18n</literal></entry> + <entry>KF5 advanced internationalization + framework</entry> + </row> + + <row> + <entry><literal>iconthemes</literal></entry> + <entry>KF5 library for handling icons in + applications</entry> + </row> + + <row> + <entry><literal>identitymanagement</literal></entry> + <entry>KDE pim identities</entry> + </row> + + <row> + <entry><literal>idletime</literal></entry> + <entry>KF5 library for monitoring user activity</entry> + </row> + + <row> + <entry><literal>imap</literal></entry> + <entry>KDE API for IMAP support</entry> + </row> + + <row> + <entry><literal>incidenceeditor</literal></entry> + <entry>Incidence editor libriares for KDEPim</entry> + </row> + + <row> + <entry><literal>infocenter</literal></entry> + <entry>Plasma5 utility providing system + information</entry> + </row> + + <row> + <entry><literal>init</literal></entry> + <entry>KF5 process launcher to speed up launching KDE + applications</entry> + </row> + + <row> + <entry><literal>itemmodels</literal></entry> + <entry>KF5 models for Qt Model/View system</entry> + </row> + + <row> + <entry><literal>itemviews</literal></entry> + <entry>KF5 widget addons for Qt Model/View</entry> + </row> + + <row> + <entry><literal>jobwidgets</literal></entry> + <entry>KF5 widgets for tracking KJob instance</entry> + </row> + + <row> + <entry><literal>js</literal></entry> + <entry>KF5 library providing an ECMAScript + interpreter</entry> + </row> + + <row> + <entry><literal>jsembed</literal></entry> + <entry>KF5 library for binding JavaScript objects to + QObjects</entry> + </row> + + <row> + <entry><literal>kaddressbook</literal></entry> + <entry>KDE contact manager</entry> + </row> + + <row> + <entry><literal>kalarm</literal></entry> + <entry>Personal alarm scheduler</entry> + </row> + + <row> + <entry><literal>kalarm</literal></entry> + <entry>Personal alarm scheduler</entry> + </row> + + <row> + <entry><literal>kate</literal></entry> + <entry>Basic editor framework for the KDE system</entry> + </row> + + <row> + <entry><literal>kcmutils</literal></entry> + <entry>KF5 utilities for working with KCModules</entry> + </row> + + <row> + <entry><literal>kde-cli-tools</literal></entry> + <entry>Plasma5 non-interactive system tools</entry> + </row> + + <row> + <entry><literal>kde-gtk-config</literal></entry> + <entry>Plasma5 GTK2 and GTK3 configurator</entry> + </row> + + <row> + <entry><literal>kdeclarative</literal></entry> + <entry>KF5 library providing integration of QML and KDE + Frameworks</entry> + </row> + + <row> + <entry><literal>kded</literal></entry> + <entry>KF5 extensible daemon for providing system level + services</entry> + </row> + + <row> + <entry><literal>kdelibs4support</literal></entry> + <entry>KF5 porting aid from KDELibs4</entry> + </row> + + <row> + <entry><literal>kdepim-addons</literal></entry> + <entry>KDE PIM addons</entry> + </row> + + <row> + <entry><literal>kdepim-apps-libs</literal></entry> + <entry>KDE PIM mail related libraries</entry> + </row> + + <row> + <entry><literal>kdepim-runtime5</literal></entry> + <entry>KDE PIM tools and services</entry> + </row> + + <row> + <entry><literal>kdeplasma-addons</literal></entry> + <entry>Plasma5 addons to improve the Plasma + experience</entry> + </row> + + <row> + <entry><literal>kdesu</literal></entry> + <entry>KF5 integration with su for elevated + privileges</entry> + </row> + + <row> + <entry><literal>kdewebkit</literal></entry> + <entry>KF5 library providing integration of + QtWebKit</entry> + </row> + + <row> + <entry><literal>kgamma5</literal></entry> + <entry>Plasma5 monitor's gamma settings</entry> + </row> + + <row> + <entry><literal>khtml</literal></entry> + <entry>KF5 KTHML rendering engine</entry> + </row> + + <row> + <entry><literal>kimageformats</literal></entry> + <entry>KF5 library providing support for additional + image formats</entry> + </row> + + <row> + <entry><literal>kio</literal></entry> + <entry>KF5 resource and network access + abstraction</entry> + </row> + + <row> + <entry><literal>kirigami2</literal></entry> + <entry>QtQuick based components set</entry> + </row> + + <row> + <entry><literal>kitinerary</literal></entry> + <entry>Data Model and Extraction System for Travel + Reservation information</entry> + </row> + + <row> + <entry><literal>kmail</literal></entry> + <entry>KDE mail client</entry> + </row> + + <row> + <entry><literal>kmail</literal></entry> + <entry>KDE mail client</entry> + </row> + + <row> + <entry><literal>kmail-account-wizard</literal></entry> + <entry>KDE mail account wizard</entry> + </row> + + <row> + <entry><literal>kmenuedit</literal></entry> + <entry>Plasma5 menu editor</entry> + </row> + + <row> + <entry><literal>knotes</literal></entry> + <entry>Popup notes</entry> + </row> + + <row> + <entry><literal>kontact</literal></entry> + <entry>KDE Personal Information Manager</entry> + </row> + + <row> + <entry><literal>kontact</literal></entry> + <entry>KDE Personal Information Manager</entry> + </row> + + <row> + <entry><literal>kontactinterface</literal></entry> + <entry>KDE glue for embedding KParts into + Kontact</entry> + </row> + + <row> + <entry><literal>korganizer</literal></entry> + <entry>Calendar and scheduling Program</entry> + </row> + + <row> + <entry><literal>kpimdav</literal></entry> + <entry>A DAV protocol implementation with KJobs</entry> + </row> + + <row> + <entry><literal>kpkpass</literal></entry> + <entry>Library to deal with Apple Wallet pass files</entry> </row> <row> - <entry><literal>akonadi</literal></entry> - <entry>Storage server for KDE PIM data</entry> + <entry><literal>kross</literal></entry> + <entry>KF5 multi-language application scripting</entry> + </row> + + <row> + <entry><literal>kscreen</literal></entry> + <entry>Plasma5 screen management library</entry> + </row> + + <row> + <entry><literal>kscreenlocker</literal></entry> + <entry>Plasma5 secure lock screen architecture</entry> + </row> + + <row> + <entry><literal>ksmtp</literal></entry> + <entry>Job-based library to send email through an SMTP + server</entry> + </row> + + <row> + <entry><literal>ksshaskpass</literal></entry> + <entry>Plasma5 ssh-add frontend</entry> + </row> + + <row> + <entry><literal>ksysguard</literal></entry> + <entry>Plasma5 utility to track and control the running + processes</entry> + </row> + + <row> + <entry><literal>kwallet-pam</literal></entry> + <entry>Plasma5 KWallet PAM Integration</entry> + </row> + + <row> + <entry><literal>kwayland-integration</literal></entry> + <entry>Integration plugins for a Wayland-based + desktop</entry> + </row> + + <row> + <entry><literal>kwin</literal></entry> + <entry>Plasma5 window manager</entry> </row> <row> - <entry><literal>soprano</literal></entry> - <entry>Library for Resource Description Framework - (RDF)</entry> + <entry><literal>kwrited</literal></entry> + <entry>Plasma5 daemon listening for wall and write + messages</entry> </row> <row> - <entry><literal>strigi</literal></entry> - <entry>Strigi desktop search library</entry> + <entry><literal>ldap</literal></entry> + <entry>LDAP access API for KDE</entry> </row> <row> <entry><literal>libkcddb</literal></entry> - <entry>KDE CDDB (compact disc database) library</entry> + <entry>KDE CDDB library</entry> </row> <row> @@ -3119,19 +3953,29 @@ USE_QT= buildtools_build</programlisting> </row> <row> - <entry><literal>libkdeedu</literal></entry> - <entry>Libraries used by educational - applications</entry> + <entry><literal>libkdcraw</literal></entry> + <entry>LibRaw interface for KDE</entry> </row> <row> - <entry><literal>libkdcraw</literal></entry> - <entry>KDE LibRaw library</entry> + <entry><literal>libkdegames</literal></entry> + <entry>Libraries used by KDE games</entry> + </row> + + <row> + <entry><literal>libkdepim</literal></entry> + <entry>KDE PIM Libraries</entry> + </row> + + <row> + <entry><literal>libkeduvocdocument</literal></entry> + <entry>Library for reading and writing vocabulary + files</entry> </row> <row> <entry><literal>libkexiv2</literal></entry> - <entry>KDE Exiv2 library</entry> + <entry>Exiv2 library interface for KDE</entry> </row> <row> @@ -3140,96 +3984,349 @@ USE_QT= buildtools_build</programlisting> </row> <row> - <entry><literal>libkonq</literal></entry> - <entry>Konqueror core library</entry> + <entry><literal>libkleo</literal></entry> + <entry>Certificate manager for KDE</entry> </row> <row> <entry><literal>libksane</literal></entry> - <entry>KDE SANE ("Scanner Access Now Easy") - library</entry> + <entry>SANE library interface for KDE</entry> </row> <row> - <entry><literal>pimlibs</literal></entry> - <entry>Personal information management libraries</entry> + <entry><literal>libkscreen</literal></entry> + <entry>Plasma5 screen management library</entry> </row> <row> - <entry><literal>kate</literal></entry> - <entry>Advanced text editor framework</entry> + <entry><literal>libksieve</literal></entry> + <entry>Sieve libriares for KDEPim</entry> + </row> + + <row> + <entry><literal>libksysguard</literal></entry> + <entry>Plasma5 library to track and control running + processes</entry> + </row> + + <row> + <entry><literal>mailcommon</literal></entry> + <entry>Common libriares for KDEPim</entry> + </row> + + <row> + <entry><literal>mailimporter</literal></entry> + <entry>Import mbox files to KMail</entry> + </row> + + <row> + <entry><literal>mailtransport</literal></entry> + <entry>KDE library to managing mail transport</entry> </row> <row> <entry><literal>marble</literal></entry> - <entry>Virtual globe and world atlas</entry> + <entry>Virtual globe and world atlas for KDE</entry> + </row> + + <row> + <entry><literal>mbox</literal></entry> + <entry>KDE library for accessing mail storages in MBox + format</entry> + </row> + + <row> + <entry><literal>mbox-importer</literal></entry> + <entry>Import mbox files to KMail</entry> + </row> + + <row> + <entry><literal>mediaplayer</literal></entry> + <entry>KF5 plugin interface for media player + features</entry> + </row> + + <row> + <entry><literal>messagelib</literal></entry> + <entry>Library for handling messages</entry> + </row> + + <row> + <entry><literal>milou</literal></entry> + <entry>Plasma5 Plasmoid for search</entry> + </row> + + <row> + <entry><literal>mime</literal></entry> + <entry>Library for handling MIME data</entry> + </row> + + <row> + <entry><literal>newstuff</literal></entry> + <entry>KF5 library for downloading application assets + from the network</entry> + </row> + + <row> + <entry><literal>notifications</literal></entry> + <entry>KF5 abstraction for system notifications</entry> + </row> + + <row> + <entry><literal>notifyconfig</literal></entry> + <entry>KF5 configuration system for KNotify</entry> </row> <row> <entry><literal>okular</literal></entry> - <entry>Universal document viewer</entry> + <entry>KDE universal document viewer</entry> + </row> + + <row> + <entry><literal>oxygen</literal></entry> + <entry>Plasma5 Oxygen style</entry> + </row> + + <row> + <entry><literal>oxygen-icons5</literal></entry> + <entry>The Oxygen icon theme for KDE</entry> + </row> + + <row> + <entry><literal>package</literal></entry> + <entry>KF5 library to load and install packages</entry> + </row> + + <row> + <entry><literal>parts</literal></entry> + <entry>KF5 document centric plugin system</entry> + </row> + + <row> + <entry><literal>people</literal></entry> + <entry>KF5 library providing access to contacts</entry> + </row> + + <row> + <entry><literal>pim-data-exporter</literal></entry> + <entry>Import and export KDE PIM settings</entry> + </row> + + <row> + <entry><literal>pimcommon</literal></entry> + <entry>Common libriares for KDEPim</entry> + </row> + + <row> + <entry><literal>pimtextedit</literal></entry> + <entry>KDE library for PIM-specific text editing + utilities</entry> + </row> + + <row> + <entry><literal>plasma-browser-integration</literal></entry> + <entry>Plasma5 components to integrate browsers into the + desktop</entry> + </row> + + <row> + <entry><literal>plasma-desktop</literal></entry> + <entry>Plasma5 plasma desktop</entry> + </row> + + <row> + <entry><literal>plasma-framework</literal></entry> + <entry>KF5 plugin based UI runtime used to write user + interfaces</entry> + </row> + + <row> + <entry><literal>plasma-integration</literal></entry> + <entry>Qt Platform Theme integration plugins for the + Plasma workspaces</entry> + </row> + + <row> + <entry><literal>plasma-pa</literal></entry> + <entry>Plasma5 Plasma pulse audio mixer</entry> + </row> + + <row> + <entry><literal>plasma-sdk</literal></entry> + <entry>Plasma5 applications useful for Plasma + development</entry> + </row> + + <row> + <entry><literal>plasma-workspace</literal></entry> + <entry>Plasma5 Plasma workspace</entry> + </row> + + <row> + <entry><literal>plasma-workspace-wallpapers</literal></entry> + <entry>Plasma5 wallpapers</entry> + </row> + + <row> + <entry><literal>plotting</literal></entry> + <entry>KF5 lightweight plotting framework</entry> + </row> + + <row> + <entry><literal>polkit-kde-agent-1</literal></entry> + <entry>Plasma5 daemon providing a polkit authentication + UI</entry> + </row> + + <row> + <entry><literal>powerdevil</literal></entry> + <entry>Plasma5 tool to manage the power consumption + settings</entry> + </row> + + <row> + <entry><literal>prison</literal></entry> + <entry>API to produce barcodes</entry> + </row> + + <row> + <entry><literal>pty</literal></entry> + <entry>KF5 pty abstraction</entry> + </row> + + <row> + <entry><literal>purpose</literal></entry> + <entry>Offers available actions for a specific + purpose</entry> + </row> + + <row> + <entry><literal>qqc2-desktop-style</literal></entry> + <entry>Qt QuickControl2 style for KDE</entry> + </row> + + <row> + <entry><literal>runner</literal></entry> + <entry>KF5 parallelized query system</entry> + </row> + + <row> + <entry><literal>service</literal></entry> + <entry>KF5 advanced plugin and service + introspection</entry> + </row> + + <row> + <entry><literal>solid</literal></entry> + <entry>KF5 hardware integration and detection</entry> + </row> + + <row> + <entry><literal>sonnet</literal></entry> + <entry>KF5 plugin-based spell checking library</entry> + </row> + + <row> + <entry><literal>syndication</literal></entry> + <entry>KDE RSS feed handling library</entry> + </row> + + <row> + <entry><literal>syntaxhighlighting</literal></entry> + <entry>KF5 syntax highlighting engine for structured + text and code</entry> + </row> + + <row> + <entry><literal>systemsettings</literal></entry> + <entry>Plasma5 system settings</entry> + </row> + + <row> + <entry><literal>texteditor</literal></entry> + <entry>KF5 advanced embeddable text editor</entry> + </row> + + <row> + <entry><literal>textwidgets</literal></entry> + <entry>KF5 advanced text editing widgets</entry> + </row> + + <row> + <entry><literal>threadweaver</literal></entry> + <entry>KF5 addons to QtDBus</entry> + </row> + + <row> + <entry><literal>tnef</literal></entry> + <entry>KDE API for the handling of TNEF data</entry> + </row> + + <row> + <entry><literal>unitconversion</literal></entry> + <entry>KF5 library for unit conversion</entry> + </row> + + <row> + <entry><literal>user-manager</literal></entry> + <entry>Plasma5 user manager</entry> + </row> + + <row> + <entry><literal>wallet</literal></entry> + <entry>KF5 secure and unified container for user + passwords</entry> </row> <row> - <entry><literal>korundum</literal></entry> - <entry>KDE Ruby bindings</entry> + <entry><literal>wayland</literal></entry> + <entry>KF5 Client and Server library wrapper for the + Wayland libraries</entry> </row> <row> - <entry><literal>perlkde</literal></entry> - <entry>KDE Perl bindings</entry> + <entry><literal>widgetsaddons</literal></entry> + <entry>KF5 addons to QtWidgets</entry> </row> <row> - <entry><literal>pykde4</literal></entry> - <entry>KDE Python bindings</entry> + <entry><literal>windowsystem</literal></entry> + <entry>KF5 library for access to the windowing + system</entry> </row> <row> - <entry><literal>pykdeuic4</literal></entry> - <entry>PyKDE user interface compiler</entry> + <entry><literal>xmlgui</literal></entry> + <entry>KF5 user configurable main windows</entry> </row> <row> - <entry><literal>smokekde</literal></entry> - <entry>KDE SMOKE libraries</entry> + <entry><literal>xmlrpcclient</literal></entry> + <entry>KF5 interaction with XMLRPC services</entry> </row> </tbody> </tgroup> </table> - <para>KDE 4 ports are installed into - <varname>KDE_PREFIX</varname>. This is - achieved by specifying the <literal>kdeprefix</literal> - component, which overrides the default - <varname>PREFIX</varname>. The ports, however, respect any - <varname>PREFIX</varname> set via the <envar>MAKEFLAGS</envar> - environment variable and/or <command>make</command> - arguments. Currently <varname>KDE_PREFIX</varname> - is identical to the default <varname>PREFIX</varname>, - <literal>${LOCALBASE}</literal>.</para> - - <example xml:id="kde4-components-example"> + <example xml:id="kde5-components-example"> <title><varname>USE_KDE</varname> Example</title> - <para>This is a simple example for a KDE 4 port. + <para>This is a simple example for a KDE port. <literal>USES= cmake</literal> instructs the port to utilize <application>CMake</application>, a - configuration tool widely used by KDE 4 projects (see + configuration tool widely used by KDE projects (see <xref linkend="using-cmake"/> for detailed usage). <varname>USE_KDE</varname> brings dependency on KDE - libraries and makes port using - <command>automoc4</command> at build stage. - Required KDE components and other dependencies can be - determined through configure log. + libraries. Required KDE components and other dependencies + can be determined through the configure log. <varname>USE_KDE</varname> does not imply <varname>USE_QT</varname>. If a port requires some - Qt 4 components, specify them in + Qt components, specify them in <varname>USE_QT</varname>.</para> - <programlisting>USES= cmake kde:4 qt:4 -USE_KDE= kdelibs kdeprefix automoc4 -USE_QT= moc_build qmake_build rcc_build uic_build</programlisting> + <programlisting>USES= cmake kde:5 qt:5 +USE_KDE= ecm +USE_QT= core buildtools_build qmake_build</programlisting> </example> </sect2> </sect1> |