1
Smb4K README (version 0.10.x)
1
Smb4K README (version 1.0.x)
2
2
============================
4
Smb4K is an SMB/CIFS share browser for KDE. It uses the Samba software suite to
5
access the SMB/CIFS shares of the local network neighborhood. Its purpose is to
6
provide a program that's easy to use and has as many features as possible.
4
Smb4K is an advanced network neighborhood browser for KDE. It uses the Samba
5
software suite to access the shares of the local network neighborhood. Its
6
purpose is to provide a program that's easy to use and has as many features
10
- Smb4K is a KDE 4.x-only application now.
11
- It has a cmake build system.
12
- The support of Solaris and IRIX has been removed. If you want to have them
13
back, please join the Smb4K team and help with development.
14
- Support of the deprecated SMBFS file system under Linux has been terminated.
15
- Support of the suid program 'super' has been terminated.
16
- The network search through the search dialog has been improved. You can now
17
search for shares (and mount them).
18
- The Konqueror plugin has not been ported yet.
11
- use of the KAuth framework for privilege escalation.
12
- improved bookmark handling
13
- better integration into the KDE desktop
15
- automatic scanning of the network
16
- support of more command line arguments of the Samba utility programs
17
- improved search dialog
18
- changed way how to force the unmounting of inaccessible shares
21
- improved custom options dialog
22
- visual mount and unmount feedback
22
26
- Scanning for (active) workgroups, hosts, and shares
23
- Mounting and unmounting of remote shares, including unmounting all shares
25
- Access to the files of a mounted share using Konqueror
26
- Auto-detection of external mounts/unmounts
27
- Mounting of recently used shares on start-up
28
- Miscellaneous infos about the remote shares
27
- Support of the CIFS (Linux) and SMBFS (FreeBSD) file system
28
- Mounting and unmounting of shares
29
- Access to the files of a mounted share using a file manager or terminal
30
- Auto-detection of external mounts and unmounts
31
- Remounting of previously used shares on program start
32
- Miscellaneous infos about remote network items and mounted shares
30
34
- WINS server support
31
- Preview of SMB/CIFS shares
32
- Selectable look-up and search methods
35
- Preview of the contents of a share
36
- Several methods to look up the initial list of workgroups and domains
34
- Ability to execute mount and umount SUID root
35
38
- Special handling of homes shares
36
- Ability to bookmark favorite shares
39
- Ability to bookmark favorite shares and organizing them in groups
38
41
- Support of advanced Samba options
39
42
- Support of printer shares
40
(- Konqueror plugin) *** not ported yet ***
42
44
- Synchronization of a remote share with a local copy and vice versa
43
45
- Ability to define custom options for individual servers and shares
46
- Laptop support through the Solid hardware device framework
47
For the list of currently supported translations please visit Smb4K's home page
48
at http://smb4k.berlios.de/information.html.
50
Translations are provided by the KDE translators.
50
52
Supported operating systems
51
53
---------------------------
57
59
This version of Smb4K depends on the development files of the following
59
- kdelibs & kdebase-runtime (>= 4.0.0): The powerful Open Source graphical
61
- kdelibs & kdebase-runtime (>= 4.4.0): The powerful Open Source graphical
60
62
desktop environment for Unix workstations [http://www.kde.org]
61
- Qt (>= 4.3.0): A multiplatform C++ application development framework.
62
[http://www.trolltech.com]
63
- Qt (>= 4.7.0): A multiplatform C++ application development framework.
63
65
- X.org or XFree86 - Freely redistributable implementations of the X Window
64
66
System [http://www.x.org or http://www.xfree86.org]
65
67
- An implementation of the C library
67
69
Make sure that you also have installed all header files of the libraries Qt
68
and KDE are depending on. Recent versions of automake and autoconf are also
70
and KDE are depending on. CMake, the cross-platform, open-source build system,
71
version 2.6 or higher, is also needed.
71
73
For a proper operation, you implicitly need:
72
74
- Support of the /proc filesystem compiled into your kernel if you are using
74
- A sh-compatible shell (bash, dash, ash, etc.) with an existing link /bin/sh
75
or the sh shell itself.
76
- Samba (3.x) including mount.cifs and umount.cifs (preferably >= 1.10)
77
[http://www.samba.org]
76
- Samba (3.x, 3.4 or higher recommended) [http://www.samba.org]
77
- LinuxCIFS utils (>= 4.1 recommended, Linux only)
78
78
- GNU grep [http://www.gnu.org/directory/grep.html]
79
79
- GNU awk (GAWK) or similar [http://www.gnu.org/directory/gawk.html]
80
80
- GNU sed [http://www.gnu.org/directory/sed.html]
81
81
- GNU findutils (xargs) [http://www.gnu.org/directory/findutils.html]
83
83
To enable full functionality, you may also want to install these packages:
84
- sudo [http://www.sudo.ws/sudo/]
85
- Tex Live or similar (dvips) [http://www.tug.org/texlive/]
86
- GNU enscript [http://www.gnu.org/directory/enscript.html]
87
84
- rsync [http://rsync.samba.org/]
89
86
Compilation and Installation
90
87
----------------------------
91
88
1. Extract the source tarball:
93
$ tar xvfj smb4k-0.10.0alpha.tar.bz2
90
$ tar xvfj smb4k-1.0.0.tar.bz2
95
92
2. Create a build directory:
99
At the moment this is not yet mandatory, but strongly adviced.
101
97
3. Change into the build directory:
105
101
4. Configure the source:
107
103
$ cmake -DCMAKE_INSTALL_PREFIX=$(kde4-config --prefix) \
108
-DCMAKE_BUILD_TYPE=Release . [path_to_source]
104
-DCMAKE_BUILD_TYPE=Release ..
110
Replace [path_to_source] with the path to the source code.
106
If you would like to install the core header files as well, add the
107
-DINSTALL_HEADER_FILES=true argument to the above command.
112
109
5. Now compile and install Smb4K:
123
120
-------------------------
124
121
If you experience crashes or similar and want to debug the source code yourself,
125
122
compile the source code with debugging symbols. The procedure is similar to the
126
one described in the "Compilation and Installation" section above except that
127
you need to modify the configure command slightly:
123
one described in the "Compilation and Installation" section above, except that
124
you need to modify the cmake command slightly:
129
126
$ cmake -DCMAKE_INSTALL_PREFIX=$(kde4-config --prefix) \
130
-DCMAKE_BUILD_TYPE=Debug . [path_to_source]
127
-DCMAKE_BUILD_TYPE=Debug ..
132
129
If you found the cause for a bug, please let us know. A backtrace or a patch
133
130
will be much appreciated.
137
134
If you encounter problems when using Smb4K and need help or support, please
138
read the 'Trouble Shooting' section of the handbook first. You can access the
139
handbook from the 'Help' menu by selecting the 'Smb4K Handbook' entry or by
140
pressing the F1 key. An online version of the handbook is also available at
141
http://smb4k.berlios.de/handbook/index.html. Most of the common problems that
142
arise when working with Smb4K are already covered there. If that's not the
143
case, we recommend that you contact the Smb4K-general mailing list at
144
https://lists.berlios.de/mailman/listinfo/smb4k-general to get help. Some of
145
the developers and many users are subscribed and can help.
135
visit our wiki at http://sourceforge.net/p/smb4k/wiki/. Most of the common
136
problems that arise when working with Smb4K are already covered there. You
137
may also look for help in our 'Help'
138
(http://sourceforge.net/p/smb4k/discussion/help/) or 'General Discussion'
139
(http://sourceforge.net/p/smb4k/discussion/general/) forums.
149
You are strongly encouraged to send a bug report to
150
http://developer.berlios.de/bugs/?group_id=769, if you find a problem. Please
151
do not forget to include information about the version of Smb4K and the
152
operating system you are using (Linux or FreeBSD). It might also help if you
153
mention the distribution you have installed (Linux).
154
If you experienced a crash, we would appreciate if you sent us the backtrace,
155
i.e. the output provided by KDE's crash dialog. Please see the section
156
"Debugging the Source Code" for a description how to make sure useful
157
debugging output is returned.
143
You are strongly encouraged to commit a bug report to
144
http://sourceforge.net/p/smb4k/tickets/, if you find a problem. Please read
145
the BUGS file for more information.
added
removed
README
