Warning, /network/smb4k/README.md is written in an unsupported language. File is not indexed.
0001 Smb4K README 0002 ============ 0003 Smb4K is an advanced network neighborhood browser and Samba share mounting utility. It is based on the KDE Frameworks 5, Samba's client library (libsmbclient) and, optionally, the KDSoap WS-Discovery client. It scans your network neighborhood for all available workgroups, servers and shares and can mount all desired shares to your local file system. It is released under the terms of the [GNU General Public License, version 2 (GPL v2+)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html). 0004 0005 Linux, FreeBSD and its derivatives (e. g. GhostBSD), NetBSD and DragonFly BSD are officially supported. 0006 0007 0008 Features 0009 -------- 0010 - Scanning for (active) workgroups, hosts, and shares using Samba's client library, DNS Service Discovery (DNS-SD) and, optionally, Web Services Dynamic Discovery (WS-Discovery) 0011 - Support of the CIFS and SMB3 file system under Linux® as well as the SMBFS file system under BSD 0012 - Mounting and unmounting of shares 0013 - Access to the files of a mounted share using a file manager or terminal 0014 - Auto-detection of external mounts and unmounts 0015 - Remounting of previously used shares on program start 0016 - Miscellaneous infos about remote network items and mounted shares 0017 - Network search 0018 - Preview of the contents of a remote share 0019 - Default login 0020 - Special handling of homes shares 0021 - Ability to bookmark favorite shares 0022 - System tray widget 0023 - Support of advanced mount options 0024 - Support of printer shares 0025 - KWallet support 0026 - Synchronization of a remote share with a local copy and vice versa 0027 - Ability to define custom settings for individual servers and shares 0028 - Hardware support through the Solid device integration framework, the KDBusAddons convenience classes and the Qt Network module 0029 - Wake-On-LAN capabilities 0030 - Plasmoid for desktop integration 0031 - Profiles for different network neighborhood setups 0032 0033 Translations 0034 ------------ 0035 Translations are provided by the KDE translators. 0036 0037 0038 Supported operating systems 0039 --------------------------- 0040 Smb4K officially supports Linux, FreeBSD and its derivatives (e. g. GhostBSD), NetBSD and DragonFly BSD. 0041 0042 0043 Requirements 0044 ------------ 0045 To compile Smb4K, you need: 0046 - CMake (version >= 3.16, https://www.cmake.org) 0047 - GNU Compiler Collection (version >= 5.0, https://gcc.gnu.org) 0048 or clang/LLVM (version >= 3.3, https://clang.llvm.org) 0049 0050 Smb4K build depends on: 0051 - Qt (version >= 5.14, https://www.qt.io): QtCore, QtGui, QtWidgets, 0052 QtNetwork, QtPrintSupport, QtQml 0053 - KDE Frameworks 5 (KF5, version >= 5.80.0, https://www.kde.org): ECM, 0054 KConfig, KAuth, KDocTools, KIconThemes, KWidgetsAddons, KI18n, 0055 KCompletion, KCoreAddons, Solid, KIO, KNotifications, KXmlGui, 0056 KJobWidgets, KWallet, KDBusAddons, KConfigWidgets, KWindowSystem, 0057 KCrash, KDNSSD 0058 - libsmbclient (version >= 4.10.0, https://www.samba.org) 0059 0060 If you would like to enable WS-Discovery support, you additionally need 0061 (see also below for required build option): 0062 - KDSoap (version >= 1.9.0, 0063 https://www.kdab.com/development-resources/qt-tools/kd-soap/) 0064 - KDSoap WS-Discovery client (version >= 0.2, 0065 https://invent.kde.org/libraries/kdsoap-ws-discovery-client) 0066 0067 It also runtime depends on: 0068 - KPlasma 0069 - LinuxCIFS utils (Linux only, https://wiki.samba.org/index.php/LinuxCIFS_utils) 0070 0071 To enable full functionality, you may also want to install: 0072 - rsync (https://rsync.samba.org) 0073 0074 The full list of changes can be found in the Git log at 0075 https://invent.kde.org/network/smb4k. A summary can be found in the ChangeLog file 0076 in the tarball. 0077 0078 0079 Configuration, Compilation and Installation 0080 ------------------------------------------- 0081 To configure, compile and install Smb4K follow the steps below. Make sure, you have read the Requirements section before you start. 0082 0083 1. Download the version of Smb4K you are interested in and extract the source tarball: 0084 ``` bash 0085 $ tar xvfj smb4k-x.y.z.tar.xz 0086 ``` 0087 2. Replace x.y.z with the version number. Change into the source code directory: 0088 ``` bash 0089 $ cd smb4k-x.y.z 0090 ``` 0091 3. Configure the source: 0092 ``` bash 0093 $ cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \ 0094 -DSMB4K_INSTALL_PLASMOID=ON -DSMB4K_WITH_WS_DISCOVERY=OFF 0095 ``` 0096 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`. 0097 0098 There are some Smb4K specific CMake arguments you might be interested in: 0099 0100 | Argument | Description | 0101 |:--------------------------------------------------------------|:---------------------------------------------------------------| 0102 | -DSMB4K_INSTALL_PLASMOID=ON/OFF | Install the plasmoid. This is on by default. | 0103 | -DSMB4K_WITH_WS_DISCOVERY=ON/OFF | Build with WS-Discovery support for browsing. This is off by default. | 0104 0105 4. After the configuration, compile and install Smb4K: 0106 ``` bash 0107 $ cmake --build build 0108 $ sudo cmake --install build 0109 ``` 0110 If you want to be able to remove Smb4K with your package manager later on, use the following approaches depending on your distribution: 0111 0112 <u>Debian, Ubuntu, openSUSE, Fedora, Redhat, Slackware:</u> Use checkinstall instead of make install. The package should be present in your distribution's repository. 0113 ``` bash 0114 $ cmake --build build 0115 $ cd build 0116 $ sudo checkinstall 0117 ``` 0118 0119 <u>Arch, Manjaro:</u> Create a PKGBUILD file inside the source's root directory and run the following command to install Smb4K. 0120 ``` bash 0121 $ makepkg -i 0122 ``` 0123 0124 For all other distributions and operating systems, please have a look at the respective documentation. 0125 0126 Debugging the Source Code 0127 ------------------------- 0128 If you experience crashes or similar and want to debug the source code yourself, compile the source code with debugging symbols. The procedure is similar to the one described in the section above, except that you need to modify the cmake command slightly: 0129 0130 ``` bash 0131 $ cmake -B build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \ 0132 -DSMB4K_INSTALL_PLASMOID=ON -DSMB4K_WITH_WS_DISCOVERY=OFF 0133 ``` 0134 0135 If you found the cause for a bug, please let us know. A backtrace or a patch will be much appreciated. 0136 0137 0138 Help and Support 0139 ---------------- 0140 If you encounter problems when using Smb4K and/or need help or support, please 0141 contact us in our [Help](https://sourceforge.net/p/smb4k/discussion/help/) or [General Discussion](https://sourceforge.net/p/smb4k/discussion/general/) 0142 forums. 0143 0144 Bugs 0145 ---- 0146 You are strongly encouraged to commit a bug report to our [bug tracker](https://bugs.kde.org/enter_bug.cgi?product=Smb4k&format=guided), if you find a problem. 0147 0148 0149 Copyright 0150 --------- 0151 Smb4K is released under the terms of the [GNU General Public License (GPL), version 2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html). A copy of the license is available in the file COPYING. 0152 0153 0154 Latest Version 0155 -------------- 0156 The latest stable version of Smb4K can always be downloaded from out [project's web page](https://sourceforge.net/projects/smb4k/files/latest/download). 0157