Warning, /network/smb4k/README is written in an unsupported language. File is not indexed.

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