README 5.92 KB
Newer Older
Alexander Reinholdt's avatar
Alexander Reinholdt committed
1
Smb4K README (version 3.0.x)
2
3
============================

Alexander Reinholdt's avatar
Alexander Reinholdt committed
4
5
6
7
8
9
10
Smb4K is an advanced network neighborhood browser and Samba share mounting
utility. It is based on the KDE Frameworks 5 and Samba's client library
(libsmbclient). 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+). Linux, FreeBSD and its derivatives (e. g. GhostBSD and TrueOS), 
NetBSD and DragonFly BSD are officially supported.
11
12
13

Features
--------
Alexander Reinholdt's avatar
Alexander Reinholdt committed
14

15
- Scanning for (active) workgroups, hosts, and shares
Alexander Reinholdt's avatar
Alexander Reinholdt committed
16
- Support of the CIFS (Linux®) and SMBFS (FreeBSD) file system
Alexander Reinholdt's avatar
Alexander Reinholdt committed
17
18
19
20
21
- Mounting and unmounting of shares
- Access to the files of a mounted share using a file manager or terminal
- Auto-detection of external mounts and unmounts
- Remounting of previously used shares on program start
- Miscellaneous infos about remote network items and mounted shares
22
- Network search
Alexander Reinholdt's avatar
Alexander Reinholdt committed
23
- Preview of the contents of a share
24
25
- Default login
- Special handling of homes shares
Alexander Reinholdt's avatar
Alexander Reinholdt committed
26
- Ability to bookmark favorite shares
Alexander Reinholdt's avatar
Alexander Reinholdt committed
27
- System tray widget
Alexander Reinholdt's avatar
Alexander Reinholdt committed
28
- Support of advanced mount options
29
30
31
32
- Support of printer shares
- KWallet support
- Synchronization of a remote share with a local copy and vice versa
- Ability to define custom options for individual servers and shares
Alexander Reinholdt's avatar
Alexander Reinholdt committed
33
- Laptop support through the Solid hardware device framework
Alexander Reinholdt's avatar
Alexander Reinholdt committed
34
35
36
37
- Wake-On-LAN capabilities
- Plasmoid for desktop integration
- Profiles for different network neighborhood setups

38
39
40

Translations
------------
Alexander Reinholdt's avatar
Alexander Reinholdt committed
41

Alexander Reinholdt's avatar
Alexander Reinholdt committed
42
Translations are provided by the KDE translators.
43
44
45

Supported operating systems
---------------------------
Alexander Reinholdt's avatar
Alexander Reinholdt committed
46
47
48

Smb4K officially supports Linux, FreeBSD and its derivatives (e. g. 
GhostBSD and TrueOS), NetBSD and DragonFly BSD.
49
50
51

Requirements
------------
Alexander Reinholdt's avatar
Alexander Reinholdt committed
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

To compile Smb4K, you need:

