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 
0034 Translations
0035 ------------
0036 Translations are provided by the KDE translators.
0037 
0038 
0039 Supported operating systems
0040 ---------------------------
0041 Smb4K officially supports Linux, FreeBSD and its derivatives (e. g. GhostBSD), NetBSD and DragonFly BSD.
0042 
0043 
0044 Requirements
0045 ------------
0046 To compile Smb4K, you need:
0047 - CMake (version >= 3.16, https://www.cmake.org)
0048 - GNU Compiler Collection (version >= 5.0, https://gcc.gnu.org)
0049   or clang/LLVM (version >= 3.3, https://clang.llvm.org)
0050 
0051 Smb4K build depends on:
0052 - Qt (version >= 5.15.8, https://www.qt.io): QtCore, QtGui, QtWidgets,
0053   QtNetwork, QtPrintSupport, QtQml
0054 - KDE Frameworks 5 (KF5, version >= 5.103.0, https://www.kde.org): ECM,
0055   KConfig, KAuth, KDocTools, KIconThemes, KWidgetsAddons, KI18n, 
0056   KCompletion, KCoreAddons, Solid, KIO, KNotifications, KXmlGui, 
0057   KJobWidgets, KWallet, KDBusAddons, KConfigWidgets, KWindowSystem,
0058   KCrash, KDNSSD
0059 - libsmbclient (version >= 4.10.0, https://www.samba.org)
0060 
0061 If you would like to enable WS-Discovery support, you additionally need
0062 (see also below for required build option):
0063 - KDSoap (version >= 1.9.0,
0064   https://www.kdab.com/development-resources/qt-tools/kd-soap/)
0065 - KDSoap WS-Discovery client (version >= 0.2, 
0066   https://invent.kde.org/libraries/kdsoap-ws-discovery-client)
0067 
0068 It also runtime depends on:
0069 - KPlasma
0070 - LinuxCIFS utils (Linux only, https://wiki.samba.org/index.php/LinuxCIFS_utils)
0071 
0072 To enable full functionality, you may also want to install:
0073 - rsync (https://rsync.samba.org)
0074 
0075 The full list of changes can be found in the Git log at 
0076 https://invent.kde.org/network/smb4k. A summary can be found in the ChangeLog file
0077 in the tarball.
0078 
0079 
0080 Configuration, Compilation and Installation
0081 -------------------------------------------
0082 To configure, compile and install Smb4K follow the steps below. Make sure, you have read the Requirements section before you start.
0083 
0084 1. Download the version of Smb4K you are interested in and extract the source tarball:
0085    ``` bash
0086    $ tar xvfj smb4k-x.y.z.tar.xz
0087    ```
0088 2. Replace x.y.z with the version number. Change into the source code directory:
0089    ``` bash
0090    $ cd smb4k-x.y.z
0091    ```
0092 3. Configure the source:
0093    ``` bash
0094    $ cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
0095    -DSMB4K_INSTALL_PLASMOID=ON -DSMB4K_WITH_WS_DISCOVERY=OFF
0096    ```
0097    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`. 
0098 
0099    There are some Smb4K specific CMake arguments you might be interested in:
0100    
0101    | Argument                                                          | Description                                                         |
0102    |:--------------------------------------------------------------|:---------------------------------------------------------------|
0103    | -DSMB4K_INSTALL_PLASMOID=ON/OFF     | Install the plasmoid. This is on by default.   |
0104    | -DSMB4K_WITH_WS_DISCOVERY=ON/OFF  | Build with WS-Discovery support for browsing. This is off by default. |
0105 
0106 4. After the configuration, compile and install Smb4K:
0107    ``` bash
0108    $ cmake --build build
0109    $ sudo cmake --install build
0110    ```
0111    If you want to be able to remove Smb4K with your package manager later on, use the following approaches depending on your distribution:
0112    
0113      <u>Debian, Ubuntu, openSUSE, Fedora, Redhat, Slackware:</u> Use checkinstall instead of make install. The package should be present in your distribution's repository.
0114       ``` bash
0115       $ cmake --build build
0116       $ cd build
0117       $ sudo checkinstall
0118       ```
0119 
0120      <u>Arch, Manjaro:</u> Create a PKGBUILD file inside the source's root directory and run the following command to install Smb4K.
0121      ``` bash
0122      $ makepkg -i
0123      ```
0124       
0125    For all other distributions and operating systems, please have a look at the respective documentation.
0126 
0127 
0128 Debugging the Source Code
0129 -------------------------
0130 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:
0131 
0132 ``` bash
0133    $ cmake -B build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
0134    -DSMB4K_INSTALL_PLASMOID=ON -DSMB4K_WITH_WS_DISCOVERY=OFF
0135 ```
0136 
0137 If you found the cause for a bug, please let us know. A backtrace or a patch will be much appreciated.
0138 
0139 
0140 Help and Support
0141 ----------------
0142 If you encounter problems when using Smb4K and/or need help or support, please
0143 contact us in our [Help](https://sourceforge.net/p/smb4k/discussion/help/) or [General Discussion](https://sourceforge.net/p/smb4k/discussion/general/) 
0144 forums.
0145 
0146 
0147 Bugs
0148 ----
0149 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.
0150 
0151 
0152 Copyright
0153 ---------
0154 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.
0155 
0156 
0157 Latest Version
0158 --------------
0159 The latest stable version of Smb4K can always be downloaded from our [project's web page](https://sourceforge.net/projects/smb4k/files/latest/download).
0160