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

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