- CMake (version >= 3.2, https://www.cmake.org)
- GNU Compiler Collection</ulink> (version >= 4.0, https://gcc.gnu.org)
  or clang/LLVM</ulink> (version >= 3.0, http://clang.llvm.org)

To be able to use the main application of Smb4K you need at least Qt, 
version >= 5.6.0 and KDE Frameworks 5 (KF5, version >= 5.25.0, 
https://www.kde.org). If you also want to make use of the provided 
Plasmoid, you should have at least Qt version 5.9.0 or later and 
compatible versions of KF5 and Plasma 5 installed.

Smb4K build depends on:

- QtCore, QtGui, QtWidgets, QtTest, QtNetwork, QtPrintSupport, QtQml
- KConfig, KAuth, KDocTools, KIconThemes, KWidgetsAddons, KI18n, 
  KCompletion, KCoreAddons, Solid, KIO, KNotifications, KXmlGui, 
  KJobWidgets, KWallet;, KDBusAddons, KConfigWidgets, KNotifications, 
  KWindowSystem
- libsmbclient
  
It also runtime depends on:

- KPlasma
- LinuxCIFS utils (&Linux; only, https://wiki.samba.org/index.php/LinuxCIFS_utils)

To enable full functionality, you may also want to install these programs:

- rsync (https://rsync.samba.org)

The full list of changes can be found in the Git log at 
https://cgit.kde.org/smb4k.git. A summary can be found in the ChangeLog file
in the tarball.


Configuration, Compilation and Installation
-------------------------------------------

To configure, compile and install Smb4K follow the steps below. Make sure, 
you have read the Requirements section before you start.

1. Download the version of Smb4K you are interested in and extract the 
   source tarball:

   $ tar xvfj smb4k-x.y.z.tar.xz

2. Replace x.y.z with the version number. Change into the source code 
   directory and create a build directory:

   $ cd smb4k-x.y.z
Alexander Reinholdt's avatar
Alexander Reinholdt committed
103
   $ mkdir build
104
105
106

3. Change into the build directory:

Alexander Reinholdt's avatar
Alexander Reinholdt committed
107
   $ cd build
108
109
110

4. Configure the source:

Alexander Reinholdt's avatar
Alexander Reinholdt committed
111
   $ cmake -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
Alexander Reinholdt's avatar
Alexander Reinholdt committed
112
     -DCMAKE_BUILD_TYPE=Release ..
113

Alexander Reinholdt's avatar
Alexander Reinholdt committed
114
115
116
117
118
119
120
121
122
123
   If Smb4K cannot find some shared libraries after the installation (e.g. 
   if you are using Kubuntu 16.04), it is necessary to add the 
   -DKDE_INSTALL_PLUGINDIR argument to the command line above:

   $ cmake -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
     -DKDE_INSTALL_PLUGINDIR=`qtpaths --plugin-dir` -DCMAKE_BUILD_TYPE=Release ..

   If you want to compile Smb4K with debug symbols, replace Release by Debug.

5. There are some Smb4K specific CMake arguments you might be interested in:
124

Alexander Reinholdt's avatar
Alexander Reinholdt committed
125
126
127
128
129
   -DINSTALL_HEADER_FILES=ON/OFF    Install the core header files. This is off 
                                    by default.
   -DINSTALL_PLASMOID=ON/OFF        Install the plasmoid. This is on by default.

6. After the configuration, compile and install Smb4K:
130
131
132

   $ make && sudo make install

Alexander Reinholdt's avatar
Alexander Reinholdt committed
133
134
135
   If you want to be able to remove Smb4K with your package manager later on, 
   use checkinstall instead of make install. The package should be present in 
   your distribution's repository:
136
137
138

   $ make && sudo checkinstall

Alexander Reinholdt's avatar
Alexander Reinholdt committed
139

140
141
Debugging the Source Code
-------------------------
Alexander Reinholdt's avatar
Alexander Reinholdt committed
142

143
144
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
Alexander Reinholdt's avatar
Alexander Reinholdt committed
145
146
one described in the section above, except that you need to modify the cmake 
command slightly:
147

Alexander Reinholdt's avatar
Alexander Reinholdt committed
148
149
   $ cmake -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
     -DCMAKE_BUILD_TYPE=Debug ..
150
151
152
153
154
155

If you found the cause for a bug, please let us know. A backtrace or a patch
will be much appreciated.

Help and Support
----------------
Alexander Reinholdt's avatar
Alexander Reinholdt committed
156
157
158
159
160

If you encounter problems when using Smb4K and/or need help or support, please
contact us in our 'Help' (https://sourceforge.net/p/smb4k/discussion/help/) or 
'General Discussion' (https://sourceforge.net/p/smb4k/discussion/general/) 
forums.
161
162
163

Bugs
----
Alexander Reinholdt's avatar
Alexander Reinholdt committed
164

Alexander Reinholdt's avatar
Alexander Reinholdt committed
165
You are strongly encouraged to commit a bug report to
Alexander Reinholdt's avatar
Alexander Reinholdt committed
166
https://bugs.kde.org/enter_bug.cgi?product=Smb4k&format=guided, if you find a problem.
167
168
169

Copyright
---------
Alexander Reinholdt's avatar
Alexander Reinholdt committed
170

171
172
173
174
175
Smb4K is released under the terms of the GNU General Public License (GPL),
version 2. A copy of the license is available in the file COPYING.

Latest Version
--------------
Alexander Reinholdt's avatar
Alexander Reinholdt committed
176
177
178

The latest stable version of Smb4K can always be downloaded from
https://sourceforge.net/projects/smb4k/files/latest/download
179