[network/smb4k] /: Updated handbook and README to reflect the recent changes towards Qt6 / KF6 only application.
Alexander Reinholdt
null at kde.org
Tue Apr 9 20:04:38 BST 2024
Git commit e2ef919b11d9b1da3dfc44f194e6ee1de064725d by Alexander Reinholdt.
Committed on 09/04/2024 at 19:04.
Pushed by areinholdt into branch 'master'.
Updated handbook and README to reflect the recent changes towards Qt6 / KF6 only application.
M +6 -15 README.md
M +6 -21 doc/index.docbook
M +- -- doc/systemsettings_manage_notifications.png
https://invent.kde.org/network/smb4k/-/commit/e2ef919b11d9b1da3dfc44f194e6ee1de064725d
diff --git a/README.md b/README.md
index 24584003..0024efef 100644
--- a/README.md
+++ b/README.md
@@ -49,17 +49,17 @@ To compile Smb4K, you need:
or clang/LLVM (version >= 3.3, https://clang.llvm.org)
Smb4K build depends on:
-- Qt (version >= 5.15.8, https://www.qt.io): QtCore, QtGui, QtWidgets, QtNetwork, QtPrintSupport, QtQml
-- KDE Frameworks (version >= 5.103.0, https://www.kde.org): ECM, KConfig, KAuth, KDocTools, KIconThemes, KWidgetsAddons, KI18n, KCompletion, KCoreAddons, Solid, KIO, KNotifications, KXmlGui, KJobWidgets, KWallet, KDBusAddons, KConfigWidgets, KWindowSystem, KCrash, KDNSSD
+- Qt (version >= 6.6.2, https://www.qt.io): QtCore, QtGui, QtWidgets, QtNetwork, QtPrintSupport, QtQml
+- KDE Frameworks (version >= 6.0.0, https://www.kde.org): ECM, KConfig, KAuth, KDocTools, KIconThemes, KWidgetsAddons, KI18n, KCompletion, KCoreAddons, Solid, KIO, KNotifications, KXmlGui, KJobWidgets, KWallet, KDBusAddons, KConfigWidgets, KWindowSystem, KCrash, KDNSSD
- libsmbclient (version >= 4.10.0, https://www.samba.org)
If you would like to enable WS-Discovery support, you additionally need (see also below for required build option):
-- KDSoap (version >= 1.9.0, https://www.kdab.com/development-resources/qt-tools/kd-soap/)
-- KDSoap WS-Discovery client (version >= 0.2, https://invent.kde.org/libraries/kdsoap-ws-discovery-client)
+- KDSoap (version >= 2.0.0, https://www.kdab.com/development-resources/qt-tools/kd-soap/)
+- KDSoap WS-Discovery client (version >= 0.4.0, https://invent.kde.org/libraries/kdsoap-ws-discovery-client)
It also runtime depends on:
-- KPlasma
-- Kirigami (Qt6 / KF6 only)
+- Plasma-Framework
+- Kirigami
- LinuxCIFS utils (Linux only, https://wiki.samba.org/index.php/LinuxCIFS_utils)
To enable full functionality, you may also want to install:
@@ -82,20 +82,11 @@ To configure, compile and install Smb4K follow the steps below. Make sure, you h
```
3. Configure the source:
- <em>Qt5 and KDE Frameworks 5:</em>
-
``` bash
$ cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
-DSMB4K_INSTALL_PLASMOID=ON -DSMB4K_WITH_WS_DISCOVERY=OFF
```
- <em>Qt6 and KDE Frameworks 6:</em>
-
- ``` bash
- $ cmake -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_WITH_QT6=ON -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
- -DSMB4K_INSTALL_PLASMOID=ON -DSMB4K_WITH_WS_DISCOVERY=OFF
- ```
-
If you want to enable WS-Discovery support, use `-DSMB4K_WITH_WS_DISCOVERY=ON` as argument. To compile Smb4K with debug symbols, replace `Release` by `Debug`.
There are some Smb4K specific CMake arguments you might be interested in:
diff --git a/doc/index.docbook b/doc/index.docbook
index 69f17331..f974dbd3 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1398,7 +1398,7 @@
<sect2 id="notifications_manage">
<title>Managing Notifications</title>
- <para>Notifications can be managed via the &systemsettings;. To modify the behavior of a notification, navigate to the <guibutton>Notifications</guibutton> page. For &plasma; 5.21 and up, next click the <guibutton>Configure</guibutton> button beside the label <guilabel>Applications</guilabel> and choose &smb4k; from the list that appears. Clicking the <guibutton>Configure Events...</guibutton> opens the following dialog:</para>
+ <para>Notifications can be managed via the &systemsettings;. To modify the behavior of a notification, navigate to the <guibutton>Notifications</guibutton> page. In the section <guilabel>Application-specific settings</guilabel> click the <guibutton>Configure</guibutton> button and choose &smb4k; from the list that appears. The following dialog is opened:</para>
<screenshot>
<screeninfo>Screenshot of the systemsettings notification module</screeninfo>
<mediaobject>
@@ -1406,7 +1406,7 @@
<textobject><phrase>Systemsettings notification module</phrase></textobject>
</mediaobject>
</screenshot>
- <para>Here, all available notifications are shown in the list view and can be edited, enabled, or disabled, any way you like.</para>
+ <para>All notifications can be edited here according to your preferences.</para>
</sect2>
</sect1>
@@ -1513,30 +1513,15 @@ server min protocol = NT1
<sect2 id="trouble_shooting_other_desktop_environments">
<title>Other Desktop Environments Than &plasma;</title>
- <para>When using a different desktop environment than &plasma;, &Qt; and &kde-frameworks; applications might be missing some icons. In that case, you might want to install one of these applications:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold"><application>qt5ct</application> (<ulink url="https://sourceforge.net/projects/qt5ct/">download</ulink>) for &Qt; 5 and &kde-frameworks; 5:</emphasis> To use <application>qt5ct</application> with your desktop environment, add the following to your <filename>~/.xinitrc</filename> or <filename>~/.profile</filename> file.</para>
- <para><emphasis>X11:</emphasis></para>
-<programlisting>
-export QT_QPA_PLATFORMTHEME=qt5ct
-</programlisting>
- <para><emphasis>Wayland:</emphasis></para>
-<programlisting>
-export QT_QPA_PLATFORM=wayland
-export QT_QPA_PLATFORMTHEME=qt5ct
-</programlisting></listitem>
- <listitem>
- <para><emphasis role="bold"><application>qt6ct</application> (<ulink url="https://github.com/trialuser02/qt6ct">download</ulink>) for &Qt; 6 and &kde-frameworks; 6:</emphasis> To use <application>qt6ct</application> with your desktop environment, add the following to your <filename>~/.xinitrc</filename> or <filename>~/.profile</filename> file.</para>
- <para><emphasis>X11:</emphasis></para>
+ <para>When using a different desktop environment than &plasma;, &Qt; and &kde-frameworks; applications might be missing some icons. In that case, you might want to install the <application>qt6ct</application> (<ulink url="https://github.com/trialuser02/qt6ct">download</ulink>) application. To use it with your desktop environment, add the following to your <filename>~/.xinitrc</filename> or <filename>~/.profile</filename> file:</para>
+ <para><emphasis>X11:</emphasis></para>
<programlisting>
export QT_QPA_PLATFORMTHEME=qt6ct</programlisting>
- <para><emphasis>Wayland:</emphasis></para>
+ <para><emphasis>Wayland:</emphasis></para>
<programlisting>
export QT_QPA_PLATFORM=wayland
export QT_QPA_PLATFORMTHEME=qt6ct
-</programlisting></listitem>
- </itemizedlist>
+</programlisting>
</sect2>
</sect1>
</chapter>
diff --git a/doc/systemsettings_manage_notifications.png b/doc/systemsettings_manage_notifications.png
index f5d85cf7..0ef1c078 100644
Binary files a/doc/systemsettings_manage_notifications.png and b/doc/systemsettings_manage_notifications.png differ
More information about the kde-doc-english
mailing list